Sign in

v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB
Counterparty

Initiate Sumsub wallet verification

Starts (or refreshes) a Sumsub liveness flow for wallet verification on a declared self-hosted OWNED counterparty.

Provide userId and counterpartyId in the body, or call with a widget session token (values are taken from the session when omitted).

post/counterparty/wallet-verification/sumsub/initiate

Request body

userIdstring uuid

User id. Provide exactly one of userId / businessId. Required when not using a widget session token; otherwise taken from the session.

businessIdstring uuid

Business id. Provide exactly one of userId / businessId. Required when not using a widget session token; otherwise taken from the session.

counterpartyIdstring uuid

Declared counterparty id. Required when not using a widget session token; otherwise taken from the session.

Example request

{
  "userId": "f714f7e8-6ba1-4802-81cc-12040113ff5b",
  "counterpartyId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Response

success

tokenstring required

Sumsub access token for the liveness flow.

expiresAtstring date-time required
sumsubActionCreatedboolean required

True when a new Sumsub applicant action was created (not a token refresh).

walletVerificationIdstring uuid required
verificationLinkstring required

Direct URL to the Sumsub liveness verification flow for this wallet verification.