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

Get a form URL

Request

Retrieve a URL for a form

Path
form_idstring or null(uuid)= 36 charactersrequired

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

Example: d87132ba092d8148ba1891736832d0451ac2
Bodyapplication/json
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

redirect_urlstring or null<= 2048 characters

The URL in your system to which a user will be redirected after completing and submitting a form

application/json
{ "applicant_id": "723f46ab04feb64f442946f2953a67eaecf7", "external_applicant_id": "cb1eebbe-9945-4e64-8f60-c920f1e3e237", "redirect_url": "https://kyc.example.com/complete" }

Responses

OK

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

Bodyapplication/json
form_idstring or null(uuid)= 36 characters

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

form_urlstring<= 2048 characters

A one-time URL to a form that includes a form token. The form remains open for completion via the URL until a user completes it

verificaiton_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

form_tokenstring(uuid)= 36 characters

A unique token for a form, generated by our system, and included as part of a form URL

verification_attempts_leftinteger or null(number)

A number of verification attempts available for a user, set in form settings in the Dashboard. A null value means “not limited”. It equals 0 if set in the settings

Response
application/json
{ "form_id": "d87132ba092d8148ba1891736832d0451ac2", "form_url": "https://forms-new.kycaid.com/7505262b02bb0145c62a04d969eacedb4873", "verificaiton_id": "d2177cdf067d424a221b5d045dc616bf81f9", "form_token": "7505262b02bb0145c62a04d969eacedb4873", "verification_attempts_left": 5 }

Get forms

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 forms

No request payload

Languages

Languages

Operations

Non-doc verifications

Non-doc verifications

Operations

Phone numbers

Phone numbers

Operations

QES

QES

Operations

Verifications

Verifications

Operations