Organizations

Start verification

Start (or refresh) a verification session for the in-scope organization. Returns a Sumsub-hosted URL plus a short-lived access token for embedding the WebSDK in your own UI.

Idempotent w.r.t. the org’s verification record: the provider keys the applicant by externalUserId = organizationId, so repeated calls return new tokens for the same applicant rather than starting over. Use this to re-issue an expired token (~30 min TTL) or to resume after RESUBMISSION_REQUIRED.

See Verification for the delivery options (hosted URL vs. embedded WebSDK).

POST

organizations

verification

cURL

curl --request POST \
  --url https://api.nxos.io/v1/organizations/verification \
  --header 'Authorization: <authorization>'

{
  "object": "verification_session",
  "url": "https://in.sumsub.com/idensic/l/#/sbx_token_placeholder",
  "accessToken": "_act-sbx-jwt-token-placeholder"
}

Headers

Authorization

string

required

Bearer token. Format: Bearer <api_key>

Idempotency-Key

string

Unique key per logical operation. UUID v4 recommended. Max 255 characters.

Response

The request has succeeded.

Session credentials for handing off to the provider-hosted (Sumsub) verification flow. Returned by POST /v1/organizations/verification.

object

enum<string>

required

Object type. Always verification_session.

Available options:

verification_session

url

string

required

Customer-facing URL that hosts the full verification flow on the provider's site. Share this with the applicant by email, redirect, or in-app link.

accessToken

string

required

Short-lived (~30 min) access token. Pass to the Sumsub WebSDK if you'd rather embed the flow in your own UI. Refresh by calling POST /v1/organizations/verification again for the same org.

Get verification

Import verification

cURL

curl --request POST \
  --url https://api.nxos.io/v1/organizations/verification \
  --header 'Authorization: <authorization>'

{
  "object": "verification_session",
  "url": "https://in.sumsub.com/idensic/l/#/sbx_token_placeholder",
  "accessToken": "_act-sbx-jwt-token-placeholder"
}