---
title: "Look up beneficiary eligibility"
description: "Read the plans or affiliation validation messages for a document and service category. Plans do not establish coverage for a specific CUPS, authorization, or voucher amount.\n\n- **Scope:** `axxa:eligibility:read`\n- **Credentials:** an API key, a client-credentials token or a person's access token\n- **Effect:** read-only; safe to retry\n- **Limits:** request body up to 32 KB, response up to 256 KB\n- **CLI:** `arbol axxa eligibility lookup` · **MCP tool:** `axxa_eligibility_lookup`"
---

> 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.

Path: AXA API › Eligibility

`POST /v1/axxa/eligibility/lookup`

Read the plans or affiliation validation messages for a document and service category. Plans do not establish coverage for a specific CUPS, authorization, or voucher amount.

- **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 eligibility lookup` · **MCP tool:** `axxa_eligibility_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.eligibility.lookup.documentNumber`; string, required)
  - pattern `^[A-Za-z0-9]{3,30}$`
- `documentType` (`axxa.eligibility.lookup.documentType`; string, required)
  - one of `"CC"`, `"CE"`, `"TI"`, `"RC"`, `"PA"`
- `serviceType` (`axxa.eligibility.lookup.serviceType`; string, required)
  - one of `"outpatient"`, `"emergency"`, `"laboratory"`, `"therapy"`, `"radiology"`, `"other"`
- `connectionId` (`axxa.eligibility.lookup.connectionId`; string, optional)
  - pattern `^con_[0-9A-Za-z]{26}$`

## Example request

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

## Code samples

### cURL

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

### 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.eligibility.lookup({
  documentNumber: "<documentNumber>",
  documentType: "CC",
  serviceType: "outpatient",
});
```

### Rust

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

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

let data = arbol
    .axxa()
    .eligibility()
    .lookup(&types::AxxaEligibilityLookupInput {
        document_number: "<documentNumber>".into(),
        document_type: types::AxxaEligibilityLookupInputDocumentType::CC,
        service_type: types::AxxaEligibilityLookupInputServiceType::Outpatient,
        connection_id: None,
    })
    .await?;
```

### CLI

```bash
arbol axxa eligibility lookup --document-number '<documentNumber>' --document-type CC --service-type outpatient
```

### MCP

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

## Responses

### 200

Successful operation.

#### Example

```json
{
  "success": true,
  "data": {
    "status": "plans_found",
    "plans": [
      {
        "name": "string",
        "contractNumber": "string",
        "notice": "string"
      }
    ],
    "validationMessages": [
      "string"
    ]
  },
  "error": null,
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`axxa.eligibility.lookup.response.200.success`; boolean, required)
  - one of `true`
- `data` (`axxa.eligibility.lookup.response.200.data`; object, required) — Observed plan/validation result for this service category. This does not establish coverage for a CUPS, active authorization, or a voucher amount.
  - `status` (`axxa.eligibility.lookup.response.200.data.status`; string, required)
    - one of `"plans_found"`, `"validation_required"`
  - `plans` (`axxa.eligibility.lookup.response.200.data.plans`; array<object>, required)
    - `name` (`axxa.eligibility.lookup.response.200.data.plans.name`; string, required)
      - minLength 1; maxLength 300
    - `contractNumber` (`axxa.eligibility.lookup.response.200.data.plans.contractNumber`; string, required)
      - minLength 1; maxLength 100
    - `notice` (`axxa.eligibility.lookup.response.200.data.plans.notice`; string | null, required)
      - maxLength 2000
  - `validationMessages` (`axxa.eligibility.lookup.response.200.data.validationMessages`; array<string>, required)
    - minLength 1; maxLength 2000
- `error` (`axxa.eligibility.lookup.response.200.error`; unknown, required)
- `metadata` (`axxa.eligibility.lookup.response.200.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.400.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.400.data`; unknown, required)
- `error` (`axxa.eligibility.lookup.response.400.error`; object, required) — The request does not match the published schema.
  - `code` (`axxa.eligibility.lookup.response.400.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INVALID_INPUT"`
  - `message` (`axxa.eligibility.lookup.response.400.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.eligibility.lookup.response.400.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`axxa.eligibility.lookup.response.400.error.data`; object, required)
    - `issues` (`axxa.eligibility.lookup.response.400.error.data.issues`; array<object>, optional)
      - `path` (`axxa.eligibility.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.eligibility.lookup.response.400.error.data.issues.message`; string, required)
        - maxLength 256
- `metadata` (`axxa.eligibility.lookup.response.400.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.401.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.401.data`; unknown, required)
- `error` (`axxa.eligibility.lookup.response.401.error`; object, required) — A valid access token is required.
  - `code` (`axxa.eligibility.lookup.response.401.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNAUTHORIZED"`
  - `message` (`axxa.eligibility.lookup.response.401.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.eligibility.lookup.response.401.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`axxa.eligibility.lookup.response.401.error.data`; object, required) — No fields.
- `metadata` (`axxa.eligibility.lookup.response.401.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.403.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.403.data`; unknown, required)
- `error` (`axxa.eligibility.lookup.response.403.error`; one of, required)
  - one of: `ForbiddenFailure`, `AxxaLoginRejectedFailure`, `AxxaAccountMismatchFailure`
  - discriminator: `code`
- `metadata` (`axxa.eligibility.lookup.response.403.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.404.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.404.data`; unknown, required)
- `error` (`axxa.eligibility.lookup.response.404.error`; object, required) — The organization has no such connection.
  - `code` (`axxa.eligibility.lookup.response.404.error.code`; string, required) — The failure code, stable across releases.
    - one of `"CONNECTION_NOT_FOUND"`
  - `message` (`axxa.eligibility.lookup.response.404.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.eligibility.lookup.response.404.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`axxa.eligibility.lookup.response.404.error.data`; object, required) — No fields.
- `metadata` (`axxa.eligibility.lookup.response.404.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.409.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.409.data`; unknown, required)
- `error` (`axxa.eligibility.lookup.response.409.error`; one of, required)
  - one of: `AxxaNotConfiguredFailure`, `AxxaSessionRequiredFailure`, `AxxaSessionBusyFailure`
  - discriminator: `code`
- `metadata` (`axxa.eligibility.lookup.response.409.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.413.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.413.data`; unknown, required)
- `error` (`axxa.eligibility.lookup.response.413.error`; object, required) — The request exceeds the allowed size.
  - `code` (`axxa.eligibility.lookup.response.413.error.code`; string, required) — The failure code, stable across releases.
    - one of `"REQUEST_TOO_LARGE"`
  - `message` (`axxa.eligibility.lookup.response.413.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.eligibility.lookup.response.413.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`axxa.eligibility.lookup.response.413.error.data`; object, required) — No fields.
- `metadata` (`axxa.eligibility.lookup.response.413.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.415.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.415.data`; unknown, required)
- `error` (`axxa.eligibility.lookup.response.415.error`; object, required) — The request content type is not supported.
  - `code` (`axxa.eligibility.lookup.response.415.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNSUPPORTED_MEDIA_TYPE"`
  - `message` (`axxa.eligibility.lookup.response.415.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.eligibility.lookup.response.415.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`axxa.eligibility.lookup.response.415.error.data`; object, required) — No fields.
- `metadata` (`axxa.eligibility.lookup.response.415.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.428.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.428.data`; unknown, required)
- `error` (`axxa.eligibility.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.eligibility.lookup.response.428.error.code`; string, required) — The failure code, stable across releases.
    - one of `"CAPTCHA_REQUIRED"`
  - `message` (`axxa.eligibility.lookup.response.428.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.eligibility.lookup.response.428.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
- `metadata` (`axxa.eligibility.lookup.response.428.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.429.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.429.data`; unknown, required)
- `error` (`axxa.eligibility.lookup.response.429.error`; one of, required)
  - one of: `RateLimitedFailure`, `AxxaLoginCooldownFailure`
  - discriminator: `code`
- `metadata` (`axxa.eligibility.lookup.response.429.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.500.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.500.data`; unknown, required)
- `error` (`axxa.eligibility.lookup.response.500.error`; object, required) — The service could not complete the operation.
  - `code` (`axxa.eligibility.lookup.response.500.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INTERNAL_ERROR"`
  - `message` (`axxa.eligibility.lookup.response.500.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.eligibility.lookup.response.500.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`axxa.eligibility.lookup.response.500.error.data`; object, required) — No fields.
- `metadata` (`axxa.eligibility.lookup.response.500.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.502.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.502.data`; unknown, required)
- `error` (`axxa.eligibility.lookup.response.502.error`; one of, required)
  - one of: `OutcomeUnknownFailure`, `AxxaPortalChangedFailure`
  - discriminator: `code`
- `metadata` (`axxa.eligibility.lookup.response.502.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.503.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.503.data`; unknown, required)
- `error` (`axxa.eligibility.lookup.response.503.error`; one of, required)
  - one of: `UpstreamUnavailableFailure`, `AxxaCaptchaUnavailableFailure`, `AxxaCaptchaPausedFailure`, `AxxaPortalUnavailableFailure`
  - discriminator: `code`
- `metadata` (`axxa.eligibility.lookup.response.503.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.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.eligibility.lookup.response.504.success`; boolean, required)
  - one of `false`
- `data` (`axxa.eligibility.lookup.response.504.data`; unknown, required)
- `error` (`axxa.eligibility.lookup.response.504.error`; object, required) — The upstream service did not respond before its deadline.
  - `code` (`axxa.eligibility.lookup.response.504.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPSTREAM_TIMEOUT"`
  - `message` (`axxa.eligibility.lookup.response.504.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`axxa.eligibility.lookup.response.504.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`axxa.eligibility.lookup.response.504.error.data`; object, required) — No fields.
- `metadata` (`axxa.eligibility.lookup.response.504.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`axxa.eligibility.lookup.response.504.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.


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