本产品主要用于菲律宾SSS,UMID和 TIN卡核验。 为异步接口,因此本文档含有两部分:调用接口和查询接口。
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 |
phone_number | String | 手机号 / 电话号码 | 必须 | 手机号,共11位,以0开头 |
name | String | 姓名 | 必须 | |
country | String | 国家 | 必须 | 国家,必填. 两位国家码,符合 ISO 3166 标准。目前支持:菲律宾(PH) |
{
"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"
}
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 | {参数}错误 | 否 |
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 |
is_valid | Boolean | 是否有效 | 条件必须 | 仅在证件类型为UMID、SSS的返回中出现 |
{
"code": 200,
"message": "success",
"sequence_id": "1648777165770866F82AC7F326307055",
"task_id": "74f4c926-250c-43ca-9c53-453e87ceacd1",
"result": {
"is_valid": true,
"status": "id_found"
}
}
code | Message | 含义 |
---|
200 | success | 成功 |
11340 | {parameter} error | {参数}错误 |
12001 | Query in process | 结果查询中 |
12002 | Process error | 任务处理失败 |
12003 | Process timout | 任务处理超时 |