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

# ADRES Health Affiliation Status

> Look up a person's affiliation to the Colombian health system (BDUA): the entities (EPS) they are or were affiliated to, the régimen (contributivo/subsidiado), affiliation dates, and affiliate type. `document_type` defaults to `CC`. Returns `found: false` when the document is not registered in BDUA.

Supports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.



## OpenAPI

````yaml /api-reference/openapi.json post /co/adres/affiliation-status/v1
openapi: 3.1.0
info:
  title: Croma Marketplace API
  version: 1.0.0
  description: >-
    Government-data APIs for Colombia, Peru, Mexico, and global web search.
    Croma normalizes public-sector data into structured JSON for product teams
    and AI agents.
servers:
  - url: https://api.croma.run
security: []
paths:
  /co/adres/affiliation-status/v1:
    post:
      tags:
        - Colombia
        - ADRES
      summary: ADRES Health Affiliation Status
      description: >-
        Look up a person's affiliation to the Colombian health system (BDUA):
        the entities (EPS) they are or were affiliated to, the régimen
        (contributivo/subsidiado), affiliation dates, and affiliate type.
        `document_type` defaults to `CC`. Returns `found: false` when the
        document is not registered in BDUA.


        Supports async delivery: set `Prefer: wait=N` for an inline result, pass
        `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.
      operationId: adres_affiliation_status
      parameters:
        - name: Prefer
          in: header
          required: false
          description: >-
            Set `wait=N` to hold the connection up to N seconds for an inline
            result. If the job finishes in time you get the normal 200 body;
            otherwise a 202 with a `status_url` to poll.
          schema:
            type: string
            example: wait=30
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - document_number
              properties:
                document_type:
                  type: string
                  enum:
                    - CC
                    - TI
                    - CE
                    - RC
                    - PA
                    - PEP
                    - PPT
                  default: CC
                  description: Colombian document type. Defaults to `CC`.
                document_number:
                  type: string
                  minLength: 3
                  maxLength: 30
                  description: Document number (alphanumeric with hyphens allowed).
                callback_url:
                  type: string
                  format: uri
                  description: POST the job result here when it finishes.
              additionalProperties: false
            example:
              document_type: CC
              document_number: '1234567890'
      responses:
        '200':
          description: Successful response
          headers:
            X-Request-Id:
              description: >-
                Unique id for the request (req_…). Include it in support
                reports.
              schema:
                type: string
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left before you are throttled.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: ISO 8601 timestamp when the window resets.
              schema:
                type: string
                format: date-time
            X-Cache:
              description: HIT or MISS. Cached hits still count against your quota.
              schema:
                type: string
                enum:
                  - HIT
                  - MISS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdresAffiliationResponse'
        '202':
          description: >-
            Accepted — the result is being computed asynchronously. Poll
            `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have
            the result POSTed to you. Returned when `Prefer: wait` elapses
            before completion, or immediately when `callback_url` is set.
          headers:
            X-Request-Id:
              description: >-
                Unique id for the request (req_…). Include it in support
                reports.
              schema:
                type: string
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            Location:
              description: Absolute URL to poll for job status.
              schema:
                type: string
                format: uri
                example: https://api.croma.run/jobs/run_123
            X-Job-Id:
              description: Id of the created job.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobEnvelope'
        '400':
          description: Invalid request body
          headers:
            X-Request-Id:
              description: >-
                Unique id for the request (req_…). Include it in support
                reports.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid API key
          headers:
            X-Request-Id:
              description: >-
                Unique id for the request (req_…). Include it in support
                reports.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: Rate limit exceeded
          headers:
            X-Request-Id:
              description: >-
                Unique id for the request (req_…). Include it in support
                reports.
              schema:
                type: string
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left before you are throttled.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: ISO 8601 timestamp when the window resets.
              schema:
                type: string
                format: date-time
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal error
          headers:
            X-Request-Id:
              description: >-
                Unique id for the request (req_…). Include it in support
                reports.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '502':
          description: Upstream source returned an error
          headers:
            X-Request-Id:
              description: >-
                Unique id for the request (req_…). Include it in support
                reports.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - bearerAuth: []
      externalDocs:
        description: Interactive documentation and examples
        url: https://docs.usecroma.com/guides/colombia/adres
components:
  schemas:
    AdresAffiliationResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - found
            - document_type
            - document_type_label
            - document_number
            - full_name
            - department
            - municipality
            - affiliations
          properties:
            found:
              type: boolean
              description: >-
                Whether the document is registered in BDUA. When false, identity
                fields are null and `affiliations` is empty.
            document_type:
              type: string
              enum:
                - CC
                - TI
                - CE
                - RC
                - PA
                - PEP
                - PPT
            document_type_label:
              type: string
            document_number:
              type: string
            full_name:
              type:
                - string
                - 'null'
              description: Registered names and surnames, or null when not found.
            department:
              type:
                - string
                - 'null'
            municipality:
              type:
                - string
                - 'null'
            affiliations:
              type: array
              description: >-
                Reported affiliations, most commonly one; multiple when the
                person has affiliation history across entities.
              items:
                $ref: '#/components/schemas/AdresAffiliation'
    JobEnvelope:
      type: object
      required:
        - job
        - data
        - error
      description: >-
        Returned by async-capable endpoints (202) and by GET /jobs/{id}. `data`
        holds the endpoint's normal result once `status` is `completed`; `error`
        is populated once `status` is `failed`.
      properties:
        job:
          type: object
          required:
            - id
            - status
            - endpoint
            - created_at
            - finished_at
            - status_url
          properties:
            id:
              type: string
            status:
              type: string
              enum:
                - queued
                - running
                - completed
                - failed
                - canceled
                - expired
            endpoint:
              type: string
              description: The endpoint path that created this job.
            created_at:
              type:
                - string
                - 'null'
              format: date-time
            finished_at:
              type:
                - string
                - 'null'
              format: date-time
            status_url:
              type: string
              format: uri
              description: GET this URL to poll the job.
        data:
          description: The endpoint's normal result object once completed; null until then.
          oneOf:
            - type: object
            - type: 'null'
        error:
          description: Populated once the job has failed; null otherwise.
          oneOf:
            - type: object
              required:
                - type
                - code
                - message
              properties:
                type:
                  type: string
                code:
                  type: string
                message:
                  type: string
            - type: 'null'
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              description: >-
                Broad category: invalid_request_error, authentication_error,
                not_found_error, rate_limit_error, upstream_error, api_error.
            code:
              type: string
              description: Machine-readable specific code.
            message:
              type: string
              description: Human-readable explanation, safe to surface in UI.
            param:
              type: string
              description: Field that triggered the error. Present on validation errors.
            details:
              type: object
              description: Free-form structured detail.
    AdresAffiliation:
      type: object
      description: One reported affiliation from BDUA.
      required:
        - status
        - entity
        - regime
        - effective_date
        - termination_date
        - affiliate_type
      properties:
        status:
          type:
            - string
            - 'null'
          description: Affiliation state, e.g. `ACTIVO` or `RETIRADO`.
        entity:
          type:
            - string
            - 'null'
          description: >-
            The entity (EPS / caja de compensación) that reported the
            affiliation.
        regime:
          type:
            - string
            - 'null'
          description: '`CONTRIBUTIVO` or `SUBSIDIADO`.'
        effective_date:
          type:
            - string
            - 'null'
          description: Effective affiliation start date (DD/MM/YYYY).
        termination_date:
          type:
            - string
            - 'null'
          description: >-
            Affiliation end date (DD/MM/YYYY). `31/12/2999` means still active
            with the entity.
        affiliate_type:
          type:
            - string
            - 'null'
          description: Affiliate type, e.g. `COTIZANTE` or `BENEFICIARIO`.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Use Authorization: Bearer YOUR_API_KEY'

````