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:27c5caea93ee4656881ef9a30fadd21a3768

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"

Example:"approved"

callback_enabledboolean

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

Enum:truefalse

Example:true

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

Enum:truefalse

Example:true

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

Enum:truefalse

Example:true

{
  "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

{
  "status": "ok",
  "data": {
    "verification_id": "27c5caea93ee4656881ef9a30fadd21a3768",
    "verification_status": "approved"
  }
}