Skip to main content
POST
Create account restriction

Headers

Idempotency-Key
string
required

Client-provided idempotency key. UUID v4 suggested, max 255 characters.

Maximum string length: 255
Pattern: \S

Path Parameters

accountId
string<uuid>
required

Account ID

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Body

application/json

Request to create a restriction for an account

type
enum<string>
required

Restriction type

Available options:
REJECT_OUTBOUND,
REJECT_INBOUND,
HOLD_INBOUND
Example:

"REJECT_OUTBOUND"

source
enum<string>
required

Restriction source

Available options:
CLIENT,
PLAIS
Example:

"PLAIS"

reason
string | null

Free-text reason for the restriction

Example:

"PLAIS restriction"

externalRef
string | null

External reference associated with the restriction

Example:

"PLAIS-2026-12345"

Response

Account restriction request accepted

Response for accepted asynchronous requests

correlationId
string

Correlation identifier for tracking the request through events

Example:

"550e8400-e29b-41d4-a716-446655440000"

Last modified on July 20, 2026