Clara API

openapi: 3.1.0
info:
  title: Clara API
  version: '2026-10-24'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-24: 28 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Clara has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 27
    pages-with-code: 3
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-24'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developers.clara.team/v1/webhooks
  - https://developers.clara.team/v1/webhooks\
  - https://developers.clara.team/sandbox
  - https://developers.clara.team/llms.txt
  - https://developers.clara.team/introduction
  - https://developers.clara.team/openapi.json
  - https://developers.clara.team
servers:
- url: https://public-api.mx.clara.com
paths:
  /api-test/v3/transactions:
    get:
      operationId: get_api_test_v3_transactions
      tags:
      - Api Test
      summary: GET /api-test/v3/transactions
      x-source: https://developers.clara.team/sandbox
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
      - name: size
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiTestV3TransactionsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --request GET  \"https://public-api.mx.clara.com/api-test/v3/transactions?page=0&size=10\"  --header \"Authorization: Bearer\
          \ <TOKEN>\"  --cert client.crt  --key client.key \n ​ Getting Sandbox Credentials \n Sandbox credentials are separate from production\
          \ credentials. Contact your Clara integration team to request access: \n Country Contact Mexico integration.support.mx@clara.team Brazil\
          \ integratio"
  /api-test/v3/webhooks/events:
    post:
      operationId: post_api_test_v3_webhooks_events
      tags:
      - Api Test
      summary: 'Submit an event with POST /api-test/v3/webhooks/events (scope write:subscribers , Content-Type: application/json ).'
      description: 'The event body is the production payload: status, type, modelVersion and data. The body must be UTF‑8. Clara delivers synchronously
        and answers with the result.'
      x-source: https://developers.clara.team/sandbox
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiTestV3WebhooksEventsRequest'
      responses:
        '202':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiTestV3WebhooksEventsResponse'
      x-evidence:
        kind: documentation
  /api-test/v3/webhooks/subscriptions:
    post:
      operationId: post_api_test_v3_webhooks_subscriptions
      tags:
      - Api Test
      summary: Create a sandbox subscription with POST /api-test/v3/webhooks/subscriptions (same body as production ; environment is SANDBOX ).
      description: Create a sandbox webhook subscription. The request body is identical to the production subscription payload.
      x-source: https://developers.clara.team/sandbox
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiTestV3WebhooksSubscriptionsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiTestV3WebhooksSubscriptionsResponse'
      x-evidence:
        kind: documentation
  /api/v1/subscribers:
    post:
      operationId: post_api_v1_subscribers
      tags:
      - Api
      summary: POST /api/v1/subscribers with an events array
      x-source: https://developers.clara.team/v1/webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1SubscribersRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/vcn:
    get:
      operationId: get_api_v1_vcn
      tags:
      - Api
      summary: Retrieve VCN templates and related identifiers.
      description: Returns a list of VCN resources (rcnId, supplierId, templateId) for the company.
      x-source: https://developers.clara.team/llms.txt
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/vcn/card:
    post:
      operationId: post_api_v1_vcn_card
      tags:
      - Api
      summary: Create a new Virtual Card Number (VCN).
      description: Creates a VCN locked to a supplier and amount; returns card details once.
      x-source: https://developers.clara.team/llms.txt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1VcnCardRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1VcnCardResponse'
      x-evidence:
        kind: documentation
  /api/v1/vcn/card/{id}:
    put:
      operationId: put_api_v1_vcn_card_id
      tags:
      - Api
      summary: Update an existing VCN.
      description: Updates fields of a VCN (specific fields not detailed on this page).
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/vcn/card/{id}/cancel:
    post:
      operationId: post_api_v1_vcn_card_id_cancel
      tags:
      - Api
      summary: Cancel a VCN.
      description: Cancels the specified VCN.
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/cards/{uuid}/configurations:
    post:
      operationId: post_api_v2_cards_uuid_configurations
      tags:
      - Api
      summary: Create or update card configuration settings.
      description: Sets configuration such as allowed time periods, ATM cash limits, weekday usage, and merchant categories for a card.
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV2CardsUuidConfigurationsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/payments:
    post:
      operationId: post_api_v2_payments
      tags:
      - Api
      summary: Create a boleto payment (Brazil only).
      description: Creates a boleto bill payment; returns payment details.
      x-source: https://developers.clara.team/llms.txt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV2PaymentsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v3/accounts-payable:
    get:
      operationId: get_api_v3_accounts_payable
      tags:
      - Api
      summary: List Pix payments with optional filters and sorting.
      description: Retrieves a list of Pix payments; supports filter and sort query parameters (not detailed in this page).
      x-source: https://developers.clara.team/llms.txt
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v3/accounts-payable/pix:
    post:
      operationId: post_api_v3_accounts_payable_pix
      tags:
      - Api
      summary: Accounts Payable API v3 — Pix payments (Brazil only) POST /api/v3/accounts-payable/pix creates a Pix payment asynchronously
      x-source: https://developers.clara.team/llms.txt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV3AccountsPayablePixRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV3AccountsPayablePixResponse'
      x-evidence:
        kind: documentation
  /api/v3/accounts-payable/pix/{externalid}:
    delete:
      operationId: delete_api_v3_accounts_payable_pix_externalid
      tags:
      - Api
      summary: Cancel a scheduled Pix payment.
      description: Deletes a scheduled Pix payment identified by the caller‑generated externalId.
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: externalid
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v3/accounts-payable/{externalid}:
    get:
      operationId: get_api_v3_accounts_payable_externalid
      tags:
      - Api
      summary: GET /api/v3/accounts-payable/{externalId} — poll until PAID, FAILED, or CANCELLED
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: externalid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV3AccountsPayableExternalidResponse'
      x-evidence:
        kind: documentation
  /api/v3/billing-statements:
    get:
      operationId: get_api_v3_billing_statements
      tags:
      - Api
      summary: Billing Statements API v3 — GET /api/v3/billing-statements
      x-source: https://developers.clara.team/llms.txt
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV3BillingStatementsResponse'
      x-evidence:
        kind: documentation
  /api/v3/billing-statements/{uuid}/transactions:
    get:
      operationId: get_api_v3_billing_statements_uuid_transactions
      tags:
      - Api
      summary: 'Get statement transactions: GET /api/v3/billing-statements/{uuid}/transactions'
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV3BillingStatementsUuidTransactionsResponse'
      x-evidence:
        kind: documentation
  /api/v3/cards:
    get:
      operationId: get_api_v3_cards
      tags:
      - Api
      summary: Cards API v3 — GET /api/v3/cards
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: userUuid
        in: query
        required: false
        schema:
          type: string
      - name: username
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: periodicity
        in: query
        required: false
        schema:
          type: string
      - name: type
        in: query
        required: false
        schema:
          type: string
      - name: userErpId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV3CardsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v3_cards
      tags:
      - Api
      summary: Cards API v3 — POST /api/v3/cards
      x-source: https://developers.clara.team/llms.txt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV3CardsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV3CardsResponse'
      x-evidence:
        kind: documentation
  /api/v3/cards/{uuid}/lock:
    patch:
      operationId: patch_api_v3_cards_uuid_lock
      tags:
      - Api
      summary: 'Lock/unlock: PATCH /api/v3/cards/{uuid}/lock with body { "lockCode": 16 }'
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiV3CardsUuidLockRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v3/digital-accounts:
    get:
      operationId: get_api_v3_digital_accounts
      tags:
      - Api
      summary: Digital Account API v3 — GET /api/v3/digital-accounts (Brazil only)
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: startDate
        in: query
        required: false
        schema:
          type: string
        description: YYYY-MM-DD
      - name: endDate
        in: query
        required: false
        schema:
          type: string
        description: YYYY-MM-DD
      - name: transactionTypeName
        in: query
        required: false
        schema:
          type: string
        description: 'enum: PIX|TED|BILL|TRANSACTION'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV3DigitalAccountsResponse'
      x-evidence:
        kind: documentation
  /api/v3/digital-accounts/balance:
    get:
      operationId: get_api_v3_digital_accounts_balance
      tags:
      - Api
      summary: 'Balance: GET /api/v3/digital-accounts/balance — no parameters; returns checkingAccount.available and collateralAccount.available'
      x-source: https://developers.clara.team/llms.txt
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV3DigitalAccountsBalanceResponse'
      x-evidence:
        kind: documentation
  /api/v3/transactions:
    get:
      operationId: get_api_v3_transactions
      tags:
      - Api
      summary: GET https://public-api.mx.clara.com/api/v3/transactions
      description: Retrieve transactions with optional pagination filters.
      x-source: https://developers.clara.team/sandbox
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
        description: Zero‑based page index.
      - name: size
        in: query
        required: false
        schema:
          type: integer
        description: Number of items per page.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV3TransactionsResponse'
      x-evidence:
        kind: documentation
  /api/v3/transactions/{uuid}/documents:
    get:
      operationId: get_api_v3_transactions_uuid_documents
      tags:
      - Api
      summary: Get pre‑signed download links for transaction documents.
      description: Returns pre‑signed S3 download links for documents attached to the transaction.
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV3TransactionsUuidDocumentsResponse'
      x-evidence:
        kind: documentation
  /api/v3/transactions/{uuid}/extracted-documents:
    get:
      operationId: get_api_v3_transactions_uuid_extracted_documents
      tags:
      - Api
      summary: Retrieve structured fiscal data extracted from transaction documents.
      description: Provides structured fiscal data extracted from the transaction’s attached documents.
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
      - name: type
        in: query
        required: false
        schema:
          type: string
        description: Filter by document type (MEXICAN_FISCAL_INVOICE|INVOICE|RECEIPT|OTHER).
      - name: validationStatus
        in: query
        required: false
        schema:
          type: string
        description: Filter by validation status (VALIDATED_BY_CLARA|VALIDATED_BY_USER|NOT_VERIFIED).
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV3TransactionsUuidExtractedDocumentsResponse'
      x-evidence:
        kind: documentation
  /api/v3/users:
    get:
      operationId: get_api_v3_users
      tags:
      - Api
      summary: Users API v3 — GET /api/v3/users
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: email
        in: query
        required: false
        schema:
          type: string
      - name: name
        in: query
        required: false
        schema:
          type: string
      - name: lastName
        in: query
        required: false
        schema:
          type: string
      - name: fullName
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: ACTIVE|LOCKED
      - name: role
        in: query
        required: false
        schema:
          type: string
        description: EMPLOYEE|MANAGER|COMPANY_OWNER|BOOKKEEPER
      - name: uuid
        in: query
        required: false
        schema:
          type: string
      - name: taxIdentifier
        in: query
        required: false
        schema:
          type: string
      - name: erpId
        in: query
        required: false
        schema:
          type: string
      - name: locationUuid
        in: query
        required: false
        schema:
          type: string
      - name: managerUuid
        in: query
        required: false
        schema:
          type: string
      - name: mobilePhone
        in: query
        required: false
        schema:
          type: string
      - name: createdAtStart
        in: query
        required: false
        schema:
          type: string
      - name: createdAtEnd
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV3UsersResponse'
      x-evidence:
        kind: documentation
  /api/v3/webhooks/subscriptions:
    post:
      operationId: post_api_v3_webhooks_subscriptions
      tags:
      - Api
      summary: POST /api/v3/webhooks/subscriptions with entity + statuses
      x-source: https://developers.clara.team/v1/webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV3WebhooksSubscriptionsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v3/webhooks/{entity}/resend:
    post:
      operationId: post_api_v3_webhooks_entity_resend
      tags:
      - Api
      summary: Resend stored webhook events for a given entity.
      description: Triggers a resend of previously stored webhook events for the specified entity.
      x-source: https://developers.clara.team/llms.txt
      parameters:
      - name: entity
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /oauth/token:
    post:
      operationId: post_oauth_token
      tags:
      - Oauth
      summary: 'Token endpoint: POST /oauth/token with Authorization: Basic base64(CLIENT_ID:CLIENT_SECRET)'
      x-source: https://developers.clara.team/llms.txt
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostOauthTokenResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiTestV3TransactionsResponse:
      type: object
      properties:
        eventId:
          type: string
        event:
          type: string
        environment:
          type: string
        outcome:
          type: string
        deliveries:
          type: array
          items:
            type: object
            properties:
              subscriptionUuid:
                type: string
              status:
                type: string
              httpStatus:
                type: integer
    PostApiTestV3WebhooksEventsRequest:
      type: object
      properties:
        status:
          type: string
          description: One of NOTIFICATION, PRE_AUTHORIZED, AUTHORIZED, SYSTEM_TRANSACTION, REJECTED, DELETED.
        type:
          type: string
          description: Event type, e.g., PURCHASE, REFUND.
        modelVersion:
          type: integer
          description: Model version number.
        data:
          type: object
          description: Payload containing event specific data.
      required:
      - status
      - type
      - modelVersion
      - data
    PostApiTestV3WebhooksEventsResponse:
      type: object
      properties:
        eventId:
          type: string
          description: UUID of the submitted event.
        event:
          type: string
          description: Event name, e.g., CARD_TRANSACTIONS.REJECTED.
        environment:
          type: string
          description: Always SANDBOX for this endpoint.
        outcome:
          type: string
          description: Result of the submission, e.g., ACCEPTED, NO_MATCH, REPLAYED.
        deliveries:
          type: array
          description: List of delivery attempts.
    PostApiTestV3WebhooksSubscriptionsRequest:
      type: object
      properties:
        callbackUrl:
          type: string
          description: URL that will receive webhook events; must not be used by any production subscription.
        secret:
          type: string
          description: Secret used to sign webhook payloads.
        events:
          type: array
          description: List of event types/statuses the subscription wants to receive.
      required:
      - callbackUrl
      - secret
      - events
    PostApiTestV3WebhooksSubscriptionsResponse:
      type: object
      properties:
        subscriptionUuid:
          type: string
          description: Identifier of the created subscription.
        environment:
          type: string
          description: Always SANDBOX for this endpoint.
    PostApiV1SubscribersRequest:
      type: object
      properties:
        events:
          type: array
          description: Array of event names
      required:
      - events
    PostApiV1VcnCardRequest:
      type: object
      properties:
        rcnId:
          type: string
        supplierId:
          type: string
        templateId:
          type: string
        amount:
          type: number
        validFrom:
          type: string
          description: ISO‑8601 date
        validTo:
          type: string
          description: ISO‑8601 date
      required:
      - rcnId
      - supplierId
      - templateId
      - amount
      - validFrom
      - validTo
    PostApiV1VcnCardResponse:
      type: object
      properties:
        cardNumber:
          type: string
        cvv:
          type: string
        expirationDate:
          type: string
    PostApiV2CardsUuidConfigurationsRequest:
      type: object
      properties:
        period:
          type: object
          description: Time window configuration with startDate, endDate, startTime (HH:MM), endTime (HH:MM), enableAutoDeletion (bool).
        atmCashLimit:
          type: number
          description: Cash withdrawal limit (physical cards only).
        weekdays:
          type: object
          description: Weekday usage control with values array and allowedDaysOfUse (bool).
        merchants:
          type: object
          description: Merchant category control with values array of MCC strings and allowedMerchants (bool).
    PostApiV2PaymentsRequest:
      type: object
      properties:
        barcodeDigitableLine:
          type: string
          description: Boleto barcode or digitable line.
      required:
      - barcodeDigitableLine
    PostApiV3AccountsPayablePixRequest:
      type: object
      properties:
        paymentMethod.dictKey:
          type: string
          description: Pix key
        paymentMethod.dictKeyType:
          type: string
        paymentMethod.qrCode:
          type: string
        beneficiary:
          type: object
          description: bank details
        externalId:
          type: string
          description: caller-generated, idempotent
      required:
      - externalId
    PostApiV3AccountsPayablePixResponse:
      type: object
      properties:
        status:
          type: integer
          description: 202 accepted
    GetApiV3AccountsPayableExternalidResponse:
      type: object
      properties:
        status:
          type: string
          description: PAID, FAILED, or CANCELLED
    GetApiV3BillingStatementsResponse:
      type: object
      properties:
        uuid:
          type: string
        statementStartDate:
          type: string
        statementEndDate:
          type: string
        currency:
          type: string
        totalAmount:
          type: number
        status:
          type: string
          description: OPEN|CLOSED
        generatedAt:
          type: string
    GetApiV3BillingStatementsUuidTransactionsResponse:
      type: object
      properties:
        content:
          type: array
          description: same as main transactions endpoint
        totalElements:
          type: integer
        totalPages:
          type: integer
        size:
          type: integer
        number:
          type: integer
    GetApiV3CardsResponse:
      type: object
      properties:
        content:
          type: array
          description: array of CardV3
        totalElements:
          type: integer
        totalPages:
          type: integer
        size:
          type: integer
        number:
          type: integer
    PostApiV3CardsRequest:
      type: object
      properties:
        type:
          type: string
          description: 'enum: VIRTUAL|PHYSICAL'
        alias:
          type: string
        userUuid:
          type: string
        threshold:
          type: number
          description: currency units
        periodicity:
          type: string
          description: 'enum: MONTHLY|WEEKLY|DAILY'
        businessType:
          type: string
          description: 'enum: BUSINESS|WORLD_ELITE'
      required:
      - type
      - alias
      - userUuid
    PostApiV3CardsResponse:
      type: object
      properties:
        uuid:
          type: string
        alias:
          type: string
        status:
          type: object
          description: code, description
        maskedPan:
          type: string
        threshold:
          type: number
        periodicity:
          type: string
        type:
          type: string
        user:
          type: object
    PatchApiV3CardsUuidLockRequest:
      type: object
      properties:
        lockCode:
          type: integer
          description: 16 for API-initiated locks
      required:
      - lockCode
    GetApiV3DigitalAccountsResponse:
      type: object
      properties:
        data:
          type: array
        meta:
          type: object
          description: totalPages, totalItems, itemsPerPage, currentPage
    GetApiV3DigitalAccountsBalanceResponse:
      type: object
      properties:
        checkingAccount.available:
          type: number
        collateralAccount.available:
          type: number
    GetApiV3TransactionsResponse:
      type: object
      properties:
        transactions:
          type: array
          description: List of transaction objects.
        page:
          type: integer
          description: Current page index.
        size:
          type: integer
          description: Page size.
        totalElements:
          type: integer
          description: Total number of transactions.
    GetApiV3TransactionsUuidDocumentsResponse:
      type: object
      properties:
        documents:
          type: array
          description: Array of objects containing pre‑signed S3 URLs (valid 12 hours).
    GetApiV3TransactionsUuidExtractedDocumentsResponse:
      type: object
      properties:
        extractedDocuments:
          type: array
          description: Array of structured fiscal data objects.
    GetApiV3UsersResponse:
      type: object
      properties:
        totalElements:
          type: integer
        content:
          type: array
          description: array of users with uuid, fullName, email, role, status
    PostApiV3WebhooksSubscriptionsRequest:
      type: object
      properties:
        entity:
          type: string
          description: Entity to subscribe to
        statuses:
          type: array
          description: Array of statuses
      required:
      - entity
      - statuses
    PostOauthTokenResponse:
      type: object
      properties:
        expires_in:
          type: integer
          description: seconds until token expiration
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Api Test
- name: Oauth