墨西哥收入核验 V2.0

墨西哥个⼈收入信息核验,返回工作细节信息;本接⼝是异步推送接⼝。


第一步:异步查询

API方式

Base URL

API

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

认证参数

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

请求参数

字段类型建议备注
id_numberString必须身份证件号,CURP号,18位, 字母为大写,建议填入关联NSS的CURP
id_typeString必须国民身份证:national_id
nss_numberString强烈建议社保号

请求示例

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

响应参数

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

API状态码

codeMessage含义
200成功
300Service not purchased or not effective服务不可⽤
301Service not purchased服务未购买
302Service has been suspend服务已被禁⽤
303Not enough balance流量不足
304Service expired服务已过期
9500Internal 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=xxxPOSTapplication/jsonJSONUTF-8

认证参数

字段类型含义建议备注
partner_codeString合作方标识必须由 TD 分配
timestampString当前时间戳必须毫秒级
access_keyStringaccess key必须由 TD 分配
signString签名必须

sign 生成方式:

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

其中 access_secret 由 TD 分配

Headers

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

推送请求参数

字段类型含义建议
resultString如果成功获取则为 OK,如果发生其他情况则为 ERROR,详细信息请参阅Message
messageString结果描述只有在result为error时出现
sequence_idString用于跟踪每次请求记录的唯一标识必须
report_baseJSONObject报告基本信息必须
report_dtString报告日期必须
user_nameString名称必须
nssStringnss号必须
curpStringcurp号必须
total_weeksString缴纳给 IMSS的总周长必须
valid_weeksString缴纳给 IMSS的周长,通常是有一份正式工作的周长。必须
decr_weeksString提前使用了的周长,通常是在失业时期。必须
incr_weeksString恢复了的周长,通常是补缴的之前提前使用的必须
worksJSONArray工作详情必须
employer_nameString所在公司的名称必须
employer_registrationString公司的IMSS 代码必须
federal_entityString所在公司的州必须
date_registrationString开始工作的时间必须
date_de_registrationString结束工作的时间. 如果未“Vigente” 则代表是当前的工作必须
base_salary_contributionString最新的基本工资必须
detailJSONArray工作细节必须
type_movementString变动类型必须
date_movementString变动时间必须
salary_baseString每次变动后的基本工资必须
message枚举值
Message含义
Por el momento no es posible entregarle su constancia por favor intente más tarde o solicítela directamente en la Subdelegación más cercana a su domicilio en días y horas hábiles.具有相同 CURP 的服务执行次数超过 3 次
Para poder generar su Reporte de Semanas Cotizadas, es necesario acuda a la subdelegación más cercana a su domicilio a recibir orientación.为了生成您的报告,您需要前往离您家最近的分代表处接受指导。
Los datos de entrada no coinciden con los datos de la entidad externa RENAPO.该数据与外部实体 RENAPO 的数据不匹配。
Es necesario que acudas a la Subdelegación más cercana a tu domicilio a presentar tu trámite.您需要亲自协助 IMSS 分支机构
La CURP proporcionada no fue localizada en la entidad externa RENAPOCURP号无法找到
Service unavailable, please retry later服务不可用,请稍后重试
The CURP is incorrectcurp号错误
The NSS does not existnss不存在
Work in progress结果正在获取中
type_movement枚举值含义
枚举值中文释义含义
Alta登记开始工作时发出的通知,无论是临时的、暂时的还是永久的。
Baja解雇是当与员工的雇佣关系结束时,公司向社会保障局提交的通知,这也结束了其在社会保障制度中维持注册的义务。
Reingreso再入重新入职动议是公司在被解雇的工人重新加入公司时向 IMSS 提交的通知。
Modificación de salario薪资调整工资调整变动是公司在社会保障制度中登记的员工基本缴款工资发生变化。
Cambios de jornada laboral工作日变化员工的工作时间的变更,例如增加或减少工作日的时间。
Cambios en la razón social o estructura de la empresa公司名称或公司结构的变更公司名称或结构的变更。

响应示例

{
    "sequence_id": "1699272744735016I303341798930550",
    "result": "OK",
    "report_base": {
        "report_dt": "13/03/2024",
        "user_name": "HERNANDEZ BUSTAMANTE GUILLERMO",
        "nss": "33634110879",
        "curp": "HEBG410210HCHRSL08",
        "total_weeks": "1091",
        "valid_weeks": "1091",
        "decr_weeks": "0",
        "incr_weeks": "0"
    },
    "works": [
        {
            "employer_name": "DISTRIBUCIONES INSTITUCIONALES",
            "employer_registration": "A803058510",
            "federal_entity": "CHIHUAHUA",
            "date_registration": "04/05/1992",
            "date_de_registration": "05/02/2007",
            "base_salary_contribution": "$111.88",
            "detail": [
                {
                    "type_movement": "BAJA",
                    "date_movement": "05/02/2007",
                    "salary_base": "$111.88"
                }
            ]
        },
        {
            "employer_name": "AERONAVES DE MEX SA",
            "employer_registration": "3301028610",
            "federal_entity": "CHIHUAHUA",
            "date_registration": "28/12/1984",
            "date_de_registration": "23/06/1988",
            "base_salary_contribution": "$28.37",
            "detail": [
                {
                    "type_movement": "BAJA",
                    "date_movement": "23/06/1988",
                    "salary_base": "$28.37"
                }
            ]
        }
    ]
}

响应参数

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

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

API 状态码

code含义
200成功

响应示例

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

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


兜底查询接口: 必须在配置推送接口后方可使用

如您长时间未收到返回数据推送,可通过下述查询接口传入第一步调用返回的sequence_id进行结果的查询。本接口仅支持48h的的结果查询。
注:该接口为异步查询的兜底接口,配置异步接口后成功调用但无返回的情况下可通过该接口查询

API方式

Base URL

API

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

认证参数

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

请求参数

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

返回参数

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

API 状态码

codeMessage含义
200成功
9060{parameter} empty{字段名}为空
9080Only queries within 48 hours are available.超时无法查询

响应示例(成功)

{
    "code": 200,
    "sequence_id": "1699272744735016I303341798930550",
    "result": "OK",
    "report_base": {
        "report_dt": "13/03/2024",
        "user_name": "HERNANDEZ BUSTAMANTE GUILLERMO",
        "nss": "33634110879",
        "curp": "HEBG410210HCHRSL08",
        "total_weeks": "1091",
        "valid_weeks": "1091",
        "decr_weeks": "0",
        "incr_weeks": "0"
    },
    "works": [
        {
            "employer_name": "DISTRIBUCIONES INSTITUCIONALES",
            "employer_registration": "A803058510",
            "federal_entity": "CHIHUAHUA",
            "date_registration": "04/05/1992",
            "date_de_registration": "05/02/2007",
            "base_salary_contribution": "$111.88",
            "detail": [
                {
                    "type_movement": "BAJA",
                    "date_movement": "05/02/2007",
                    "salary_base": "$111.88"
                }
            ]
        },
        {
            "employer_name": "AERONAVES DE MEX SA",
            "employer_registration": "3301028610",
            "federal_entity": "CHIHUAHUA",
            "date_registration": "28/12/1984",
            "date_de_registration": "23/06/1988",
            "base_salary_contribution": "$28.37",
            "detail": [
                {
                    "type_movement": "BAJA",
                    "date_movement": "23/06/1988",
                    "salary_base": "$28.37"
                }
            ]
        }
    ]
}

响应示例(失败)

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