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

# Corridors

> Payout schemes available to this workspace. Use each offer's `scheme`
on `POST /beneficiaries`, and its `fields[].key` values as `routing`
keys (camelCase; snake_case aliases accepted). Also returns allowed
`relationships` codes — full list in
[Relationships & purposes](/guides/relationships-and-purposes).

Optional `country` is an **ISO 3166-1 alpha-2** code (**2 letters**) —
e.g. `NG`. When set, only corridors that reach that country are
returned (see [Country codes](/guides/country-codes)).




## OpenAPI

````yaml /openapi.yaml get /corridors
openapi: 3.1.0
info:
  title: Keette API
  version: 1.0.0
  description: |
    Public HTTP API for Keette workspaces. One base URL — live vs sandbox is
    selected by your API key (`sk_live_…` / `sk_test_…`).

    Endpoints are added as each implementation phase ships.
  contact:
    name: Keette Support
    email: talk@keette.com
servers:
  - url: https://1178-41-90-137-132.ngrok-free.app/v1
    description: Local tunnel (ngrok → core :8080)
  - url: https://api.keette.com/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Identity for the authenticating API key
  - name: Utilities
    description: |
      Lookup helpers for building beneficiaries and payouts — corridors
      (schemes + routing field keys), bank directory codes, account resolve,
      and SWIFT/BIC lookup.
  - name: Balances
    description: Wallet books
  - name: Beneficiaries
    description: Payout recipients
  - name: Transactions
    description: Unified transaction index
  - name: FX
    description: Indicative rates and firm quotes
  - name: Payouts
    description: Send money to a beneficiary
  - name: Payins
    description: Collect money into your books
  - name: Swaps
    description: FX between your own books
  - name: Webhooks
    description: Durable event log, ping, and webhook delivery helpers
paths:
  /corridors:
    get:
      tags:
        - Utilities
      summary: Corridors
      description: |
        Payout schemes available to this workspace. Use each offer's `scheme`
        on `POST /beneficiaries`, and its `fields[].key` values as `routing`
        keys (camelCase; snake_case aliases accepted). Also returns allowed
        `relationships` codes — full list in
        [Relationships & purposes](/guides/relationships-and-purposes).

        Optional `country` is an **ISO 3166-1 alpha-2** code (**2 letters**) —
        e.g. `NG`. When set, only corridors that reach that country are
        returned (see [Country codes](/guides/country-codes)).
      operationId: listCorridors
      parameters:
        - name: country
          in: query
          required: false
          description: |
            ISO 3166-1 alpha-2 destination country. Omit to list every corridor.
          schema:
            type: string
            minLength: 2
            maxLength: 2
            pattern: ^[A-Za-z]{2}$
          example: NG
      responses:
        '200':
          description: Corridor catalog
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - list
                  country:
                    type: string
                    description: Echoed when the `country` query was set.
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                  relationships:
                    type: array
                    items:
                      type: string
              examples:
                ng:
                  summary: Filtered to Nigeria
                  value:
                    object: list
                    country: NG
                    data:
                      - scheme: ng_nip
                        label: Nigerian bank transfer
                        method: bank
                        currencies:
                          - NGN
                        countries:
                          - NG
                        fields:
                          - key: bankCode
                            label: Bank
                            kind: bank
                          - key: accountNumber
                            label: Account number
                            kind: account
                    relationships:
                      - vendor
                      - supplier
                      - contractor
                      - employee
                      - customer
                      - partner
                      - family
                      - self
                      - other
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication_error
              code: invalid_api_key
              message: Invalid API key provided.
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              description: Broad error class for client handling.
              enum:
                - invalid_request
                - authentication_error
                - permission_error
                - rate_limit
                - api_error
            code:
              type: string
              description: Stable machine-readable code (e.g. `parameter_invalid`).
            message:
              type: string
              description: Human-readable explanation safe to show developers.
            param:
              type: string
              description: Request field that failed validation, when applicable.
            doc_url:
              type: string
              format: uri
              description: Optional link to docs for this error.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: |
        Secret API key from **Settings → Developers → API keys**.
        Example: `Authorization: Bearer sk_test_…`

````

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