# Client disabled

Sent when an onboarded client can no longer use Client Account API operations. Do not create new Client Account API resources for the client until it is activated again.

Product: Client Account API
Event reference version: 0.2.0 (current)
OpenAPI contract: https://docs.sandbox.axiym.io/openapi/client-account-api/events/0.2.0.yaml
Canonical page: https://docs.sandbox.axiym.io/client-account-api/events/0.2.0/client/onClientDisabled

[Compact reference](/client-account-api/events/0.2.0/client/onClientDisabled.md)

## POST /webhooks/client.disabled

## Authentication

```json
{
  "security": [],
  "securitySchemes": {}
}
```

## Parameters

### header: X-Signature

```json
{
  "name": "X-Signature",
  "in": "header",
  "required": true,
  "schema": {
    "type": "string"
  },
  "description": "Base64-encoded Ed25519 signature of the raw HTTP request body bytes. Verify it before parsing or re-serializing the JSON."
}
```

### header: X-Key-Id

```json
{
  "name": "X-Key-Id",
  "in": "header",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "Identifier of the public key used to verify the delivery signature. Retrieve it with `GET /webhooks/public-keys/{publicKeyId}`."
}
```

### header: X-Algorithm

```json
{
  "name": "X-Algorithm",
  "in": "header",
  "required": true,
  "schema": {
    "type": "string",
    "const": "Ed25519"
  },
  "description": "Signature algorithm used for the delivery."
}
```

## Request body

```json
{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "id",
          "timestamp",
          "type",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Unique event identifier. Repeated deliveries of the same event carry the same `id`; use it to avoid processing the event more than once."
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "Event timestamp. Formatted in ISO 8601."
          },
          "type": {
            "type": "string",
            "const": "client.disabled"
          },
          "data": {
            "$ref": "#/components/schemas/ClientStatusEventData"
          }
        }
      }
    }
  }
}
```

## Responses

### 200

```json
{
  "description": "Acknowledged by your endpoint."
}
```

## Operation metadata

```json
{
  "tags": [
    "Client"
  ],
  "operationId": "onClientDisabled"
}
```

## Referenced definitions

- [`#/components/parameters/WebhookSignature`](#definition-1)
- [`#/components/parameters/WebhookKeyId`](#definition-2)
- [`#/components/parameters/WebhookAlgorithm`](#definition-3)
- [`#/components/schemas/ClientStatusEventData`](#definition-4)

### definition-1

`#/components/parameters/WebhookSignature`

```json
{
  "name": "X-Signature",
  "in": "header",
  "required": true,
  "schema": {
    "type": "string"
  },
  "description": "Base64-encoded Ed25519 signature of the raw HTTP request body bytes. Verify it before parsing or re-serializing the JSON."
}
```

### definition-2

`#/components/parameters/WebhookKeyId`

```json
{
  "name": "X-Key-Id",
  "in": "header",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "Identifier of the public key used to verify the delivery signature. Retrieve it with `GET /webhooks/public-keys/{publicKeyId}`."
}
```

### definition-3

`#/components/parameters/WebhookAlgorithm`

```json
{
  "name": "X-Algorithm",
  "in": "header",
  "required": true,
  "schema": {
    "type": "string",
    "const": "Ed25519"
  },
  "description": "Signature algorithm used for the delivery."
}
```

### definition-4

`#/components/schemas/ClientStatusEventData`

```json
{
  "type": "object",
  "description": "Compact client availability change. Fetch `GET /clients/{clientId}` when current profile details are required.",
  "required": [
    "clientId",
    "status"
  ],
  "properties": {
    "clientId": {
      "type": "string",
      "format": "uuid",
      "description": "Axiym identifier of the represented client.",
      "examples": [
        "1d2f7f5e-8a3b-4c6d-9e0f-2a4b6c8d0e2f"
      ]
    },
    "status": {
      "type": "string",
      "description": "Client availability at the time the event was emitted.",
      "enum": [
        "ACTIVE",
        "DISABLED"
      ],
      "examples": [
        "ACTIVE"
      ]
    }
  }
}
```