Skip to main content
If your platform already uses Sumsub for identity verification, you can pass a share token to Contro instead of re-collecting KYC data. This avoids duplicate verification and provides a faster onboarding experience.

Prerequisites

  • Your platform is a Sumsub client (the “donor”)
  • Your user has completed KYC verification on your Sumsub-integrated platform
  • You can generate share tokens from your Sumsub account targeting Contro’s client ID

Flow

  1. Your user completes KYC on your platform via Sumsub
  2. You generate a Sumsub share token targeting Contro’s client ID
  3. Call POST /partner/cardholders with kycSource: "sumsub" and the share token
  4. Contro imports the applicant data immediately — the token is not stored

Create a cardholder with Sumsub KYC

curl -X POST https://api.contro.me/v1/partner/cardholders \
  -H "x-contro-api-key: $CONTRO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "externalUserId": "user_42",
    "kycSource": "sumsub",
    "sumsubShareToken": "eyJhbGciOiJub25lIn0...",
    "email": "jane@example.com",
    "phoneNumber": "+14155552671"
  }'

Key details

  • firstName and lastName are extracted automatically from the imported Sumsub applicant data. You do not need to provide them.
  • The share token is imported immediately at cardholder creation time. It is not stored.
  • If the imported applicant is already approved, kycStatus is set to "approved" right away.
  • If the applicant is still pending review in Sumsub, kycStatus starts as "pending" and updates via webhook when Sumsub completes the review.

Required fields

FieldTypeDescription
externalUserIdstringYour unique identifier for this user
kycSourcestringMust be "sumsub"
sumsubShareTokenstringSumsub share token from your platform
emailstringValid email address
phoneNumberstringE.164 formatted phone number

Sandbox behavior

In sandbox mode, the share token import is skipped. A dummy applicant ID is stored and KYC is auto-approved.