Documentação

Consultar a conta

Devolve os dados da conta dona da chave de API.

GET
/account

Autenticação

apiKey
headerAuthorizationBearer <chave de API>

Chave de API no cabeçalho Authorization: Bearer cf_live_.... Crie e revogue chaves no painel, em Desenvolvedores > Chaves de API.

Corpo da resposta

A conta.

application/json
  1. response

A conta CartaFlow dona da chave de API usada na requisição.

id*string

Identificador único da conta. Sempre começa com acc_.

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

Tipo do objeto. Sempre account.

legal_name*string

Razão social da empresa.

trade_name*|

Nome fantasia. É o nome que aparece nas correspondências de verificação, junto com o logo; sem ele, usamos a razão social. Muda no painel, em Configurações > Empresa. null quando não foi informado.

cnpj*string

CNPJ da empresa, formatado. Pode ser alfanumérico (emitido desde julho de 2026): os 12 primeiros caracteres podem ser letras maiúsculas ou dígitos, e os 2 últimos, os dígitos verificadores, são sempre números. Por exemplo 12.345.678/0001-90 ou 12.ABC.345/01DE-35.

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

O plano atual. Define o preço de cada envio.

Valores possíveis

  • pay_as_you_go: Avulso. Sem mensalidade, preço por envio mais alto.
  • essential: Essencial.
  • professional: Profissional.
  • scale: Escala.
  • enterprise: Enterprise. Contrato de 12 meses com volume mensal combinado.
Valores"pay_as_you_go""essential""professional""scale""enterprise"
default_sender*

Remetente usado quando uma correspondência não traz from. Muda no painel, em Configurações > Empresa.

created_at*string

Quando a conta foi criada.

Formatodate-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"}