Applications

Delete an application

Remove an application owned by the current organization and clean up associated loyalty resources.

delete/v1/applications/{appId}

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/applications/{appId}
  • Auth: one of:
    • API key in header X-Api-Key
    • bearer (a scheme the document does not define)

Path parameters

appIdstring uuid required

The unique identifier of the application to delete

Response

Application deleted successfully

idstring uuid required

Entity UUID

createdAtstring date-time required

Creation date (ISO 8601)

updatedAtstring date-time required

Last update date (ISO 8601)

namestring required

Human-readable name of the application.

slugstring required

URL-safe identifier of the application (kebab-case, unique within the organization). Used in URLs and API paths.

featuresstring[] required

List of enabled features for this application.

domainsstring[] required

List of authorized domains for this application.

preferredCurrency'EUR' | 'USD' | 'JPY' | 'null' nullable required

Fiat currency (ISO 4217) the application displays monetary values in: wallet balances are converted to it, and spending policies are authored in it. Read-only mirror of the organization's preferredCurrency, chosen once for the whole organization. Null until the organization picks it.

network'EthereumAnvil' | 'BaseSepolia' | 'BaseMainnet' | 'XdcApothem' | 'XdcMainnet' | 'StellarQuickstart' | 'StellarTestnet' | 'StellarMainnet' | 'null' nullable required

Blockchain network the application runs on. One network per application: agent wallets, balances and spending policies all assume a single chain, and creating a wallet on another network is rejected. Declared once from the agent-wallet onboarding step of the dashboard, then immutable — its wallets are deployed on that chain, so changing it would orphan them; a different network means a different application. The declaration is also checked against the organization quota (allowedNetworks). Null on applications that never declared it.

cloudflareSessionobject nullable

Example response

{
  "organization": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "createdAt": "2024-01-15T09:30:00.000Z",
    "name": "Keyban SAS",
    "slug": "keyban-sas",
    "logo": "https://cdn.example.com/logos/keyban.png",
    "defaultLocale": "fr-FR",
    "preferredCurrency": "EUR",
    "agentRoles": [
      "sales",
      "analyst"
    ],
    "acquisitionChannel": "n8n",
    "settings": {
      "authConfig": {
        "auth0": {
          "clientId": "abc123xyz",
          "domain": "keyban.eu.auth0.com"
        }
      }
    }
  },
  "slug": "my-shop-app",
  "preferredCurrency": "EUR",
  "network": "BaseMainnet",
  "dppSettings": {
    "tokens": [
      {
        "address": "0x04ceB44e3b6E4aC4C14f29F7e0Ee40DAFcb3A0e1",
        "name": "DPP Certification Token",
        "symbol": "DPP"
      }
    ],
    "actions": [
      {
        "type": "circularity",
        "url": "https://example.com/authenticity-proof",
        "label": {
          "en-US": "Verify authenticity",
          "fr-FR": "Vérifier l'authenticité"
        },
        "description": {
          "en-US": "Verify authenticity",
          "fr-FR": "Vérifier l'authenticité"
        },
        "icon": "recycle"
      }
    ],
    "heroTitle": {
      "en-US": "Verify authenticity",
      "fr-FR": "Vérifier l'authenticité"
    },
    "heroSubtitle": {
      "en-US": "Verify authenticity",
      "fr-FR": "Vérifier l'authenticité"
    }
  },
  "loyaltySettings": {
    "tokens": [
      {
        "address": "0x9F8a7c2AEE85E24b2B3b58C20B9A46c83E2c7a12",
        "name": "Acme Loyalty Points",
        "symbol": "ACME-LP"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.