Settings (2.0)

Languages
Servers

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 verification services

Non-doc verification services

Operations

Brazil • CPF number

Request

Access the article from the previous version of the documentation:

Brazilian CPF

Security
Your API key
No request payload

Brazil • CPF number (Alternative)

Request

The Brazil CPF verification service allows you to verify the identity of an individual in Brazil using their individual taxpayer identification number (Cadastro de Pessoas Físicas). The service returns the person’s full name, date of birth, and CPF registration status, including whether the CPF is active, suspended, or cancelled. No document upload is required for verification. This enables quick and automated identity checks against official records.

Security
Your API key
Path
cpf_numberstring= 11 charactersrequired

Brazilian individual taxpayer identification number (Cadastro de Pessoas Físicas), consisting of 11 numeric digits without formatting (no dots or hyphens)

Example: 388415129
No request payload

Responses

OK

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

Bodyapplication/json
One of:
cpf_numberstring= 11 characters

Brazilian individual taxpayer identification number (Cadastro de Pessoas Físicas), consisting of 11 numeric digits without formatting (no dots or hyphens)

full_namestring or null(name)[ 1 .. 100 ] characters^[a-zA-Z ,.''-]{1,100}$

A full name of an object, which consists of a first name and a last name

social_namestring or null(name)

The name the individual chooses to be known by in social or public contexts. May differ from the legal name

mother_namestring or null(name)

Full legal name of the individual’s mother

dobstring or null(date)

The date of birth of a person, formatted according to ISO 8601

genderstring or null

Gender of the individual. M indicates male, F indicates female

Enum"M""F"
cpf_status_codestring

Status code of the CPF number, based on official data - 00 — Valid (CPF is active and in good standing) - 02 — Suspended (CPF is temporarily inactive) - 03 — Canceled (CPF has been officially canceled) - 05 — Pending regularisation (CPF requires corrective action) - 08 — Null (CPF was never issued or is invalid)

Enum"00""02""03""04""05""08""09"
cpf_statusstring

Descriptive status of the CPF number, based on official data. Indicates the current registration condition of the CPF holder - Regular — Valid (CPF is active and in good standing) - Suspensa — Suspended (CPF is temporarily inactive) - Cancelada — Canceled (CPF has been officially canceled) - Pendente — Pending regularisation (CPF requires corrective action) - Nula — Null (CPF was never issued or is invalid)

cpf_status_reasonstring

Human-readable reason for the current CPF registration status, as provided by officials. Explains why the CPF holds its specific status (e.g., suspension due to missing tax declarations, cancellation by request, invalid registration, death)

deceased_yearinteger or null(int32)

Calendar year in which the individual was reported deceased, based on available records. The field may be null if the information is not applicable

cpf_registration_datestring(date)

Date on which the individual's CPF was officially registered by federal tax authorities. Provided in ISO 8601 format (YYYY-MM-DD)

Response
application/json
{ "cpf_number": 388415129, "full_name": "Josh Coffey", "social_name": "Bird", "mother_name": "Maria Aparecida da Silva", "dob": "1976-02-21", "gender": "M", "cpf_status_code": "00", "cpf_status": "Regular", "cpf_status_reason": "REGULAR", "deceased_year": null, "cpf_registration_date": "1998-05-12" }

India • Aadhaar number

Request

Access the article from the previous version of the documentation:

India aadhaar card

Security
Your API key
No request payload

Kazakhstan • IIN (basic)

Request

Access the article from the previous version of the documentation:

Kazakhstan Iin

Security
Your API key
No request payload

Kazakhstan • IIN (extended)

Request

Access the article from the previous version of the documentation:

Kazakhstan Personal Data

Security
Your API key
No request payload

Mexico • CURP

Request

Access the article from the previous version of the documentation:

Mexican CURP

Security
Your API key
No request payload

Nigeria • NIN

Request

Access the article from the previous version of the documentation:

Nigerian NIN

Security
Your API key
No request payload

Nigeria • Driver license number

Request

Access the article from the previous version of the documentation:

Nigerian Driver License Number

Security
Your API key
No request payload

Peru • CUI number (basic)

Request

Access the article from the previous version of the documentation:

Peru DNI

Security
Your API key
Path
dni_numberanyrequired
No request payload

Peru • CUI number (extended)

Request

Access the article from the previous version of the documentation:

Peru DNI Extra

Security
Your API key
Path
dni_numberanyrequired
No request payload

Peru • Foreigner resident ID

Request

The foreigner resident ID (Peru) verification service allows you to verify the identity of a foreign resident in Peru by their CE (Carné de Extranjería) number. The service returns the individual’s full name, given and family names, date of birth, nationality, immigration status, and residence details, including ID issuance and expiration dates

Security
Your API key
Bodyapplication/json
document_numberstring or null[ 7 .. 9 ] charactersrequired

A number of a document

dobstring or null(date)required

The date of birth of a person, formatted according to ISO 8601

application/json
{ "document_number": "006016372", "dob": "1976-02-21" }

Responses

OK

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

Bodyapplication/json
One of:
validationobject
dataobject
Response
application/json
{ "validation": { "valid": true }, "data": { "number": "006016372", "full_name": "Josh Coffey", "first_name": "Josh", "last_name": "Coffey", "names": [ null ], "dob": "1976-02-21", "issue_date": "2020-11-04", "expiry_date": "2028-11-04", "residence_expiry_date": "2028-04-16", "immigration_status": "ESPECIAL", "nationality": "GB", "nationality_demonym_es": "VENEZOLANA" } }

Turkey • Türkiye Cumhuriyeti Kimlik Numarası

Request

Access the article from the previous version of the documentation:

Turkey Identity Number

Security
Your API key
No request payload

Ukraine • BankID/Diia • Create a verification

Request

Create a verification using BankID or Diia services in Ukraine

Security
Your API key
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

Access the article from the previous version of the documentation:

Get external verification

Security
Your API key
Path
external_verification_idanyrequired
No request payload

Phone numbers

Phone numbers

Operations

QES

QES

Operations

Verifications

Verifications

Operations