Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Verification

List Verifications

List verificatins.

get/alpha/verifications

Query parameters

sizeinteger
Example:50

The number of objects you want returned in a collection.

cursorstring

Uses the filter values of the previous page to determine the next set of items.

verificationIdstring

Filter to those associated with a particular verification ID.

finalMatchesboolean

Filter to those associated with verification final match result.

startDatestring date

Filter by create date, start of date range (YYYY-MM-DD)

endDatestring date

Filter by create date, end of date range (YYYY-MM-DD)

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": {
    "nextCursor": "1259723474",
    "items": [
      {
        "createdAt": "2021-04-14T09:30:24Z",
        "updatedAt": "2021-04-14T09:30:24Z",
        "requestMeta": {
          "firstName": "John",
          "middleName": "Doe",
          "lastName": "Smith",
          "suffix": "Jr",
          "fullName": "John Doe Smith Jr",
          "additionalData": {
            "email": "john.doe@smile.com",
            "dob": "2000-01-21",
            "gender": "Male",
            "address": "123 Main St, Anytown, CA 12345",
            "employer": "Google",
            "ids": [
              {
                "idSubType": "CERTIFIED PUBLIC ACCOUNTANT",
                "idNumber": "1234567890"
              }
            ]
          },
          "consent": {
            "type": "Terms and Conditions",
            "version": "1.0.0",
            "consentedAt": "2021-04-14T09:30:24Z",
            "consentedWith": "I agree to the terms and conditions"
          }
        }
      }
    ]
  }
}