---
title: "Look up coverage of a service"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.getarbol.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Look up coverage of a service

Path: AXA API › Coverage

`POST /v1/axxa/coverage/lookup`

Read whether a person's plan and this provider cover one exact service code in one service category, whether it requires an authorization and, when both cover it, the voucher quote. AXA lists each service under one category, so service_not_found there does not mean it is not covered. Generates no authorization.

- **Scope:** `axxa:eligibility:read`
- **Credentials:** an API key, a client-credentials token or a person's access token
- **Effect:** read-only; safe to retry
- **Limits:** request body up to 32 KB, response up to 256 KB
- **CLI:** `arbol axxa coverage lookup` · **MCP tool:** `axxa_coverage_lookup`

## Authentication

Requires one of the following:

- `arbolHuman`, oauth2, scopes: `axxa:eligibility:read`
- `arbolMachine`, oauth2, scopes: `axxa:eligibility:read`
- `arbolApiKey`, http, header `Authorization`

## Request body

_Required._

- `documentNumber` (`axxa.coverage.lookup.documentNumber`; string, required)
  - pattern `^[A-Za-z0-9]{3,30}$`
- `documentType` (`axxa.coverage.lookup.documentType`; string, required)
  - one of `"CC"`, `"CE"`, `"TI"`, `"RC"`, `"PA"`
- `serviceType` (`axxa.coverage.lookup.serviceType`; string, required)
  - one of `"outpatient"`, `"emergency"`, `"laboratory"`, `"therapy"`, `"radiology"`, `"other"`
- `cupsCode` (`axxa.coverage.lookup.cupsCode`; string, required) — The exact service code. Only this code is answered, never one that merely starts with it.
  - pattern `^[0-9A-Za-z-]{3,20}$`
- `contractNumber` (`axxa.coverage.lookup.contractNumber`; string, optional) — The plan to read, from an eligibility lookup. Required only when the person has several.
  - minLength 1; maxLength 100
- `connectionId` (`axxa.coverage.lookup.connectionId`; string, optional)
  - pattern `^con_[0-9A-Za-z]{26}$`

## Example request

```json
{
  "documentNumber": "string",
  "documentType": "CC",
  "serviceType": "outpatient",
  "contractNumber": "string",
  "cupsCode": "string",
  "connectionId": "string"
}
```

## Code samples

### cURL

```bash
curl https://api.getarbol.com/v1/axxa/coverage/lookup \
  --request POST \
  --header "Authorization: Bearer $ARBOL_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "documentNumber": "<documentNumber>",
  "documentType": "CC",
  "serviceType": "outpatient",
  "cupsCode": "<cupsCode>"
}'
```

### TypeScript

```typescript
import { createClient } from "@arbol-ai/sdk";

const arbol = createClient({
  baseUrl: "https://api.getarbol.com",
  token: process.env.ARBOL_API_KEY!,
});

const { data } = await arbol.axxa.coverage.lookup({
  documentNumber: "<documentNumber>",
  documentType: "CC",
  serviceType: "outpatient",
  cupsCode: "<cupsCode>",
});
```

### Rust

```rust
use arbol_sdk::{types, Client, Credential};

let arbol = Client::new(Credential::ApiKey(std::env::var("ARBOL_API_KEY")?))?;

let data = arbol
    .axxa()
    .coverage()
    .lookup(&types::AxxaCoverageLookupInput {
        document_number: "<documentNumber>".into(),
        document_type: types::AxxaCoverageLookupInputDocumentType::CC,
        service_type: types::AxxaCoverageLookupInputServiceType::Outpatient,
        cups_code: "<cupsCode>".into(),
        contract_number: None,
        connection_id: None,
    })
    .await?;
```

### CLI

```bash
arbol axxa coverage lookup --document-number '<documentNumber>' --document-type CC --service-type outpatient --cups-code '<cupsCode>'
```

### MCP

```json
{
  "name": "axxa_coverage_lookup",
  "arguments": {
    "documentNumber": "<documentNumber>",
    "documentType": "CC",
    "serviceType": "outpatient",
    "cupsCode": "<cupsCode>"
  }
}
```

## Responses

### 200

Successful operation.

#### Example

```json
{
  "success": true,
  "data": {
    "status": "found",
    "plans": [
      {
        "name": "string",
        "contractNumber": "string",
        "notice": "string"
      }
    ],
    "selectedPlan": {
      "name": "string",
      "contractNumber": "string",
      "notice": "string"
    },
    "service": {
      "cupsCode": "string",
      "description": "string",
      "affiliateCovered": true,
      "providerCovered": true,
      "authorizationRequired": true
    },
    "voucher": {
      "status": "quoted",
      "amount": 0
    },
    "validationMessages": [
      "string"
    ]
  },
  "error": null,
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.200.success`; boolean, required)
  - one of `true`
- `data` (`axxa.coverage.lookup.response.200.data`; object, required) — AXA's answer for one exact service, in one service category. Affiliation, coverage, authorization and the voucher are separate facts, and none confirms an appointment.
  - `status` (`axxa.coverage.lookup.response.200.data.status`; string, required) — found: the service exists in this category. service_not_found: this category does not list that code; another category may. plan_required: name one of the plans. plan_restricted: AXA offers no service search on this plan, see its notice. validation_required: see the messages.
    - one of `"found"`, `"service_not_found"`, `"plan_required"`, `"plan_restricted"`, `"validation_required"`
  - `plans` (`axxa.coverage.lookup.response.200.data.plans`; array<object>, required)
    - `name` (`axxa.coverage.lookup.response.200.data.plans.name`; string, required)
      - minLength 1; maxLength 300
    - `contractNumber` (`axxa.coverage.lookup.response.200.data.plans.contractNumber`; string, required)
      - minLength 1; maxLength 100
    - `notice` (`axxa.coverage.lookup.response.200.data.plans.notice`; string | null, required)
      - maxLength 2000
  - `selectedPlan` (`axxa.coverage.lookup.response.200.data.selectedPlan`; object | null, required)
    - `name` (`axxa.coverage.lookup.response.200.data.selectedPlan.name`; string, required)
      - minLength 1; maxLength 300
    - `contractNumber` (`axxa.coverage.lookup.response.200.data.selectedPlan.contractNumber`; string, required)
      - minLength 1; maxLength 100
    - `notice` (`axxa.coverage.lookup.response.200.data.selectedPlan.notice`; string | null, required)
      - maxLength 2000
  - `service` (`axxa.coverage.lookup.response.200.data.service`; object | null, required)
    - `cupsCode` (`axxa.coverage.lookup.response.200.data.service.cupsCode`; string, required)
    - `description` (`axxa.coverage.lookup.response.200.data.service.description`; string, required)
    - `affiliateCovered` (`axxa.coverage.lookup.response.200.data.service.affiliateCovered`; boolean, required) — Whether the person's plan covers it.
    - `providerCovered` (`axxa.coverage.lookup.response.200.data.service.providerCovered`; boolean, required) — Whether this provider has an agreement for it.
    - `authorizationRequired` (`axxa.coverage.lookup.response.200.data.service.authorizationRequired`; boolean | null, required) — Null when AXA answers that it does not apply.
  - `voucher` (`axxa.coverage.lookup.response.200.data.voucher`; object | null, required) — Read only when both coverages hold.
    - `status` (`axxa.coverage.lookup.response.200.data.voucher.status`; string, required) — quoted: AXA stated an amount. not_enabled: AXA reports no voucher for this service. unavailable: AXA did not answer, which says nothing about the amount.
      - one of `"quoted"`, `"not_enabled"`, `"unavailable"`
    - `amount` (`axxa.coverage.lookup.response.200.data.voucher.amount`; number | null, required) — COP. AXA's quote at this moment for this service: not a balance and not proof of payment.
      - min 0
  - `validationMessages` (`axxa.coverage.lookup.response.200.data.validationMessages`; array<string>, required)
    - minLength 1; maxLength 2000
- `error` (`axxa.coverage.lookup.response.200.error`; unknown, required)
- `metadata` (`axxa.coverage.lookup.response.200.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.200.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 400

`INVALID_INPUT`: The request does not match the published schema.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INVALID_INPUT",
    "message": "string",
    "retryable": false,
    "data": {
      "issues": [
        {
          "path": "string",
          "message": "string"
        }
      ]
    }
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.400.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.400.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.400.error`; object, required) — The request does not match the published schema.
  - `code` (`axxa.coverage.lookup.response.400.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INVALID_INPUT"`
  - `message` (`axxa.coverage.lookup.response.400.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.coverage.lookup.response.400.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`axxa.coverage.lookup.response.400.error.data`; object, required)
    - `issues` (`axxa.coverage.lookup.response.400.error.data.issues`; array<object>, optional)
      - `path` (`axxa.coverage.lookup.response.400.error.data.issues.path`; string, required) — RFC 6901 JSON Pointer to the refused field; empty for the whole input.
        - maxLength 256
      - `message` (`axxa.coverage.lookup.response.400.error.data.issues.message`; string, required)
        - maxLength 256
- `metadata` (`axxa.coverage.lookup.response.400.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.400.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 401

`UNAUTHORIZED`: A valid access token is required.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.401.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.401.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.401.error`; object, required) — A valid access token is required.
  - `code` (`axxa.coverage.lookup.response.401.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNAUTHORIZED"`
  - `message` (`axxa.coverage.lookup.response.401.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.coverage.lookup.response.401.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`axxa.coverage.lookup.response.401.error.data`; object, required) — No fields.
- `metadata` (`axxa.coverage.lookup.response.401.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.401.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 403

- `FORBIDDEN`: The token does not authorize this operation.
- `LOGIN_REJECTED`: The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.
- `ACCOUNT_MISMATCH`: The portal session does not match the configured account and branch.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "FORBIDDEN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.403.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.403.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.403.error`; AxxaLookupCoverageForbiddenFailure, required)
  - one of: `ForbiddenFailure`, `AxxaLoginRejectedFailure`, `AxxaAccountMismatchFailure`
  - discriminator: `code`
- `metadata` (`axxa.coverage.lookup.response.403.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.403.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 404

`CONNECTION_NOT_FOUND`: The organization has no such connection.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "CONNECTION_NOT_FOUND",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.404.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.404.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.404.error`; object, required) — The organization has no such connection.
  - `code` (`axxa.coverage.lookup.response.404.error.code`; string, required) — The failure code, stable across releases.
    - one of `"CONNECTION_NOT_FOUND"`
  - `message` (`axxa.coverage.lookup.response.404.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.coverage.lookup.response.404.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`axxa.coverage.lookup.response.404.error.data`; object, required) — No fields.
- `metadata` (`axxa.coverage.lookup.response.404.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.404.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 409

- `NOT_CONFIGURED`: This organization has no AXA account configured. Contact your administrator.
- `SESSION_REQUIRED`: The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.
- `SESSION_BUSY`: The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "NOT_CONFIGURED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.409.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.409.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.409.error`; AxxaLookupCoverageConflictFailure, required)
  - one of: `AxxaNotConfiguredFailure`, `AxxaSessionRequiredFailure`, `AxxaSessionBusyFailure`
  - discriminator: `code`
- `metadata` (`axxa.coverage.lookup.response.409.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.409.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 413

`REQUEST_TOO_LARGE`: The request exceeds the allowed size.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "REQUEST_TOO_LARGE",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.413.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.413.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.413.error`; object, required) — The request exceeds the allowed size.
  - `code` (`axxa.coverage.lookup.response.413.error.code`; string, required) — The failure code, stable across releases.
    - one of `"REQUEST_TOO_LARGE"`
  - `message` (`axxa.coverage.lookup.response.413.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.coverage.lookup.response.413.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`axxa.coverage.lookup.response.413.error.data`; object, required) — No fields.
- `metadata` (`axxa.coverage.lookup.response.413.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.413.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 415

`UNSUPPORTED_MEDIA_TYPE`: The request content type is not supported.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.415.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.415.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.415.error`; object, required) — The request content type is not supported.
  - `code` (`axxa.coverage.lookup.response.415.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNSUPPORTED_MEDIA_TYPE"`
  - `message` (`axxa.coverage.lookup.response.415.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.coverage.lookup.response.415.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`axxa.coverage.lookup.response.415.error.data`; object, required) — No fields.
- `metadata` (`axxa.coverage.lookup.response.415.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.415.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 428

`CAPTCHA_REQUIRED`: The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "CAPTCHA_REQUIRED",
    "message": "string",
    "retryable": false
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.428.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.428.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.428.error`; object, required) — The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.
  - `code` (`axxa.coverage.lookup.response.428.error.code`; string, required) — The failure code, stable across releases.
    - one of `"CAPTCHA_REQUIRED"`
  - `message` (`axxa.coverage.lookup.response.428.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.coverage.lookup.response.428.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
- `metadata` (`axxa.coverage.lookup.response.428.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.428.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 429

- `RATE_LIMITED`: The request rate limit was exceeded. Try again later.
- `LOGIN_COOLDOWN`: The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RATE_LIMITED",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.429.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.429.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.429.error`; AxxaLookupCoverageTooManyRequestsFailure, required)
  - one of: `RateLimitedFailure`, `AxxaLoginCooldownFailure`
  - discriminator: `code`
- `metadata` (`axxa.coverage.lookup.response.429.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.429.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 500

`INTERNAL_ERROR`: The service could not complete the operation.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.500.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.500.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.500.error`; object, required) — The service could not complete the operation.
  - `code` (`axxa.coverage.lookup.response.500.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INTERNAL_ERROR"`
  - `message` (`axxa.coverage.lookup.response.500.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.coverage.lookup.response.500.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`axxa.coverage.lookup.response.500.error.data`; object, required) — No fields.
- `metadata` (`axxa.coverage.lookup.response.500.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.500.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 502

- `OUTCOME_UNKNOWN`: The operation may have been applied; check its result before repeating it.
- `PORTAL_CHANGED`: The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "OUTCOME_UNKNOWN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.502.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.502.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.502.error`; AxxaLookupCoverageBadGatewayFailure, required)
  - one of: `OutcomeUnknownFailure`, `AxxaPortalChangedFailure`
  - discriminator: `code`
- `metadata` (`axxa.coverage.lookup.response.502.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.502.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 503

- `UPSTREAM_UNAVAILABLE`: The upstream service could not complete the request.
- `CAPTCHA_UNAVAILABLE`: The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.
- `CAPTCHA_PAUSED`: The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.
- `PORTAL_UNAVAILABLE`: The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_UNAVAILABLE",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.503.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.503.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.503.error`; AxxaLookupCoverageServiceUnavailableFailure, required)
  - one of: `UpstreamUnavailableFailure`, `AxxaCaptchaUnavailableFailure`, `AxxaCaptchaPausedFailure`, `AxxaPortalUnavailableFailure`
  - discriminator: `code`
- `metadata` (`axxa.coverage.lookup.response.503.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.503.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 504

`UPSTREAM_TIMEOUT`: The upstream service did not respond before its deadline.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_TIMEOUT",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.coverage.lookup.response.504.success`; boolean, required)
  - one of `false`
- `data` (`axxa.coverage.lookup.response.504.data`; unknown, required)
- `error` (`axxa.coverage.lookup.response.504.error`; object, required) — The upstream service did not respond before its deadline.
  - `code` (`axxa.coverage.lookup.response.504.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPSTREAM_TIMEOUT"`
  - `message` (`axxa.coverage.lookup.response.504.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.coverage.lookup.response.504.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`axxa.coverage.lookup.response.504.error.data`; object, required) — No fields.
- `metadata` (`axxa.coverage.lookup.response.504.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.coverage.lookup.response.504.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.


Source: https://docs.getarbol.com/api/axxa/coverage/lookup/index.md
