Skip to content

Get verification

Request

Use this endpoint to get the current status and result of a verification.

The response depends on the verification state:

  • unused — the verification ID is reserved (for example, by a form URL), but the applicant has not submitted the form yet. Only verification_id and status are returned.
  • pending — the verification is in progress. verified is null. The verifications object shows the result of each verification type that is already checked.
  • completed — the verification is finished. verified shows the final result.
Callbacks

To get the result without polling, use the VERIFICATION_COMPLETED callback.

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:27c5caea93ee4656881ef9a30fadd21a3768
curl -i -X GET \
  https://api.kycaid.com/verifications/27c5caea93ee4656881ef9a30fadd21a3768 \
  -H 'API-Key: YOUR_API_KEY_HERE'

Responses

OK

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

Bodyapplication/json
applicant_idstring, = 36 characters

The applicant unique identifier. Not returned when status is unused.

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
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:"27c5caea93ee4656881ef9a30fadd21a3768"
statusstringrequired

The verification status:

  • unused — the applicant has not submitted the form yet
  • pending — the verification is in progress
  • completed — the verification is finished
Enum:"unused""pending""completed"
Example:"completed"
verifiedboolean or null

The overall verification result:

  • true — the applicant passed the verification
  • false — the applicant failed the verification
  • null — the verification is in progress

Not returned when status is unused.

Example:true
verificationsobject

The results of each verification type. The object key is the verification type in lowercase (for example, profile, document, facial, address, tax_id, aml, payment_method, video, database_screening, company).

The object contains only the types that were requested for this verification. Not returned when status is unused.

Response
{
  "applicant_id": "0a1b2c3d4e5f0a1b2c3d4e5f0a1b2c3d4e5f",
  "verification_id": "9f8e7d6c5b4a9f8e7d6c5b4a9f8e7d6c5b4a",
  "status": "completed",
  "verified": true,
  "verifications": {
    "profile": {
      "verified": true,
      "comment": "",
      "decline_reasons": []
    },
    "document": {
      "verified": true,
      "comment": "",
      "decline_reasons": []
    },
    "facial": {
      "verified": true,
      "comment": "",
      "decline_reasons": []
    }
  }
}