Welcome to Belvo's API Reference documentation! We're always working hard to improve the experience for our developers - because we all know you want to get things working as quickly and smoothly as possible.
If you would like to download our API reference specification file, just click on the format you prefer:
- JSON format (opens in separate browser tab)
- YAML format (automatically prompts to download the file)
In our API specification, you'll see that some response parameters will have a required annotation. According to the OpenAPI specification, when a response parameter is marked as required, this means that the response key must be returned. However, the value of that response parameter can be
In short, any response parameter marked as required will be returned by our API, but the value can be set to
If you'd like to have more in-depth information about which field can be required and
null, check out our OpenAPI specification file.
Just add your secret keys, select the right environment, and fill in the details for your call! All the required fields are automatically highlighted for you in red and there's automatic data validation so you'll always know exactly what parameters you need to provide.
Your API keys will be stored for a given page for the duration of your browser session. We highly recommend you only use your Sandbox credentials while using the interactive API.
Auto-filled cURL requests
When you test our API using cURL, our API reference will automatically construct the right payload for you!
For all our API calls, you can see examples of our SDKs. Just click on the Node, Python, or Ruby icon, and see an example call!
Additionally, you can also see auto-generated code examples for the most popular languages.
To view the response schema, just click on the response type in the Responses section of the call. What's more - we've included plenty of sample responses for most endpoints!
In addition to our general guide about Filtering responses, for all our LIST requests we've included examples on how to apply filtering in cURL, Node, Python, and Ruby.
Did you see something that wasn't quite right? Or have a suggestion? Just use the Feedback widget at the bottom of any page or email us at
[email protected] !
Of course, we know you love Postman - so don't worry. We'll always keep our Postman Public Workspace up to date with all the new developments we make to our API.
To get set up, just follow our dedicated guide on Setting up our Postman collection.
We all hate getting errors - that's why we've created a pretty exhaustive list on how to troubleshoot them in our API and Widget Errors documentation.