Docs
Address verifications

List verifications

Returns the account’s verifications, created through the API and the dashboard, newest first.

GET
/verifications

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).

Query Parameters

status?string

Only items in this status.

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

Only items with exactly this reference.

limit?integer

How many items to return per page, from 1 to 100. Default: 20.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor of the previous page. Leave it out to fetch the first page.

created_after?string

Only items created at or after this moment. ISO 8601 date and time.

Formatdate-time
created_before?string

Only items created before this moment. ISO 8601 date and time.

Formatdate-time

Response Body

A page of verifications.

application/json
  1. response

A page of verifications, newest first.

object*string

Object type. Always list.

data*array<>

The items on this page.

has_more*boolean

true when there are more items after this page.

next_cursor*|

Send this value as cursor to fetch the next page. null when this is the last page.

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}