Skip to content
Last updated

API Errors

The Public API returns errors in RFC 9457 — Problem Details for HTTP APIs format (rfc-editor.org/rfc/rfc9457), with Content-Type: application/problem+json.


Error response structure

Each error response is a JSON object with the standard RFC 9457 fields and, where applicable, extension fields.

FieldTypeRequiredDescription
typestringyesURI that identifies the error type. It points to the error’s documentation page (see Error types).
titlestringyesShort human-readable description of the problem type.
statusnumberyesHTTP status code (e.g. 400, 404, 500).
detailstringyesHuman-readable message specific to this occurrence.
codestringyesApplication error code (TS-xxx), useful for logging and automation.

Error types

The response type field contains a URI that identifies the error category and points to the corresponding documentation page.

typeHTTP statusDescriptionPage
.../errors/validation-error400Invalid payload or parametersValidation error
.../errors/not-found-error404Resource not foundNot found error
.../errors/resource-gone-error410Resource deletedResource gone error
.../errors/server-error500Internal server errorServer error

Each page lists the associated TS-xxx codes, response examples, and guidance for resolving the issue.


Full error code list

CodeHTTP statustypeDetail
TS-000500server-errorInternal server error.
TS-001400validation-errorMalformed payload.
TS-002400validation-errorValidation data error.
TS-003400validation-errorRelative resource not found.
TS-004400validation-errorFlow data validation error.
TS-005400validation-errorSign data validation error.
TS-006400validation-errorAttachment already linked to Template.
TS-007400validation-errorOn before create function not found.
TS-008400validation-errorInsufficient credits available.
TS-009410resource-gone-errorCertification deleted.
TS-010404not-found-errorCertification not found.
TS-011400validation-errorNo certification attachments found.
TS-012400validation-errorA certification has already been created for this upload session token.
TS-013400validation-errorNot all files have been uploaded.
TS-014500server-errorThe certification could not be completed after creation.
TS-901400validation-errorThis True Link has already been used to create a certification.

Certification GET: async processing failure

When GET /v1/certifications/{reportId} refers to a certification that was created successfully but failed during asynchronous processing, the API returns an HTTP status appropriate to the error (for example 5xx). The body is application/problem+json (RFC 9457), with the same fields as other errors.

If you supplied a webhook_url on creation, the failure callback uses the same problem+json payload this GET would return.


Handling errors in the client

  1. Check the response Content-Type: if it is application/problem+json, parse the body as an RFC 9457 object.
  2. Use status to distinguish 4xx (client error) from 5xx (server error).
  3. Use type to identify the error category and consult the corresponding documentation page.
  4. Use code (TS-xxx) for logging, analytics, or localized messages.
  5. Show the user detail; use title for generic labels.

Reference