墨西哥个⼈收入信息核验,返回工作细节信息;本接⼝是异步推送 接⼝。
请求方式 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 强烈建议 社保号
JSON
{
"id_number":"GUPN8904****CRRN08",
"id_type":"national_id",
"nss_number":"9213****746"
}
字段 类型 含义 备注 code Integer API 状态码 message String 状态信息 在 API 异常状态下会输出具体的异常原因 sequence_id String 响应唯一码 用于跟踪每次请求记录的唯一标识
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 推送给您。
您提供给 TD 的订阅 API 地址。请您在配置时联系运营同事,我们将为您配置。
注:回调地址支持http 80端口以及https的443端口
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 = HmacSHA1(partner_code+timestamp+access_key,access_secret)
其中 access_secret 由 TD 分配
参数名 参数值 建议 Content-Type application/json 必须
字段 类型 含义 建议 result String 如果成功获取则为 OK,如果发生其他情况则为 ERROR,详细信息请参阅Message message String 结果描述 只有在result为error时出现 sequence_id String 用于跟踪每次请求记录的唯一标识 必须 report_base JSONObject 报告基本信息 必须 report_dt String 报告日期 必须 user_name String 名称 必须 nss String nss号 必须 curp String curp号 必须 total_weeks String 缴纳给 IMSS的总周长 必须 valid_weeks String 缴纳给 IMSS的周长,通常是有一份正式工作的周长。 必须 decr_weeks String 提前使用了的周长,通常是在失业时期。 必须 incr_weeks String 恢复了的周长,通常是补缴的之前提前使用的 必须 works JSONArray 工作详情 必须 employer_name String 所在公司的名称 必须 employer_registration String 公司的IMSS 代码 必须 federal_entity String 所在公司的州 必须 date_registration String 开始工作的时间 必须 date_de_registration String 结束工作的时间. 如果未“Vigente” 则代表是当前的工作 必须 base_salary_contribution String 最新的基本工资 必须 detail JSONArray 工作细节 必须 type_movement String 变动类型 必须 date_movement String 变动时间 必须 salary_base String 每次变动后的基本工资 必须
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 RENAPO CURP号无法找到 Service unavailable, please retry later 服务不可用,请稍后重试 The CURP is incorrect curp号错误 The NSS does not exist nss不存在 Work in progress 结果正在获取中
枚举值 中文释义 含义 Alta 登记 开始工作时发出的通知,无论是临时的、暂时的还是永久的。 Baja 解雇 是当与员工的雇佣关系结束时,公司向社会保障局提交的通知,这也结束了其在社会保障制度中维持注册的义务。 Reingreso 再入 重新入职动议是公司在被解雇的工人重新加入公司时向 IMSS 提交的通知。 Modificación de salario 薪资调整 工资调整变动是公司在社会保障制度中登记的员工基本缴款工资发生变化。 Cambios de jornada laboral 工作日变化 员工的工作时间的变更,例如增加或减少工作日的时间。 Cambios en la razón social o estructura de la empresa 公司名称或公司结构的变更 公司名称或结构的变更。
JSON
{
"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 Integer API 状态码 必须 message String 状态信息 必须 在 API 异常状态下会输出具体的异常原因
JSON
{
"code": 200,
"message": ""
}
说明: 若您返回的状态码非 200,我们会重试 3 次,3 次均失败则不会再推送。但您可以通过下述查询接口进行查询。
如您长时间未收到返回数据推送,可通过下述查询接口传入第一步调用返回的sequence_id进行结果的查询。本接口仅支持48h的的结果查询。
注:该接口为异步查询的兜底接口,配置异步接口后成功调用但无返回的情况下可通过该接口查询
请求方式 Content-Type 输出格式 字符集 POST application/json Json UTF-8
字段 类型 建议 备注 partner_code String 必须 合作⽅标识,由TD提供 partner_key String 必须 合作⽅标识,由TD提供
字段 类型 建议 备注 sequence_id String 必须 第一步调用返回的sequence_id
与上述推送请求参数保持一致。可参考文档推送请求参数 部分内容
code Message 含义 200 成功 9060 {parameter} empty {字段名}为空 9080 Only queries within 48 hours are available. 超时无法查询
JSON
{
"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"
}
]
}
]
}
JSON
{
"code": 9080,
"message": "Only queries within 48 hours are available.",
"sequence_id": "1703123181798646G109E3248****377"
}