Novidades

14 de outubro de 2026Copiar link da seção

• Evento letter.updated: uma correspondência alterada no painel antes da produção (data de envio, endereço, arquivo, variáveis, impressão, serviços dos Correios ou referência) gera letter.updated, com a correspondência como ficou. Veja Correspondências e status.
• Página de confirmação: passa a ficar em https://verifica.cartaflow.com.br/{id da sua conta}/{token da página} (hosted_page_url). Mostra o contato da sua empresa (Configurações > Empresa) e, depois do código certo, oferece compartilhar a localização do aparelho. confirmation ganha campos novos: location.postal_code, location.latitude, location.longitude, user_agent, device, client e precise_location. Veja A página de confirmação.

13 de outubro de 2026Copiar link da seção

Primeira versão da API (v1).

A versão inclui:

• Correspondências: criar a partir de um PDF enviado como arquivo (multipart), por URL, em base64 ou com o upload em duas etapas (POST /v1/uploads, para PDFs de até 10 MB); consultar, listar e cancelar. Uma correspondência que falha na produção vai para failed e o valor volta para o saldo. Veja Correspondências e status e Documento e área do endereço.
• Variáveis em PDF: marcações como {{nome}} num PDF, preenchidas com variables em cada correspondência. Veja Documento e área do endereço.
• Serviços dos Correios: carta registrada (com código de rastreio em tracking_code), aviso de recebimento (AR) e mão própria (MP), em postal_services. Veja Correspondências e status.
• Agendamento: send_date agenda o envio para uma data, com a cobrança feita na data. Veja Agendar envios.
• Cálculo de preço: POST /v1/letters/quote simula uma correspondência com o mesmo corpo da criação, sem criar nem cobrar. Veja Preços e saldo.
• Endereços: só nome, CEP e número são obrigatórios; o resto é preenchido a partir do CEP. Veja Endereços no Brasil.
• Verificação de endereço físico: correspondência com código e a sua marca, do modelo da CartaFlow (personalizável em letter) ou do seu próprio PDF com a marcação {{OTP_CODE}}, confirmada por página hospedada ou pelo seu app. A verificação registra por onde foi criada (source) e como foi confirmada (confirmation), e pode ser revogada depois da produção (revoked, sem devolução). Veja Verificação de endereço físico.
• CEP: consulta do endereço de um CEP.
• Conta e saldo: dados da conta, saldo pré-pago e movimentações.
• Eventos e webhooks: um evento por mudança de status, entregue com assinatura no padrão Standard Webhooks, e um evento de teste enviado pelo painel. Veja Webhooks.

A referência completa de cada endpoint está em Referência da API.