Skip to main content

ExternalApiProblem

RFC 9457 problem details returned by the External API.

codestringrequired

Stable machine-readable problem code.

Possible values: [invalid-request, invalid-cursor, invalid-correlation-id, authentication-failed, access-denied, not-found, method-not-allowed, not-acceptable, unsupported-media-type, validation-failed, conflict, service-unavailable, internal-error]

Example: authentication-failed
detailstringrequired

Human-readable explanation specific to this occurrence.

Example: The bearer token is missing or invalid.
instancestring<uri>required

URI identifying this specific problem occurrence.

Example: urn:uuid:b495f901-5456-4df6-a4da-cc750638c66b
requestIdstring<uuid>required

Server-generated identifier used to correlate this HTTP attempt.

Example: b495f901-5456-4df6-a4da-cc750638c66b
statusinteger<int32>required

HTTP status code for this occurrence.

Example: 401
titlestringrequired

Short, human-readable summary of the problem category.

Example: Authentication failed
typestring<uri>required

Stable URI identifying the problem category.

Example: https://docs.portfolio.exchange/external-api/v1/problems/authentication-failed
violations object[]required

Field-level violations, or null when the problem is not a validation failure.

  • Array [
    • codestringrequired

    Stable machine-readable validation code.

    Example: invalid-format
    detailstringrequired

    Human-readable explanation of the validation failure.

    Example: Must be an ISO 4217 alphabetic currency code.
    pointerstringrequired

    JSON Pointer locating the invalid request value.

    Example: /currency
  • ]
    • ExternalApiProblem
    {
      "code": "authentication-failed",
      "detail": "The bearer token is missing or invalid.",
      "instance": "urn:uuid:b495f901-5456-4df6-a4da-cc750638c66b",
      "requestId": "b495f901-5456-4df6-a4da-cc750638c66b",
      "status": "401",
      "title": "Authentication failed",
      "type": "https://docs.portfolio.exchange/external-api/v1/problems/authentication-failed",
      "violations": "Unknown Type: array,null"
    }