Intro
This API allows you to find out the employment history of a person who has worked for the Instituto de Seguridad y Servicios Sociales de los Trabajadores del Estado (ISSSTE).
Important points
Required parameter
The curp field in the request body are required.
curp
Is the Clave Única de Registro de Población (CURP for its acronym in Spanish), must be an 18-character alphanumeric data.
| field | type | required | length | Description |
|---|---|---|---|---|
| curp | Alphanumeric | Yes | 18 | Provide a valid CURP according to the CURP rules |
If you are not sure how to obtain this field and you have your client's personal data, we suggest you visit the CURP validate by data service to apply a validation and recover the CURP.
Successful response
To know the fields of a successful response you should see our example called success in the response section.
Inside the response structure you will get the next fields.
| field Name | subfield name | Description |
|---|---|---|
| clinica | Object to indicate the ISSSTE clinic where the user is registered. | |
| clave | ISSSTE clinic key | |
| delegacionIssste | name of the Issste delegation | |
| domicilio | address of the Issste delegation | |
| nombre | name of the Issste delegation | |
| tipo | type of the Issste delegation: -CAF: Consultorio de Atención Familiar -CE: Clínica de Especialidades -CH: Clínica Hospital -CMCT: Consultorio Médico en Centro de Trabajo -CMF: Clinica de Medicina Familiar -CMFE: Clinica de Medicina Familiar con especialidades -CMN: Centro Médico Nacional -HAE: Hospital de Alta Especialidad -HG: Hospital General -HR: Hospital Regional -UMF: Unidad de Medicina Familiar | |
| curp | CURP of the requested person. | |
| datosLaborales | Array of one element that will return the last work record of the person consulted | |
| fechaAlta | Date on which the last job was registered in dd/mm/yyyy format | |
| modalidad | N/A | |
| pagaduria | Institution that pays the salary | |
| ramo | branch or role played at work. | |
| remuneracionTotal | salary earned in employment | |
| salarioBaseCotizacion | quoted base salary | |
| tipoPension | type of pension: -CONFIANZA -BASE | |
| derechoServicioMedico | ||
| domicilio | Most recent registered address | |
| calle | Street | |
| colonia | Colony | |
| cp | Postal Code | |
| delegacionMunicipio | municipality | |
| estado | State | |
| numeroExterior | exterior number | |
| numeroInterior | interior number | |
| estadoCivil | Civil status: -SOLTERO (A) -CASADO (A) | |
| status | Estatus of the request -FOUND: The CURP was found in the ISSSTE system and the response was successfully retrieved. -NOT_FOUND: The CURP was not found in the ISSSTE system and and we could not return information. | |
| fechaAltaPlazaActual | date of registration of current employment in format dd/mm/yyyy | |
| fechaBaja | date of termination in format dd/mm/yyyy | |
| fechaIngresoGobiernoFederal | date of entry into the Federal Government in format dd/mm/yyyy | |
| fechaNacimiento | Birth date | |
| nombre | Name(s) of the person | |
| nss | Social security number | |
| primerApellido | last name | |
| rfc | RFC | |
| segundoApellido | Second last name | |
| sexo | Gender: -HOMBRE -MUJER | |
| situacionAfiliatoria | Affiliation Status: -ACTIVO -INACTIVO | |
| tipoDerechohabiente | type of beneficiary: -PENSIONISTA -TRABAJADOR |
Test the service (test cases)
We included a query param in Sandbox environment, so you can query test cases that we created to run tests.
In order to obtain the response you shall fill the query param with:
-
success: it sends back a successful example of a requests.
-
invalidInput: it returns the response indicating when the curp provided was invalid and the query could not be applied
-
unavailable: it returns a response indicating that the service of the IMSS platform is not available and we could not apply the query.
Test your own test case
In case you want to test your own test case created in link, you can change the testCase parameter to testCaseId and send the identifier of the test case you want to use
Listing the possible error responses
Required fields
You will get a 400 bad request error when the RFC is not provided in the request body.
{
"curp": "REQUIRED_FIELD_ERROR; EMPTY_ERROR; can't be empty"
}
Invalid format
You will get a 400 bad request error when the RFC does not conform the specific format.
{
"curp": "FORMAT_ERROR; must match [A-Z]{1}[AEIOUX]{1}[A-Z]{2}[0-9]{2}(0[1-9]|1[0-2])(0[1-9]|1[0-9]|2[0-9]|3[0-1])[HM]{1}(AS|BC|BS|CC|CS|CH|CL|CM|DF|DG|GT|GR|HG|JC|MC|MN|MS|NT|NL|OC|PL|QT|QR|SP|SL|SR|TC|TS|TL|VZ|YN|ZS|NE)[B-DF-HJ-NP-TV-Z]{3}[0-9A-Z]{1}[0-9]{1}"
}
Test case not found
If a test case parameter is not sent or a value other than those mentioned above is sent, the service will return the following error 400 bad request
{
"testCase": "EMPTY_ERROR; test case not found",
"testCaseId": "EMPTY_ERROR; test case not found with given id"
}
CURP not found
You will get a 200 http code response when we could not find data on the ISSSTE platform associated with the CURP provided, the status of the request will be NOT_FOUND
{
"id": "65553db7acf971fe2a459351",
"createdAt": "2023-11-15T21:52:55.338558267Z",
"finishedAt": "2023-11-15T21:57:38.181184331Z",
"duration": 282842,
"status": "SUCCESS",
"request": {
"curp": "KIBA801010HDFPMD00"
},
"response": {
"mensaje": "Verifique que la CURP sea correcta y se encuentre en la base de datos del ISSSTE",
"status": "NOT_FOUND"
}
}
Unauthorized
It means that the provided API KEY is incorrect and you are not authorized to access it. You will not receive a body, only a 401 HTTP code.