Retrieve a verification

Unique identifier of the verification. Always starts with ver_.

Object type. Always verification.

Where the verification is. It only moves forward: received, in_production, awaiting_code, verified. From received it can move to canceled; from in_production, to canceled (by CartaFlow) or revoked; from awaiting_code, to failed, expired or revoked; from verified, to revoked. Only verified means a confirmed address.

Possible values

• received: CartaFlow received the request, charged the price to your balance and put the letter with the code in the production queue. If you cancel now, nothing is printed and the amount goes back to the balance.
• in_production: The letter with the code is being printed and enveloped. Canceling now revokes the verification (revoked), with no refund.
• awaiting_code: The letter was posted. Now we wait for the person to confirm the code. They have 60 days from posting (see expires_at). Canceling now revokes the verification, with no refund.
• verified: The person confirmed the right code. They receive mail at the address on file. confirmation says how and when. You can still revoke the verification, which moves it to revoked.
• failed: 5 wrong codes were entered. The verification was locked to stop guessing. Create a new verification to try again.
• expired: 60 days went by after posting without the person confirming the code.
• canceled: The verification was canceled before posting and the amount went back to your balance. Either you canceled it while it was received, or CartaFlow canceled it because the letter could not be produced.
• revoked: You canceled the verification after production started: in production, awaiting the code or already verified. The amount does not go back to the balance, because production already started, and a letter that was in production is still posted. The code stops working, on the page and in the API, and the verification never shows as verified again.

How the person confirms the code.

Possible values

• hosted_page: On the page with your brand, through the QR code or by typing the code.
• code: By typing the code into your website or app.

Where the verification was created. It does not depend on how it is confirmed (see confirmation).

Possible values

• api: Through the API, with POST /v1/verifications.
• dashboard: In the dashboard, by someone on your team.

The address being verified.

How the letter was made: the CartaFlow letter template or your own PDF. A copy of it, with the code hidden (000 000), is at preview_url.

The text you sent to print below the code, on the CartaFlow letter template. null when you did not send one.

Where the page sends the person after confirming. null when not set.

The address of the confirmation page, with your brand (for now on the verifica.cartaflow.com.br domain): https://verifica.cartaflow.com.br/{your account id}/{page token}. It is the address printed on the letter and the one the QR code opens; the QR code carries the code with it, but this link does not, so whoever opens the link has to type the code. You can email this link or show it in your app. Treat it as an opaque address: store and use it as it came. null when method is code.

How many more wrong codes can be entered. Starts at 5 and goes down with each wrong code, on the page or through the API. At 0 the verification moves to failed.

Deadline for the person to confirm: 60 days after posting. null before posting.

How and when the person confirmed the code: where (method), when, from which IP and from where, approximately. null until the verification is confirmed. A verification revoked after being confirmed keeps this record, but its status is revoked: the address no longer counts as verified.

Link to a copy of the letter as it will be printed, address included, but without the code: in its place it shows 000 000, and in place of the QR code, a box that shows where it will be printed. The code only exists in the file CartaFlow prints: neither the API nor the dashboard can show it. The link works for 60 minutes: retrieve the verification again for a fresh link. null in events and webhooks, and when the file is not available.

The price charged to the balance at creation. With the CartaFlow letter template, one base mailing on your plan: a single base line. With your own PDF, the price of a letter with the same options: base, additional_sheets and color. There are never Correios services. It goes back to the balance when the verification is canceled (canceled); it does not when the verification is revoked (revoked).

Your identifier for this verification, such as the invoice number or the customer id in your system. Shown in the dashboard and usable as a filter when listing. It does not have to be unique. Up to 100 characters. null when you did not send one.

Key-value pairs to store your own data with the object, such as your customer or contract id. Returned in every response and webhook and never printed. Up to 20 keys; keys up to 40 characters and string values up to 500 characters. Do not store sensitive data such as passwords or card numbers. Empty object {} when you did not send any.

When the verification reached each status. null for statuses it has not reached. The received status happens at created_at. A verification revoked after being confirmed keeps verified_at.

When the verification was created.