Create an employment link

POST {{baseUrl}}/api/links/

Documentation

This API call is designed to work in Belvo's sandbox environment out of the box. However, if you'd like to test it out in our development or production environments, you just need to make the following changes to the request body:

{
    "institution": "imss_mx_employment",
    "username": "a_valid_curp",
    "access_mode": "single"
}

Once the link is successfully created, the link id is saved as a collection variable so that it can automatically run through the next API requests.

Request Body

{"institution"=>"planet_mx_employment", "username"=>"MOAI540326HDGNYG04", "access_mode"=>"single", "fetch_historical"=>true, "fetch_resources"=>["EMPLOYMENT_RECORDS", "OWNERS"]}

HEADERS

| Key | Datatype | Required | Description |

RESPONSES

status: ``