Subscribe to Service

This endpoint allows you to Subscribe to Dojah's webhook service

Request

{{baseUrl}}api/v1/webhook/subscribe

Header

Parameter

Type

Description

AppId

string

you would need to create an app to get your app ID

Authorization

string

public secret key e.g prod_sk_1T1eSavlZxy02OT3OWlvbxK4G

Body

Body

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]

Response

{
  "entity": "Webhook added successfully"
}
{
    "error": "invalid value for service"
}

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.

Webhook Content

{
  "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"
  }
}
{
  "date_done": 2021-12-22 11:22:11,
  "reason": "",
  "date_submit": "2021-12-22 11:22:11",
  "mobile": "2349131943254",
  "message_id": "dj_9445773f-1811-4e9d-a5db-11a75f62b5ad",
  "type": "sms",
  "sender_id": "Dojah",
  "delivery_status": "DELIVERED"
}
{
  "metadata": {
    "deviceInfo": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:98.0) Gecko/20100101 Firefox/98.0",
    "ipInfo": {
      "status": "success",
      "country": "Nigeria",
      "countryCode": "NG",
      "region": "LA",
      "regionName": "Lagos",
      "city": "Lagos",
      "zip": "",
      "lat": 6.4474,
      "lon": 3.3903,
      "timezone": "Africa/Lagos",
      "isp": "MTN NIGERIA Communication limited",
      "org": "MTN Nigeria",
      "as": "AS29465 MTN NIGERIA Communication limited",
      "query": "102.89.33.XX"
    }
  },
  "data": {
    "index": {
      "data": {},
      "status": true,
      "message": "Successfully continued to the main checks."
    },
    "countries": {
      "data": {
        "country": "Nigeria"
      },
      "status": true,
      "message": "Successfully continued to the next step."
    },
    "phonenumber": {
      "data": {
        "mobile": "+234819999999999"
      },
      "status": true,
      "message": "Successfully continued to the next step."
    },
    "user-data": {
      "status": true,
      "data": {
        "firstName": "JOHN",
        "lastName": "DOE",
        "dob": "1997-12-10"
      },
      "message": ""
    },
    "government-data": {
      "data": {
        "entity": {
          "nin": "12334567899",
          "firstname": "JOHN",
          "middlename": "DOJAH",
          "surname": "DOE",
          "maidenname": "",
          "telephoneno": "0809999999999",
          "state": "Imo",
          "place": "MBUTU",
          "profession": "STUDENT",
          "title": "mr",
          "height": "****",
          "email": "",
          "birthdate": "1997-12-10",
          "birthstate": "Lagos",
          "birthcountry": "nigeria",
          "centralID": "8051646",
          "documentno": "",
          "educationallevel": "",
          "employmentstatus": "",
          "othername": "",
          "pfirstname": "",
          "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDB",
           "pmiddlename": "",
          "psurname": "",
          "nspokenlang": "IGBO",
          "ospokenlang": "ENGLISH",
          "religion": "christianity",
          "residence_Town": "OJO",
          "residence_lga": "Ojo",
          "residence_state": "Lagos",
          "residencestatus": "birth",
          "residence_AddressLine1": "CAMP 5 BLOCK 8 ROOM 7 NIGERIAN ARMY CANTONMENT",
          "residence_AddressLine2": "CAMP 5 BLOCK 8 ROOM 7 NIGERIAN ARMY CANTONMENT",
          "self_origin_lga": "Ojo",
          "self_origin_place": "",
          "self_origin_state": "Lagos",
          "signature": "/9j/4AAQSkZJRgABAQEAlgCWA",
          "nationality": "",
          "gender": "m",
          "trackingId": "S7Y0NYFM1000468",
          "customer": "365eb08f-6a1d-46bc-9aa0-XXXXXXXX"
        }
      },
      "message": "",
      "status": true
    }
  },
  "governmentData": {
    "nin": "1233445566667",
    "firstname": "JOHN",
    "middlename": "DOJAH",
    "surname": "DOE",
    "maidenname": "",
    "telephoneno": "08099999999999",
    "state": "Imo",
    "place": "MBUTU",
    "profession": "STUDENT",
    "title": "mr",
    "height": "****",
    "email": "",
    "birthdate": "1997-12-10",
    "birthstate": "Lagos",
    "birthcountry": "nigeria",
    "centralID": "8051646",
    "documentno": "",
    "educationallevel": "",
    "employmentstatus": "",
    "othername": "",
    "pfirstname": "",
    "photo": "/9j/4AAQSkZJ/2Q==",
    "pmiddlename": "",
    "psurname": "",
    "nspokenlang": "IGBO",
    "ospokenlang": "ENGLISH",
    "religion": "christianity",
    "residence_Town": "OJO",
    "residence_lga": "Ojo",
    "residence_state": "Lagos",
    "residencestatus": "birth",
    "residence_AddressLine1": "XXXXXXXXXXXXXXXXXXXXNTONMENT",
    "residence_AddressLine2": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXONMENT",
    "self_origin_lga": "Ojo",
    "self_origin_place": "",
    "self_origin_state": "Lagos",
    "signature": "/9j/AAQRBRIhMUEGE1FhB",
     "nationality": "",
    "gender": "m",
    "trackingId": "S7Y0NYFM1000468",
    "customer": "365eb08f-XXXXXXXXXXXXXXXXXXX"
  },
  "verificationType": "nin",
  "verificationValue": "12334567899",
  "userDetails": {
    "nin": "12334567899",
    "firstname": "JOHN",
    "middlename": "DOJAH",
    "surname": "DOE",
    "maidenname": "",
    "telephoneno": "08038296941",
    "state": "Imo",
    "place": "MBUTU",
    "profession": "STUDENT",
    "title": "mr",
    "height": "****",
    "email": "",
    "birthdate": "1992-12-30",
    "birthstate": "Lagos",
    "birthcountry": "nigeria",
    "centralID": "8051646",
    "documentno": "",
    "educationallevel": "",
    "employmentstatus": "",
    "othername": "",
    "pfirstname": "",
    "photo": "/9j/4AAQSkZJRgABAgAAAQaTnvQ"
    "pmiddlename": "",
    "psurname": "",
    "nspokenlang": "IGBO",
    "ospokenlang": "ENGLISH",
    "religion": "christianity",
    "residence_Town": "OJO",
    "residence_lga": "Ojo",
    "residence_state": "Lagos",
    "residencestatus": "birth",
    "residence_AddressLine1": "XXXXXXXXXXXX",
    "residence_AddressLine2": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "self_origin_lga": "Ojo",
    "self_origin_place": "",
    "self_origin_state": "Lagos",
    "signature": "/9j/4AAQSkZJRgABAAAQUBAQEBAQEAAAAAAAAAAAEC,
    "gender": "m",
    "trackingId": "XXXXXXXXXXXXXX",
    "customer": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  },
  "idType": "nin",
  "value": "XXXXXXXXXXXXXXXX"
}

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


Whatโ€™s Next
Did this page help you?