> ## 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. # Hard-delete an API key (deprovision / error cleanup) > Permanently delete an API key record (deprovision a retired terminal or clean up a provisioning error). Modeled as `POST` (not HTTP `DELETE`) so it carries the canonical envelope and `Idempotency-Key` header uniformly with the rest of the mutating surface. After delete, the key fails verification and no JWT can be minted; unlike revoke, the record is removed (use revoke for a reversible, audited soft state, and delete for true deprovisioning). The audit event is preserved even though the record is removed. Idempotent on the `Idempotency-Key` header and idempotent by nature: deleting an already-deleted key replays a deleted-state result rather than a `404` when the same idempotency key is reused; a fresh request against an unknown id returns `NOT_FOUND`. The `Idempotency-Key` (not the key id) governs this outcome: replay of the original key returns `200`, any fresh key against a removed record returns `404`. Tenant-scoped: another integration's key resolves to `NOT_FOUND` (`404`). Requires the `integrations` `DELETE` permission. ## OpenAPI ````yaml /api-reference/openapi.yaml post /auth/keys/{keyId}/delete 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/{keyId}/delete: post: tags: - auth summary: Hard-delete an API key (deprovision / error cleanup) description: >- Permanently delete an API key record (deprovision a retired terminal or clean up a provisioning error). Modeled as `POST` (not HTTP `DELETE`) so it carries the canonical envelope and `Idempotency-Key` header uniformly with the rest of the mutating surface. After delete, the key fails verification and no JWT can be minted; unlike revoke, the record is removed (use revoke for a reversible, audited soft state, and delete for true deprovisioning). The audit event is preserved even though the record is removed. Idempotent on the `Idempotency-Key` header and idempotent by nature: deleting an already-deleted key replays a deleted-state result rather than a `404` when the same idempotency key is reused; a fresh request against an unknown id returns `NOT_FOUND`. The `Idempotency-Key` (not the key id) governs this outcome: replay of the original key returns `200`, any fresh key against a removed record returns `404`. Tenant-scoped: another integration's key resolves to `NOT_FOUND` (`404`). Requires the `integrations` `DELETE` permission. operationId: authKeyDelete parameters: - $ref: '#/components/parameters/IdempotencyKey' - name: keyId in: path required: true description: The API key id to delete. schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/AuthKeyMutationRequest' example: meta: partner_request_id: ee05... occurred_at: '2026-06-05T08:40:00Z' sent_at: '2026-06-05T08:40:00Z' api_version: '2026-06-01' context: merchant_id: 11111111-1111-1111-1111-111111111111 reason: provisioning_error_cleanup responses: '200': description: Key deleted (or idempotent replay of a prior delete). content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: data: $ref: '#/components/schemas/ApiKeyStatusResult' example: ok: true data: key_id: ak_01H9X2 status: deleted deleted_at: '2026-06-05T08:40:00Z' error: null meta: request_id: req_kd1 idempotency_replayed: false api_version: '2026-06-01' '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), lacks `integrations` DELETE permission, or cross-tenant. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' '404': description: '`NOT_FOUND`, key does not exist or belongs to another integration.' content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' '422': description: '`IDEMPOTENCY_KEY_REUSED`, same key, different payload.' content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' security: - ApiKeyAuth: [] components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: true description: >- Partner-generated UUID; the ONE dedup key for all mutating endpoints. 24h TTL. Same key + same payload -> byte-identical replay; same key + different payload -> IDEMPOTENCY_KEY_REUSED (422). schema: type: string format: uuid schemas: AuthKeyMutationRequest: type: object description: >- Generic envelope for a no-body key mutation (revoke / regenerate / delete). The canonical envelope plus an optional audit reason. required: - meta - context properties: meta: $ref: '#/components/schemas/RequestMeta' context: $ref: '#/components/schemas/PartnerContext' reason: type: - string - 'null' maxLength: 200 description: >- Optional human-readable audit reason (e.g. 'terminal_decommissioned', 'scheduled_rotation'). 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' ApiKeyStatusResult: type: object description: >- Compact result of a revoke/delete. `status` reflects the post-operation lifecycle state. required: - key_id - status properties: key_id: type: string status: type: string enum: - inactive - deleted description: >- `inactive` after a revoke (soft, row preserved); `deleted` after a hard delete (row removed, audit preserved). revoked_at: type: - string - 'null' format: date-time description: Present on a revoke result. deleted_at: type: - string - 'null' format: date-time description: Present on a delete result. 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 RequestMeta: type: object description: >- Common request metadata shared across all Partner API domains. `partner_request_id` is a correlation identifier only: it appears in logs and responses for tracing but is **never used as the deduplication key**. Request deduplication is keyed exclusively on the `Idempotency-Key` header. required: - partner_request_id - api_version properties: partner_request_id: type: string format: uuid description: Partner's own correlation id. NOT the idempotency basis. occurred_at: type: string format: date-time description: >- When the event happened at the POS (RFC3339). Clock-drift signal vs sent_at. sent_at: type: string format: date-time description: When the partner sent the request (RFC3339). api_version: type: string description: The single API version field. example: '2026-06-01' PartnerContext: type: object description: >- The canonical `context` block. `merchant_id` is key-enforced to a merchant the caller is authorized for, never a free-text trust field. `cashier_id` is server-trusted only when it is signed into the terminal JWT. required: - merchant_id properties: merchant_id: type: string format: uuid description: The resolved Feddi tenant. Key-enforced. branch_id: type: - string - 'null' format: uuid terminal_id: type: - string - 'null' cashier_id: type: - string - 'null' description: Server-trusted only when present in the signed terminal JWT. partner_session_id: type: - string - 'null' description: The partner's own order/session ref. feddi_session_id: type: - string - 'null' format: uuid description: The checkout_session id, when this call hangs off a session. 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. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Partner API key (platform- or merchant-scoped). Contract key-enforces context.merchant_id. ````