Register a new link

POST {{baseUrl}}/api/links/

Documentation 📖

In the Single Link Flow (MFA) we will create a link to Belvo's Sandbox institution that requires you to authenticate using a token.

Once you click Send, Belvo will to log in to the Sandbox institution and then respond with a 428 - Token Required , indicating that the institution requires an MFA token to complete the login process. You will then need to make the PATCH Complete links request to complete the login process.

Request Body

{"institution"=>"heimdall_mx_retail", "username"=>"mfa_default", "password"=>"pass_valid", "access_mode"=>"single", "external_id"=>"BelvoSingleLinkFlow"}