Request
[POST]
https://ingest.dojah.io/api/ingest
[POST]
https://ingest.dojah.io/api/ingest/backfill
Headers
| Header | Type | Description |
|---|---|---|
| Authorization | string | Private/secret key. Use <key> not Bearer <key> |
The
key in the request body is your Ingest key, which is different from your Authorization secret key. You can find your Ingest key in the EasyDetect settings on your dashboard.Request Body Template
Transaction Monitoring - Use cases
Banking
Request body
{
"key": "<your_ingest_key>",
"type":"banking", //banking, payments, onboarding
"event":{
"transaction":{
"id": "87554303-3f75-4883-8fb8-48fce003859f", //unique transaction id
"time": "2022-12-12T12:15:05.391Z", //ISO 8601 format
"amount": 8291,
"currency": "XAF",
"ref": "xaf",
"session_id": "xaf",
"type": "deposit", //debit, credit, transfer, etc.
"channel": "mobile", //online, mobile, atm, branch, pos
"purpose": "salary payment", //bill payment, transfer, airtime, etc.
"source_of_funds": "employment income" //savings, business, investment, etc.
},
"user":{
"user_id":"9931fac0-6bfa-4b3c-842c-7840006d89b6",
"user_type": "individual", //individual, business, government, other
"registration_time": "2022-12-12T12:15:05.392Z",
"email":"erik.miller@buchanan.com",
"name":"Trevor Arias",
"tier": "silver", //basic, silver, gold, platinum
"account_type": "checking", //savings, checking, business, student
"gender": "male", //male, female, other
"balance": 24500.50, //current account balance before transaction
"mobile":"5797454931",
"last_pin_change": "2022-11-01T08:30:00.000Z",
"last_password_change": "2022-10-15T14:22:10.000Z"
},
"receiver":{
"account_name": "John Doe",
"bank_name": "EcoBank",
"account_number": "CM21100375689",
"country": "Cameroon"
},
"sender":{
"account_name": "Anon Doe",
"bank_name": "Paystack TITAN",
"account_number": "NG0567890321",
"country": "Nigeria"
},
"device":{
"type":"mobile",
"os":"Android",
"model":"Pixel 7",
"language":"en-US",
"ip_address":"154.72.170.233",
"device_id":"ff97adb7-8d3d-4f15-94df-87e21e1212de"
},
"address":{
"city":"North Sarah",
"street":"6238 Walker Unions Suite 802",
"country":"Morocco"
},
"meta": [
{"key": "value"}
]
}
}
Payments
Request body
{
"key": "<your_ingest_key>",
"type":"payments",
"event":{
"user":{
"user_id":"9931fac0-6bfa-4b3c-842c-7840006d89b6",
"user_type": "individual", //individual, business, government, other
"registration_time": "2022-12-12T12:15:05.392Z",
"email":"erik.miller@buchanan.com",
"name":"Trevor Arias",
"dob": "1980-01-01", //User's date of birth, YYYY-MM-DD format
"tier": "silver", //basic, silver, gold, platinum
"account_type": "checking", //savings, checking, business, student
"gender": "male", //male, female, other
"balance": 24500.50, //current account balance before transaction
"mobile":"5797454931",
"last_pin_change": "2022-11-01T08:30:00.000Z",
"last_password_change": "2022-10-15T14:22:10.000Z",
"credit_score": "720",
"employer_information": {
"annual_income": "",
"employment_status": "employed",
"employer_name": "Innovate Solutions",
},
"kyc_information": [
{
"id_number": "1234567890",
"id_type": "bvn",
"country": "NG",
},
{
"id_number": "1234567890",
"id_type": "NIN",
"country": "NG",
}
]
},
"transaction":{
"id": "87554303-3f75-4883-8fb8-48fce003859f", //unique transaction id
"time": "2022-12-12T12:15:05.391Z", //ISO 8601 format
"amount": 8291,
"currency": "XAF",
"ref": "xaf",
"session_id": "xaf",
"type": "deposit", //debit, credit, transfer, purchase, refund, withdrawal etc.
"channel": "mobile", //online, mobile, atm, branch, pos
"purpose": "salary payment", //bill payment, transfer, airtime, etc.
"source_of_funds": "employment income" //savings, business, investment, etc.
},
"payment":{
"payment_id": "9931fac0-6bfa-4b3c-842c",
"is_recurring": true, //true or false
"method_type": "card", //card, ussd, transfer etc
"scheme": "Visa",
"card_funding": "debit", //credit or debit
"card_last_four": "9876",
"expiry_month": "10",
"expiry_year": "25",
"is_3ds_enabled": true,
"is_card_present": true,
"cvv_provided": true,
"avs_passed": true,
"name_on_card": "John Buchanan",
"billing_address": {
"city": "North Sarah",
"street": "6238 Walker Unions Suite 802",
"country": "Morocco"
}
},
"merchant": {
"name":"Merchant 1",
"category":"Android",
"country":"Nigeria"
},
"device":{
"type":"mobile",
"os":"Android",
"model":"Pixel 7",
"language":"en-US",
"ip_address":"154.72.170.233",
"device_id":"ff97adb7-8d3d-4f15-94df-87e21e1212de" //fingerprint_id
},
"address":{
"address1": "6238 Walker Unions Suite 802",
"address2": "",
"city": "North Sarah",
"region": "",
"zipcode" : "23401",
"country":"Morocco"
}
}
}
Onboarding
Request body
{
"key": "<your_ingest_key>",
"type":"onboarding",
"event":{
"user":{
"user_id":"9931fac0-6bfa-4b3c-842c-7840006d89b6",
"user_type": "individual", //individual, business, government, other
"registration_time": "2022-12-12T12:15:05.392Z",
"email":"erik.miller@buchanan.com",
"name":"Trevor Arias",
"dob": "1980-01-01", //User's date of birth, YYYY-MM-DD format
"tier": "silver", //basic, silver, gold, platinum
"account_type": "checking", //savings, checking, business, student
"gender": "male", //male, female, other
"balance": 24500.50, //current account balance before transaction
"mobile":"5797454931",
"last_pin_change": "2022-11-01T08:30:00.000Z",
"last_password_change": "2022-10-15T14:22:10.000Z",
"credit_score": "720",
"employer_information": {
"annual_income": "",
"employment_status": "employed",
"employer_name": "Innovate Solutions",
},
"kyc_information": [
{
"id_number": "1234567890",
"id_type": "bvn",
"country": "NG",
},
{
"id_number": "1234567890",
"id_type": "NIN",
"country": "NG",
}
]
},
"device":{
"type":"mobile",
"os":"Android",
"model":"Pixel 7",
"language":"en-US",
"ip_address":"154.72.170.233",
"device_id":"ff97adb7-8d3d-4f15-94df-87e21e1212de" //fingerprint_id
},
"address":{
"address1": "6238 Walker Unions Suite 802",
"address2": "",
"city": "North Sarah",
"region": "",
"zipcode" : "23401",
"country":"Morocco"
}
}
}
Webhook Notification Response
Response
{
event: {
meta: [
{
transaction_id: "Dojah-20231111085937073"
}
],
user: {
name: "Maplerad-Provarex-Acc None",
email: "",
mobile: "None",
user_id: "4ac1bc59-34ad-485a-bda5-eb406a49a411",
registration_time: "1696421468798421"
},
device: {
os: "Android",
type: "mobile",
model: "Pixel 7",
language: "en-US",
device_id: "ff97adb7-8d3d-4f15-94df-87e21e1212de",
ip_address: "154.72.170.233"
},
sender: {
country: "NG",
bank_name: "",
account_name: "Paystack",
account_number: "1017692813"
},
address: {
city: "Lagos",
street: "Ikeja",
country: "Nigeria"
},
receiver: {
country: "NG",
bank_name: "VFD_NEW",
account_name: "",
account_number: "1029283851"
},
transaction: {
id: "Dojah-20231111085937073",
ref: "Dojah-20231111085937073",
time: "1699693180085313",
type: "deposit",
amount: 300,
channel: "transfer",
currency: "NGN",
session_id: "Dojah-20231111085937073"
}
},
score: 30,
decision: {
action: "Allow",
rule_status: false
},
behavioral: {
UnusualTimeTransactions: {
state: true,
description: "User transaction time is outside of normal business hours"
},
AbnormalTransactionVolume: {
state: true,
description: "User has abnormally high transaction volume of 34 within a short period"
}
}
}