Webhooks
Subscribe to Service
Webhooks
Subscribe to Service
Dojah uses webhooks to let your application know when events happen, such as receiving an SMS message. When the event occurs, Dojah makes an HTTP request (usually a POST or a GET) to the URL you configured for the webhook. Dojah’s request will include details of the event such as the service type and Webhook Url. Dojah’s Webhook services allow you to subscribe for webhooks, Fetch all Webhooks subscription, and Delete a Webhook service.
This endpoint allows you to Subscribe to Dojah’s webhook service
Request
[POST]
{{baseUrl}}api/v1/webhook/subscribe
Headers
| Parameter | Type | Description |
|---|---|---|
| AppId | string | you would need to create an app to get your app ID |
| Authorization | string | private secret key e.g prod_sk_1T1eSavlZxy02OT3OWlvbxK4G |
Body Params
| Key | Type | Description |
|---|---|---|
| webhook | string | webhook is the webhook url that allows Dojah to send (i.e “push”) data to your application as soon as an event occurs, Create a Test webhook url on webhook.site. Example https://webhook.site/db8ad2b6-91b6-485b-9761-e546b540ccf6 |
| service | string | Type of services [ sms, ngn_wallet, kyc_widget, address, , AML Monitoring]] |
Response
Response
{
"entity": "Webhook added successfully"
}
An active webhook allows Dojah to send (i.e “push”) data to your application as soon as an event occurs.
Below is the Sample Data that will be sent to your application.
Verification Status.
These are possible verification status : Ongoing, Completed, Pending, Failed
The Sample response data after successful verification
KYC Widget notification
kyc_widget
{
aml: {
status: false
},
data: {
id: {
data: {
id_url: "https://images.dojah.io/id_sample_id_1720624047.jpg",
id_data: {
extras: "",
last_name: "John",
first_name: "Doe",
mrz_status: "",
date_issued: "2019-01-01",
expiry_date: "2020-01-01",
middle_name: "",
nationality: "Nigerian",
date_of_birth: "1990-01-01",
document_type: "National ID",
document_number: "123456789"
},
back_url: "https://images.dojah.io/id_sample_id_1720624047.jpg"
},
status: true,
message: "Successfully verified your id"
},
email: {
data: {
email: "abc@gmail.com"
},
status: true,
message: "abc@gmail.com validation Successful"
},
index: {
data: {},
status: true,
message: "Successfully continued to the main checks."
},
selfie: {
data: {
selfie_url: "https://images.dojah.io/selfie_sample_image_1720624219.jpg"
},
status: true,
message: "Successfully validated your liveness"
},
countries: {
data: {
country: "Nigeria"
},
status: true,
message: "Successfully continued to the next step."
},
user_data: {
data: {
dob: "1990-12-03",
last_name: "John",
first_name: "Doe"
},
status: true,
message: ""
},
business_id: {
image_url: "https://images.dojah.io/selfie_sample_image_1720624219.jpg",
business_name: "ABC Company LIMITED",
business_type: "Business",
business_number: "1237654",
business_address: "",
registration_date: ""
},
phone_number: {
data: {
phone: "234810123456"
},
status: true,
message: "2348103817187 validation Successful"
},
business_data: {
business_name: null,
business_type: "BN",
business_number: null,
business_address: null,
registration_date: null
},
government_data: {
data: {
bvn: {
entity: {
bvn: "222222222222",
nin: "",
email: "",
title: "",
gender: "Male",
customer: "6bb82c41-e15e-4308-b99d-e9640818eca9",
image_url: "https://images.dojah.io/id_John_Doe_1720615487.jpg",
last_name: "John",
first_name: "Doe",
middle_name: "Anon",
nationality: "",
name_on_card: "",
watch_listed: "",
date_of_birth: "01-Jun-1982",
lga_of_origin: "",
phone_number1: "08011111111",
phone_number2: "",
marital_status: "",
enrollment_bank: "",
state_of_origin: "",
level_of_account: "",
lga_of_residence: "",
enrollment_branch: "",
registration_date: "",
state_of_residence: "",
residential_address: ""
}
},
nin: {
entity: {
nin: "1234567891",
firstname: "John",
middlename: "Doe",
surname: "Anon",
maidenname: "",
telephoneno: "0901234567",
state: "",
place: "",
profession: "ZOOLOGY",
title: "",
height: "167",
email: "",
birthdate: "1960-01-01",
birthstate: "",
birthcountry: "Not Available",
centralID: "",
documentno: "",
educationallevel: "tertiary",
employmentstatus: "unemployed",
othername: "",
pfirstname: "",
pmiddlename: "",
psurname: "",
nspokenlang: "YORUBA",
ospokenlang: "",
religion: "christianity",
residence_Town: "",
residence_lga: "Alimosho",
residence_state: "Lagos",
residencestatus: "birth",
residence_AddressLine1: "No 2 Anon house, John does estate, Lagos state, Nigeria",
residence_AddressLine2: "",
self_origin_lga: "",
self_origin_place: "",
self_origin_state: "",
signature: null,
nationality: null,
gender: "Female",
trackingId: "",
customer: "1234444y373737373737373737",
image_url: "https://images.dojah.io/id_SANDBOX_1721830110.jpg"
}
}
},
status: true,
message: ""
},
additional_document: [
{
document_url: "https://dojah-image.s3.amazonaws.com/66bcc73a4ff8e1003100454212aec768-3344-4df5-88f6-7e723c46cbb0.jpeg",
document_type: "image"
}
]
},
value: "123456",
id_url: "https://images.dojah.io/id_sample_id_1720624047.jpg",
status: true,
id_type: "BVN",
message: "Successfully completed the verification.",
back_url: "https://images.dojah.io/id_sample_id_1720624047.jpg",
metadata: {
ipinfo: {
as: "AS29465 MTN NIGERIA Communication limited",
isp: "MTN NIGERIA Communication limited",
lat: 6.4474,
lon: 3.3903,
org: "MTN Nigeria",
zip: "",
city: "Lagos",
proxy: false,
query: "102.89.34.49",
mobile: true,
status: "success",
country: "Nigeria",
hosting: true,
district: "",
timezone: "Africa/Lagos",
region_name: "Lagos"
},
device_info: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36"
},
selfie_url: "https://images.dojah.io/selfie_sample_image_1720624219.jpg",
reference_id: "DJ-31038041E0",
verification_url: "https://app.dojah.io/verifications/bio-data/49fd74a4-8181-4ce8-a87a-0e63f7159257",
verification_mode: "LIVENESS",
verification_type: "RC-NUMBER",
verification_value: "123456",
verification_status: "Completed"
}
Wallet Service notification
wallet
{
"event": "deposit",
"status": "COMPLETED",
"environment": "production",
"data": {
"wallet_id": "e10xxxxx-xxxx-xxxxx-a26e-xxxxxxxx",
"transaction_id": "Dojah-20220103060847147",
"transaction_remarks": "deposit",
"event_type": "wallet:event:inter",
"transaction_date": "2022-01-18 13:34:45.992363+00:00"
}
}
Address verification notification
address verification
{
"entity": {
"status":"pending",
"reference_id": "69e10264-4b90-64fe-b4b7-c9dddafd0241",
"data": {
"applicant": {
"first_name": "John",
"last_name": "Doe",
"phone": "08012345678",
"middle_name": "Kabiru",
"photo": "",
"gender": "Male",
"dob": "17/01/1988"
},
"location": "7.081273, 8.232523",
"photos": [
""
],
"neighbor": {
"name": "Anon John",
"comment": "Very friendly",
"phone": "08056781234"
},
"city": "oshodi",
"street": "270 Murtala Muhammed Way, Alagomeji. Yaba",
"lga": "lagos mainland",
"state": "Lagos",
"country": "Nigeria",
"comments": ""
}
}
}
The webhook content description
| content | Type | Description |
|---|---|---|
| environment | string | environment values are production, sandbox |
| status | string | Event status values are COMPLETED, PENDING, FAILED |
| event | string | event values are deposit, transfer |
| event_type | string | event_type values are “wallet:event:inter”, “wallet:event:intra” |
📘
How to recieve kyc_widget webhook notification
Set In Config object Kindly set webhook object value to true (Boolean)
Example : webhook : true
Subscribe to Service on Dojah Dashboard here
Click on Subscribe Button
Fill in the Webhook details
Was this page helpful?