AIaiprise
SDK

Get Onboarding SDK Token

Changed on

Get an onboarding SDK token for a verification session you want to resume without OTP. (Only for KYB sessions)

Server-side only. Call this from your backend. The X-API-KEY it requires is a company-wide secret that authenticates every AiPrise API call you make, so it must never be shipped to a browser, embedded in frontend code, or passed through an end user's device - anyone who obtains it can act as your company across the entire API.

The minted token is what crosses that boundary, not the key: it is scoped to this one verification session and expires 5 minutes after it is issued, so a token that leaks exposes a single session for a few minutes rather than your whole account. Mint it on your server at the moment you are about to start the SDK, and hand the SDK only the token.

get/verify/get_onboarding_sdk_token/{session_id}

Request

Path parameters

session_idstring required

Verification session ID

Response

Successful operation

onboarding_sdk_tokenstring

Short-lived JWT (HS256) scoped to this one verification session. Expires 5 minutes after it is issued, so mint it when you are about to hand it to the SDK. Its payload carries company_id, verification_session_id, type (always onboarding_sdk), iat and exp, but treat the token as opaque - the SDK passes it back to AiPrise as-is.

successboolean

Whether the operation was successful

Example response

{
  "onboarding_sdk_token": "<base64url-header>.<base64url-payload>.<signature>"
}

Changes