Events

This article lists the Webhooks you may receive when regarding Users.

API – See the Users API Reference for attributes description

The detailed information of the User attributes are available in the of the Users API Reference. Webhooks object_payload is identical to the API object.

User events

user.create

Notifies the creation of a User, usually triggered by the /v1/users endpoint.

JSON

{
  "webhook": "user.create",
  "object_payload": {
    "users": [
      {
        "userId": "123456789",
        "userTypeId": "1",
        "userStatus": "VALIDATED",
        "clientId": "12345",
        "userTag": "",
        "parentUserId": null,
        "parentType": null,
        "title": "M",
        "firstname": "Alex",
        "lastname": "OAK",
        "middleNames": "",
        "birthday": "1994-01-01",
        "email": "aoak@example.com",
        "address1": "10 RUE DE LA PAIX",
        "address2": "",
        "address3": "",
        "postcode": "75001",
        "city": "PARIS",
        "state": "",
        "country": "FR",
        "countryName": "France",
        "distributionCountry": null,
        "phone": "+33191605190",
        "mobile": "",
        "nationality": "",
        "nationalityOther": "",
        "placeOfBirth": "",
        "birthCountry": "",
        "secondaryAddress1": null,
        "secondaryAddress2": null,
        "secondaryAddress3": null,
        "secondaryPostcode": null,
        "secondaryCity": null,
        "secondaryState": null,
        "secondaryCountry": null,
        "occupation": "",
        "incomeRange": "",        // DEPRECATED
        "legalName": "",
        "legalNameEmbossed": "",
        "legalRegistrationNumber": "",
        "legalTvaNumber": "",
        "legalRegistrationDate": null,
        "legalForm": "",
        "legalShareCapital": "0",
        "legalSector": "",
        "legalAnnualTurnOver": "",
        "legalNetIncomeRange": "",
        "legalNumberOfEmployeeRange": "",
        "effectiveBeneficiary": "0.00",
        "position": "",
        "personalAssets": "",
        "taxResidence": "", // DEPRECATED
        "taxNumber": "",    // DEPRECATED
        "kycLevel": "2",
        "kycReview": "0",
        "kycReviewComment": "",
        "isFreezed": "0",
        "language": null,
        "specifiedUSPerson": "0",
        "employeeType": "1",
        "entityType": "0",      // DEPRECATED
        "controllingPersonType": "0",
        "activityOutsideEu": null,
        "economicSanctions": null,
        "residentCountriesSanctions": null,
        "involvedSanctions": null,
        "sanctionsQuestionnaireDate": null,
        "timezone": null,
        "occupationType": null, // DEPRECATED
        "isOnStockExchange": null,
        "IsLegalFrozen": "0",
        "sourceOfFunds": null,
        "legalSectorType": null,
        "createdDate": "2026-03-10 15:59:22",
        "modifiedDate": "2026-03-10 15:59:22",
        "codeStatus": "110009",
        "informationStatus": "",
        "sepaCreditorIdentifier": null,
        "walletCount": "1",
        "payinCount": "0",
        "totalRows": "1"
      }
    ]
  },
  "object_id": "100060789",
  "object": "user",
  "webhook_created_at": 17047224279950,
  "webhook_id": "e77663b0-0c4f-49c3-be53-96f39001234",
  "object_payload_signature": "abcDZ6MeUFRIjNoRDMN4KFjNJ0yR2Eok+MFrEq1k2/ho="
}

user.update

Notifies the modification of a User, usually triggered by the /v1/users/{userId} endpoint.

JSON

{
  "webhook": "user.update",
  "object_payload": {
    "users": [
      {
        "userId": "123456789",
        "userTypeId": "1",
        "userStatus": "VALIDATED",
        "clientId": "12345",
        "userTag": "",
        "parentUserId": null,
        "parentType": null,
        "title": "M",
        "firstname": "Alex",
        "lastname": "OAK",
        "middleNames": "",
        "birthday": "1994-01-01",
        "email": "aoak@example.com",
        "address1": "10 RUE DE LA PAIX",
        "address2": "",
        "address3": "",
        "postcode": "75001",
        "city": "PARIS",
        "state": "",
        "country": "FR",
        "countryName": "France",
        "distributionCountry": null,
        "phone": "+33191605190",
        "mobile": "",
        "nationality": "",
        "nationalityOther": "",
        "placeOfBirth": "",
        "birthCountry": "",
        "secondaryAddress1": null,
        "secondaryAddress2": null,
        "secondaryAddress3": null,
        "secondaryPostcode": null,
        "secondaryCity": null,
        "secondaryState": null,
        "secondaryCountry": null,
        "occupation": "",
        "incomeRange": "",        // DEPRECATED
        "legalName": "",
        "legalNameEmbossed": "",
        "legalRegistrationNumber": "",
        "legalTvaNumber": "",
        "legalRegistrationDate": null,
        "legalForm": "",
        "legalShareCapital": "0",
        "legalSector": "",
        "legalAnnualTurnOver": "",
        "legalNetIncomeRange": "",
        "legalNumberOfEmployeeRange": "",
        "effectiveBeneficiary": "0.00",
        "position": "",
        "personalAssets": "",
        "taxResidence": "", // DEPRECATED
        "taxNumber": "",    // DEPRECATED
        "kycLevel": "2",
        "kycReview": "0",
        "kycReviewComment": "",
        "isFreezed": "0",
        "language": null,
        "specifiedUSPerson": "0",
        "employeeType": "1",
        "entityType": "0",      // DEPRECATED
        "controllingPersonType": "0",
        "activityOutsideEu": null,
        "economicSanctions": null,
        "residentCountriesSanctions": null,
        "involvedSanctions": null,
        "sanctionsQuestionnaireDate": null,
        "timezone": null,
        "occupationType": null, // DEPRECATED
        "isOnStockExchange": null,
        "IsLegalFrozen": "0",
        "sourceOfFunds": null,
        "legalSectorType": null,
        "createdDate": "2026-03-10 15:59:22",
        "modifiedDate": "2026-03-10 15:59:22",
        "codeStatus": "110009",
        "informationStatus": "",
        "sepaCreditorIdentifier": null,
        "walletCount": "1",
        "payinCount": "0",
        "totalRows": "1"
      }
    ]
  },
  "object_id": "100060789",
  "object": "user",
  "webhook_created_at": 17047224279950,
  "webhook_id": "e77663b0-0c4f-49c3-be53-96f39001234",
  "object_payload_signature": "abcDZ6MeUFRIjNoRDMN4KFjNJ0yR2Eok+MFrEq1k2/ho="
}

user.cancel

Notifies the deletion of a User, usually triggered by the /v1/users/{userId} endpoint.

JSON

{
  "webhook": "user.cancel",
  "object_payload": {
    "users": [
      {
        "userId": "123456789",
        "userTypeId": "1",
        "userStatus": "CANCELED",
        "clientId": "12345",
        "userTag": "",
        "parentUserId": null,
        "parentType": null,
        "title": "M",
        "firstname": "Alex",
        "lastname": "OAK",
        "middleNames": "",
        "birthday": "1994-01-01",
        "email": "aoak@example.com",
        "address1": "10 RUE DE LA PAIX",
        "address2": "",
        "address3": "",
        "postcode": "75001",
        "city": "PARIS",
        "state": "",
        "country": "FR",
        "countryName": "France",
        "distributionCountry": null,
        "phone": "+33191605190",
        "mobile": "",
        "nationality": "",
        "nationalityOther": "",
        "placeOfBirth": "",
        "birthCountry": "",
        "secondaryAddress1": null,
        "secondaryAddress2": null,
        "secondaryAddress3": null,
        "secondaryPostcode": null,
        "secondaryCity": null,
        "secondaryState": null,
        "secondaryCountry": null,
        "occupation": "",
        "incomeRange": "",        // DEPRECATED
        "legalName": "",
        "legalNameEmbossed": "",
        "legalRegistrationNumber": "",
        "legalTvaNumber": "",
        "legalRegistrationDate": null,
        "legalForm": "",
        "legalShareCapital": "0",
        "legalSector": "",
        "legalAnnualTurnOver": "",
        "legalNetIncomeRange": "",
        "legalNumberOfEmployeeRange": "",
        "effectiveBeneficiary": "0.00",
        "position": "",
        "personalAssets": "",
        "taxResidence": "", // DEPRECATED
        "taxNumber": "",    // DEPRECATED
        "kycLevel": "2",
        "kycReview": "0",
        "kycReviewComment": "",
        "isFreezed": "0",
        "language": null,
        "specifiedUSPerson": "0",
        "employeeType": "1",
        "entityType": "0",      // DEPRECATED
        "controllingPersonType": "0",
        "activityOutsideEu": null,
        "economicSanctions": null,
        "residentCountriesSanctions": null,
        "involvedSanctions": null,
        "sanctionsQuestionnaireDate": null,
        "timezone": null,
        "occupationType": null, // DEPRECATED
        "isOnStockExchange": null,
        "IsLegalFrozen": "0",
        "sourceOfFunds": null,
        "legalSectorType": null,
        "createdDate": "2026-03-10 15:59:22",
        "modifiedDate": "2026-03-10 15:59:22",
        "codeStatus": "110009",
        "informationStatus": "",
        "sepaCreditorIdentifier": null,
        "walletCount": "1",
        "payinCount": "0",
        "totalRows": "1"
      }
    ]
  },
  "object_id": "100060789",
  "object": "user",
  "webhook_created_at": 17047224279950,
  "webhook_id": "e77663b0-0c4f-49c3-be53-96f39001234",
  "object_payload_signature": "abcDZ6MeUFRIjNoRDMN4KFjNJ0yR2Eok+MFrEq1k2/ho="
}