Appearance
Events
This article lists the Webhooks you may receive when regarding Users.
User events
API – See the Users API Reference for attributes description
The detailed information of the attributes are available in the Users API Reference. Webhooks object_payload is identical to the API object.
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="
}User Relationship events
API – See the User Relationships API Reference for attributes description
The detailed information of the attributes are available in the User Relationships API Reference. Webhooks object_payload is identical to the API object.
user.relationship.create
Notifies the creation of a Relationship, usually triggered by the /v1/users/{targetUserId}/relationships endpoint.
json
{
"webhook": "user.relationship.create",
"object_payload": {
"relationships": [
{
"relationshipId": 990,
"targetUserId": 202,
"sourceUserId": 101,
"relationshipTypeId": 3,
"relationshipTypeName": "EFFECTIVE_BENEFICIARY_SHARES",
"value": "45.75"
}
]
},
"object_id": "990",
"object": "relationship",
"webhook_created_at": "<timestamp>",
"webhook_id": "123",
"object_payload_signature": "XWvC\/4wAhkqIOgHAccHTkZQ73zp7QMBZC5APTU5oZww="
}user.relationship.cancel
Notifies the deletion of a Relationship, usually triggered by the /v1/user/{targetUserId}/relationships/{relationshipId} endpoint.
json
{
"webhook": "user.relationship.cancel",
"object_payload": {
"relationships": [
{
"relationshipId": 990,
"targetUserId": 202,
"sourceUserId": 101,
"relationshipTypeId": 3,
"relationshipTypeName": "EFFECTIVE_BENEFICIARY_SHARES",
"value": "45.75"
}
]
},
"object_id": "990",
"object": "relationship",
"webhook_created_at": "<timestamp>",
"webhook_id": "123",
"object_payload_signature": "XWvC\/4wAhkqIOgHAccHTkZQ73zp7QMBZC5APTU5oZww="
}Tax Residence events
API – See the User Tax Residences API Reference for attributes description
The detailed information of the attributes are available in the User Tax Residences API Reference. Webhooks object_payload is identical to the API object.
taxResidence.create
Notifies the creation of a Tax Residence, usually triggered by the /v1/taxResidences endpoint.
json
{
"webhook": "taxResidence.create",
"object_payload": {
"taxResidences": [
{
"id": 199519,
"userId": 100642533,
"country": "FR",
"taxPayerId": "12345",
"liabilityWaiver": false,
"createdDate": "2026-08-14 09:22:11",
"lastUpdate": "",
"deletedDate": "",
"isDeleted": false
}
]
},
"object_id": "199519",
"object": "taxResidence",
"webhook_created_at": 17914176012345,
"webhook_id": "a3f7c1d0-5b2e-4f89-9c34-e12b56789012",
"object_payload_signature": "XWvC/4wAhkqIOgHAccHTkZQ73zp7QMBZC5APTU5oZww="
}taxResidence.update
Notifies the modification of a Tax Residence, usually triggered by the /v1/taxResidences/{taxResidenceId} endpoint.
json
{
"webhook": "taxResidence.update",
"object_payload": {
"taxResidences": [
{
"id": 199519,
"userId": 100642533,
"country": "FR",
"taxPayerId": "67890",
"liabilityWaiver": false,
"createdDate": "2026-08-14 09:22:11",
"lastUpdate": "2026-09-03 11:45:22",
"deletedDate": "",
"isDeleted": false
}
]
},
"object_id": "199519",
"object": "taxResidence",
"webhook_created_at": 17914180067890,
"webhook_id": "b8e2f4a1-7c3d-4e60-a195-f34c78901234",
"object_payload_signature": "YXmD/5xBilrJPhIAccIUlAR84aq8RNCAD6BQVU6pAxv="
}taxResidence.cancel
Notifies the deletion of a Tax Residence, usually triggered by the /v1/taxResidences/{taxResidenceId} endpoint.
json
{
"webhook": "taxResidence.cancel",
"object_payload": {
"taxResidences": [
{
"id": 199519,
"userId": 100642533,
"country": "FR",
"taxPayerId": "12345",
"liabilityWaiver": false,
"createdDate": "2026-08-14 09:22:11",
"lastUpdate": "2026-09-03 11:45:22",
"deletedDate": "2026-10-08 10:15:33",
"isDeleted": true
}
]
},
"object_id": "199519",
"object": "taxResidence",
"webhook_created_at": 17914184234567,
"webhook_id": "c9d3f5b2-8a4e-4f71-b2c6-f45d89012345",
"object_payload_signature": "ZYnE/6yCjmsKQiJBddJVmBS95br9SODBF7CRWV7qByw="
}