Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Sign people in on NEUS. Authenticate your server with a key or gate check.
neus.network/verify via VerifyGate, getHostedCheckoutUrl, or MCP OAuth.
| Where | What | Wallets or keys in your app |
|---|---|---|
| Browser: access gate | VerifyGate + gateId | No |
| Browser: sign-in | getHostedCheckoutUrl + intent: 'login' | No |
| Server | NeusClient + gateCheck with the same gateId | No |
| Automation as your profile | NeusClient + profile access key (npk_*) | No |
| Advanced server | verifyFromApp after per-user approval | No |
| Browser (exception) | client.verify({ wallet }) | Yes. Signing format |
import { VerifyGate } from '@neus/sdk/widgets';
<VerifyGate gateId="gate_your-app-name">
<ProtectedContent />
</VerifyGate>;
import { getHostedCheckoutUrl } from '@neus/sdk';
const url = getHostedCheckoutUrl({
gateId: 'gate_your-app-name',
returnUrl: 'https://yourapp.com/auth/callback',
});
const loginUrl = getHostedCheckoutUrl({
intent: 'login',
returnUrl: 'https://yourapp.com/auth/callback',
});
import { NeusClient } from '@neus/sdk';
const client = new NeusClient();
const result = await client.gateCheck({
gateId: 'gate_your-app-name',
address: user.accountAddress,
});
if (result.data?.gate?.allRequiredSatisfied !== true) {
// Send the visitor back to VerifyGate or NEUS sign-in
}
import { NeusClient } from '@neus/sdk';
// Server only. Never ship npk_* in a browser bundle
const client = new NeusClient({ apiKey: process.env.NEUS_ACCESS_KEY });
Authorization: Bearer <npk_...>.
neus setup. Default is browser OAuth. Set NEUS_ACCESS_KEY first only for servers and CI.
See MCP setup.
verifyFromAppconst client = new NeusClient({
appId: 'acme-web',
appOrigin: 'https://yourapp.com',
apiKey: process.env.NEUS_ACCESS_KEY, // optional. Your builder profile
});
await client.verifyFromApp({
user: { walletAddress: user.accountAddress },
verifier: 'ownership-basic',
content: 'Hello NEUS',
});