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

# Navegar pelo catálogo de formatos suportados

> Retorna o catálogo somente leitura de formatos que o engine de ingestão pode parsear, com namespace região -> família -> variante. O catálogo é global-first e estático (parsers embutidos não carregam tenant), então a resposta é idêntica para todo chamador autenticado. Sem parâmetros de path, query ou corpo — o tenant é irrelevante para o catálogo embutido.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml get /v1/imports/formats
openapi: 3.1.0
info:
  title: Matcher APIs
  description: >-
    Referência completa de API para o motor de conciliação Matcher, que fornece
    conciliação automática de transações entre o Midaz Ledger e sistemas
    externos.
  version: 4.1.0
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
servers:
  - url: https://matcher.sandbox.lerian.net
security: []
paths:
  /v1/imports/formats:
    get:
      tags:
        - Ingestion
      summary: Navegar pelo catálogo de formatos suportados
      description: >-
        Retorna o catálogo somente leitura de formatos que o engine de ingestão
        pode parsear, com namespace região -> família -> variante. O catálogo é
        global-first e estático (parsers embutidos não carregam tenant), então a
        resposta é idêntica para todo chamador autenticado. Sem parâmetros de
        path, query ou corpo — o tenant é irrelevante para o catálogo embutido.
      operationId: browseFormatCatalog
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormatCatalogResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
      security:
        - BearerAuth: []
components:
  schemas:
    FormatCatalogResponse:
      additionalProperties: false
      properties:
        regions:
          description: >-
            Eixo de região do catálogo (ISO-3166 alpha-2 em maiúsculas, ou XX
            para formatos neutros de região), ordenado por código de região
          items:
            $ref: '#/components/schemas/FormatCatalogRegion'
          type:
            - array
            - 'null'
      required:
        - regions
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina com escopo
            no serviço emissor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            Uma explicação legível por humanos específica para esta ocorrência
            do problema.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Lista opcional de detalhes de erro individuais
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            Uma referência URI que identifica a ocorrência específica do
            problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de status HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Um resumo curto e legível por humanos do tipo do problema. Este
            valor não deve mudar entre ocorrências do erro.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: >-
            Uma referência URI para documentação legível por humanos sobre o
            erro.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    FormatCatalogRegion:
      additionalProperties: false
      properties:
        families:
          description: Famílias de formato sob esta região, ordenadas por família
          items:
            $ref: '#/components/schemas/FormatCatalogFamily'
          type:
            - array
            - 'null'
        region:
          description: >-
            Código de região: ISO-3166 alpha-2 em maiúsculas, ou XX para
            formatos neutros de região
          examples:
            - BR
          type: string
      required:
        - region
        - families
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: 'Onde o erro ocorreu, ex.: ''body.items[3].tags'' ou ''path.thing-id'''
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: O valor na localização informada
      type: object
    FormatCatalogFamily:
      additionalProperties: false
      properties:
        family:
          description: >-
            Nome de família de formato de enum fechado (ex.: cnab240, delimited,
            camt)
          examples:
            - cnab240
          type: string
        variants:
          description: >-
            Variantes de marca/banco sob esta família, ordenadas por variante;
            uma família de layout único canônico (ex.: camt) resulta em uma
            entrada com variante vazia
          items:
            $ref: '#/components/schemas/FormatCatalogVariant'
          type:
            - array
            - 'null'
      required:
        - family
        - variants
      type: object
    FormatCatalogVariant:
      additionalProperties: false
      properties:
        key:
          description: >-
            Chave canônica de registro com namespace
            (região/família[/variante]); a identidade que um upload ou
            declaração de origem fixa
          examples:
            - br/cnab240/febraban-base
          type: string
        variant:
          description: >-
            Eixo aberto de marca/banco (ex.: itau, febraban-base); vazio para
            uma família de layout único canônico
          examples:
            - febraban-base
          type: string
      required:
        - variant
        - key
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Autenticação por Bearer token (formato: "Bearer {token}")'

````