API Reference
English

身份验真-菲律宾

本产品主要用于菲律宾SSS,UMID, TIN,PRC和DL卡核验。 为异步接口,因此本文档含有两部分:调用接口和查询接口。

调用接口

API 方式

Base URL

API

URL请求方式Content-Type输出格式字符集
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8

认证参数

字段类型含义建议备注
partner_codeString合作方标识必须由 TD 分配
partner_keyString合作方密钥必须由 TD 分配

请求参数

字段类型含义建议备注
id_numberString身份证件 ID 号码必须ID number
id_typeString身份证件 ID 类型必须菲律宾-枚举值: SSS, UMID, TIN,PRC,DL
phone_numberString手机号 / 电话号码强烈建议手机号,共11位,以0开头
nameString姓名必须
first_namestringFirst name on ID card条件必须名,ID类型填入PRC时且prc_verification_mode=verify_using_name为必须
last_namestringLast name on ID card条件必须姓,ID类型填入PRC时且prc_verification_mode=verify_using_name为必须
countryString国家必须国家,必填. 两位国家码,符合 ISO 3166 标准。目前支持:菲律宾(PH)
expiry_dateStringExpiration date on the card条件必须yyyy-MM-dd
ID类型填入DL时为必须
serial_numberStringSerial number on the card条件必须ID类型填入DL时为必须
prc_verification_modeStringPRC Mode - Name based or Number based条件必须ID类型填入PRC时为必须,枚举值:
verify_using_name / verify_using_license
professionStringProfession on ID card条件必须ID类型填入PRC时为必须
birth_dateString生日条件必须yyyy-MM-dd
ID类型填入PRC时且prc_verification_mode=verify_using_license为必须
请求示例
{
          "country":  "PH",
          "phone_number":  "0217656789",
          "id_type":  "TIN",
          "id_number":  "380486089000",
          "name":  "Joe"
}

响应参数

字段类型含义建议备注
codeIntegerAPI 状态码必须
messageString状态信息必须成功时返回success;在 API 异常状态下会输出具体的异常原因
sequence_idString响应唯一码必须用于跟踪每次请求记录的唯一标识
task_idString任务id必须用于结果查询
响应示例
{
          "code":  200,
          "message":  "success",
          "sequence_id":  "1648777165770866F82AC7F326307055",
          "task_id": "74f4c926-250c-43ca-9c53-453e87ceacd1"
}

API状态码

codeMessage含义是否收费
200success成功
301Service not purchased服务未购买
302Service has been suspend服务已被禁⽤
303Not enough balance流量不足
304Service expired服务已过期
305Daily maximum volume reached日流量已封顶
600Service Temporarily Unavailable服务超过限制
11350Internal error系统错误
11301{parameter} empty{参数}为空
11304The country partner located is not open国家不支持
11340{parameter} error{参数}错误

查询接口

API方式

Base URL

API

URL请求方式Content-Type输出格式字符集
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8

认证参数

字段类型建议备注
partner_codeString必须合作⽅标识,由TD提供
partner_keyString必须合作⽅标识,由TD提供

请求参数

字段类型建议备注
task_idString必须第一步调用返回的task_id

响应参数

字段类型含义建议备注
codeIntegerAPI 状态码必须
messageString状态信息必须在 API 异常状态下会输出具体的异常原因
sequence_idString响应唯一码必须用于跟踪每次请求记录的唯一标识
task_idString任务码必须查询时传入的taskid
resultObject核验结果必须
statusString核验状态必须枚举值:id_found;id_not_found
status_messageString核验信息条件必须仅在证件类型为DL,PRC的返回中出现
is_validBoolean是否有效条件必须仅在证件类型为UMID、SSS、PRC(且verify_using_name)的返回中出现
prc_registration_dateStringPRC注册日期条件必须仅在证件类型为PRC且prc_verification_mode=verify_using_license的返回中出现
prc_expiration_dateStringPRC过期日期条件必须仅在证件类型为PRC且prc_verification_mode=verify_using_license的返回中出现
响应示例-UMID/SSS
{
          "code":  200,
          "message":  "success",
          "sequence_id":  "1648********0866F82AC7F326307055",
          "task_id": "74f4c926-250c-43ca-9c53-45******acd1",
          "result":  {
                    "is_valid":  true,
                    "status":  "id_found"
          }
}
响应示例-TIN
{
          "code":  200,
          "message":  "success",
          "sequence_id":  "1648********0866F82AC7F326307055",
          "task_id": "74f4c926-250c-43ca-9c53-45******acd1",
          "result":  {
                    "status":  "id_found"
          }
}
响应示例-DL
{
	"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"
}
响应示例-PRC: verify_using_name
{
	"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"
}
响应示例-PRC: verify_using_license
{
	"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"
}

API 状态码

codeMessage含义
200success成功
11340{parameter} error{参数}错误
12001Query in process结果查询中
12002Process error任务处理失败
12003Process timout任务处理超时