POST/api/v2/users/{userId}/kyc/sumsub-access-token

Get a SumSub access token for the user (for mobile SDK)

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
Field	Type	Required	Description
userId (path)	unknown	Yes	User ID

Request body

application/json

Request body fields
Field	Type	Required	Description
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+.
DocumentIssueDate	string	Yes	Format: YYYY-MM-DD.
Nationality	string	No	ISO 3166-1 alpha-3 country code. When USA, Ssn is required.
Ssn	string	No	Required for US nationals. Exactly 9 digits, without separators.
IpAddress	string	No

Responses

200 — OK

Response 200 fields
Field	Type	Required
Success	boolean	No
Token	string	No
UserId	string	No
Error	unknown	No

401 — Unauthorized

Response 401 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

404 — Not Found

Response 404 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

500 — Internal Server Error

Response 500 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

Example request

curl -X POST "https://{base_url}/api/v2/users/{userId}/kyc/sumsub-access-token" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"Occupation":"…","AnnualSalary":"…","AccountPurpose":"…","ExpectedMonthlyVolume":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.