> ## Documentation Index > Fetch the complete documentation index at: https://docs.feddi.io/llms.txt > Use this file to discover all available pages before exploring further. # List API keys for the calling integration (non-secret metadata) > List the API keys provisioned for the calling integration. Returns non-secret metadata only: `id`, scope (enterprise, brand, or branch, plus names), `key_prefix`, `key_last_four`, `status`, `expires_at`, `last_used_at`, and `created_at`. **The raw key is never present in a list response**: it appears only once, in the create response. Tenant-scoped to the calling integration: keys belonging to another integration or enterprise are never visible. Supports `status` filtering and cursor pagination. Read-only; requires the `integrations` `READ` permission. ## OpenAPI ````yaml /api-reference/openapi.yaml get /auth/keys openapi: 3.1.0 info: title: Feddi Partner API version: '2026-06-01' description: >- Operate a Feddi closed-loop wallet and loyalty program at the point of sale: identify customers, read balances, accept wallet payments, run top-ups, and reconcile transactions. All amounts are integer minor units with an explicit ISO-4217 currency. Balances are merchant-held and closed-loop. Every response uses a typed envelope (`ok` / `data` / `error` / `meta`) with string error codes (never a bare HTTP number) and an idempotency-replay flag. Authenticate with the `x-api-key` header; exchange it for a short-lived POS terminal JWT for hot-path calls. Self-validate against this document (`GET /openapi`) and read `GET /capabilities` for the credential types, currencies, and features enabled for your integration before assuming any enum. Operations are tagged `x-feddi-availability: ga` (stable) or `beta` (callable, contract may still change additively); confirm what is enabled for your credentials via `GET /capabilities`. Sandbox access is granted per partner agreement; request credentials from your Feddi contact. servers: - url: https://api.feddi.io/v1/partner description: production - url: https://api.dev.feddi.io/v1/partner description: dev security: - ApiKeyAuth: [] tags: - name: platform description: >- Platform cross-cutting: health, capabilities, openapi self-serve, merchant provisioning, settlement, reconciliation. - name: checkout_session description: >- Checkout sessions: every interaction opens a session, then identity and basket attach to it, and payment, top-up, and offers run against it. - name: auth description: >- Partner authentication + onboarding: API key lifecycle, POS terminal JWT exchange, terminal heartbeat. - name: customers description: >- Customer lookup + identification: resolve identity, cashier-panel summaries, preferences, GDPR export/erase. - name: enrollment description: >- Enrollment + signup: OTP enroll, cashback claims, identity/consent, customer correction + merge. - name: payments description: >- Payments + redemption: debit wallet (promo-first), balance-check, void, refund, QR mint. - name: topup description: >- Wallet top-up: 2-step prepare/confirm, reload-bonus grants, SKU top-up, settlement + reconciliation. - name: incentives description: >- Incentives + offers: offer feeds, apply/redeem/release locks, proposals, budget envelopes, points, grant clawback. - name: transactions description: >- Transactions + receipts: transaction detail, void, receipts, disputes, settlements, reconciliation, exports. - name: webhooks description: >- Webhooks + events: subscriptions, delivery history + retry, event catalog, polling fallback. paths: /auth/keys: get: tags: - auth summary: List API keys for the calling integration (non-secret metadata) description: >- List the API keys provisioned for the calling integration. Returns non-secret metadata only: `id`, scope (enterprise, brand, or branch, plus names), `key_prefix`, `key_last_four`, `status`, `expires_at`, `last_used_at`, and `created_at`. **The raw key is never present in a list response**: it appears only once, in the create response. Tenant-scoped to the calling integration: keys belonging to another integration or enterprise are never visible. Supports `status` filtering and cursor pagination. Read-only; requires the `integrations` `READ` permission. operationId: authKeysList parameters: - name: status in: query required: false description: Filter by key status. schema: type: string enum: - active - inactive - name: branch_id in: query required: false description: Filter to keys scoped to a specific branch. schema: type: string format: uuid - name: cursor in: query required: false description: Opaque cursor from a prior page's `meta.next_cursor`. schema: type: string - name: limit in: query required: false description: Page size (default 50, max 200). schema: type: integer minimum: 1 maximum: 200 default: 50 responses: '200': description: A page of API key metadata (no secrets). content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: data: type: array items: $ref: '#/components/schemas/ApiKeySummary' example: ok: true data: - key_id: ak_01H9X2 scope: branch enterprise_id: 11111111-1111-1111-1111-111111111111 brand_id: 44444444-4444-4444-4444-444444444444 brand_name: Acme Coffee branch_id: 22222222-2222-2222-2222-222222222222 branch_name: Al-Olaya label: Al-Olaya Branch POS-360-0007 key_prefix: fddi_odo_3pQ8 key_last_four: 8hJ is_sandbox: false status: active expires_at: null last_used_at: '2026-06-05T07:59:12Z' created_at: '2026-06-01T10:00:00Z' error: null meta: request_id: req_kl1 idempotency_replayed: false api_version: '2026-06-01' next_cursor: null has_more: false '401': description: '`INVALID_API_KEY` (HTTP 401), missing/invalid `x-api-key`.' content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' '403': description: >- `FORBIDDEN` (HTTP 403), the key lacks the `integrations` READ permission. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' security: - ApiKeyAuth: [] components: schemas: ResponseEnvelope: type: object description: >- The standard response envelope that every enveloped endpoint serializes through. `ok` is a boolean discriminator: when `ok` is `true`, the typed result is carried in `data`; when `ok` is `false`, a typed error object is returned instead. The `meta` object is uniform across the entire API surface. required: - ok - meta properties: ok: type: boolean data: type: - object - 'null' error: oneOf: - $ref: '#/components/schemas/Error' - type: 'null' meta: $ref: '#/components/schemas/Meta' ApiKeySummary: type: object description: >- Non-secret key metadata returned by list/get/update. NEVER contains the raw key, only prefix + last-four. required: - key_id - scope - enterprise_id - key_prefix - key_last_four - is_sandbox - status - created_at properties: key_id: type: string scope: $ref: '#/components/schemas/ApiKeyScope' enterprise_id: type: string format: uuid brand_id: type: - string - 'null' format: uuid brand_name: type: - string - 'null' branch_id: type: - string - 'null' format: uuid branch_name: type: - string - 'null' label: type: - string - 'null' key_prefix: type: string key_last_four: type: string is_sandbox: type: boolean status: $ref: '#/components/schemas/ApiKeyStatus' expires_at: type: - string - 'null' format: date-time last_used_at: type: - string - 'null' format: date-time description: >- When this key last authenticated a request (best-effort, fire-and-forget write on verify). created_at: type: string format: date-time Error: type: object description: >- The typed error object returned with every non-2xx response. `code` is a string enum (for example `WALLET_PROGRAM_AMBIGUOUS`, `CREDENTIAL_TYPE_UNSUPPORTED`, `INSUFFICIENT_FUNDS`, `IDEMPOTENCY_KEY_REUSED`, `CURRENCY_NOT_SUPPORTED`), **never a bare HTTP status number**. Inspect `code` for programmatic branching, not the HTTP status. Some codes echo the valid set in `details` so clients can present or reconcile the accepted values: for example `CREDENTIAL_TYPE_UNSUPPORTED` lists the supported credential types, `CURRENCY_NOT_SUPPORTED` lists the supported ISO-4217 currencies, and `WALLET_PROGRAM_AMBIGUOUS` lists the candidate `wallet_program_id` values that matched the request. required: - code - message properties: code: type: string enum: - INSUFFICIENT_FUNDS - INVALID_API_KEY - CREDENTIAL_TYPE_UNSUPPORTED - CURRENCY_NOT_SUPPORTED - IDEMPOTENCY_KEY_REUSED - WALLET_PROGRAM_AMBIGUOUS - REQUIRES_DYNAMIC_CREDENTIAL - NOT_FOUND - FORBIDDEN - VALIDATION_ERROR - RATE_LIMITED - CONFLICT - INTERNAL_SERVER_ERROR message: type: string details: type: object additionalProperties: true Meta: type: object description: >- The uniform response metadata block returned on every response. `data_completeness_score` is computed per call and reports the completeness of the returned data. `decision_trace_id` is present on responses that carry decision or insight output and can be used to correlate the response with its reasoning. `capabilities` is an additive, response-level array of hints advertising features the caller may use, and may be extended over time without notice. required: - request_id - api_version properties: request_id: type: string description: Feddi-issued correlation id for this response. idempotency_replayed: type: boolean description: True when this response was replayed from the idempotency store. api_version: type: string description: The single API version field. example: '2026-06-01' data_completeness_score: type: integer minimum: 0 maximum: 100 description: >- 0-100, computed per call (basket/identity/tax/category/consent presence). decision_trace_id: type: - string - 'null' description: Opaque trace id on intelligence-bearing responses; one per response. capabilities: type: object additionalProperties: true description: Additive response-level capability hints. ApiKeyScope: type: string enum: - enterprise - brand - branch description: >- The authority scope of a key, derived from which of enterprise/brand/branch ids are set (most-specific present wins). ApiKeyStatus: type: string enum: - active - inactive description: >- Key lifecycle status. `inactive` = revoked (soft); `active` and `inactive` mirror the key's enabled state. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Partner API key (platform- or merchant-scoped). Contract key-enforces context.merchant_id. ````