Skip to content

Retry Email (Single)

Retries the authorization email for a specific document.

POST /v1/documents/:accessKey/email-retry

By default only retries if email_status is PENDING or FAILED. Add ?force=true to resend even if the email was already successfully sent.

Authentication

Authorization: Bearer <api-key> and X-Issuer-Id: <issuer-id> (numeric id from GET /v1/issuers)

Path parameters

ParameterDescription
accessKeyThe 49-digit access key of the document

Query parameters

ParameterRequiredDescription
forceNoSet to true to resend even if email_status is already SENT or DELIVERED

Response

200 OK

json
{
  "ok": true,
  "result": {
    "sent": true,
    "messageId": "[email protected]"
  }
}

Errors

CodeStatusWhen
UNAUTHORIZED401Missing or invalid API key
NOT_FOUND404Document not found
BAD_REQUEST400Document is not AUTHORIZED, or email already sent and force not set

Comprobify API Documentation