# Get access to the Accounts API

How to ask for the Accounts API, how we switch it on for your business, what the Accounts API card shows, what changes once it is on, and what happens if it is switched off.

Source: https://vezmo.com/docs/developers/accounts-api-access


## Overview

The Accounts API reads your Vezmo accounts, so we switch it on one business at a time. You ask from the dashboard, and our
team looks at the request and switches it on. Until then, the API answers `403` with
the code `api_access_not_enabled` to every Accounts API call from your keys.

What the API reads is on the [Accounts API](/docs/developers/accounts-api) page.

## Ask for access

You need the API keys permissions to see the card. If you can't see it, ask whoever manages your team's roles. See
[Your team and roles](/docs/run-your-business/team).

1. **Open the Accounts API card**
Go to **Settings**, then **Developers**, and find **Accounts API**. It also sits under the keys in
**Payments › VezmoPay › Developers › API keys**.

2. **Select Ask for access**
A support ticket opens with the subject **Accounts API access**. Tell us what you'll use it for, for example
reconciling your accounts in your ERP, then send it.

3. **Wait for our reply**
We reply on the ticket. When the Accounts API is on, the card says **On · read only**.

## What the card shows

| Card | What it means |
| --- | --- |
| Not on yet | The Accounts API isn't on for your business. The four reads are shown locked, with **Ask for access**. |
| On · read only | Your keys can be given the Accounts API permissions. The card shows **Create a key** and three steps to start. |

## Once it is on

- **New permissions in the key form.** When you generate a key, a section called **Accounts API · read only** lists
  four permissions: accounts and balances, transactions, statements and account events. Before access they are shown
  as **Not on yet** and can't be ticked. See
  [Keys and permissions for the Accounts API](/docs/developers/accounts-api-keys).
- **Live keys before VezmoPay.** Live keys normally open once VezmoPay is active for your business. With the Accounts
  API on, you can make a live key before that, holding only Accounts API permissions. The **Live keys** card says so.
- **Accounts events for webhooks.** Endpoints that use the Standard Webhooks format can listen to Accounts events. See
  [Webhooks for Accounts](/docs/developers/accounts-api-webhooks).

Keys you made before keep the permissions they have. A key can't be given more later: make a new one with the Accounts
API permissions.

## If it is switched off

Our team can switch the Accounts API off for a business. From then on:

- every Accounts API call from your keys answers `403` with the code `api_access_not_enabled`;
- your keys keep their other permissions, so the rest of your integration goes on working;
- your webhook endpoints can still be edited: you can take Accounts events off them or change their URL, not add events;
- Accounts events stop being recorded for your business, and Accounts events still waiting to be delivered aren't
  sent. Test events still go.

## Questions

### Who can ask?

Anyone in your business who can see API keys. Our team looks at each request before switching it on.

### Can I switch it on myself?

No. Only our team can switch it on or off.

### Does asking change anything else?

No. Your accounts, keys and webhooks stay as they are until the Accounts API is on.

## Related

- [Accounts API](/docs/developers/accounts-api)
- [Keys and permissions for the Accounts API](/docs/developers/accounts-api-keys)
- [Contact support](https://vezmo.com/contact-us?topic=support)

Vezmo is a financial technology company, not a bank. Banking, stablecoin and card services are provided by regulated
partners.
