πŸŽ‰ Belvo API reference

We're really proud to show off our new API reference documentation 🀩.

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.

Our solutions

Aggregation

aggregation-icon

Access and aggregate financial data.

Enrichment

enrichment-icon

Enrich financial data to obtain insights.

Payment

payments-icon

Accept and issue bank-to-bank payments.

πŸ“– OpenAPI specification file

If you would like to download our API reference specification file, just click on the format you prefer:

Aggregation and Enrichment

Payment Initiation

  • Coming soon!

ℹ️ OpenAPI: required and nullable fields

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 null.

πŸ“˜

In short, any response parameter marked as required will be returned by our API, but the value can be set to null.

If you'd like to have more in-depth information about which field can be required and null, check out our OpenAPI specification file.