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

调用接口

API 方式

Base URL

新加坡节点：https://sg.apitd.net/verification/kyc/idverify/v1

API

URL	请求方式	Content-Type	输出格式	字符集
api-base-url?partner_code=xxx&partner_key=xxx	POST	application/json	JSON	UTF-8

认证参数

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

请求参数

字段	类型	含义	建议	备注
id_number	String	身份证件 ID 号码	必须	ID number
id_type	String	身份证件 ID 类型	必须	菲律宾-枚举值： SSS, UMID, TIN, PRC, DL
phone_number	String	手机号 / 电话号码	强烈建议	手机号，共11位，以0开头
name	String	姓名	必须
first_name	string	First name on ID card	条件必须	名，ID类型填入PRC时且prc_verification_mode=verify_using_name为必须
last_name	string	Last name on ID card	条件必须	姓，ID类型填入PRC时且prc_verification_mode=verify_using_name为必须
country	String	国家	必须	国家，必填. 两位国家码，符合 ISO 3166 标准。目前支持：菲律宾(PH)
expiry_date	String	Expiration date on the card	条件必须	yyyy-MM-dd ID类型填入DL时为必须
serial_number	String	Serial number on the card	条件必须	ID类型填入DL时为必须
prc_verification_mode	String	PRC Mode - Name based or Number based	条件必须	ID类型填入PRC时为必须，枚举值： verify_using_name / verify_using_license
profession	String	Profession on ID card	条件必须	ID类型填入PRC时为必须
birth_date	String	生日	条件必须	yyyy-MM-dd ID类型填入PRC时且prc_verification_mode=verify_using_license为必须

请求示例

{
          "country":  "PH",
          "phone_number":  "0217656789",
          "id_type":  "TIN",
          "id_number":  "380486089000",
          "name":  "Joe"
}

响应参数

字段	类型	含义	建议	备注
code	Integer	API 状态码	必须
message	String	状态信息	必须	成功时返回success；在 API 异常状态下会输出具体的异常原因
sequence_id	String	响应唯一码	必须	用于跟踪每次请求记录的唯一标识
task_id	String	任务id	必须	用于结果查询

响应示例

{
          "code":  200,
          "message":  "success",
          "sequence_id":  "1648777165770866F82AC7F326307055",
          "task_id": "74f4c926-250c-43ca-9c53-453e87ceacd1"
}

API状态码

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

查询接口

API方式

Base URL

新加坡节点：https://sg.apitd.net/verification/kyc/idverify/query/v1

API

URL	请求方式	Content-Type	输出格式	字符集
api-base-url?partner_code=xxx&partner_key=xxx	POST	application/json	JSON	UTF-8

认证参数

字段	类型	建议	备注
partner_code	String	必须	合作⽅标识，由TD提供
partner_key	String	必须	合作⽅标识，由TD提供

请求参数

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

响应参数

字段	类型	含义	建议	备注
code	Integer	API 状态码	必须
message	String	状态信息	必须	在 API 异常状态下会输出具体的异常原因
sequence_id	String	响应唯一码	必须	用于跟踪每次请求记录的唯一标识
task_id	String	任务码	必须	查询时传入的taskid
result	Object	核验结果	必须
status	String	核验状态	必须	枚举值：id_found；id_not_found
status_message	String	核验信息	条件必须	仅在证件类型为DL，PRC的返回中出现
is_valid	Boolean	是否有效	条件必须	仅在证件类型为UMID、SSS、PRC(且verify_using_name)的返回中出现
prc_registration_date	String	PRC注册日期	条件必须	仅在证件类型为PRC且prc_verification_mode=verify_using_license的返回中出现
prc_expiration_date	String	PRC过期日期	条件必须	仅在证件类型为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 状态码

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