A valid request URL is required to generate request examples

{
  "register": "united-states",
  "registration": "<string>",
  "status": "listed",
  "charity": {
    "id": "<string>",
    "slug": "<string>"
  }
}

{
  "defined": true,
  "code": "VALIDATION_ERROR",
  "status": 400,
  "message": "Validation failed",
  "data": {
    "error": "<string>",
    "code": "VALIDATION_ERROR",
    "issues": [
      null
    ]
  }
}

{
  "defined": true,
  "code": "REGISTRATION_NOT_FOUND",
  "status": 404,
  "message": "No current entry with this registration number was found in the register",
  "data": {
    "error": "<string>",
    "code": "REGISTRATION_NOT_FOUND"
  }
}

{
  "defined": true,
  "code": "CHARITY_UNAVAILABLE",
  "status": 409,
  "message": "This charity is currently unavailable",
  "data": {
    "error": "<string>",
    "code": "CHARITY_UNAVAILABLE"
  }
}

{
  "defined": true,
  "code": "NOT_ELIGIBLE",
  "status": 422,
  "message": "This register entry cannot be requested",
  "data": {
    "error": "<string>",
    "code": "NOT_ELIGIBLE"
  }
}

{
  "defined": true,
  "code": "RATE_LIMIT_EXCEEDED",
  "status": 429,
  "message": "Rate limit exceeded",
  "data": {
    "error": "<string>",
    "code": "RATE_LIMIT_EXCEEDED"
  }
}

{
  "defined": true,
  "code": "PROVIDER_UNAVAILABLE",
  "status": 503,
  "message": "Provider temporarily unavailable",
  "data": {
    "error": "<string>",
    "code": "PROVIDER_UNAVAILABLE"
  }
}