Export SumSub KYC token

This API enables merchants to transfer a customer's KYC token from the SumSub provider to XGateway. Consequently, the customer can use XGateway without undergoing the KYC.

Before using this API, contact XGateway support. It is disabled by default and requires signing an additional agreement.

Deprecated

Export a KYC applicant from external provider.

post

Exports an existing applicant from a KYC provider and binds it with a customer using the given external ID.

Access to this endpoint requires a valid API key. The API key is sent in the x-api-key header on requests.

Authorizations

Path parameters

idstringRequired

• The external identifier for the customer, used to uniquely identify them and associate them with a merchant.

Body

• Contains share token and additional params for exporting application data.

Params:

• shareToken - The share token you got from the KYC provider to export the applicant.
• sourceOfFunds - The source of funds. "BUSINESS_INCOME" || "PENSION" || "SALARY" || "OTHER".

shareTokenstringOptional

sourceOfFundsstring · enumOptionalPossible values:

Responses

post

HTTPcURLJavaScriptPython

POST /api/v2/customer/{id}/bank-transfer/export-kyc-applicant HTTP/1.1
Host: api.xgateway.tech
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "shareToken": "string",
  "sourceOfFunds": "BUSINESS_INCOME"
}

{
  "success": true,
  "data": "text"
}