This product is mainly used for SSS, UMID and TIN 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/Optional Notes partner_code String Partner Code Required Assigned by TD partner_key String Partner Key Required Assigned by TD
Parameter Type Description Required/Optional Notes id_number String ID type Required ID number id_type String ID number Required Enumeration: SSS, UMID, TIN phone_number String Phone number Required Phone number, 11 digits, start with 0 name String Name Required country String Country Required 2-letter country code according to ISO 3166
JSON
{
"country": "PH",
"phone_number": "0217656789",
"id_type": "TIN",
"id_number": "380486089000",
"name": "Joe"
}
Parameter Type Description Required/Optional Notes code Integer API status code Required message String Status Information Required Returns ‘success’ when the API call is successful；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
JSON
{
"code": 200,
"message": "success",
"sequence_id": "1648777165770866F82AC7F326307055",
"task_id": "74f4c926-250c-43ca-9c53-453e87ceacd1"
}
Code Message Description Charged 200 success Success YES 301 Service not purchased Service not purchased NO 302 Service has been suspend Traffic blocked NO 303 Not enough 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} empty NO 11304 The country partner located is not open The country partner located is not open NO 11340 {parameter} error {parameter} error NO
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/Optional Notes partner_code String Partner Code Required Assigned by TD partner_key String Partner Key Required Assigned by TD
Parameter Type Required/Optional Notes task_id String Required The task_id returned by the first call
Parameter Type Description Required/Optional 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 values：id_found；id_not_found is_valid Boolean Whether Conditionally required Only returns when ID type is UMID and SSS
JSON
{
"code": 200,
"message": "success",
"sequence_id": "1648777165770866F82AC7F326307055",
"task_id": "74f4c926-250c-43ca-9c53-453e87ceacd1",
"result": {
"is_valid": true,
"status": "id_found"
}
}
Code Message Description 200 success Success 11340 {parameter} error {parameter} error 12001 Query in process Querying results 12002 Process error Process error 12003 Process timout Process timout
