Income verification API is suitable for personal income information verification in Mexico. This is an asynchronous interface, returning work details to customers.
If the result is successfully obtained, OK is returned. If other conditions occur, ERROR is returned. For details, please refer to "Message"
message
String
Description of the result, only occur when the result is Error
Conditionally required
sequence_id
String
Unique identifier used to track each request record
Required
report_base
JSONObject
Report basic information
Required
report_dt
String
Report date
Required
user_name
String
User name
Required
nss
String
nss number
Required
curp
String
curp number
Required
total_weeks
String
Total week that the person paid to the IMSS.
Required
valid_weeks
String
Week that the person paid to the IMSS. Usually equals to the week the person work a formal job.
Required
decr_weeks
String
Weeks used in advance, usually during periods of unemployment.
Required
incr_weeks
String
Restored weeks. It is usually used in advance before payment is made.
Required
works
JSONArray
Work details
Required
employer_name
String
Company name
Required
employer_registration
String
Company IMSS code
Required
federal_entity
String
Company state
Required
date_registration
String
Date the person started in that job.
Required
date_de_registration
String
Date the person stop working in that job. If it says “Vigente” it means is the current job.
Required
base_salary_contribution
String
The latest base salary
Required
detail
JSONArray
Working details
Required
type_movement
String
Movement type
Required
date_movement
String
Movement date
Required
salary_base
String
Base salary after each movement
Required
Enumeration values of 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.
More than 3 executions of the service with the same CURP
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.
In order to generate your Report, it is necessary to go to the subdelegation closest to your home to receive guidance.
Los datos de entrada no coinciden con los datos de la entidad externa RENAPO.
The data does not match the data of the external entity RENAPO.
Es necesario que acudas a la Subdelegación más cercana a tu domicilio a presentar tu trámite.
You need to assist to an IMSS branch physically
La CURP proporcionada no fue localizada en la entidad externa RENAPO
CURP not found
Service unavailable, please retry later
Service unavailable, please retry later
The CURP is incorrect
curp error
The NSS does not exist
nss not exist
Work in progress
Work in progress
Enumeration values and meanings of type_movement
Enumeration values
English definition
Description
Alta
Registration
Notice given when work begins, whether temporary, temporary or permanent.
Baja
Dismissal
This is the notification that a company submits to the Social Security Administration when the employment relationship with an employee ends, which also ends its obligation to maintain registration in the social security system.
Reingreso
Reentry
A motion to rejoin is a notice that a company must file with IMSS when a laid off worker rejoins the company.
Modificación de salario
Salary modification
Wage adjustment changes are notifications issued by the company when there is a change in the basic contribution wages of employees registered in the social security system.
Cambios de jornada laboral
Working day changes
Modifications on an employee's working hours, such as increasing or decreasing the number of hours in the working day.
Cambios en la razón social o estructura de la empresa
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.
API Status Code
code
**Description**
200
Success
Response Example
{
"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.
Synchronous API: Can be used only when webhook failed
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 48 hours).
Remark: This interface is back up interface for asynchronous queries. After configuring the asynchronous interface, if the call is successful but there is no return, you can query through this interface
