Customers
This section describes notifications triggered when a customer is added or modified
Customer Events
EVENT | DESCRIPTION |
---|---|
banking.customer.created | A new customer has been created for your institution |
banking.customer.updated | A modification has been made to a customer's data |
Sample Customer Event Data
{
"id": "01969139-8ad6-70f3-a3dd-b702107cc179",
"event": "banking.customer.created",
"timestamp": 1746193185487,
"data": {
"id": "01969139-7acf-7be0-be00-b9dd32e14f4c",
"type": "BUSINESS",
"email": "[email protected]",
"state": "ACTIVE",
"business": {
"name": "Acme Corporation",
"phone_number": "+12025550179",
"incorporation_number": "BUS12345",
"incorporation_date": "2010-05-20",
"incorporation_country": "US",
"tax_id": "12-3456789",
"business_type": "CORPORATION",
"website": "https://www.acmecorp.com",
"registered_address": {
"line_1": "100 Corporate Way",
"line_2": "Suite 300",
"city": "San Francisco",
"state": "CA",
"postal_code": "94107",
"country": "US"
},
"contact_person": {
"first_name": "Jane",
"last_name": "Smith",
"email": "[email protected]",
"phone_number": "+12025550180",
"position": "Chief Financial Officer"
},
"created_date": "2025-05-02T13:39:45.487Z",
"updated_date": "2025-05-02T13:39:45.487Z",
"institution_id": "019644e9-eb8e-73d9-bedd-839996556e06",
"client_reference": "[email protected]",
"verification_status": "UNVERIFIED"
}
}
}
{
"id": "0196913e-b802-72a9-9162-4c39824644f7",
"event": "banking.customer.created",
"timestamp": 1746193524978,
"data": {
"id": "0196913e-a8f1-7c9e-ae0f-57939d1f36aa",
"type": "INDIVIDUAL",
"email": "[email protected]",
"state": "ACTIVE",
"individual": {
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "2022-02-28",
"residential_address": {
"line_1": "Some address",
"line_2": "",
"city": "Lagos",
"state": "Lagos",
"postal_code": "333443",
"country": "NG"
}
},
"country_data": {
"ng": {
"bvn": "33332232354",
"nin": "77467634657"
},
"created_date": "2025-05-02T13:45:24.977Z",
"updated_date": "2025-05-02T13:45:24.977Z",
"institution_id": "019644e9-eb8e-73d9-bedd-839996556e06",
"client_reference": "[email protected]",
"verification_status": "UNVERIFIED"
}
}
}
Customer Event Schema
Field | Data Type | Description |
---|---|---|
id | string | Unique identifier for the webhook event (UUID format) |
event | string | Type of event see customer events |
timestamp | number | Unix timestamp in milliseconds when the event was generated |
data | object | An object containing the customer data data. See customer schema |
Updated 2 months ago