Errors
SignatureAPI uses conventional HTTP response codes to indicate the success or failure of an API request. In general:
- Codes in the
2XX
range indicate success. - Codes in the
4XX
range indicate problems with the request, like missing parameters. - Codes in the
5XX
range indicate problems with SignatureAPI servers.
Errors messages conform to RFC 7807 and use a Content-Type of application/problem+json
.
General Errors
This payload is for 4XX
client errors, except validation errors, and 5XX
errors.
A URL that identifies the problem type. Visit the URL to learn more about this problem.
short, human-readable summary of the problem type
The HTTP status code generated by the server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem.
Example
{
"type": "https://signatureapi.com/docs/v1/errors/invalid-api-key",
"title": "Invalid API Key",
"status": 401,
"detail": "Please provide a valid API key in the X-Api-Key header."
}
Validation Errors
This payload is for validation errors (along a 422
status code).
A URL that identifies the problem type. Visit the URL to learn more about this problem.
short, human-readable summary of the problem type
The HTTP status code generated by the server for this occurrence of the problem.
For validation errors, this value is always 422
.
A human-readable list of specific validation errors.
Example
{
"type": "https://signatureapi.com/docs/v1/errors/validation-error",
"title": "Validation Error",
"status": 422,
"errors": [
"documents[0].url protocol must be HTTPS",
"recipients[0].email must be a valid email address"
]
}
Was this page helpful?