Clarafintech Extracted Documents API

openapi: 3.2.0
info:
  title: Clara Extracted Documents API
  summary: Corporate card and spend management API for Mexico, Brazil, and Colombia.
  description: Use the Clara API to manage corporate cards, retrieve transactions, provision users, reconcile billing statements, download transaction documents, and automate spend-management workflows. Every API request requires both mutual TLS and an OAuth 2.0 Bearer token. This docs-published schema is derived from the current Clara developer documentation and should be checked against backend-owned API contracts before being treated as exhaustive.
  version: 3.0.0
  contact:
    name: Clara Integration Support
    email: integration.support.mx@clara.team
    url: https://developers.clara.team
servers:
- url: https://public-api.mx.clara.com
  description: Mexico production
- url: https://public-api.br.clara.com
  description: Brazil production
- url: https://public-api.co.clara.com
  description: Colombia production
- url: https://public-api.mx.clara.com/api-test
  description: Mexico sandbox. Use the same paths without the leading /api segment when testing, for example /v3/transactions.
- url: https://public-api.br.clara.com/api-test
  description: Brazil sandbox. Use the same paths without the leading /api segment when testing, for example /v3/transactions.
- url: https://public-api.co.clara.com/api-test
  description: Colombia sandbox. Use the same paths without the leading /api segment when testing, for example /v3/transactions.
security:
- MutualTLS: []
  BearerAuth: []
tags:
- name: Extracted Documents
  description: Retrieve structured invoice, receipt, and other document data extracted from transactions.
paths:
  /api/v3/transactions/{uuid}/extracted-documents:
    get:
      operationId: listTransactionExtractedDocumentsV3
      summary: List transaction extracted documents
      description: Retrieve structured extracted documents associated with a transaction, with optional filters for document UUID, document type, and validation status.
      tags:
      - Extracted Documents
      parameters:
      - $ref: '#/components/parameters/TransactionUuid'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Size'
      - name: documentUuid
        in: query
        description: Filter by extracted document UUID. Some docs also refer to this filter as uuid.
        schema:
          type: string
          format: uuid
      - name: type
        in: query
        description: Filter by extracted document type.
        schema:
          $ref: '#/components/schemas/ExtractedDocumentType'
      - name: validationStatus
        in: query
        description: Filter by document validation status.
        schema:
          $ref: '#/components/schemas/DocumentValidationStatus'
      responses:
        '200':
          description: Paginated extracted documents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractedDocumentPageV3'
        '400':
          $ref: '#/components/responses/BadRequest'
components:
  schemas:
    ErrorResponse:
      type: object
      required:
      - message
      properties:
        code:
          type: string
          description: Machine-readable Clara or HTTP error code when available.
        message:
          type: string
          description: Human-readable error message.
        timestamp:
          type: string
          format: date-time
        details:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
    ExtractedDocumentPageV3:
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/ExtractedDocumentV3'
        totalElements:
          type: integer
        totalPages:
          type: integer
        size:
          type: integer
        number:
          type: integer
      additionalProperties: true
    ExtractedDocumentType:
      type: string
      enum:
      - MEXICAN_FISCAL_INVOICE
      - INVOICE
      - RECEIPT
      - OTHER
    DocumentValidationStatus:
      type: string
      enum:
      - VALIDATED_BY_CLARA
      - VALIDATED_BY_USER
      - NOT_VERIFIED
    ExtractedDocumentV3:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        type:
          $ref: '#/components/schemas/ExtractedDocumentType'
        userUuid:
          type: string
          format: uuid
        data:
          type: object
          additionalProperties: true
        fileValidation:
          type: object
          properties:
            status:
              $ref: '#/components/schemas/DocumentValidationStatus'
            date:
              type: string
              format: date-time
            user:
              type: string
            userUuid:
              type: string
              format: uuid
          additionalProperties: true
      additionalProperties: true
  parameters:
    Size:
      name: size
      in: query
      description: Number of records per page. Use 100 for large exports unless an endpoint documents a lower limit.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    TransactionUuid:
      name: uuid
      in: path
      required: true
      description: Transaction UUID.
      schema:
        type: string
        format: uuid
    Page:
      name: page
      in: query
      description: Zero-based page index.
      schema:
        type: integer
        minimum: 0
        default: 0
  responses:
    BadRequest:
      description: Bad request. Fix invalid parameters or missing fields before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    MutualTLS:
      type: mutualTLS
      description: All API requests require a valid Clara-issued X.509 client certificate.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 Bearer token from /oauth/token.
    BasicAuth:
      type: http
      scheme: basic
      description: Use CLIENT_ID:CLIENT_SECRET when requesting an access token.
externalDocs:
  description: Clara API documentation
  url: https://developers.clara.team
x-source: Derived from the developers.clara.team documentation in this repository. Replace with the backend-owned OpenAPI contract if one is available.