Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Employment Records Mexico

Get an employment record's details

Get the details of a specific employment record.

get/api/employment-records/{id}/

Path parameters

idstring uuid required

The employment-record.id you want to get detailed information about.

Query parameters

omitstring

Omit certain fields from being returned in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

Response

Ok

idstring uuid

Belvo's unique identifier for the current item.

linkstring uuid nullable

The link.id the data belongs to.

created_atstring date-time

The ISO-8601 timestamp of when the data point was created in Belvo's database.

collected_atstring date-time

The ISO-8601 timestamp when the data point was collected.

report_datestring date

The date when the employment record report was generated, in YYYY-MM-DD format.

days_since_extractioninteger

The number of days that have passed since the employment data was originally extracted from the institution.

internal_identificationstring

Unique ID for user according to the institution. For IMSS and ISSSTE Mexico, this is the CURP.

Example response

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "collected_at": "2022-02-09T08:45:50.406032Z",
  "report_date": "2023-01-19",
  "days_since_extraction": 42,
  "internal_identification": "BLPM951331IONVGR54",
  "personal_data": {
    "official_name": "Bruce Banner del Torro",
    "first_name": "Bruce",
    "last_name": "Banner del Torro",
    "birth_date": "2022-02-09",
    "entitlements": {
      "entitled_to_health_insurance": true,
      "entitled_to_company_benefits": true,
      "status": "EMPLOYED"
    },
    "document_ids": [
      {
        "document_type": "NSS",
        "document_number": "10277663582"
      }
    ],
    "email": "bruce.banner@avengers.com"
  },
  "social_security_summary": {
    "weeks_contributed": 188
  },
  "employment_records": [
    {
      "collected_at": "2020-04-23T21:32:55.336854+00:00",
      "employer": "Batman Enterprises CDMX",
      "employer_id": "780-BAT-88769-CDMX",
      "start_date": "2019-10-10",
      "end_date": "2019-12-31",
      "weeks_employed": 12,
      "state": "DISTRITO FEDERAL",
      "most_recent_base_salary": 762.54,
      "monthly_salary": 23193.925,
      "currency": "MXN",
      "employment_status_updates": [
        {
          "event": "HIRED",
          "base_salary": 1033.09,
          "update_date": "2021-09-01"
        }
      ]
    }
  ],
  "employment_scores": [
    {
      "score": 722,
      "period": 3,
      "version": "1.0.0"
    },
    {
      "score": 612,
      "period": 6,
      "version": "1.0.0"
    },
    {
      "score": 570,
      "period": 12,
      "version": "1.0.0"
    }
  ],
  "salary_estimation": {
    "employment_status_estimate": "EMPLOYED",
    "base_salary_estimate": 1000,
    "currency": "MXN"
  },
  "files": [
    {
      "type": "ReporteSemanasCotizadas_190123",
      "value": "=PDF_BINARY="
    }
  ]
}