Skip to navigation
API ReferenceForwarding

Confirm Verification

Submit the code emailed by Start Verification to verify the address. A code allows 10 wrong attempts, then stops working even with the right code, and Start Verification sends a new one. Needs an organization- or pod-scoped API key in an organization that has completed agent verification.

CLI:

agentmail forwarding confirm-verification --destination ops@example.com --code 7KQ2M-XW9PD

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
destinationstringRequired
Address the code was sent to.
codestringRequired

The 10-character code from the email, shown as XXXXX-XXXXX. Case, spaces and the dash are ignored.

Response

This endpoint returns an object.
verified_atdatetime
Time at which the address was verified.

Errors

400
Validation Error
403
Forwarding Forbidden Error
409
Conflict Error