Sign in
Verification

Request Verification

Request a Verification object.

This endpoint requires consent and the identity information to verify. Place idType, idSubType, and idNumber in additionalData.ids. The Sandbox field dateOfBirth maps to additionalData.dob, and gender maps to additionalData.gender.

Supported Sandbox ID Types

ID TypeAvailable Test Fields
tin_phfullName, firstName, middleName, lastName, suffix, idNumber, gender, dateOfBirth
pagibig_phfullName, idNumber
prclicense_phfullName, idSubType, idNumber, dateOfBirth
nbi_phfullName, idNumber

Sandbox Test Values

ID TypeParameterValue
tin_phidTypetin_ph
tin_phfullNameGeorge Cimafranca Palomero Jr.
tin_phfirstNameGeorge
tin_phmiddleNameCimafranca
tin_phlastNamePalomero
tin_phsuffixJr.
tin_phidNumber123456789
tin_phgenderMale
tin_phdateOfBirth1970-08-24
pagibig_phidTypepagibig_ph
pagibig_phfullNameGeorge Cimafranca Palomero Jr.
pagibig_phidNumber123456789012
prclicense_phidTypeprclicense_ph
prclicense_phfullNameGeorge Cimafranca Palomero Jr.
prclicense_phidSubTypeCRIMINOLOGIST
prclicense_phidNumber0123456
prclicense_phdateOfBirth1970-08-24
nbi_phidTypenbi_ph
nbi_phfullNameGeorge Cimafranca Palomero Jr.
nbi_phidNumberABC123DEF4-56GHI789J

Use one Sandbox record per Verification request. For inputs outside these test values, the Sandbox may not return a matched verification result.

post/alpha/verifications

Request body

firstNamestring

First Name

middleNamestring

Middle Name

lastNamestring

Last Name

suffixstring

Suffix

fullNamestring

Full Name

Example request

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

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