Skip to content

Overview

Terms of Service

Languages
Servers

https://api.kycaid.com/

🇧🇷 Brazil

Brazil

Operations

🇮🇳 India

🇮🇳 India

Operations

🇰🇿 Kazakhstan

🇰🇿 Kazakhstan

Operations

🇲🇽 Mexico

🇲🇽 Mexico

Operations

🇳🇬 Nigeria

🇳🇬 Nigeria

Operations

🇵🇪 Peru

🇵🇪 Peru

Operations

🇹🇷 Turkey

🇹🇷 Turkey

Operations

🇺🇦 Ukraine

🇺🇦 Ukraine

Operations

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"
    }
  ]
}

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