Documentation
API ReferenceChangelogFAQDashboard

Copy Applicant

Easily duplicate applicant data across Sumsub clients.

You can use the Copy Applicant feature to duplicate applicant data across multiple client keys. Once clients agree to share verification data, they become the donor and the recipient.

Copy Applicant duplicates verification data across client keys without performing additional checks. This process does not qualify as a KYC procedure under most regulatory standards. If regulatory-compliant KYC is required, use the Reusable KYC service.

How Copy Applicant works

The Copy Applicant process involves the following steps:

  1. Donor generates a new share token for a specific applicant. To generate a share token, use this API method:
curl --request POST \
     --url https://api.sumsub.com/resources/accessTokens/shareToken \
     --header 'content-type: application/json' \
     --data '
            {
              "applicantId": "63e092c51b7b4030f2e01154",
              "forClientId": "CoolCoinLtd",
              "ttlInSecs": "600"
            }
      '
NameTypeRequiredDescription
applicantIdStringYesApplicant ID in donor company.
forClientIdStringYesClient ID for recipient. You can find your clientId in the Dashboard in the applicant profile (field Created for) and in the response (field clientId).
ttlInSecsIntegerNoTime to live in seconds. Default 1200.

Response

A new share token is returned.

{
  "token": "eyJhbGciOiJub25lIn0.eyJqdGkiOiJfYWN0LTZmODI2ZTU0LTE2MzctNDViMS05NzMyLWY1MjZiN2YxNWE3YyIsInVybCI6Imh0dHBzOi8vYXBpLnN1bXN1Yi5jb20ifQ.",
  "forClientId": "CoolCoinLtd"
}

📘

Info

Make sure your integration code does not validate or analyze the access token content, as the format is not fixed and may undergo further changes in the future. The token must be treated as an arbitrary string with the maximum length of 1KB.

  1. Donor passes the share token to the recipient.
  2. Recipient includes the share token in the request using this API method to import the applicant data.
curl -X POST \
    'https://api.sumsub.com/resources/applicants/-/import?shareToken=_act-0b8a43f6-b70f-4ad3-bda9-7ce904589380'
NameTypeRequiredDescription
shareTokenStringYesShare token generated by Company A.
resetIdDocSetTypesStringNoSpecify one or a few comma-separated document types if an applicant has to resubmit the documents. Examples, SELFIE, IDENTITY, and so on.
userIdStringNoSets your own externalUserId for the imported applicant. In case of an empty value, we will generate a random one.
levelNameStringYesSets the specified levelName to the imported applicant and sets init in case not all required documents are present.

Response

A new applicant ID is returned.

{
    // Applicant in Company B
    "id": "5d08a63239b79354a2ebaa1d",
    "createdAt": "2019-06-18 10:52:02",
    "clientId": "CoolCoinLtd",
    ...
}

❗️

Important

Share tokens are invalidated once used.

How to enable Copy Applicant

Step 1: Sign contract

Contact our support team at [email protected] so that the donor and recipient can each sign a one-time contract to use the service. You will not have to sign any additional documents.

Step 2: Add sharing partners

Once the service is enabled, you can add sharing partners directly in the Dashboard. For more instructions, see this article.

Step 3: Use share token

Implement the share token approach as described above.

Updated about 12 hours ago