Skip to main content
GET
/
v0
/
kyc
/
details
Get detailed KYC verification information
curl --request GET \
  --url https://api.sumvin.com/v0/kyc/details \
  --header 'x-sumvin-pat: <api-key>'
{
  "_links": {
    "self": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "user": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "status": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "access-token": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    }
  },
  "status": "<string>",
  "verified_at": 123,
  "rejected_at": 123,
  "started_at": 123,
  "personal_info": {
    "first_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "<string>",
    "nationality": "<string>",
    "country_of_residence": "<string>"
  },
  "documents": [
    {
      "document_type": "<string>",
      "country": "<string>",
      "submitted_at": 123,
      "image_ids": [
        "<string>"
      ]
    }
  ],
  "verification_complete": false,
  "verification_passed": false,
  "rejection": {
    "can_retry": true,
    "message": "<string>"
  }
}

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 details retrieved successfully

Detailed KYC verification information (GDPR-compliant).

HAL-style hypermedia links for navigation.

status
string
required

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

verified_at
integer | null

Timestamp when KYC was approved (epoch milliseconds).

rejected_at
integer | null

Timestamp when KYC was rejected (epoch milliseconds).

started_at
integer | null

Timestamp when KYC verification was started (epoch milliseconds).

personal_info
KYCPersonalInfo · object

Personal information from KYC. Only name is stored locally.

documents
KYCDocumentInfo · object[]

List of submitted documents and their verification status.

verification_complete
boolean
default:false

True if all required documents have been submitted.

verification_passed
boolean
default:false

True if verification passed all checks.

rejection
KYCRejectionInfo · object

Rejection details if KYC was rejected or needs retry.