Error reference / auth-required
Confirm your email first
The recipient has to enter a one-time code before the document opens.
| Problem type | /problems/auth-required |
|---|---|
| HTTP status | 409 |
| Emitted by | REST API (/v1) |
| Title values | Confirm your email first |
| Trigger | Signing page: the recipient's auth level (`otp`, D55) is not yet satisfied: document, fields, consent, completion withheld until the code is entered; decline stays open |
What happened
The signing link belongs to a recipient whose sender asked for email confirmation (the otp authentication level). The document, its fields, consent, or completion was requested before the code was entered. The response is HTTP 409.
What it means
Nothing is lost. The signing page shows the confirmation step first: a six-digit code is emailed to the recipient’s address, and entering it records the verification in the document’s audit trail. Declining the document does not need the code.
What to do next
In the signing page, request the code and enter it. Integrations embedding the ceremony call the OTP send and verify endpoints before consent; a link-level recipient never sees this error.
Problem body
Every error is an RFC 9457 problem document with media type
application/problem+json. The type member is the
stable identifier to switch on; docs_url is this page.
{
"type": "/problems/auth-required",
"title": "Confirm your email first",
"status": 409,
"instance": "/v1/...",
"docs_url": "https://docs.signenvoy.com/errors/auth-required"
}