Download an adverse-action notice PDF

Path parameters

Responses

• 200 Binary PDF application/pdf

  Binary body (application/pdf). Save the response to a file.

• 401 Missing, malformed, expired or revoked bearer token. The WWW-Authenticate header carries the RFC 6750 challenge. application/json

  Schema: ErrorEnvelope

  401 exampleCopy

  {
    "error": {
      "code": "unauthorized",
      "message": "A valid bearer token is required.",
      "details": [],
      "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
      "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/unauthorized"
    }
  }

• 403 Token does not hold the required scope. details lists the scope(s) that were checked. application/json

  Schema: ErrorEnvelope

  403 exampleCopy

  {
    "error": {
      "code": "insufficient_scope",
      "message": "This token does not have the required scope.",
      "details": [
        {
          "field": "scope",
          "message": "executions:write"
        }
      ],
      "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
      "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/insufficient_scope"
    }
  }

• 404 Resource does not exist or belongs to another tenant / api_client application/json

  Schema: ErrorEnvelope

  404 exampleCopy

  {
    "error": {
      "code": "not_found",
      "message": "The requested resource was not found.",
      "details": [],
      "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
      "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/not_found"
    }
  }

• 429 Rate limit exceeded (60 req/min per IP on /api/v1, 600 req/hour per token prefix, or 300 req/5 min per IP globally). The body is the standard error envelope and Retry-After gives the seconds until the window resets. application/json

  Schema: ErrorEnvelope

  429 exampleCopy

  {
    "error": {
      "code": "rate_limited",
      "message": "Rate limit exceeded. Retry later.",
      "details": [],
      "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
      "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/rate_limited"
    }
  }

Related

• Adverse action — How an AdverseAction node fires, the notice stages and flows, the draft-first default, the webhook events it emits, and where the notice PDFs end up.