Identity Verification (IDV)

Initiate Sumsub IDV for a user

Changed on

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.

post/api/sumsub-service/v1/idv

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/sumsub-service/v1/idv
  • Auth
    none declared

Request body

userIdstring required

The BitGo user ID

enterpriseIdstring required

The BitGo enterprise ID

verificationType'penny-drop' | 'video-id' | 'liveness-only' | 'deposit-verification' required

The verification flow to use. 'penny-drop' requires a bank transfer step. 'video-id' uses a video identification step. 'liveness-only' uses a liveness check only. 'deposit-verification' uses SumSub liveness plus an in-house SEPA deposit review, not a SumSub-hosted bank check.

sumsubShareTokenstring

Share token to copy an existing applicant from another Sumsub environment

lang'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'

Language code for the Sumsub WebSDK UI (ISO 639-1). Defaults to en.

includeSdkTokenboolean

When true, generates and returns a Sumsub Mobile SDK access token alongside the WebSDK URL. Not supported for penny-drop verification — returns 400 if combined with verificationType 'penny-drop' (MobileSDK does not support the penny-drop flow).

Response

200

OR
OR
OR
OR

Changes

  • 41968a022e9fRevision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the non-success response with the status

  • 88b45e633667Revision changes
    • breaking

      added subschema #3: Liveness Complete to the response body oneOf list for the response status