TrustShield

Developer documentation

Error Codes

Understand API failures without exposing implementation details or stack traces to users.

Troubleshooting

Error response model

TrustShield clients should treat errors as typed operational states. Show user-friendly messages, log correlation IDs for support, and avoid exposing backend exception details.

Possible causes

  • Invalid JSON
  • Missing URL or QR payload
  • Unsupported field type

Resolution

Validate payloads locally with the published schema before sending the request.

Example response
{
  "code": "invalid_request",
  "message": "The submitted URL is not valid.",
  "correlationId": "req_01HX..."
}