Skip to main content
POST
/
v0
/
kyc
/
applicant
Create KYC applicant
curl --request POST \
  --url https://api.sumvin.com/v0/kyc/applicant \
  --header 'x-sumvin-pat: <api-key>'
{
  "_links": {},
  "applicant_id": "<string>",
  "user_id": "<string>",
  "already_existed": false
}

Authorizations

​
x-sumvin-pat
string
header
required

Personal access token issued to the Sumvin CLI. Send it in the x-sumvin-pat header to authenticate as the owning user.

Headers

​
x-juno-orgid
string | null

Tenant org ID for multi-tenant auth

​
x-sumvin-token
string | null
​
x-sumvin-pat
string | null
​
x-juno-jwt
string | null
​
X-Timestamp-Format
string

Controls how timestamp fields are serialized in JSON response bodies.

Default (header omitted or any other value): epoch milliseconds as integers. iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.

Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".

Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.

Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.

Example:

"iso8601"

Response

Applicant already exists

​
_links
Links · object
required

HAL-style hypermedia links for navigation and available actions.

​
applicant_id
string
required

Sumsub applicant ID.

​
user_id
string
required

User ID associated with this applicant.

​
already_existed
boolean
default:false

True if applicant was already created.