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

# Handles `GET /v1/verification-catalog`.

> What an organisation may build a flow from. Enabled entries only, unless
`include_disabled=true`.

# Errors

`401` without usable credentials, `503` when a store cannot be reached.



## OpenAPI

````yaml /openapi.json get /v1/verification-catalog
openapi: 3.1.0
info:
  title: Esectra API
  description: >-
    Transaction screening, identity verification, and wallet risk.


    Every create route accepts `Idempotency-Key`; replaying one returns the
    original record with `200` where the first call returned `201`. `POST
    /v1/transactions` requires the header, because a duplicated transaction is a
    duplicated financial record.
  license:
    name: proprietary
    identifier: proprietary
  version: 0.1.0
servers: []
security: []
paths:
  /v1/verification-catalog:
    get:
      tags:
        - Verification flows
      summary: Handles `GET /v1/verification-catalog`.
      description: |-
        What an organisation may build a flow from. Enabled entries only, unless
        `include_disabled=true`.

        # Errors

        `401` without usable credentials, `503` when a store cannot be reached.
      operationId: tenant_list_handler
      parameters:
        - name: include_disabled
          in: query
          description: Also list disabled entries
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: The catalog
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogListBody'
        '401':
          description: No usable credentials
        '503':
          description: A backing store could not be reached
      security:
        - api_key: []
        - session_cookie: []
components:
  schemas:
    CatalogListBody:
      type: object
      description: A catalog listing.
      required:
        - capabilities
      properties:
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/CapabilityBody'
          description: Entries, ordered by country then document type.
    CapabilityBody:
      type: object
      description: A catalog entry as the API shows it.
      required:
        - code
        - country
        - country_name
        - document_type
        - display_name
        - extraction_support
        - capture
        - enabled
        - revision
        - created_at
        - updated_at
      properties:
        capture:
          $ref: '#/components/schemas/CaptureRequirements'
          description: Capture rules.
        code:
          type: string
          description: Stable code, `{country}_{document type}`.
        country:
          type: string
          description: ISO-3166-1 alpha-2 issuing country.
        country_name:
          type: string
          description: >-
            The country's English short name, from the same table the capture
            page

            uses, so a console shows "Nigeria" without carrying its own list.
        created_at:
          type: string
          description: RFC 3339 creation time.
        display_name:
          type: string
          description: What a person is shown.
        document_type:
          $ref: '#/components/schemas/DocumentType'
          description: Document type.
        enabled:
          type: boolean
          description: Whether new flows may select it.
        extraction_support:
          $ref: '#/components/schemas/ExtractionSupport'
          description: |-
            `AUTOMATED` when a reader exists, otherwise `MANUAL_REVIEW`: the
            document is captured and its reading goes to a reviewer.
        reader:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ReaderClass'
              description: The reader that reads it, when one exists.
        revision:
          type: integer
          format: int32
          description: Change counter, from 1.
          minimum: 0
        updated_at:
          type: string
          description: RFC 3339 time of the last change.
    CaptureRequirements:
      type: object
      description: |-
        Capture rules a capability may set, from the ones the page and the route
        already implement. Nothing here invents a requirement the application
        cannot enforce.
      required:
        - document_number_required
      properties:
        document_number_required:
          type: boolean
          description: >-
            Whether the person must type their document number. The page
            compares

            the last four characters against what was read, so a document that
            is

            read wants it; a document with no number does not.
    DocumentType:
      type: string
      description: Kind of identity document presented.
      enum:
        - PASSPORT
        - DRIVING_LICENCE
        - NATIONAL_ID
        - RESIDENCE_PERMIT
        - NIN_SLIP
        - OTHER
    ExtractionSupport:
      type: string
      description: What happens to a capability's document once it is captured.
      enum:
        - AUTOMATED
        - MANUAL_REVIEW
    ReaderClass:
      type: string
      description: >-
        The reader classes the inference service implements.


        These are the document classes `Gorgon-ML` reports and

        [`crate::document_reading`] accepts; a test holds the two lists
        together.

        Adding a class here without a reader behind it is exactly the dishonesty

        the catalog exists to prevent, so the list is closed and reviewed.
      enum:
        - NG_NIN_SLIP
        - TD3_MRZ
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
      description: >-
        A tenant API key. Acts for exactly one tenant and cannot conclude a
        case, because a conclusion records a person.
    session_cookie:
      type: apiKey
      in: cookie
      name: esectra_session
      description: >-
        A signed-in reviewer's session. httpOnly and SameSite=Lax; set by `POST
        /v1/control/sessions` and only usable once the second factor is met.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.