Sign in
Verification

Request Verification

sumbit required parameters to request verification.

post/alpha/verifications

Request body

firstNamestring

First Name

middleNamestring

Middle Name

lastNamestring

Last Name

suffixstring

Suffix

fullNamestring

Full Name

Example request

{
  "additionalData": {
    "dob": "2000-01-21",
    "gender": "Male"
  },
  "consent": {
    "consentedAt": "2021-04-14T09:30:24Z"
  }
}

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "createdAt": "2021-04-14T09:30:24Z",
    "updatedAt": "2021-04-14T09:30:24Z",
    "requestMeta": {
      "additionalData": {
        "dob": "2000-01-21",
        "gender": "Male"
      },
      "consent": {
        "consentedAt": "2021-04-14T09:30:24Z"
      }
    }
  }
}

Changes