Customer created Webhook
This webhook confirms the customer is created based on previously sent Application.
Request
Body - JSON
Parameter | Type | Mandatory | Description |
|---|---|---|---|
applicationId | String | Mandatory | Numeric Identifier of the Application sent for onboarding |
applicationUid | String | Mandatory | String Identifier of of the Application sent for onboarding |
customerId | String | Mandatory | Identifier of the created Customer |
person | object | Non mandatory | Data of the Person in case of Individual Customer |
organisation | object | Non mandatory | Data of the Organisation in case of Business Customer |
Person
Parameter | Type | Mandatory | Description |
|---|---|---|---|
id | string | Mandatory | Identifier, guid |
givenName | string | Mandatory | First name of the Person |
surname | string | Mandatory | Last name of the Person |
middleName | string | Non mandatory | Middle name of the Person if exists |
dateOfBirth | string | Mandatory | Date in format YYYY-MM-DD |
dateOfDeath | string | Non mandatory | Date in format YYYY-MM-DD |
countryOfBirthExtId | string | Mandatory | Identifier from Countries lookup. LookupId = 4 |
countryOfBirth | string | Yes | ISO 2-letters Code of the country |
countryOfBirthName | string | Yes | Name of the country |
string | Mandatory | Email address of the Person | |
phone | string | Mandatory | Mobile phone number of the Person |
genderExtId | int | Mandatory | Identifier from Genders lookup. LookupId = 2 |
gender | string | Mandatory | Name of the Gender |
address | Location | Non mandatory | Residence address of the Person |
Organisation
Parameter | Type | Mandatory | Description |
|---|---|---|---|
legalName | string | Mandatory | Legal name of the Organisation according to registration Documents |
brandName | string | Mandatory | Brand name |
registrationNumber | string | Mandatory | Registration number of the Organisation according to registration Documents |
dateOfIncorporation | string | Mandatory | Date in format YYYY-MM-DD |
countryOfIncorporationExtId | string | Mandatory | Identifier from Countries lookup. LookupId = 4 |
countryOfIncorporation | string | Mandatory | ISO 2-letters Code of the country |
countryOfIncorporationName | string | Yes | Name of the country |
address | Location | Non mandatory | Registration address of the Organisation |
Location - object
Parameter | Type | Mandatory | Description |
|---|---|---|---|
id | string | Yes | Identifier, guid |
country | string | Yes | ISO 2-letters Code of the country |
countryName | string | Yes | Name of the country |
countryExtId | int | Yes | Identifier from Countries lookup, Id = 4 |
state | string | No | State for Countries where applicable |
city | string | Yes | City name |
street | string | Yes | Street name |
building | string | Yes | Building name/number |
postCode | string | Yes | Postcode |