Income verification API is suitable for personal income information verification in Mexico. This is an asynchronous interface.
Request Methods Content-Type Output Format Character Set POST application/json Json UTF-8
Parameter Type Required/Optional Notes partner_code String Required To be assigned by TD partner_key String Required To be assigned by TD
Parameter Type Required/Optional Notes id_number String Required ID card number, CURP, eighteen character alphanumeric code with capital letters. Please fill in the CURP for applying NSS id_type String Required national_id nss_number String Strongly Recommended Social Security Number
JSON
{
"id_number":"GUPN8904****CRRN08",
"id_type":"national_id",
"nss_number":"9213****746"
}
Parameter Type Description Notes code Integer API status code message String Status information The specific cause of the exception is displayed when the API is in an abnormal state sequence_id String Response unique code A unique identifier used to track the record of each request
code Message Description 200 Success 300 Service not purchased or not effective Service not purchased or not effective 301 Service not purchased Service not purchased 302 Service has been suspend Service has been suspend 303 Not enough balance Not enough balance 304 Service expired Service expired 9500 Internal error Internal error 9060 {parameter} empty {parameter} empty 9061 {parameter} error {parameter} error
After post the data to TD through the above API interface, TD will return the income data to you through the bellowing API.
The subscription API address you provide to TD. Please contact us for the configuration and we will help you with it.
Remark: The subscription API address supports http with port 80 and https with port 443.
URL HTTP Method Request Content Type Response Content Type Charset api-base-url?partner_code=xxx×tamp=xxx&access_key=xxx&sign=xxx POST application/json JSON UTF-8
Name Type Description Required/Optional Notes partner_code String Partner Code Required Assigned by TD timestamp String Current timestamp Required Millisecond level access_key String Access key Required Assigned by TD sign String Sign Required
sign = HmacSHA1(partner_code+timestamp+access_key,access_secret)
access_secret is assigned by TD
Parameter name Value Required/Optional Content-Type application/json Required
Parameter Type Description Required/Optional Notes result String OK if the job history was obtain, ERROR if something else happened, see message for details Required message String Description of the result Conditionally required Only occur when the result is Error sequence_id String A unique identifier used to track the record of each request Required social_security_info JSONObject Social security information Required name String Name of the person. Required working_time_detail JSONObject Detail of working time Required working_week String Week that the person paid to the IMSS. Usually equals to the week the person work a formal job. Required reinstated_week String Reinstated week, if they where previously discounted. Required discounted_week String Discounted weeks because the person made use of them in advanced. Required work_detail JSONArray Detail of work Required start_date String Date the person started in that job. Required end_date String Date the person stop working in that job. If it says “Vigente” it means is the current job. Required daily_salary String Daily salary. Usually to be multiply by 30. Required state_workplace String State where the company is located. Required name_workplace String Name of the company or person who is hiring. Required imss_code_workplace String IMSS internal code for the company. Required
JSON
{
"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"
}
]
}
}
JSON
{
"result":"ERROR",
"sequence_id":"1702460928800627G10EC1EB6784****",
"social_security_info":{
"working_time_detail":{
},
"work_detail":[
]
},
"message":"Invalid Social Security Number status"
}
Parameters that your business system needs to respond to after receiving a push request
Parameter Type Description Required/Optional Notes code Integer API status code Required message String Status message Required In the API exception state, the specific exception reason will be output.
code **Description** 200 Success
JSON
{
"code": 200,
"message": ""
}
Note: If the status code you return is not 200, we will retry 3 times. If we failed for all 3 times, we will not push the data any more. However, you can query through the following query interface if the push is missed.
If you have not received the returned data push for a long time, you can pass the sequence_id returned by the first call through the following query interface to query the results. This interface only supports result query within 24 hours.
Request Methods Content-Type Output Format Character Set POST application/json Json UTF-8
Parameter Type Required/Optional Notes partner_code String Required To be assigned by TD partner_key String Required To be assigned by TD
Parameter Type Required/Optional Notes sequence_id String Required sequence_id from the first step
The response will be the same with the above push request parameters. Please refer to Response Parameters For Push Notifications within this document.
code Message Description 200 Success 9060 {parameter} empty {parameter} empty 9080 Only queries within 24 hours are available. Only queries within 24 hours are available/ No results returned
JSON
{
"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****"
}
JSON
{
"code": 9080,
"message": "Only queries within 24 hours are available.",
"sequence_id": "1703123181798646G109E3248****377"
}
