Ctrl+K

Initiate Sumsub IDV for a user

post/api/sumsub-service/v1/idv

Initiates the Sumsub identity verification flow for a user within an enterprise. Returns a WebSDK URL when verification is pending, or a completion status if the user has already been verified.

Request Body

Body
userId string required
The BitGo user ID
enterpriseId string required
The BitGo enterprise ID
sumsubShareToken string
Share token to copy an existing applicant from another Sumsub environment
Min length: >= 1 characters
lang string
Language code for the Sumsub WebSDK UI (ISO 639-1). Defaults to en.
Allowed values: ar hy az bn bg my ca km zh zh-tw hr cs da nl en et fl fi fr ka de el ha he hi hu id it ja kk ko lo lv lt ms no fa pl pt pt-br ro ru sr sk sl es sw sv tg tr th uk ur uz vi zu

200 Response

One of
idvId string required
status string required
Allowed value: pending
url string required
expiresAt string required

400 Response

error string required
Error message

403 Response

error string required
Error message

500 Response

error string required
Error message