Register a new link
POST {{baseUrl}}/api/links/
Documentation 📖
Register a new link with your Belvo account.
See detailed documentation for the Register a new link call in our API Reference .
Request Body
{"institution"=>"name_country_type", "username"=>"username", "password"=>"password", "external_id"=>"your_internal_id", "access_mode"=>"single", "fetch_resources"=>["RESOURCE_1", "RESOURCE_2", "RESOURCE_3"]}
HEADERS
| Key | Datatype | Required | Description |
| Content-Type | string | | |
RESPONSES
status: Created
{"id":"5fbae30b-8ac1-49d6-a665-b95de84af9cb","institution":"tatooine_mx_fiscal","access_mode":"single","status":"valid","refresh_rate":null,"created_by":"6e9be884-4781-4143-b673-aca02475ee8c","last_accessed_at":"2024-02-02T13:11:42.593032Z","external_id":"postman-link-test-fiscal-mexico","created_at":"2024-02-02T13:11:42.586099Z","institution_user_id":"Tyc362ErLbrIBeW4Sob_pOPz6j-RWTorYPTSVukDFIM=","credentials_storage":"5d","stale_in":"30d","fetch_resources":["TAX_STATUS","TAX_COMPLIANCE_STATUS","TAX_RETURNS","INVOICES"]}