API Reference
English

全球黑名单

本接⼝是同步接⼝,适⽤于印尼、墨西哥等多国黑名单信息查询

API方式

Base URL

API

请求方式Content Type输出格式字符集
POSTapplication/jsonjsonUTF-8

认证参数

字段类型建议描述
partner_codeString必须合作⽅标识,由TD分配
partner_keyString必须合作⽅标识,由TD分配

请求参数

字段类型建议描述
nameString必须姓名
phone_numberString必须手机号码,不带国家码
id_numberString必须身份证件 ID 号码,如:印尼16位纯数字,墨西哥18位
countryString必须两位国家码,符合 ISO 3166 标准。目前支持:墨西哥(MX) ;印尼(ID);印度(IN) ;泰国(TH);哥伦比亚(CO) 菲律宾(PH);尼日利亚(NG);巴基斯坦(PK);越南(VN)
id_typeString必须ID 类型枚举值: 国民身份证national_id
(菲律宾ID类型:UMID, SSS card, Passport, Driver's license, PRC ID ,Potal ID, PhilHealth, AFP ID, HDMF ID, ACR/ICR, GSIS card, TIN, Seaman's book, OWWA ID, Voter's ID)
package_nameString必须枚举值:blacklist

响应参数

字段类型含义备注
codeIntegerAPI 状态码
messageString状态信息在 API 异常状态下会输出具体的异常原因
sequence_idString响应唯一码用于跟踪每次请求记录的唯一标识
resultString是否命中枚举值:命中:hit 无记录:no_record

API状态码

codeMessage含义
200成功
301This service has not been purchased未购买此服务
302The traffic has been disabled流量已被禁用
303Underflow流量不足
304Service expired服务已过期
305The daily traffic has been capped日流量已封顶
9060{parameter} empty{字段名}为空
9061{parameter} error{字段名}错误

命中样例

{
    "code": 200,
    "result": "hit",
    "sequence_id": "1699272744735016I303341798930550"
}

未命中样例

{
"code":200,
"result": "no_record",
"sequence_id": "75ccadf47dab4c81a06e6f0da746cd9c"
}

失败样例

{
    "code": 9060,
    "message": " country empty"
}