Kycaid API (2.0)

Languages
Servers
Mock server

https://docs.kycaid.com/_mock/api/

https://api.kycaid.com/

Addresses

Addresses

Operations

Affiliated persons

Affiliated persons

Operations

Applicants

Applicants

Operations

Blacklist databases

Blacklist databases

Operations

Business activities

Business activities

Operations

Countries

Countries

Operations

Crypto

Crypto

Operations

Documents

Documents

Operations

Files

Files

Operations

Forms

Forms

Operations

Languages

Languages

Operations

Non-doc verifications

Non-doc verifications

Operations

Brazil • CPF number

Request

This documentation is currently in beta and still under construction. Some sections may be incomplete. We are actively working on improvements.

Meanwhile, you may access the article from the previous version of the documentation:

Brazilian CPF

No request payload

India • Aadhaar number

Request

This documentation is currently in beta and still under construction. Some sections may be incomplete. We are actively working on improvements.

Meanwhile, you may access the article from the previous version of the documentation:

India aadhaar card

No request payload

Kazakhstan • IIN (basic)

Request

This documentation is currently in beta and still under construction. Some sections may be incomplete. We are actively working on improvements.

Meanwhile, you may access the article from the previous version of the documentation:

Kazakhstan Iin

No request payload

Kazakhstan • IIN (extended)

Request

This documentation is currently in beta and still under construction. Some sections may be incomplete. We are actively working on improvements.

Meanwhile, you may access the article from the previous version of the documentation:

Kazakhstan Personal Data

No request payload

Mexico • CURP

Request

This documentation is currently in beta and still under construction. Some sections may be incomplete. We are actively working on improvements.

Meanwhile, you may access the article from the previous version of the documentation:

Mexican CURP

No request payload

Nigeria • NIN

Request

This documentation is currently in beta and still under construction. Some sections may be incomplete. We are actively working on improvements.

Meanwhile, you may access the article from the previous version of the documentation:

Nigerian NIN

No request payload

Nigeria • Driver license number

Request

This documentation is currently in beta and still under construction. Some sections may be incomplete. We are actively working on improvements.

Meanwhile, you may access the article from the previous version of the documentation:

Nigerian Driver License Number

No request payload

Peru • CUI number (basic)

Request

This documentation is currently in beta and still under construction. Some sections may be incomplete. We are actively working on improvements.

Meanwhile, you may access the article from the previous version of the documentation:

Peru DNI

Path
dni_numberanyrequired
No request payload

Peru • CUI number (extended)

Request

This documentation is currently in beta and still under construction. Some sections may be incomplete. We are actively working on improvements.

Meanwhile, you may access the article from the previous version of the documentation:

Peru DNI Extra

Path
dni_numberanyrequired
No request payload

Turkey • Türkiye Cumhuriyeti Kimlik Numarası

Request

This documentation is currently in beta and still under construction. Some sections may be incomplete. We are actively working on improvements.

Meanwhile, you may access the article from the previous version of the documentation:

Turkey Identity Number

No request payload

Ukraine • BankID/Diia • Create a verification

Request

Create a verification using BankID or Diia services in Ukraine

Bodyapplication/json
One of:
typestringrequired
Example: "UA_BANK_ID"
form_idstring or null(uuid)= 36 charactersrequired

A unique identifier of a form, assigned by our system after it is created in the Dashboard

applicant_idstring(uuid)= 36 characters

A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request

external_applicant_idstring or null[ 0 .. 50 ] characters

A unique identifier of your user in your system

language_codestring= 2 characters

A language of an object. A two-letter language code according to ISO 639-1

application/json
{ "type": "UA_BANK_ID", "form_id": "d87132ba092d8148ba1891736832d0451ac2", "applicant_id": "723f46ab04feb64f442946f2953a67eaecf7", "external_applicant_id": "cb1eebbe-9945-4e64-8f60-c920f1e3e237", "language_code": "EN" }

Responses

OK

The request was successful, and our system returned an expected response.

Bodyapplication/json
external_verification_idstring or null[ 0 .. 50 ] characters

A unique identifier of an object in your system

verification_idstring or null(uuid)= 36 characters

A unique identifier for a verification, assigned by our system after a verification is created using the “Create a verification" request

applicant_idstring(uuid)= 36 characters

A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request

requestobject
additional_requestsArray of objects
Response
application/json
{ "external_verification_id": "ed469618898d75b149e5c7c4b6a1c415", "verification_id": "d2177cdf067d424a221b5d045dc616bf81f9", "applicant_id": "723f46ab04feb64f442946f2953a67eaecf7", "request": { "method": "PRIVATBANK", "url": "https://bankid.org.ua/DataAccessService/das/authorize?response_type=code&client_id=fb58c7a4-cbb8-4331-a974-228e7ff30ff1&redirect_uri=https://api2.needhelp.com.ua/callbacks/ua-bank-id/d947a2180d6461447119b6d4c4a8f3c201a1" }, "additional_requests": [ { "type": "PRIVATBANK", "method": "GET", "url": "https://bankid.org.ua/DataAccessService/das/authorize?response_type=code&client_id=fb58c7a4-cbb8-4331-a974-228e7ff30ff1&redirect_uri=https://api2.needhelp.com.ua/callbacks/ua-bank-id/d947a2180d6461447119b6d4c4a8f3c201a1" } ] }

Ukraine • BankID/Diia • Get a verification

Request

This documentation is currently in beta and still under construction. Some sections may be incomplete. We are actively working on improvements.

Meanwhile, you may access the article from the previous version of the documentation:

Get external verification

Path
external_verification_idanyrequired
No request payload

Phone numbers

Phone numbers

Operations

QES

QES

Operations

Verifications

Verifications

Operations