Verification events
CartaFlow POSTs to your webhook URL on every status change of a verification, created through the API or the dashboard.
webhook-id*stringEvent id. The same on every delivery attempt of an event: use it to ignore repeats.
webhook-timestamp*stringTime of sending in Unix seconds. Reject deliveries more than 5 minutes away from your clock.
webhook-signature*stringHMAC-SHA256 signature following the Standard Webhooks spec. Verify it before trusting the content; see the Webhooks guide.
application/json- body
Something that happened in your account, such as a letter being posted. CartaFlow sends each event to your webhooks and keeps it for 30 days.
id*stringUnique identifier of the event. It is the same value as the webhook-id header: use it to ignore repeated deliveries. Always starts with evt_.
^evt_[A-Za-z0-9]+$object*stringObject type. Always event.
type*stringThe event type.
Possible values
verification.received: A verification was created, through the API or the dashboard (seesource), and the letter with the code is in the production queue.verification.in_production: The letter with the code is being printed. From here on, canceling revokes the verification, with no refund.verification.awaiting_code: The letter with the code was posted. The person can confirm once it arrives.verification.verified: The person confirmed the right code. The address is verified.verification.failed: 5 wrong codes were entered and the verification was locked.verification.expired: The person did not confirm the code within 60 days of posting.verification.canceled: The verification was canceled before posting, by you or by CartaFlow, and the amount went back to the balance.verification.revoked: You canceled the verification after production started. The code stopped working and the amount does not go back to the balance. If it wasverified, treat the address as not verified.
"verification.received""verification.in_production""verification.awaiting_code""verification.verified""verification.failed""verification.expired""verification.canceled""verification.revoked"data*|The full object as it was right after the event: a letter for letter.* events and a verification for verification.* events.
created_at*stringWhen the event happened.
date-timeAnswer with any 2xx status within 15 seconds to confirm receipt. Do slow work after answering.
Example Requests
/verification-events