NEUS Docs

npm install @neus/sdk

The JavaScript SDK does four things: build hosted verify URLs, create receipts, poll status, and run server-side gate checks. Use as much or as little as you need — a hosted link and a server check are enough for most apps. MCP calls the same APIs: MCP.

Default placement

Use case	Where
Hosted verify URL, `VerifyGate`	Browser (or WebView)
`gateCheck` with `gateId`	Server
`verifyFromApp`, `npk_*`	Server

Avoid credentialed fetch to api.neus.network from the browser; use SDK helpers or your backend.

Browser (default)

Hosted sign-in and checks on NEUS:

import { getHostedCheckoutUrl } from '@neus/sdk';

window.location.assign(
  getHostedCheckoutUrl({
    gateId: 'gate_your-app-name',
    returnUrl: 'https://myapp.com/callback',
  }),
);

React: VerifyGate from @neus/sdk/widgets — Quickstart. After you have a receipt ID (qHash), optional wait: NeusClient + pollProofStatus — Verifications.

In-app signing (optional)

client.verify({ wallet: ... }) only if signing stays in your page. Pass the wallet/provider explicitly. Non-EVM signing also needs chain as CAIP-2. CAIP-380 Portable Proof · Signing format.

Eligibility on your server

const client = new NeusClient();

const gate = await client.gateCheck({
  gateId: 'gate_your-app-name',
  address: '0x...',
});

API mapping

Need	Method
Hosted handoff	`getHostedCheckoutUrl()`, `VerifyGate`
Sign inside your app	`verify()`
Wait	`pollProofStatus()`
Allow / deny	`gateCheck()` (server)

Optional: timeout on NeusClient.

Defaults

client.verify() defaults private. Security. VerifyGate create also defaults private. Security and trust

JavaScript

Client setup and common methods.

Verifications

Create, poll, and read receipts.

Authentication

Access keys and server auth.

Verification

Platform

SDK

Widget UI

API

SDK Overview

Default placement

Browser (default)

In-app signing (optional)

Eligibility on your server

API mapping

Defaults

Next

JavaScript

Verifications

Authentication

​Default placement

​Browser (default)

​In-app signing (optional)

​Eligibility on your server

​API mapping

​Defaults

​Next

JavaScript

Verifications

Authentication

Default placement

Browser (default)

In-app signing (optional)

Eligibility on your server

API mapping

Defaults

Next