Individual verifications

Individuals

post
/api/v1/invites/individuals
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

OK

application/json
post
/api/v1/invites/individuals

The endpoint's body requires the following values to be included in the request:

Parameter
Values
Info
Required?

email

The customer's email address, where the invitation will be sent. I will also be displayed on the "Individual verifications" tab on the lists.

Yes

redirect_url_success

The URL, where the customer will be redirected if the KYC process finishes successfully.

No

redirect_url_failure

The URL, where the customer will be redirected if the KYC process fails.

No

customer_id

external id to be used to match invitation with verification

No

Upload externally calculated risk score

Update External Risk Score

post
/api/v1/webhooks/external_risk_score
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringOptional

uuid

Example: c02d2b4c-e207-4335-a15a-ceb325f8444f
risk_score[simple]stringOptional

(optional) low, medium, high

Example: low
risk_score[detailed][score]stringOptional

string

Example: 99%
risk_score[detailed][reasons][]stringOptional

string

Example: Lorem ipsum dolor sit amet 2
Responses
200

OK

application/json
post
/api/v1/webhooks/external_risk_score

Get the list of all your individual verifications and their details

List

get
/api/v1/verification_individuals
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
statusstringOptional

new | in_progress | data_update_requested | qa |completed

Example: new,in_progress,completed
assessment_statusstringOptional

approved | rejected

Example: approved,rejected
created_atstringOptional

YYYY-MM-DD

Example: 2022-07-14
updated_atstringOptional

YYYY-MM-DD

Example: 2022-07-14
order_bystringOptionalExample: updated_at,desc
Responses
200

OK

application/json
get
/api/v1/verification_individuals
200

OK

Details

get
/api/v1/verification_individuals/{id}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: 0b98b29c-713c-4fe0-a60b-70504563a22e
Query parameters
timestampintegerOptional

defaults to newest

Example: 1692689997
Responses
200

OK

application/json
get
/api/v1/verification_individuals/{id}
200

OK

Details

get
/api/v1/verification_individuals/{verification_individual_id}/people
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_individual_idstringRequiredExample: 0b98b29c-713c-4fe0-a60b-70504563a22e
Query parameters
timestampintegerOptional

(optional) defaults to newest

Example: 1692689997
Responses
200

OK

application/json
get
/api/v1/verification_individuals/{verification_individual_id}/people
200

OK

List

get
/api/v1/verification_individuals/{verification_individual_id}/addresses
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_individual_idstringRequiredExample: 0b98b29c-713c-4fe0-a60b-70504563a22e
Query parameters
timestampintegerOptional

(optional) defaults to newest

Example: 1692689997
Responses
200

OK

application/json
get
/api/v1/verification_individuals/{verification_individual_id}/addresses
200

OK

Details

get
/api/v1/verification_individuals/{verification_individual_id}/addresses/{id}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_individual_idstringRequiredExample: 0b98b29c-713c-4fe0-a60b-70504563a22e
idstringRequiredExample: ed7d5634-d928-4ddf-941c-540fc2a7e56f
Query parameters
timestampintegerOptional

(optional) defaults to newest

Example: 1692689997
Responses
200

OK

application/json
get
/api/v1/verification_individuals/{verification_individual_id}/addresses/{id}
200

OK

Audit Log

get
/api/v1/verification_individuals/{id}/audit_log
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: bba9d483-98bd-487c-bb7c-a77ddb615ff3
Responses
200

OK

application/json
get
/api/v1/verification_individuals/{id}/audit_log
200

OK

Individual documents

Download Attachement

get
/api/v1/attachments/{rest}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
reststringRequiredExample: eyJpZCI6ImI4NmQyMTE4NmU2YmZiNmM5Mjg2ZWNiOTU0N2JhYzNlLnBkZiIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjpudWxsLCJzaXplIjoxNzYzNTYsIm1pbWVfdHlwZSI6ImFwcGxpY2F0aW9uL3BkZiJ9fQ
Responses
200

Successful response

application/json
get
/api/v1/attachments/{rest}
200

Successful response

No content

Upload externally calculated risk score

Update External Risk Score

post
/api/v1/webhooks/external_risk_score
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringOptional

uuid

Example: c02d2b4c-e207-4335-a15a-ceb325f8444f
risk_score[simple]stringOptional

(optional) low, medium, high

Example: low
risk_score[detailed][score]stringOptional

string

Example: 99%
risk_score[detailed][reasons][]stringOptional

string

Example: Lorem ipsum dolor sit amet 2
Responses
200

OK

application/json
post
/api/v1/webhooks/external_risk_score

Last updated

Was this helpful?