Partner Webhooks

Last updated 6 days ago

Customer Notification

post

Notification about customer changes related to event CUSTOMER_NOTIFICATION

Body

customerIdstring · uuidRequired

modifiedOnstring · date-timeOptional

statusstring · enumOptionalPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /customer-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "CREATED",
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "ALREADY_EXISTS_ERROR",
    "description": "text"
  }
}

200

No content

Natural Person Notification

post

Notification about natural person changes related to event NATURAL_PERSON_NOTIFICATION

Body

naturalPersonIdstring · uuidRequired

modifiedOnstring · date-timeOptional

statusstring · enumOptionalPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /natural-person-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "CREATED",
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "ALREADY_EXISTS_ERROR",
    "description": "text"
  }
}

200

No content

Identification Verification Notification

post

Notification about identification verification changes related to event IDENTIFICATION_VERIFICATION_NOTIFICATION

Body

identificationVerificationIdstring · uuidRequired

naturalPersonIdstring · uuidRequired

modifiedOnstring · date-timeRequired

statusstring · enumRequiredPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /identification-verification-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 293

{
  "identificationVerificationId": "123e4567-e89b-12d3-a456-426614174000",
  "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "RECEIVED",
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "ALREADY_EXISTS_ERROR",
    "description": "text"
  }
}

200

No content

Labels Update Notification

post

Notification about labels updates related to event LABELS_UPDATE_NOTIFICATION

Body

updatedCustomersstring · uuid[]Optional

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /labels-update-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "updatedCustomers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "CUSTOMERS_NOT_FOUND_ERROR",
    "description": "text"
  }
}

200

No content

Onboarding Notification

post

Notification about onboarding update related to event ONBOARDING_NOTIFICATION

Body

onboardingIdstring · uuidRequired

modifiedOnstring · date-timeRequired

statusstring · enumRequiredPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /onboarding-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "onboardingId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "CREATED",
  "notificationType": "STARTED",
  "validationErrors": [
    {
      "errorType": "CUSTOMER_STATUS_VERIFICATION",
      "description": "text"
    }
  ]
}

200

No content

Proxy Notification

post

Notification about proxy update related to event PROXY_NOTIFICATION

Body

proxyIdstring · uuidRequired

modifiedOnstring · date-timeOptional

statusstring · enumOptionalPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /proxy-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "proxyId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "CREATED",
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "ALREADY_EXISTS_ERROR",
    "description": "text"
  }
}

200

No content

Beneficial Owner Notification

post

Notification about beneficial owner update related to event BENEFICIAL_OWNER_NOTIFICATION

Body

beneficialOwnerIdstring · uuidRequired

modifiedOnstring · date-timeOptional

statusstring · enumOptionalPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /beneficial-owner-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "beneficialOwnerId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "CREATED",
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "ALREADY_EXISTS_ERROR",
    "description": "text"
  }
}

200

No content

Partner Document Notification

post

Notification about partner document update related to event PARTNER_DOCUMENT_NOTIFICATION

Body

documentIdstring · uuidRequired

modifiedOnstring · date-timeRequired

Responses

200

post

POST /partner-document-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "documentId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z"
}

200

No content

Document Notification

post

Notification about document update related to event DOCUMENT_NOTIFICATION

Body

documentIdstring · uuidRequired

modifiedOnstring · date-timeRequired

statusstring · enumRequiredPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /document-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "documentId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "RECEIVED",
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "UNKNOWN_ERROR",
    "description": "text"
  }
}

200

No content

Customer Product Notification

post

Notifications about customer product update related to event CUSTOMER_PRODUCT_NOTIFICATION

Body

customerIdstring · uuidRequired

customerProductIdstring · uuidRequired

modifiedOnstring · date-timeOptional

statusstring · enumOptionalPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /customer-product-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 274

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerProductId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "PENDING",
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "PRODUCT_NOT_ACTIVE",
    "description": "text"
  }
}

200

No content

Legal Entity Search Notification

post

Notification about legal entity search changes related to event LEGAL_ENTITY_SEARCH_NOTIFICATION

Body

searchIdstring · uuidRequired

modifiedOnstring · date-timeRequired

statusstring · enumRequired

status of the search

Possible values:

Responses

200

post

POST /legal-entity-search-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "searchId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "WAITING_FOR_DATA"
}

200

No content

Strategy Notification

post

Notification about strategy update related to event STRATEGY_NOTIFICATION

Body

strategyIdstring · uuidRequired

subscriberIdstring · uuidOptional

modifiedOnstring · date-timeOptional

statusstring · enumOptionalPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /strategy-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "strategyId": "123e4567-e89b-12d3-a456-426614174000",
  "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "EXECUTING",
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "ALREADY_EXISTS_ERROR",
    "description": "text"
  }
}

200

No content

Transfer Notification

post

Notification about transfer update related to event TRANSFER_NOTIFICATION

Body

customerIdstring · uuidRequired

customerProductIdstring · uuidRequired

transferIdstring · uuidRequired

modifiedOnstring · date-timeOptional

statusstring · enumOptionalPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /transfer-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 329

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerProductId": "123e4567-e89b-12d3-a456-426614174000",
  "transferId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "RECEIVED",
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "INSUFFICIENT_BALANCE",
    "description": "text"
  }
}

200

No content

Digital Asset Order Notification

post

Notification about digital asset order update related to event DIGITAL_ASSET_ORDER_NOTIFICATION

Body

orderIdstring · uuidRequired

quoteIdstring · uuidOptional

customerProductIdstring · uuidRequired

externalIdstringRequired

statusstring · enumRequiredPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /digital-asset-order-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 373

{
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "quoteId": "123e4567-e89b-12d3-a456-426614174000",
  "customerProductId": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "status": "RECEIVED",
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "INSUFFICIENT_BALANCE",
    "description": "text"
  },
  "executionData": {
    "quantity": 1,
    "executionPrice": 1,
    "executionAmount": 1
  }
}

200

No content

Traditional Asset Order Notification

post

Notification about traditional asset order update related to event TRADITIONAL_ASSET_ORDER_NOTIFICATION

Body

orderIdstring · uuidRequired

customerProductIdstring · uuidRequired

externalIdstringRequired

statusstring · enumRequiredPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /traditional-asset-order-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 254

{
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "customerProductId": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "status": "RECEIVED",
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "INSUFFICIENT_BALANCE",
    "description": "text"
  }
}

200

No content

User Notification

post

Notification related to event USER_NOTIFICATION

Body

userIdstringRequired

modifiedOnstring · date-timeOptional

statusstring · enumOptionalPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /user-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "userId": "text",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "RECEIVED",
  "notificationType": "CREATED",
  "validationError": {
    "errorType": "ALREADY_EXISTS_ERROR",
    "description": "text"
  }
}

200

No content

Real estate token prices Notification

post

Notification related to event RE_TOKEN_PRICES

Body

regularTokennumber · currencyRequired

premiumTokennumber · currencyRequired

Responses

200

post

POST /re-token-prices HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "regularToken": 1,
  "premiumToken": 1
}

200

No content

Offboarding Notification

post

Notification about offboarding update related to event OFFBOARDING_NOTIFICATION

Body

offboardingIdstring · uuidRequired

modifiedOnstring · date-timeRequired

statusstring · enumRequiredPossible values:

notificationTypestring · enumRequiredPossible values:

Responses

200

post

POST /offboarding-notification HTTP/1.1
Host: client-api-address
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "offboardingId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedOn": "2025-05-23T00:32:56.709Z",
  "status": "CREATED",
  "notificationType": "STARTED",
  "validationError": {
    "errorType": "ALREADY_EXISTS_ERROR",
    "description": "text"
  }
}

200

No content