Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Current Employments Mexico

Retrieve current employments

Retrieve current employment information for a specific link.id.

post/api/mx/current-employments/

Request body

linkstring uuid required

The link.id you want to retrieve information for.

save_databoolean

Indicates whether or not to persist the data in Belvo. By default, this is set to true and we return a 201 Created response.

When set to false, the data won't be persisted and we return a 200 OK response.

Example request

{
  "link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
  "save_data": true
}

Response

Ok (when existing)

idstring uuid required

Belvo's unique identifier for the current item.

linkstring uuid nullable required

The link.id the data belongs to.

created_atstring date-time required

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

collected_atstring date-time required

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

monthstring nullable required

The month for which the current employment status is reported, in YYYY-MM format. If status is UNEMPLOYED, this field is null.

internal_identificationstring nullable required

Unique ID for user according to the institution. For IMSS and ISSSTE Mexico, this is the CURP. If status is UNEMPLOYED, this field is null.

status'EMPLOYED' | 'UNEMPLOYED' required

The current employment status of the individual.

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",
    "month": "2023-01",
    "internal_identification": "BLPM230130IONVGR54",
    "personal_data": {
      "official_name": "Bruce Banner del Torro",
      "first_name": "Bruce",
      "last_name": "Banner del Torro",
      "birth_date": "1990-02-09",
      "document_ids": [
        {
          "document_type": "NSS",
          "document_number": "10277663582"
        }
      ]
    },
    "status": "EMPLOYED",
    "current_employment_records": [
      {
        "employer": "Batman Enterprises CDMX",
        "employer_id": "123456789010",
        "employer_rfc": "RFC123456",
        "state": "CDMX",
        "days_employed": 365,
        "base_salary": 10000,
        "monthly_salary": 304166.67
      }
    ]
  }
]