Documentação

Listar verificações

Devolve as verificações da conta, criadas pela API e pelo painel, da mais recente para a mais antiga.

GET
/verifications

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.

Parâmetros de consulta

status?string

Só itens neste status.

Valores"received""in_production""awaiting_code""verified""failed""expired""canceled""revoked"
reference?string

Só itens com exatamente esta reference.

limit?integer

Quantos itens devolver por página, de 1 a 100. Padrão: 20.

Intervalo1 <= value <= 100
Padrão20
cursor?string

O next_cursor da página anterior. Omita para buscar a primeira página.

created_after?string

Só itens criados a partir deste momento, inclusive. Data e hora ISO 8601.

Formatodate-time
created_before?string

Só itens criados antes deste momento. Data e hora ISO 8601.

Formatodate-time

Corpo da resposta

Uma página de verificações.

application/json
  1. response

Uma página de verificações, da mais recente para a mais antiga.

object*string

Tipo do objeto. Sempre list.

data*array<>

Os itens desta página.

has_more*boolean

true quando existem mais itens depois desta página.

next_cursor*|

Envie este valor em cursor para buscar a próxima página. null quando esta é a última.

curl "https://api.cartaflow.com.br/v1/verifications" \  -H "Authorization: Bearer $CARTAFLOW_API_KEY"
{  "object": "list",  "data": [    {      "id": "ver_3Hd9Kp2qZ6tW",      "object": "verification",      "status": "awaiting_code",      "method": "hosted_page",      "source": "api",      "to": {        "name": "Destinatário Exemplo",        "street": "Praça da Sé",        "number": "128",        "complement": "Ap. 52",        "neighborhood": "Sé",        "city": "São Paulo",        "state": "SP",        "postal_code": "01001-000"      },      "document": {        "type": "template",        "title": "Confirme o seu endereço",        "body": "{{empresa}} pediu a confirmação de que você recebe correspondência neste endereço. Use o código abaixo para confirmar.",        "footer": "O código vale por 60 dias depois da postagem e só funciona para este endereço. Não compartilhe este código com ninguém.",        "include_qr_code": true,        "include_page_url": true      },      "instructions": null,      "return_url": "https://www.exemplo.com.br/conta",      "hosted_page_url": "https://verifica.cartaflow.com.br/acc_7Jw3Nf8Xq2Lp/9Qx2Lm7Tp4Rb8Kd3Wn6Yc1",      "attempts_remaining": 5,      "expires_at": "2026-12-14T16:05:00Z",      "confirmation": null,      "preview_url": "https://files.cartaflow.com.br/previews/ver_3Hd9Kp2qZ6tW.pdf?expires=1760369400&signature=5d2e81b3",      "price": {        "currency": "BRL",        "total": 990,        "items": [          {            "type": "base",            "quantity": 1,            "unit_amount": 990,            "amount": 990          }        ]      },      "reference": "cliente-1842",      "metadata": {},      "status_transitions": {        "in_production_at": "2026-10-13T21:00:00Z",        "awaiting_code_at": "2026-10-15T16:05:00Z",        "verified_at": null,        "failed_at": null,        "expired_at": null,        "canceled_at": null,        "revoked_at": null      },      "created_at": "2026-10-13T14:20:00Z"    }  ],  "has_more": false,  "next_cursor": null}