SMsmileapi
Verification

List Verifications

Changed on

List verificatins.

get/alpha/verifications

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/alpha/verifications
  • Auth
    HTTP basic

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": "George",
          "middleName": "Cimafranca",
          "lastName": "Palomero",
          "suffix": "Jr.",
          "fullName": "George Cimafranca Palomero Jr.",
          "additionalData": {
            "email": "john.doe@smile.com",
            "dob": "2000-01-21",
            "gender": "Male",
            "address": "123 Main St, Anytown, CA 12345",
            "employer": "Google",
            "ids": [
              {
                "idType": "tin_ph",
                "idSubType": "CRIMINOLOGIST",
                "idNumber": "123456789"
              }
            ]
          },
          "consent": {
            "type": "Terms and Conditions",
            "version": "1.0.0",
            "consentedAt": "2021-04-14T09:30:24Z",
            "consentedWith": "I agree to the terms and conditions"
          }
        }
      }
    ]
  }
}

Changes

  • v1a68faef4b017Revision changes
    • breaking

      the ///// response's property type changed from string to no type, and format from date-time to no format for status

    • info

      added to the ///// response property allOf list for the response status

  • v1a4930eb49f4dRevision changes
    • breaking

      the ///// response's property type changed from string to no type, and format from date to no format for status

    • breaking

      the ///// response's property type changed from string to no type for status

    • breaking

      the /////// response's property type changed from string to no type for status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the /////// response property allOf list for the response status

    • info

      removed the Female enum value from the ///// response property for the response status

    • info

      removed the Male enum value from the ///// response property for the response status

    • info

      removed the Non-binary enum value from the ///// response property for the response status

    • info

      removed the undefined enum value from the ///// response property for the response status