--- title: "Get an employment record's details" method: GET path: "/api/employment-records/{id}/" tags: ["Employment Records Mexico"] --- # Get an employment record's details `GET /api/employment-records/{id}/` Get the details of a specific employment record. ## Path parameters - `id` string, uuid, required ## Query parameters - `omit` string - `fields` string ## Response `200` Ok - EmploymentRecord — Employment record response payload - `id` string, uuid — Belvo's unique identifier for the current item. - `link` string, uuid, nullable — The `link.id` the data belongs to. - `created_at` string, date-time — The ISO-8601 timestamp of when the data point was created in Belvo's database. - `collected_at` string, date-time — The ISO-8601 timestamp when the data point was collected. - `report_date` string, date — The date when the employment record report was generated, in `YYYY-MM-DD` format. - `days_since_extraction` integer — The number of days that have passed since the employment data was originally extracted from the institution. - `internal_identification` string — Unique ID for user according to the institution. For IMSS and ISSSTE Mexico, this is the CURP. - `personal_data` EmploymentRecordPersonalData — Details regarding the personal information of the individual. - `official_name` string, nullable — The legal name of the individual. - `first_name` string, nullable — The first name of the individual. - `last_name` string, nullable — The last name of the individual. - `birth_date` string, date, nullable — The date of birth of the individual, in `YYYY-MM-DD` format. - `entitlements` EmploymentRecordEntitlement — Details regarding the benefits the individual is entitled to. - `entitled_to_health_insurance` boolean — Indicates whether or not the individual is entitled to health insurance. - `entitled_to_company_benefits` boolean — Indicates whether or not the individual is entitled to company benefits. - `valid_until` string, date, nullable — Date until when the individual is covered by health insurance and/or company benefits. If `null` the employee is currently working and no end date is required. - `status` 'EMPLOYED' | 'RETIRED' | 'UNEMPLOYED' | 'null' — Indicates the employment status of the individual. We return one of the following responses: - `EMPLOYED` - `RETIRED` - `UNEMPLOYED` - `null` - `document_ids` EmploymentRecordDocumentId[] — Details regarding the individual's ID documents. - `document_type` 'NSS' | 'CURP' | 'RFC', nullable — The type of document related to the individual. We return one of the following values: - `NSS` - `CURP` - `RFC` - `document_number` string, nullable — The ID document's number (as a string). - `email` string, nullable — The email address of the individual. - `social_security_summary` EmploymentRecordSocialSecuritySummary, nullable — Details regarding the individual's social security contributions, according to the IMSS. >**Note**: For ISSSTE Mexico, this value will return `null`. - `weeks_redeemed` integer, nullable — Number of weeks the individual needed to take out of their pension. - `weeks_reinstated` integer, nullable — Number of weeks the individual has paid back into their pension (*AFORE*), after having redeemed them previously. - `weeks_contributed` integer, nullable — Number of weeks the individual has contributed to their social security, based on the number of weeks the individual has worked according to IMSS. - `employment_records` EmploymentRecordDetail[] — Details regarding the individual's employment history. - `collected_at` string, date-time — The ISO-8601 timestamp when the data point was collected. - `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). - `employer_id` string, nullable — The official ID of the employer, according to the country. >**Note**: For ISSSTE Mexico, this value will return `null`. - `start_date` string, date — Date when employment started, in `YYYY-MM-DD` format. - `end_date` string, date, nullable — Date when employment finished, in `YYYY-MM-DD` format. >**Note**: This field will return `null` for the user's current employment. - `weeks_employed` integer — Number of weeks that the individual was employed. - `state` string, nullable — In what geographical state the individual was employed, according to the country. >**Note**: For ISSSTE Mexico, this value will return `null`. - `most_recent_base_salary` number, float — The most recent base salary the individual earned. - 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 dividing `monthly_salary` by 30 (days), and excludes the individual's perks. - `monthly_salary` number, float — The monthly salary of the individual, including any additional perks. - 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 perks. - `currency` string — The three-letter currency code in which the salary is paid. - `employment_status_updates` EmploymentRecordEmploymentStatusUpdates[], nullable — Details regarding any employment changes of the individual. - `event` 'DISMISSED_RESIGNED' | 'SALARY_MODIFICATION' | 'HIRED' | 'VOLUNTARY_CONTRIBUTION' | 'ABSENCE' | 'SICK_LEAVE' | 'NORMAL' | 'BDUTA_CERTIFICATE' | 'DYE_CERTIFICATE', nullable — For IMSS Mexico, this is the event that caused the change in employment status or salary. We return one of the following values: - `DISMISSED_RESIGNED`: The employee was either dismissed or resigned. - `SALARY_MODIFICATION`: The employee received a salary modification (increase or decrease). - `HIRED`: The employee was hired. - `VOLUNTARY_CONTRIBUTION`: The employee made a voluntary contribution to IMSS. - `ABSENCE`: The employee was on absent (such as on vacation). - `SICK_LEAVE`: The employee was on sick leave. For ISSSTE Mexico, this is the information source regarding the change in employment status or salary. We return one of the following values: - `NORMAL`: Indicates that the information was received from the **Instituto de Seguridad y Servicios Sociales de los Trabajadores del Estado (ISSSTE)**. - `BDUTA_CERTIFICATE`: Indicates that the information was received from the central database, **Base de Datos Única de Trabajadores Activos (BDUTA)**. - `DYE_CERTIFICATE`: Indicates that the information was received from an affiliate institution, **Dependencia y Entidad (DYE)**. - `base_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. - `update_date` string, date — The date that the employment event occurred, in `YYYY-MM-DD` format. - `employment_scores` EmploymentRecordScore[], nullable — An array of `employment_record` scores. Each score provides an insight into employability and income generation potential in a given period. > **Note 1**: This field is only available for links created with Mexico's IMSS. For other institutions, this field will return `null`. > **Note 2**: This field will return `null` for employment records retrieved before 16-04-2024. For employment records generated before 16-04-2024, you'll need to make a new POST request to retrieve employment records to calculate the scores. - `score` integer, nullable — A score between 300 and 900 that provides an insight into employability and income generation potential. - A low score (closer to 300) could indicate lower predicted employability and income generation potential, suggesting potential challenges in securing employment or achieving higher income levels in the future. - A high score (closer to 900) could suggest a greater likelihood of securing employment and generating higher income levels. The score can return `null` if the individual has no employment history. - `period` integer — The number of months (in the future) that the score is calculated for. For example, a period of `6` indicates that the score is calculated for the next `6` months. > **Note**: At present Belvo calculates the score for 3, 6, and 12 months. - `version` string — The version of our employment score model used to perform the calculation. - `salary_estimation` EmploymentRecordSalaryEstimation, nullable — Provides a modeled estimation of the user's current base salary and employment status. > **Note**: This field is only available for links created with Mexico's IMSS. For other institutions (such as ISSSTE), this field will return `null`. - `employment_status_estimate` string, nullable, required — Current employment status estimated using an employment record with a past report date. Returns `"EMPLOYED"` (if the `base_salary_estimate` is greater than 0) or `"UNEMPLOYED"`. - `base_salary_estimate` number, float, nullable, required — Current base salary (daily amount) estimated using an employment record with a past report date. - `currency` string, required — The three-letter currency code (ISO-4217). For example, `"MXN"`. - `files` EmploymentRecordFile[], nullable — Additional PDF binary files relating to the individual's employment. - `type` string — The title of the document. - `value` string, nullable — The PDF binary of the file (as a string). > **Note**: In our sandbox environment, this field will return `null`. ## Other responses - `401` — Unauthorized - `403` — Access to Belvo API denied - `404` — Not Found Error - `408` — Request Timeout - `500` — Unexpected Error --- [API](https://skmtc.net/belvo/apis/belvo-api-docs.md) · [All operations](https://skmtc.net/belvo/apis/belvo-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/belvo/belvo-api-docs/versions/3423c786ece5/schema)