This product is mainly used for SSS, UMID, TIN, PRC and DL card verification in the Philippines. It is an asynchronous interface, so this document contains two parts: the POST call API and the GET call API.
URL Request Methods Content-Type Output Format Character Set api-base-url?partner_code=xxx&partner_key=xxx POST application/json JSON UTF-8
Parameter Type Description Required Notes partner_code String Partner Code Required Assigned by TD partner_key String Partner Key Required Assigned by TD
Parameter Type Description Required Notes id_number String ID number Required Unique identifier id_type String ID type Required Enumeration: SSS, UMID, TIN, PRC, DL phone_number String Phone number Strongly recommended 11 digits, starts with 0 name String Name Required Full name first_name String First name on ID card Conditionally required Required for PRC when prc_verification_mode=verify_using_name last_name String Last name on ID card Conditionally required Required for PRC when prc_verification_mode=verify_using_name country String Country Required 2-letter country code (ISO 3166) expiry_date String Expiration date on card Conditionally required Format: yyyy-MM-dd, required for DL serial_number String Serial number on card Conditionally required Required for DL prc_verification_mode String PRC verification mode Conditionally required Required for PRC profession String Profession on ID card Conditionally required Required for PRC birth_date String Date of Birth Conditionally required Format: yyyy-MM-dd, required for PRC with prc_verification_mode=verify_using_license
JSON
{
"country": "PH",
"phone_number": "0217656789",
"id_type": "TIN",
"id_number": "380486089000",
"name": "Joe"
}Parameter Type Description Required Notes code Integer API status code Required - message String Status Information Required Returns 'success' when the API call is successful sequence_id String Unique response code Required Tracks each request task_id String Task ID Required Used to query results
JSON
{
"code": 200,
"message": "success",
"sequence_id": "1648777165770866F82AC7F326307055",
"task_id": "74f4c926-250c-43ca-9c53-453e87ceacd1"
}Code Message Description Charged 200 Success Successful verification YES 301 Service not purchased Service not purchased NO 302 Service suspended Traffic blocked NO 303 Insufficient balance Traffic insufficient NO 304 Service expired Service expired NO 305 Daily maximum volume reached Daily maximum volume reached NO 600 Service Temporarily Unavailable Service reached limit NO 11350 Internal error Internal error NO 11301 {parameter} empty{parameter} emptyNO 11304 Country partner not open Country partner not open NO 11340 {parameter} error{parameter} errorNO
URL Request Methods Content-Type Output Format Character Set api-base-url?partner_code=xxx&partner_key=xxx POST application/json JSON UTF-8
Parameter Type Description Required Notes partner_code String Partner Code Required Assigned by TD partner_key String Partner Key Required Assigned by TD
Parameter Type Required Notes task_id String Required The task_id returned by the first call
Parameter Type Description Required Notes code Integer API status code Required - message String Status Information Required Specific abnormal reasons will be provided when the API is abnormal sequence_id String Unique response code Required A unique ID used to track each request task_id String Task ID Required Used to query results result Object Verification result Required - status String Verification status Required Enumeration: id_found, id_not_found status_message String Verification message Conditionally required Only appears for DL, PRC is_valid Boolean Validation status Conditionally required Only for UMID, SSS, PRC(verify_using_name) prc_registration_date String PRC Registration Date Conditionally required Only for PRC with verify_using_license prc_expiration_date String PRC Expiration Date Conditionally required Only for PRC with verify_using_license
JSON
{
"code": 200,
"message": "success",
"sequence_id": "1648********0866F82AC7F326307055",
"task_id": "74f4c926-250c-43ca-9c53-45******acd1",
"result": {
"is_valid": true,
"status": "id_found"
}
}JSON
{
"code": 200,
"message": "success",
"sequence_id": "1648********0866F82AC7F326307055",
"task_id": "74f4c926-250c-43ca-9c53-45******acd1",
"result": {
"status": "id_found"
}
}JSON
{
"result": {
"status_message": "The Professional Driver's License you have entered is a valid license.",
"status": "id_found"
},
"code": 200,
"sequence_id": "1724********6364G13401C079160432",
"task_id": "733b9225-807d-4dc1-b862-d7******cf70",
"message": "success"
}JSON
{
"result": {
"status_message": "Name not matched with ID",
"is_valid": true,
"status": "id_found"
},
"code": 200,
"sequence_id": "1724********6427G13B41A1F7067250",
"task_id": "df3772a8-a853-4aa5-b754-cb******8108",
"message": "success"
}JSON
{
"result": {
"status_message": "Name not matched with ID",
"prc_expiration_date": "2026-01-05",
"prc_registration_date": "2011-02-16",
"status": "id_found"
},
"code": 200,
"sequence_id": "1724********7003G13401C078201623",
"task_id": "12ec65c8-ac93-4ffd-9266-63******0410",
"message": "success"
}Code Message Description 200 Success Success 11340 {parameter} error{parameter} error12001 Query in process Querying results 12002 Process error Process error 12003 Process timeout Process timeout
