墨西哥收入核验

收入核验适⽤于墨西哥个⼈收入信息核验；本接⼝是异步推送接⼝。

API方式

Base URL

墨西哥：https://mx.apitd.net/credit/data/feature/income/v1
新加坡：https://sg.apitd.net/credit/data/feature/income/v1

API

请求方式	Content-Type	输出格式	字符集
POST	application/json	Json	UTF-8

认证参数

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

请求参数

字段	类型	建议	备注
id_number	String	必须	身份证件号，CURP号，18位, 字母为大写，建议填入申请NSS时的CURP
id_type	String	必须	国民身份证：national_id
nss_number	String	强烈建议	社保号

请求示例

{
    "id_number":"GUPN8904****CRRN08",
    "id_type":"national_id",
     "nss_number":"9213****746"
}

响应参数

字段	类型	含义	备注
code	Integer	API 状态码
message	String	状态信息	在 API 异常状态下会输出具体的异常原因
sequence_id	String	响应唯一码	用于跟踪每次请求记录的唯一标识

API状态码

code	Message	含义
200		成功
300	Service not purchased or not effective	服务不可⽤
301	Service not purchased	服务未购买
302	Service has been suspend	服务已被禁⽤
303	Not enough balance	流量不足
304	Service expired	服务已过期
9500	Internal error	内部错误
9060	{parameter} empty	{字段名}为空
9061	{parameter} error	{字段名}错误

通过上述接口传输数据给到TD后，TD 将返回的收入数据通过本 API 推送给您。

API 方式

Base URL

您提供给 TD 的订阅 API 地址。请您在配置时联系运营同事，我们将为您配置。

注：回调地址支持http 80端口以及https的443端口

API

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

认证参数

字段	类型	含义	建议	备注
partner_code	String	合作方标识	必须	由 TD 分配
timestamp	String	当前时间戳	必须	毫秒级
access_key	String	access key	必须	由 TD 分配
sign	String	签名	必须

sign 生成方式

sign = HmacSHA1(partner_code+timestamp+access_key,access_secret)

其中 access_secret 由 TD 分配

headers

参数名	参数值	建议
Content-Type	application/json	必须

推送请求参数

字段	类型	含义	建议	备注
result	String	如果成功获取则为 OK，如果发生其他情况则为 ERROR，详细信息请参阅Message	必须
message	String	结果描述	建议	只有在result为error时出现
sequence_id	String	用于跟踪每次请求记录的唯一标识	必须
social_security_info	JSONObject	社保信息	必须
name	String	姓名	必须
working_time_detail	JSONObject	工作时长信息	必须
working_week	String	缴纳给 IMSS的周长，通常是有一份正式工作的周长。	必须
reinstated_week	String	恢复了的周长，通常是补缴的之前提前使用的	必须
discounted_week	String	提前使用了的周长，通常是在失业时期。	必须
work_detail	JSONArray	工作详情	必须
start_date	String	开始工作的时间	必须
end_date	String	结束工作的时间. 如果未“Vigente” 则代表是当前的工作	必须
daily_salary	String	日薪。通常乘以 30。	必须
state_workplace	String	所在公司的州	必须
name_workplace	String	所在公司的名称	必须
imss_code_workplace	String	公司的IMSS 代码	必须

响应示例

{
    "sequence_id":"1699272744735016I303341798930550",
    "result":"OK",
    "social_security_info":{
        "name":"David HE",
        "working_time_detail":{
            "working_week":"200",
            "reinstated_week":"0",
            "discounted_week":"0"
        },
        "work_detail":[
            {
                "start_date":"21/12/2022",
                "end_date":"27/12/2022",
                "daily_salary":"$334.26",
                "state_workpalce":"MÉXICO",
                "name_workpalce":"CAPITAL ARRECIFE",
                "imss_code_workpalce":"C417***210"
            },
            {
                "start_date":"21/11/2022",
                "end_date":"22/11/2022",
                "daily_salary":"$244.25",
                "state_workpalce":"DISTRITO FEDERAL",
                "name_workpalce":"HOOTERS DE MEXICO",
                "imss_code_workpalce":"Y64****210"
            }
        ]
    }
}

响应示例(ERROR样例)

{
    "result":"ERROR",
    "sequence_id":"1702460928800627G10EC1EB6784****",
    "social_security_info":{
        "working_time_detail":{

        },
        "work_detail":[

        ]
    },
    "message":"Invalid Social Security Number status"
}

响应参数

您的业务系统在收到推送请求后需要响应的参数

字段	类型	含义	建议	备注
code	Integer	API 状态码	必须
message	String	状态信息	必须	在 API 异常状态下会输出具体的异常原因

API 状态码

code	含义
200	成功

响应示例

{
  "code": 200,
  "message": ""
}

说明：若您返回的状态码非 200，我们会重试 3 次，3 次均失败则不会再推送。但您可以通过下述查询接口进行查询。

如您长时间未收到返回数据推送，可通过下述查询接口传入第一步调用返回的sequence_id进行结果的查询。本接口仅支持24小时内的结果查询。

API方式

Base URL

墨西哥：http://mx.apitd.net/credit/data/feature/income/query
新加坡：http://sg.apitd.net/credit/data/feature/income/query

API

请求方式	Content-Type	输出格式	字符集
POST	application/json	Json	UTF-8

认证参数

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

请求参数

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

返回参数

与上述推送请求参数保持一致。可参考文档推送请求参数 部分内容

API 状态码

code	Message	含义
200		成功
9060	{parameter} empty	{字段名}为空
9080	Only queries within 24 hours are available.	超时无法查询/结果暂未返回

响应示例（成功）

{
    "code":200,
    "data":{
        "result":"OK",
        "sequence_id":"1703169657863033G109E3248435****",
        "social_security_info":{
            "working_time_detail":{
                "discounted_week":"0",
                "reinstated_week":"0",
                "working_week":"272"
            },
            "work_detail":[
                {
                    "end_date":"16/05/2023",
                    "state_workplace":"GUANAJUATO",
                    "name_workplace":"LEVDOS",
                    "imss_code_workplace":"Z065861410",
                    "start_date":"16/03/2023",
                    "daily_salary":"$374.61"
                },
                {
                    "end_date":"15/03/2023",
                    "state_workplace":"DISTRITO FEDERAL",
                    "name_workplace":"DERIVADORA DE SERVICIOS PROFESIONALES, S.A. DE C.V.",
                    "imss_code_workplace":"Y623742910",
                    "start_date":"01/05/2020",
                    "daily_salary":"$373.63"
                }
            ],
            "name":"David"
        }
    },
    "sequence_id":"1703169657863033G109E3248435****"
}

响应示例（调用已超过24小时/结果暂未返回）

{
    "code": 9080,
    "message": "Only queries within 24 hours are available.",
    "sequence_id": "1703123181798646G109E3248****377"
}