SignEnvoy docs

Error reference / validation-failed

Validation failed

The input describes something the engine cannot accept.

Problem type /problems/validation-failed
HTTP status 422
Emitted by Signing page, REST API (/v1)
Title values
Validation failed
image_b64 is not valid base64
pdf_base64 is not valid base64
signature image must be a PNG
Trigger
REST API (/v1): engine rejected field/recipient/envelope input
Signing page: field value rejected

What happened

The request was well-formed JSON but the values describe something invalid: a field outside its page, a recipient without an email, a signing order that skips a number, or an upload that is not the PDF the request claimed. The response is HTTP 422.

What it means

Nothing was created or changed. The detail member names the first problem found. On the signing page the same slug covers a rejected field value, for example a signature image that is not a PNG.

What to do next

Fix the value detail names and resend. Field coordinates are fractions of the page (x, y, w, h between 0 and 1, origin at the top left); recipient_index is the position in the recipients list, starting at 0.

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/validation-failed",
  "title": "pdf_base64 is not valid base64",
  "status": 422,
  "instance": "/v1/...",
  "docs_url": "https://docs.signenvoy.com/errors/validation-failed"
}