Docs
Account and balance

Retrieve the account

Returns the account that owns the API key.

GET
/account

Authorization

apiKey
headerAuthorizationBearer <token>

API key in the Authorization: Bearer cf_live_... header. Create and revoke keys in the dashboard, under Desenvolvedores > Chaves de API (Developers > API keys).

Response Body

The account.

application/json
  1. response

The CartaFlow account that owns the API key used in the request.

id*string

Unique identifier of the account. Always starts with acc_.

Match^acc_[A-Za-z0-9]+$
object*string

Object type. Always account.

legal_name*string

Registered company name ("razão social").

trade_name*|

Trade name ("nome fantasia"). It is the name shown on verification letters, next to the logo; without it, we use the registered name. Change it in the dashboard, under Configurações > Empresa (Settings > Company). null when not set.

cnpj*string

The company’s CNPJ (Brazilian company tax id), formatted. It can be alphanumeric (issued since July 2026): the first 12 characters can be capital letters or digits, and the last 2, the check digits, are always numbers. For example 12.345.678/0001-90 or 12.ABC.345/01DE-35.

Match^[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2}$
plan*string

The current plan. It sets the price of each mailing.

Possible values

  • pay_as_you_go: Pay as you go. No monthly fee, higher price per mailing.
  • essential: Essential.
  • professional: Professional.
  • scale: Scale.
  • enterprise: Enterprise. 12-month contract with a committed monthly volume.
Value in"pay_as_you_go""essential""professional""scale""enterprise"
default_sender*

Sender used when a letter has no from. Change it in the dashboard, under Configurações > Empresa (Settings > Company).

created_at*string

When the account was created.

Formatdate-time
curl "https://api.cartaflow.com.br/v1/account" \  -H "Authorization: Bearer $CARTAFLOW_API_KEY"
{  "id": "acc_7Jw3Nf8Xq2Lp",  "object": "account",  "legal_name": "Exemplo Serviços Ltda.",  "trade_name": "Exemplo",  "cnpj": "12.345.678/0001-90",  "plan": "essential",  "default_sender": {    "name": "Exemplo Serviços Ltda.",    "street": "Avenida Exemplo",    "number": "1000",    "complement": "Sala 301",    "neighborhood": "Bela Vista",    "city": "São Paulo",    "state": "SP",    "postal_code": "01310-100"  },  "created_at": "2026-09-01T12:00:00Z"}