Employment Records Data (Mexico)
Below we break down each section of the data returned by our Employment Records API.
Core fields
| parameter name | type | format | description | example |
|---|---|---|---|---|
| id | string | UUID | Belvo's unique identifier for the current item. | 0d3ffb69-f83b-456e-ad8e-208d0998d71d |
| link | string | UUID | The link.id the data belongs to. | 30cb4806-6e00-48a4-91c9-ca55968576c8 |
| created_at | string (date-time) | date-time | The ISO-8601 timestamp of when the data point was created in Belvo's database. | 2022-02-09T08:45:50.406032Z |
| collected_at | string | date-time | The ISO-8601 timestamp when the data point was collected. | 2022-02-09T08:45:50.406032Z |
| report_date | string | date | The date when the employment record report was generated, in YYYY-MM-DD format. | 2023-01-19 |
| internal_identification | string | string | The unique ID for the user according to the institution. For IMSS and ISSSTE Mexico, this is the CURP. | BLPM951331IONVGR54 |
| personal_data | object | Details regarding the personal information of the individual. | See the Personal data section for details . | |
| social_security_summary | object | Details regarding the individual's social security contributions, according to the IMSS. > Note: For ISSSTE Mexico, this value will return null | See the Social security summary section for details. | |
| employment_records | array of objects | Details regarding the individual's employment history. | See the Employment records section for details. | |
| employment_scores | array of objects | An array of employment_record scores. Each score provides an insight into employability and income generation potential in a given period.> Note: For ISSSTE Mexico, this value will return null | See the Employment scores section for details. | |
| files | object | Additional PDF binary files relating to the individual's employment. | See the Files section for details. |
Personal data
| parameter name | type | format | description | example |
|---|---|---|---|---|
| official_name | string | - | The legal name of the individual. | Bruce Banner del Torro |
| first_name | string | - | The first name of the individual. | Bruce |
| last_name | string | - | The last name of the individual. | Banner del Torro |
| birth_date | string | date | The date of birth of the individual, in YYYY-MM-DD format. | 2022-02-09 |
| entitlements | object | - | Details regarding the benefits the individual is entitled to. | See the Entitlements section for details. |
| document_ids | array of objects | - | Details regarding the individual's ID documents. | See the Document IDs section for details. |
Entitlements
| parameter name | type | format | description | example |
|---|---|---|---|---|
| entitled_to_health_insurance | boolean | - | Indicates whether or not the individual is entitled to health insurance. | true |
| entitled_to_company_benefits | boolean | - | Indicates whether or not the individual is entitled to company benefits. | true |
| valid_until | string | date | Date until when the individual is covered by health insurance and/or company benefits. If the value is null, the employee is currently working and no end date is required. | null |
| status | string | - | Indicates the employment status of the individual. We return one of the following responses: - EMPLOYED- RETIRED- UNEMPLOYED- null | EMPLOYED |
Document IDs
| parameter name | type | format | description | example |
|---|---|---|---|---|
| document_type | string | - | The type of document related to the individual. We return one of the following values: - NSS- CURP- RFC (ISSTE only) | CURP |
| document_number | string | - | The ID document's number. | BLPM951331IONVGR54 |
Social security summary
Note: For ISSSTE Mexico, this value will return
null
| param_name | type | format | description | example |
|---|---|---|---|---|
| weeks_redeemed | integer | int32 | Number of weeks the individual needed to take out of their pension. | 0 |
| weeks_reinstated | integer | int32 | Number of weeks the individual has paid back into their pension (*AFORE*), after having redeemed them previously. | 0 |
| weeks_contributed | integer | int32 | Number of weeks the individual has contributed to their social security, based on the number of weeks the individual has worked according to IMSS. | 188 |
Employment records
| param_name | type | format | description | example |
|---|---|---|---|---|
| collected_at | string | date-time | The ISO-8601 timestamp when the data point was collected. | 2020-04-23T21:32:55.336854+00:00 |
| employer | string | - | The official name of the employer. > Note: For ISSSTE Mexico, this is the official name of the entity along with the entity that is responsible for managing the employee's information, separated by a semicolon ( ;). For example: SECRETARIA DE EDUCACION PUBLICA (SEP);SECRETARIA DE EDUCACION PUBLICA (SEP). | Batman Enterprises CDMX |
| employer_id | string | - | The official ID of the employer, according to the country. > Note: For ISSSTE Mexico, this value will return null | 780-BAT-88769-CDMX |
| start_date | string | date | Date when employment started, in YYYY-MM-DD format. | 2019-10-10 |
| end_date | string | date | Date when employment finished, in YYYY-MM-DD format.> Note: This field will return null for the individual's current employment. | 2019-12-31 |
| weeks_employed | integer | int32 | Number of weeks that the individual was employed. | 12 |
| state | string | - | In what geographical state the individual was employed, according to the country. | DISTRITO FEDERAL |
| most_recent_base_salary | number | float | The most recent base salary the individual earned. For Mexico, this is the *daily* rate that the individual earned, including the perks that the individual is entitled to throughout the year. | 762.54 |
| monthly_salary | number | float | The monthly salary of the individual, including any additional perks. | 25000.0 |
| currency | string | - | The three-letter currency code in which the salary is paid. | MXN |
| employment_status_updates | array of objects | - | Details regarding any employment changes of the individual. | See the Employment status updates section for details . |
Employment status updates
| parameter name | type | format | description | example |
|---|---|---|---|---|
| event | string | - | The event that caused the change in employment status or salary. For IMSS Mexico, we return one of the following values: - DISMISSED_RESIGNED- SALARY_MODIFICATION- HIRED- VOLUNTARY_CONTRIBUTION- ABSENCE- SICK_LEAVEFor ISSSTE Mexico, we return one of the following values:- NORMAL- BDUTA_CERTIFICATE- DYE_CERTIFICATE | SALARY_MODIFICATION |
| salary | number | float | The base salary of the individual, current as of the update_date.- For IMSS Mexico, this value is calculated including the perks that the individual is entitled to throughout the year. - For ISSSTE Mexico, this value is calculated excluding the individual's perks. | |
| event | string | date | The date that the employment event occurred, in YYYY-MM-DD format. |
Employment scores
Note: For ISSSTE Mexico, this value will return
null
| parameter name | type | format | description | example |
|---|---|---|---|---|
| score | integer | A score between 300 and 900 that provides an insight into employability and income generation potential. | 722 | |
| period | integer | The number of months (in the future) that the score is calculated for. | 3 | |
| version | string | The version of our employment score model used to perform the calculation. | 1.0.0 |
Files
| param_name | type | format | description | example |
|---|---|---|---|---|
| type | string | The title of the document. | ReporteSemanasCotizadas_190123 | |
| value | string | The PDF binary of the file (as a string). > Note: In our sandbox environment, this field will return null. | =PDF_BINARY= |
Updated 3 months ago