Kyc

Create KYC record for individual

post
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Body
kycFirstNamestring · min: 2 · max: 150RequiredExample: John
kycLastNamestring · min: 2 · max: 150RequiredExample: Doe
kycDocumentTypestring · enumRequiredExample: DRIVER_LICENSEPossible values:
kycDocumentIdstring · min: 4 · max: 50RequiredExample: D1234567
kycDocumentIssuerstring · enumRequiredExample: CAPossible values:
kycDocumentIssuedDatestring · nullableRequiredExample: 05/20/1990
kycDocumentExpirationDatestring · nullableRequiredExample: 05/20/1990
kycDocumentDobstring · nullableRequiredExample: 05/20/1990
kycProviderstring · enumRequiredPossible values:
kycLogstringRequiredExample: {"review":"Approved","inquiry_id":"inq_123"}
kycDocumentFrontFileIdanyRequiredExample: file_01j5y5ghx8fvc83dmx3pznq7hv
kycDocumentBackFileIdanyOptionalExample: file_01j5y5ghx8fvc83dmx3pznq7hv
kycSelfieFileIdanyOptionalExample: file_01j5y5ghx8fvc83dmx3pznq7hv
Responses
post
/clients/api/v1/kycs/{id}

Update KYC record for individual

patch
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Body
kycFirstNamestring · min: 2 · max: 150OptionalExample: John
kycLastNamestring · min: 2 · max: 150OptionalExample: Doe
kycDocumentTypestring · enumOptionalExample: DRIVER_LICENSEPossible values:
kycDocumentIdstring · min: 4 · max: 50OptionalExample: D1234567
kycDocumentIssuerstring · enumOptionalExample: CAPossible values:
kycDocumentIssuedDatestring · nullableOptionalExample: 01/15/2020
kycDocumentExpirationDatestring · nullableOptionalExample: 01/15/2030
kycDocumentDobstring · nullableOptionalExample: 05/20/1990
kycProviderstring · enumOptionalPossible values:
kycLogstringOptionalExample: {"review":"Approved","inquiry_id":"inq_123"}
kycDocumentFrontFileIdanyOptionalExample: file_01j5y5ghx8fvc83dmx3pznq7hv
kycDocumentBackFileIdanyOptionalExample: file_01j5y5ghx8fvc83dmx3pznq7hv
kycSelfieFileIdanyOptionalExample: file_01j5y5ghx8fvc83dmx3pznq7hv
Responses
chevron-right
200

200

application/json
idstringRequiredExample: entityprefix_01j1xgme5qeqq97gpdztd7e4a6
__entitystringOptionalExample: Entity
createdAtone ofRequiredExample: 2026-03-27T15:47:09.539Z
string · date-timeOptional
or
string · date-timeOptional
updatedAtone ofRequiredExample: 2026-03-27T15:47:09.539Z
string · date-timeOptional
or
string · date-timeOptional
deletedAtone of · nullableRequiredExample: 2026-03-27T15:47:09.540Z
string · date-timeOptional
or
string · date-timeOptional
tidstring · nullableRequiredExample: third_party_kyc_123
platformstringRequiredExample: KYC Platform
individualIdstringRequiredExample: individual_01j1xgme5qeqq97gpdztd7e4a6
documentTypestringRequiredExample: Passport
documentImagestringRequiredExample: https://example.com/passport.jpg
kycStatusstring · enumRequiredExample: PENDINGPossible values:
reasonstring · nullableRequiredExample: Document unclear
responsestring · nullableRequiredExample: Submitted clearer document
patch
/clients/api/v1/kycs/{id}

Last updated