NewTell a voided invoice from a totally rectified one, without a second call
BeeL
Get StartedMulti-NIFVeriFactuStripeAPI ReferenceChangelog
Accounts

Get a provisioned account's authoritative status

Scopeaccounts:read

Returns the current lifecycle status and access for one account you provisioned. A 403 is returned when the account was not provisioned by you or does not exist (existence is not disclosed). Requires the accounts:read scope.

GET
/v1/accounts/{account_id}

Authorization

AuthorizationBearer <token>

API Key authentication.

Format: Authorization: Bearer beel_sk_<key>

Scopes: API Keys use the same scopes as OAuth2 tokens. Each key is created with specific scopes that limit which endpoints it can access. The required scope for each endpoint is documented in the operation's security section under OAuth2.

Obtaining Keys: API Keys are managed from the BeeL dashboard

Security: API Keys are secret credentials. Do not share them or store them in source code

In: header

Path Parameters

account_idstring
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.beel.es/api/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "success": true,
  "data": {
    "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
    "external_ref": "string",
    "display_name": "string",
    "access_level": "NONE",
    "status": "PROVISIONED",
    "claim": {
      "status": "NOT_ISSUED",
      "expires_at": "2019-08-24T14:15:22Z"
    },
    "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
    "representation_signed": true,
    "created_at": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have permission to access this resource"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Please try again in 60 seconds."
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

List the accounts you provisioned, with lifecycle status GET

Returns the accounts you provisioned, each with its lifecycle `status` (`PROVISIONED` → `CLAIMED` → `ACTIVE`) and the access you hold. Newest first, cursor-paginated. Filter by `status`, or look one up by `external_ref` (your own id) — an `external_ref` that matches nothing returns an empty list, never an error. Requires the `accounts:read` scope.

Provisioning usage of your own account GET

Returns how many accounts you have provisioned and how many NIFs (companies) they hold — the billable figure for your offline B2B invoice. Requires the `accounts:read` scope. `account_id` is **your own account**: usage is a property of the provisioner, not of each provisioned account. Any other id — an account you provisioned, one belonging to someone else, or one that does not exist — returns the same `404`, so the endpoint cannot be used to probe which accounts exist.