Skip to content

Overview (1.0)

Download OpenAPI description
objects.json
objects.yaml
Overview
Terms of Service
Languages
Servers
https://api.kycaid.com/

Addresses

Addresses

Operations

Affiliated persons

Affiliated persons

Operations

Applicants

Applicants

Operations

Documents

Documents

Operations

Files

Files

Operations

Forms

Forms

Operations

Verifications

Verifications

Operations

Create a verification

Request

Access the article from the previous version of the documentation:

Create verification

Security
API-Key
No request payload

Get a verification

Request

Access the article from the previous version of the documentation:

Get verification

Security
API-Key
Path
verification_idanyrequired
No request payload

Get a report

Request

Access the article from the previous version of the documentation:

Get verifications report

Security
API-Key
No request payload

Update verification status

Request

This endpoint is used to programmatically change the status of an existing verification record. This is typically utilised by your systems to finalise or adjust a verification's outcome after review

Security
API-Key
Path
verification_idstring or null= 36 charactersrequired

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

Example: d2177cdf067d424a221b5d045dc616bf81f9
Bodyapplication/json
verification_statusstringrequired

The status of the verification. This value is set automatically by our system, or manually in the Admin panel or the Dashboard after a review

  • approved: a reviewed and approved verification
  • declined: a reviewed and declined verification
Enum"approved""declined"
callback_enabledboolean

If set to true, our system will send the “Verification completed” callback for the specified verification

Enumtruefalse
project_owner_email_enabledboolean

If set to true, a notification email regarding the status of the verification will be sent by our system to the project owner of the project

Enumtruefalse
applicant_email_enabledboolean

If set to true, a notification email regarding the status of the verification will be sent by our system directly to the applicant who completed the form

Enumtruefalse
application/json
{
  "verification_status": "approved",
  "callback_enabled": true,
  "project_owner_email_enabled": true,
  "applicant_email_enabled": true
}

Responses

OK

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

Bodyapplication/json
statusstring
Example: "ok"
dataobject
Response
application/json
{
  "status": "ok",
  "data": {
    "verification_id": "d2177cdf067d424a221b5d045dc616bf81f9",
    "verification_status": "approved"
  }
}