Skip to main content
GET
/
v0
/
kyc
/
status
Get current KYC verification status
curl --request GET \
  --url https://api.sumvin.com/v0/kyc/status \
  --header 'x-sumvin-pat: <api-key>'
{
  "_links": {
    "self": {
      "href": "/v0/kyc/status"
    },
    "user": {
      "href": "/v0/user/me"
    }
  },
  "applicant_id": "65abc123def456",
  "has_passport": false,
  "status": "approved",
  "verified_at": 1704067200000
}

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"

Query Parameters

​
refresh
boolean
default:false

Response

KYC status retrieved successfully

​
_links
KYCLinks · object
required

HAL-style hypermedia links for navigation.

​
status
string
required

Current KYC status: pending, in_progress, retry, approved, or rejected.

​
applicant_id
string | null
required

Sumsub applicant ID. Null if verification not started.

​
verified_at
integer | null
required

Timestamp when KYC was approved (epoch milliseconds). Null if not approved.

​
rejected_at
integer | null
required

Timestamp when KYC was rejected (epoch milliseconds). Null if not rejected.

​
reject_reason
string | null
required

Reason for rejection or retry request. Null if approved or pending.

​
global_id
string | null

Deterministic SumSub global ID for partner sharing. Null if not connected via ID Connect.

​
has_passport
boolean
default:false

True if a verified passport document is on file in SumSub.