PUT
/api/v2/users/{userId}/kyc/sumsub-tokenUpdate user SumSub KYC token
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userId (path) | unknown | Yes | User ID |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| SumsubSdkToken | string | Yes | |
| FirstName | string | No | |
| LastName | string | No | |
| MiddleName | string | No | |
| Dob | string | No | |
| Gender | string | No | |
| Nationality | string | No | ISO 3166-1 alpha-2 country code. |
| Country | string | No | |
| PlaceOfBirth | string | No | |
| CountryOfBirth | string | No | |
| string | No | ||
| NationalId | string | No | |
| IdType | string | No | |
| DocumentIssueDate | string | Yes | Format: YYYY-MM-DD. |
| ExpiryDate | string | Yes | |
| Ssn | string | No | Required when Nationality is US. Exactly 9 digits, without separators. |
| PhoneCountryCode | string | Yes | |
| Phone | string | Yes | |
| Occupation | string | Yes | |
| AnnualSalary | 0-10000 | 10001-30000 | 30001-50000 | 50001-75000 | 75001-100000 | 100001-150000 | … | Yes | Possible values: 0-10000, 10001-30000, 30001-50000, 50001-75000, 75001-100000, 100001-150000, 150001-250000, 250001+. |
| AccountPurpose | string | Yes | |
| ExpectedMonthlyVolume | 0-1000 | 1001-5000 | 5001-15000 | 15001-50000 | 50001-100000 | 100001+ | Yes | Possible values: 0-1000, 1001-5000, 5001-15000, 15001-50000, 50001-100000, 100001+. |
| IpAddress | string | No | |
| Street | string | No | |
| Street2 | string | No | |
| City | string | No | |
| State | string | No | |
| PostCode | string | No | |
| AddressCountry | string | No | ISO 3166-1 alpha-2 country code. |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| UserId | unknown | No | |
| SumsubSdkToken | string | No | |
| Message | string | No | |
| Success | boolean | No | |
| SumsubUserId | string | No | |
| UpdatedAt | string | No |
400 — Bad Request
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
404 — Not Found
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
500 — Internal Server Error
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
Example request
curl -X PUT "https://{base_url}/api/v2/users/{userId}/kyc/sumsub-token" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"SumsubSdkToken":"…","DocumentIssueDate":"…","ExpiryDate":"…","PhoneCountryCode":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.