# Belvo API Docs API

> Belvo API Docs API on Apizie: 80 endpoints (List all links, Register a new link, Complete a links request, Get a link's details, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/payments:belvo/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:belvo`
- Category: Payments
- Status: byok
- Source: https://belvo.com
- Page: https://zieapi.vercel.app/api/payments/belvo
- OpenAPI: https://zieapi.vercel.app/api/payments/belvo/openapi.json

# Introduction Belvo is an open banking API for Latin America that allows companies to access banking and fiscal information in a secure as well as agile way. Through our API, you can access: - **Bank information**…

## Endpoints

### List all links
`GET https://zieapi.vercel.app/v1/payments:belvo/links-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| id | string | no | Return information only for this resource `id`. |
| id__in | array | no | Return information for these resource `id`s. |
| institution | string | no | Return results only for this institution (use the Belvo-designated name, such as `erebor_mx_retail`). |
| institution__in | array | no | Return results only for these institutions (use the Belvo-designated names, such as `erebor_mx_retail` and `gringotts_mx_retail`). |
| access_mode | string | no | Return links only with this access mode. Can be either `single` or `recurrent`. |
| created_at | string | no | Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format). |
| created_at__gt | string | no | Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format). |
| created_at__gte | string | no | Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format). |
| created_at__lt | string | no | Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format). |
| created_at__lte | string | no | Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format). |
| created_at__range | array | no | Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format). |
| created_by__not_in | array | no | Return links that were not created by these Belvo users. |
| external_id | string | no | Return links with this external ID. |
| external_id__in | array | no | Return links with these external IDs. |
| institution_user_id | string | no | Return links with this specific institution user ID. |
| institution_user_id__in | array | no | Return links with these institution user IDs. |
| refresh_rate | string | no | Return links with this refresh rate. Choose between `6h`, `12h`, `24h`, `7d`, or `30d`. |
| status | string | no | Return links with this status. Choose between `valid`, `invalid`, `unconfirmed`, or `token_required`. |
| status__in | array | no | Return links with these statuses. Choose between `valid`, `invalid`, `unconfirmed`, or `token_required`. |

### Register a new link
`POST https://zieapi.vercel.app/v1/payments:belvo/links-register-new-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Complete a links request
`POST https://zieapi.vercel.app/v1/payments:belvo/links-resume-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a link's details
`GET https://zieapi.vercel.app/v1/payments:belvo/links-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `link.id` you want to get detailed information about. |

### Update a link's credentials
`POST https://zieapi.vercel.app/v1/payments:belvo/links-update-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `link.id` you want to update. |
| body | object | yes | JSON request body |

### Change a link's access mode
`POST https://zieapi.vercel.app/v1/payments:belvo/links-change-access-mode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `link.id` you want to change the `access_mode` for. |
| body | object | yes | JSON request body |

### Delete a link
`POST https://zieapi.vercel.app/v1/payments:belvo/links-delete-link-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `link.id` that you want to delete. |

### List all accounts
`GET https://zieapi.vercel.app/v1/payments:belvo/accounts-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| balance__available | number | no | Return accounts that have a `balance.available` matching exactly this value. |
| balance__available__lt | number | no | Return accounts that have a `balance.available` less than this value. |
| balance__available__lte | number | no | Return accounts that have a `balance.available` less than or equal to this value. |
| balance__available__gt | number | no | Return accounts that have a `balance.available` greater than this value. |
| balance__available__gte | number | no | Return accounts that have a `balance.available` greater than or equal to this value. |
| balance__available__range | array | no | Return accounts that have a `balance.available` within a range of two values. |
| balance__current | number | no | Return accounts that have a `balance.current` matching exactly this value. |
| balance__current__lt | number | no | Return accounts that have a `balance.current` less than this value. |
| balance__current__lte | number | no | Return accounts that have a `balance.available` less than or equal to this value. |
| balance__current__gt | number | no | Return accounts that have a `balance.current` greater than this value. |
| balance__current__gte | number | no | Return accounts that have a `balance.available` greater than or equal to this value. |
| balance__current__range | array | no | Return accounts that have a `balance.current` within a range of two values. |
| category | string | no | Return accounts only for the given category (for example, `CHECKING_ACCOUNT` and `SAVINGS_ACCOUNT`). |
| category__in | array | no | Return accounts only for the given categories (for example, `CHECKING_ACCOUNT` and `SAVINGS_ACCOUNT`). |
| created_at | string | no | Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format). |
| created_at__gt | string | no | Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format). |
| created_at__gte | string | no | Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format). |
| created_at__lt | string | no | Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format). |
| created_at__lte | string | no | Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format). |
| created_at__range | array | no | Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format). |
| currency | string | no | Return results that hold finances or balances in only this three-letter currency code. |
| currency__in | array | no | Return results that have funds or balances in one of these three-letter currency codes. |
| id | string | no | Return information only for this resource `id`. |
| id__in | array | no | Return information for these resource `id`s. |
| institution | string | no | Return results only for this institution (use the Belvo-designated name, such as `erebor_mx_retail`). |
| institution__in | array | no | Return results only for these institutions (use the Belvo-designated names, such as `erebor_mx_retail` and `gringotts_mx_retail`). |
| name | string | no | Return accounts with exactly this internal (specified by the institution) name. |
| name__icontains | string | no | Return accounts partially matching this internal (specified by the institution) name. |
| number | string | no | Return information only for this account number (as specified by the institution). |
| number__in | array | no | Return information for these account numbers (as specified by the institution). |
| public_identification_name | string | no | Return information only for this type of account ID. For example, CLABE accounts. |
| public_identification_value | string | no | Return information only for this account ID. For example, the account number for a CLABE account. |
| type | string | no | Return information only for accounts matching this account type, as designated by the institution. |

### Retrieve accounts for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/accounts-create-link-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Complete an accounts request
`POST https://zieapi.vercel.app/v1/payments:belvo/accounts-resume-retrieve-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get an account's details
`GET https://zieapi.vercel.app/v1/payments:belvo/accounts-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `account.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete an account
`POST https://zieapi.vercel.app/v1/payments:belvo/accounts-delete-specific-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `account.id` you want to delete. |

### List all transactions
`GET https://zieapi.vercel.app/v1/payments:belvo/transactions-list-all-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| link | string | yes | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| account | string | no | The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve… |
| account__in | array | no | Return results only for these `account.id`s. |
| account__balance__available | number | no | Return transactions that have a `account.balance.available` matching exactly this value. |
| account__balance__available__lt | number | no | Return transactions that have a `account.balance.available` less than this value. |
| account__balance__available__lte | number | no | Return transactions that have a `account.balance.available` less than or equal to this value. |
| account__balance__available__gt | number | no | Return transactions that have a `account.balance.available` more than this value. |
| account__balance__available__gte | number | no | Return transactions that have a `account.balance.available` more than or equal to this value. |
| account__balance__available__range | array | no | Return transactions that have a `account.balance.available` within a range of two values. |
| account__balance__current | number | no | Return transactions that have a `account.balance.current` matching exactly this value. |
| account__balance__current__gt | number | no | Return transactions that have a `account.balance.current` greater than this value. |
| account__balance__current__gte | number | no | Return transactions that have a `account.balance.current` greater than or equal to this value. |
| account__balance__current__lt | number | no | Return transactions that have a `account.balance.current` less than this value. |
| account__balance__current__lte | number | no | Return transactions that have a `account.balance.current` less than or equal to this value. |
| account__balance__current__range | array | no | Return transactions that have a `account.balance.current` within a range of two values. |
| account_type | string | no | Return information only for transactions matching this account type, as designated by the institution. |
| account_type__in | array | no | Return information only for transactions matching these account types, as designated by the institution. |
| accounting_date | string | no | Return transactions that were processed by the institution on exactly this date (`YYYY-MM-DD`). |
| accounting_date__gt | string | no | Return transactions that were processed by the institution after this date (`YYYY-MM-DD`). |
| accounting_date__gte | string | no | Return transactions that were processed by the institution on this date (`YYYY-MM-DD`) or later. |
| accounting_date__lt | string | no | Return transactions that were processed by the institution before this date (`YYYY-MM-DD`). |
| accounting_date__lte | string | no | Return transactions that were processed by the institution on this date (`YYYY-MM-DD`) or earlier. |
| accounting_date__range | array | no | Return transactions that were processed by the institution in this date range (`YYYY-MM-DD`). |
| amount | number | no | Return results only for this value. |
| amount__gt | number | no | Return results only for more than this amount. |
| amount__gte | number | no | Return results only for and more than this amount. |
| amount__lt | number | no | Return results only for less than this amount. |
| amount__lte | number | no | Return results only for this amount or less. |
| amount__range | array | no | Return results between this amount range. |
| collected_at | string | no | Return items that were retrieved from the institution on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp). |
| collected_at__gt | string | no | Return items that were retrieved from the institution after this date (`YYYY-MM-DD` or full `ISO-8601` timestamp). |
| collected_at__gte | string | no | Return items that were retrieved from the institution after or on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp). |
| collected_at__lt | string | no | Return items that were retrieved from the institution before this date (`YYYY-MM-DD` or full `ISO-8601` timestamp). |
| collected_at__lte | string | no | Return items that were retrieved from the institution before or on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp). |
| collected_at__range | array | no | Return items that were retrieved from the institution between two dates (`YYYY-MM-DD` or full `ISO-8601` timestamp). |
| created_at | string | no | Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format). |
| created_at__gt | string | no | Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format). |
| created_at__gte | string | no | Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format). |
| created_at__lt | string | no | Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format). |
| created_at__lte | string | no | Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format). |
| created_at__range | array | no | Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format). |
| currency | string | no | Return results that hold finances or balances in only this three-letter currency code. |
| currency__in | array | no | Return results that have funds or balances in one of these three-letter currency codes. |
| credit_card_data__bill_name__in | array | no | Return transactions for one of these bill names. |
| reference | string | no | Returns transactions with this institution-assigned reference number. |
| reference__in | array | no | Returns transactions with these institution-assigned reference numbers. |
| status | string | no | Return transactions with this status. Can be either `PENDING`, `PROCESSED`, or `UNCATEGORIZED`. |
| status__in | array | no | Return transactions with these statuses. Can be either `PENDING`, `PROCESSED`, or `UNCATEGORIZED`. |
| type | string | no | Return transactions with this type. Can be either `INFLOW` or `OUTFLOW`. |
| type__in | array | no | Return transactions with this types. Can be either `INFLOW` or `OUTFLOW`. |
| value_date | string | no | Return results for exactly this date (`YYYY-MM-DD`). |
| value_date__gt | string | no | Return results that occurred after this date (`YYYY-MM-DD`). |
| value_date__gte | string | no | Return results for this date (`YYYY-MM-DD`) or later. |
| value_date__lt | string | no | Return results for before this date (`YYYY-MM-DD`). |
| value_date__lte | string | no | Return results for this date (`YYYY-MM-DD`) or earlier. |
| value_date__range | array | no | Return results for this date (`YYYY-MM-DD`) range. |

### Retrieve transactions for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/transactions-create-link-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Belvo-Request-Mode | string | no | Recommended header parameter to make your POST request to retrieve transactions asynchronous (thus preventing timeouts). When you make a… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Complete a transactions request
`POST https://zieapi.vercel.app/v1/payments:belvo/transactions-resume-retrieve-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get a transaction's details
`GET https://zieapi.vercel.app/v1/payments:belvo/transactions-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `transaction.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete a transaction
`POST https://zieapi.vercel.app/v1/payments:belvo/transactions-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `transaction.id` that you want to delete. |

### List all balances
`GET https://zieapi.vercel.app/v1/payments:belvo/balances-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| account | string | no | The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve… |
| account__in | array | no | Return results only for these `account.id`s. |
| account__type | string | no | Return information only for accounts matching this account type, as designated by the institution. |
| account__type__in | array | no | Return information only for accounts matching these account types, as designated by the institution. |
| balance | number | no | Return balances matching exactly this value. |
| balance__lt | number | no | Return balances less than this value. |
| balance__lte | number | no | Return balances less than or equal to this value. |
| balance__gt | number | no | Return balances greater than this value. |
| balance__gte | number | no | Return balances greater than or equal to this value. |
| balance__range | array | no | Return balances between these two values. |
| currency | string | no | Return results that hold finances or balances in only this three-letter currency code. |
| currency__in | array | no | Return results that have funds or balances in one of these three-letter currency codes. |
| id | string | no | Return information only for this resource `id`. |
| id__in | array | no | Return information for these resource `id`s. |
| institution | string | no | Return results only for this institution (use the Belvo-designated name, such as `erebor_mx_retail`). |
| institution__in | array | no | Return results only for these institutions (use the Belvo-designated names, such as `erebor_mx_retail` and `gringotts_mx_retail`). |
| value_date | string | no | Return results for exactly this date (`YYYY-MM-DD`). |
| value_date__gt | string | no | Return results that occurred after this date (`YYYY-MM-DD`). |
| value_date__gte | string | no | Return results for this date (`YYYY-MM-DD`) or later. |
| value_date__lt | string | no | Return results for before this date (`YYYY-MM-DD`). |
| value_date__lte | string | no | Return results for this date (`YYYY-MM-DD`) or earlier. |
| value_date__range | array | no | Return results for this date (`YYYY-MM-DD`) range. |

### Retrieve balances for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/balances-get-link-balances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Complete a balances request
`POST https://zieapi.vercel.app/v1/payments:belvo/balances-resume-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get a balance's details
`GET https://zieapi.vercel.app/v1/payments:belvo/balances-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `balance.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete a balance
`POST https://zieapi.vercel.app/v1/payments:belvo/balances-delete-balance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `balance.id` that you want to delete. |

### List all institutions
`GET https://zieapi.vercel.app/v1/payments:belvo/institutions-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| display_name | string | no | Return institutions that partially match this display name. |
| country_code | string | no | Return institutions only for this two-letter country code. |
| country_code__in | array | no | Return institutions only for these two-letter country codes. |
| resources__allin | array | no | Return institutions that support these resources. |
| name | string | no | Return an institution with this Belvo-designated name. |
| name__in | array | no | Return institutions with one or more of these Belvo-designated names. |
| status | string | no | Return institutions with the given status. You can choose between `healthy` or `down`. |
| status__in | array | no | Return institutions with one of the given statuses. You can choose between `healthy` or `down`. |
| type | string | no | Return institutions of this type. You can choose between `bank`, `fiscal`, or `employment`. |
| type__in | array | no | Return institutions of one of these types. You can choose between `bank`, `fiscal`, or `employment`. |
| website | string | no | Return institutions with this website URL. |

### Get an institution's details
`GET https://zieapi.vercel.app/v1/payments:belvo/institutions-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `institution.id` you want to get detailed information about. |

### List all owners
`GET https://zieapi.vercel.app/v1/payments:belvo/owners-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| id | string | no | Return information only for this resource `id`. |
| id__in | array | no | Return information for these resource `id`s. |
| created_at | string | no | Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format). |
| created_at__gt | string | no | Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format). |
| created_at__gte | string | no | Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format). |
| created_at__lt | string | no | Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format). |
| created_at__lte | string | no | Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format). |
| created_at__range | array | no | Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format). |
| email | string | no | Returns owners whose email address match your query. |
| display_name__icontains | string | no | Return owners whose full display name partially matches your query. For example, `mar` will return results for Mark, Maria, Neymar,… |

### Retrieve owners for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/owners-get-link-owner` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Complete an owners request
`POST https://zieapi.vercel.app/v1/payments:belvo/owners-resume-retrieve-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get an owner's details
`GET https://zieapi.vercel.app/v1/payments:belvo/owners-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `owner.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete an owner
`POST https://zieapi.vercel.app/v1/payments:belvo/owners-delete-owner` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `owner.id` that you want to delete. |

### List all invoices
`GET https://zieapi.vercel.app/v1/payments:belvo/invoices-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| id | string | no | Return information only for this resource `id`. |
| id__in | array | no | Return information for these resource `id`s. |
| created_at | string | no | Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format). |
| created_at__gt | string | no | Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format). |
| created_at__gte | string | no | Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format). |
| created_at__lt | string | no | Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format). |
| created_at__lte | string | no | Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format). |
| created_at__range | array | no | Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format). |
| invoice_date | string | no | Return invoices issued exactly on this date (`YYYY-MM-DD`). |
| invoice_date__lt | string | no | Return balances issued before this date (`YYYY-MM-DD`). |
| invoice_date__lte | string | no | Return balances issued on this date or earlier (`YYYY-MM-DD`). |
| invoice_date__gt | string | no | Return invoices issued after this date (`YYYY-MM-DD`). |
| invoice_date__gte | string | no | Return invoices issued on this date or later (`YYYY-MM-DD`) |
| invoice_date__range | array | no | Return invoices issued within this date range (`YYYY-MM-DD`). |
| invoice_identification | string | no | Return an invoice with this ID (as provided by the insitution). |
| invoice_identification__in | array | no | Return invoices with these IDs (as provided by the institution). |
| status | string | no | Return invoices with this status. Can be either `Vigente` (valid) or `Cancelado` (cancelled). |
| status__in | array | no | Return invoices with these statuses. Can be either `Vigente` (valid) or `Cancelado` (cancelled). |
| type | string | no | Return invoices of this type. Can be either `OUTFLOW` or `INFLOW`. |
| type__in | array | no | Return invoices of these types. Can be either `OUTFLOW` or `INFLOW`. |
| total_amount | number | no | Return invoices matching exactly this value. |
| total_amount__lt | number | no | Return invoices less than this value. |
| total_amount__lte | number | no | Return invoices less than or equal to this value. |
| total_amount__gt | number | no | Return invoices greater than this value. |
| total_amount__gte | number | no | Return invoices greater than or equal to this value. |
| total_amount__range | array | no | Return invoices between these two values. |

### Retrieve invoices for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/invoices-get-link-invoices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Belvo-Request-Mode | string | no | Recommended header parameter to make your POST request to retrieve invoices asynchronous (thus preventing timeouts). When you make a… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Complete an invoices request
`POST https://zieapi.vercel.app/v1/payments:belvo/invoices-complete-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get an invoice's details
`GET https://zieapi.vercel.app/v1/payments:belvo/invoices-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `invoice.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete an invoice
`POST https://zieapi.vercel.app/v1/payments:belvo/invoices-delete-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `invoice.id` that you want to delete. |

### List all tax returns
`GET https://zieapi.vercel.app/v1/payments:belvo/tax-returns-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| id | string | no | Return information only for this resource `id`. |
| id__in | array | no | Return information for these resource `id`s. |
| created_at | string | no | Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format). |
| created_at__gt | string | no | Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format). |
| created_at__gte | string | no | Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format). |
| created_at__lt | string | no | Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format). |
| created_at__lte | string | no | Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format). |
| created_at__range | array | no | Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format). |
| ejercicio | string | no | Return tax returns for exactly this year (`YYYY`). |
| ejercicio__lt | string | no | Return tax returns for before this year (`YYYY`). |
| ejercicio__lte | string | no | Return tax returns for this year and earlier (`YYYY`). |
| ejercicio__gt | string | no | Return tax returns for after this year (`YYYY`). |
| ejercicio__gte | string | no | Return tax returns for this year or later (`YYYY`). |
| ejercicio__range | array | no | Return tax returns for this range of years (`YYYY`). |
| tipo_declaracion | string | no | Return tax returns with this declaration type. |
| tipo_declaracion__in | array | no | Return tax returns with these declaration types. |

### Retrieve tax returns for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/tax-returns-get-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get a tax return's details
`GET https://zieapi.vercel.app/v1/payments:belvo/tax-returns-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `tax-return.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete a tax return
`POST https://zieapi.vercel.app/v1/payments:belvo/tax-returns-delete-specific-tax-return` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the tax return you want to delete. |

### List all tax statuses
`GET https://zieapi.vercel.app/v1/payments:belvo/tax-status-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| id | string | no | Return information only for this resource `id`. |
| id__in | array | no | Return information for these resource `id`s. |
| created_at | string | no | Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format). |
| created_at__gt | string | no | Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format). |
| created_at__gte | string | no | Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format). |
| created_at__lt | string | no | Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format). |
| created_at__lte | string | no | Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format). |
| created_at__range | array | no | Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format). |

### Retrieve tax statuses for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/tax-status-get-link-tax-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get a tax status's details
`GET https://zieapi.vercel.app/v1/payments:belvo/tax-status-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `tax-status.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete a tax status
`POST https://zieapi.vercel.app/v1/payments:belvo/tax-status-delete-specific-tax-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | the `tax-status.id` that you want to delete |

### List all tax compliance statuses
`GET https://zieapi.vercel.app/v1/payments:belvo/tax-compliance-status-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| id | string | no | Return information only for this resource `id`. |
| id__in | array | no | Return information for these resource `id`s. |
| created_at | string | no | Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format). |
| created_at__gt | string | no | Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format). |
| created_at__gte | string | no | Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format). |
| created_at__lt | string | no | Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format). |
| created_at__lte | string | no | Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format). |
| created_at__range | array | no | Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format). |

### Retrieve tax compliance statuses for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/tax-compliance-status-get-fiscal-link-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get a tax compliance status's details
`GET https://zieapi.vercel.app/v1/payments:belvo/tax-compliance-status-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `tax-compliance-status.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete a tax compliance status
`POST https://zieapi.vercel.app/v1/payments:belvo/tax-compliance-status-delete-specific-tax-compliance-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `tax-compliance-status.id` that you want to delete. |

### List all incomes
`GET https://zieapi.vercel.app/v1/payments:belvo/incomes-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| account | string | no | The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve… |
| account__in | array | no | Return results only for these `account.id`s. |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |

### Retrieve incomes for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/incomes-get-insights` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Complete an incomes request
`POST https://zieapi.vercel.app/v1/payments:belvo/incomes-resume-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get an income's details
`GET https://zieapi.vercel.app/v1/payments:belvo/incomes-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `income.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete an income
`POST https://zieapi.vercel.app/v1/payments:belvo/incomes-delete-income` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | the `income.id` that you want to delete |

### List all recurring expenses
`GET https://zieapi.vercel.app/v1/payments:belvo/recurring-expenses-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| account | string | no | The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve… |
| account__in | array | no | Return results only for these `account.id`s. |
| id | string | no | Return information only for this resource `id`. |
| id__in | array | no | Return information for these resource `id`s. |

### Retrieve recurring expenses for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/recurring-expenses-get-insights` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Complete a recurring expenses request
`POST https://zieapi.vercel.app/v1/payments:belvo/recurring-expenses-resume-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get a recurring expense's details
`GET https://zieapi.vercel.app/v1/payments:belvo/recurring-expenses-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `recurring-expenses.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete a recurring expense
`POST https://zieapi.vercel.app/v1/payments:belvo/recurring-expenses-delete-expense` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `recurring-expenses.id` that you want to delete |

### List all risk insights
`GET https://zieapi.vercel.app/v1/payments:belvo/risk-insights-list-all-risk-insights` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| account | string | no | The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve… |
| account__in | array | no | Return results only for these `account.id`s. |
| id | string | no | Return information only for this resource `id`. |
| id__in | array | no | Return information for these resource `id`s. |

### Retrieve risk insights for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/risk-insights-get-for-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Complete a risk insights request
`POST https://zieapi.vercel.app/v1/payments:belvo/risk-insights-resume-insights-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get a risk insight's details
`GET https://zieapi.vercel.app/v1/payments:belvo/risk-insights-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `risk-insights.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete a risk insight
`POST https://zieapi.vercel.app/v1/payments:belvo/risk-insights-delete-specific-insight` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `risk-insights.id` that you want to delete |

### List all tax retentions
`GET https://zieapi.vercel.app/v1/payments:belvo/tax-retentions-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| created_at | string | no | Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format). |
| created_at__gt | string | no | Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format). |
| created_at__gte | string | no | Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format). |
| created_at__lt | string | no | Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format). |
| created_at__lte | string | no | Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format). |
| created_at__range | array | no | Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format). |

### Retrieve tax retentions for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/tax-retentions-get-link-tax-retentions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get a tax retention's details
`GET https://zieapi.vercel.app/v1/payments:belvo/tax-retentions-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `tax-retention.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete a tax retention
`POST https://zieapi.vercel.app/v1/payments:belvo/tax-retentions-delete-specific-tax-retention` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `tax-retention.id` that you want to delete. |

### List all tax declarations
`GET https://zieapi.vercel.app/v1/payments:belvo/tax-declarations-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| id | string | no | Return information only for this resource `id`. |
| id__in | array | no | Return information for these resource `id`s. |
| created_at | string | no | Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format). |
| created_at__gt | string | no | Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format). |
| created_at__gte | string | no | Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format). |
| created_at__lt | string | no | Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format). |
| created_at__lte | string | no | Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format). |
| created_at__range | array | no | Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format). |
| year | number | no | Return results for this year (`YYYY`). |
| year__gt | number | no | Return results for after this year (`YYYY`). |
| year__gte | number | no | Return results for this year or after (`YYYY`). |
| year__lt | number | no | Return results for before this year (`YYYY`). |
| year__lte | number | no | Return results for this year or earlier (`YYYY`). |
| year__range | array | no | Return results between these two years (`YYYY`). |

### Retrieve tax declarations for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/tax-declarations-get-fiscal-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get a tax declaration's details
`GET https://zieapi.vercel.app/v1/payments:belvo/tax-declarations-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `tax-declaration.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete a tax declration
`POST https://zieapi.vercel.app/v1/payments:belvo/tax-declarations-delete-specific-declaration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `tax-declration.id` that you want to delete. |

### List all employment records
`GET https://zieapi.vercel.app/v1/payments:belvo/employment-records-mexico-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| id | string | no | Return information only for this resource `id`. |
| id__in | array | no | Return information for these resource `id`s. |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |
| internal_identification | string | no | The `internal_identification` you want to filter by. |
| internal_identification__in | array | no | One or more `internal_identification`s you want to filter by. |
| collected_at | string | no | Return items that were retrieved from the institution on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp). |
| collected_at__gt | string | no | Return items that were retrieved from the institution after this date (`YYYY-MM-DD` or full `ISO-8601` timestamp). |
| collected_at__gte | string | no | Return items that were retrieved from the institution after or on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp). |
| collected_at__lt | string | no | Return items that were retrieved from the institution before this date (`YYYY-MM-DD` or full `ISO-8601` timestamp). |
| collected_at__lte | string | no | Return items that were retrieved from the institution before or on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp). |
| collected_at__range | array | no | Return items that were retrieved from the institution between two dates (`YYYY-MM-DD` or full `ISO-8601` timestamp). |
| created_at | string | no | Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format). |
| created_at__gt | string | no | Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format). |
| created_at__gte | string | no | Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format). |
| created_at__lt | string | no | Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format). |
| created_at__lte | string | no | Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format). |
| created_at__range | array | no | Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format). |

### Retrieve employment record details
`POST https://zieapi.vercel.app/v1/payments:belvo/employment-records-mexico-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get an employment record's details
`GET https://zieapi.vercel.app/v1/payments:belvo/employment-records-mexico-get-details-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `employment-record.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete an employment record
`POST https://zieapi.vercel.app/v1/payments:belvo/employment-records-mexico-delete-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `employment-record.id` that you want to delete. |

### Verify incomes
`POST https://zieapi.vercel.app/v1/payments:belvo/income-verification-enrich-user-incomes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Categorize transactions
`POST https://zieapi.vercel.app/v1/payments:belvo/categorization-categorize-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List all credit scores
`GET https://zieapi.vercel.app/v1/payments:belvo/credit-score-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | A page number within the paginated result set. |
| page_size | integer | no | Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per… |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| account | string | no | The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve… |
| account__in | array | no | Return results only for these `account.id`s. |
| link | string | no | The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. |
| link__in | array | no | Return results only for these `link.id`s. |

### Retrieve a credit score for a link
`POST https://zieapi.vercel.app/v1/payments:belvo/credit-score-get-by-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |
| body | object | yes | JSON request body |

### Get a credit score's details
`GET https://zieapi.vercel.app/v1/payments:belvo/credit-score-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The `credit-score.id` you want to get detailed information about. |
| omit | string | no | Omit certain fields from being returned in the response. For more information, see our [Filtering… |
| fields | string | no | Return only the specified fields in the response. For more information, see our [Filtering… |

### Delete a credit score
`POST https://zieapi.vercel.app/v1/payments:belvo/credit-score-delete-specific-score` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | the `credit-score.id` that you want to delete |

### Retrieve Credit Score
`POST https://zieapi.vercel.app/v1/payments:belvo/credit-score-eyod-get-user-credit-score` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/payments:belvo/links-list-all" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Belvo API Docs API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/payments:belvo/links-list-all with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Belvo API Docs API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Belvo API Docs itself also needs your own key from development.belvo.com.

### Can AI agents use the Belvo API Docs API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:belvo.

### What is the status of the Belvo API Docs API?
Needs your own provider key (bring your own key)