README

Use Dojah to verify, onboard and manage user identity across Africa!

Installation & Usage

Requirements

This library requires PHP ^8.0

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/dojah-inc/dojah-php-sdk.git"
    }
  ],
  "require": {
    "konfig/dojah-php-sdk": "4.1.0"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/dojah-php-sdk/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$dojah = new \Dojah\Client(
    Authorization: "AUTHORIZATION",
    AppId: "APP_ID",
);

$profile_id = "WC7117469";

try {
    $result = $dojah->aML->getScreeningInfo(
        profile_id: $profile_id
    );
} catch (\Exception $e) {
    echo 'Exception when calling AMLApi->getScreeningInfo: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.dojah.io

Class	Method	HTTP request	Description
AMLApi	getScreeningInfo	GET /api/v1/aml/screening/info	Get AML Info
AMLApi	screenAml	POST /api/v1/aml/screening/platform	AML Screening
AuthenticationApi	getSenderId	GET /api/v1/messaging/sender_ids	Messaging - Get Sender IDs
AuthenticationApi	getSmsStatus	GET /v1/messaging/sms/get_status	Messaging - Get SMS Status
AuthenticationApi	requestSenderId	POST /api/v1/messaging/sender_id	Messaging - Request Sender ID
AuthenticationApi	sendOtp	POST /api/v1/messaging/otp	Messaging - Send OTP
AuthenticationApi	sendSms	POST /api/v1/messaging/sms	Messaging - Send SMS
AuthenticationApi	validateOtp	GET /api/v1/messaging/otp/validate	Messaging - Validate OTP
DocumentAnalysisApi	analyzeDocument	POST /api/v1/document/analysis	KYC - Document Analysis
FraudApi	getEmailReputation	GET /api/v1/kyc/email	Email Reputation
FraudApi	getIpReputation	GET /api/v1/fraud/ip	IP Reputation
FraudApi	screenPhone	GET /api/v1/fraud/phone	Phone Screening
FraudApi	screenUser	GET /api/v1/fraud/user	User Screening
GhKycApi	getDriversLicense	GET /api/v1/gh/kyc/dl	Driver's License
GhKycApi	getPassport	GET /api/v1/gh/kyc/passport	Passport
GhKycApi	getSsnit	GET /api/v1/gh/kyc/ssnit	SSNIT
GhKycApi	getVoter	GET /api/v1/gh/kyc/voter	Voter ID Lookup
GeneralApi	getBanks	GET /v1/general/banks	General - Get Banks
GeneralApi	getBin	GET /v1/general/bin	General Resolve BIN
GeneralApi	getNuban	GET /api/v1/general/account	General Resolve NUBAN
GlobalKycApi	caEkyc	GET /api/v1/ca/kyc	Canada Ekyc
GlobalKycApi	getUsSsn	GET /api/v1/us/kyc	US SSN
GlobalKycApi	ukTwoPlusTwo	GET /api/v1/uk/kyc	UK 2+2
KeKycApi	getNationalId	GET /api/v1/ke/kyc/id	KYC - National ID
KeKycApi	getPassport	GET /api/v1/ke/kyc/passport	KYC - Passport
KYBApi	businessDetail	GET /api/v1/kyb/business/detail	Business Detail
KYBApi	businessSearch	GET /api/v1/kyb/business/search	Business Search
KYBApi	getCac	GET /api/v1/kyc/cac	KYC - Get CAC
KYBApi	getTin	GET /api/v1/kyc/tin	KYC - Fetch Tin
KYCApi	checkLiveness	POST /api/v1/ml/liveness	Liveness Check
KYCApi	getAccounts	GET /api/v1/kyc/accounts	KYC - Fetch Accounts
KYCApi	getAddressVerification	GET /api/v1/kyc/address	Fetch Address Verification Data
KYCApi	getBvnFromNuban	GET /api/v1/kyc/nuban/bvn	Lookup BVN from NUBAN
KYCApi	getVin	GET /api/v1/kyc/vin	KYC - Get VIN
KYCApi	submitAddress	POST /api/v1/kyc/address	Submit Address
MLApi	verifyPhotoIdWithSelfie	POST /api/v1/kyc/photoid/verify	KYC - Selfie Photo ID Verification
NigeriaKycApi	getBasicBvn	GET /api/v1/kyc/bvn	KYC - Get Basic BVN Info
NigeriaKycApi	getBasicBvn1	GET /api/v1/kyc/bvn/basic	KYC - Lookup BVN Basic 1
NigeriaKycApi	getBasicPhoneNumber	GET /api/v1/kyc/phone_number/basic	KYC Lookup Phone Number Basic
NigeriaKycApi	getDriversLicense	GET /api/v1/kyc/dl	KYC - Get Drivers License Info
NigeriaKycApi	getNin	GET /api/v1/kyc/nin	KYC - Get NIN Info
NigeriaKycApi	getNormalBvn	GET /api/v1/kyc/bvn/full	KYC - Lookup BVN Normal
NigeriaKycApi	getNuban	GET /api/v1/kyc/nuban	KYC - Get NUBAN Information
NigeriaKycApi	getPassport	GET /api/v1/kyc/passport	KYC - Passport
NigeriaKycApi	getPhoneNumber	GET /api/v1/kyc/phone_number	KYC - Lookup Phone Number
NigeriaKycApi	getPremiumBvn	GET /api/v1/kyc/bvn/advance	KYC - Lookup BVN Premium
NigeriaKycApi	getVnin	GET /api/v1/kyc/vnin	Lookup VNIN
PurchaseApi	sendAirtime	POST /v1/purchase/airtime	Purchase - Send Airtime
ServicesApi	getWalletBalance	GET /api/v1/balance	Get Dojah Wallet Balance
TzKycApi	getNin	GET /api/v1/tz/kyc/nin	Lookup TZ NIN
UgKycApi	getVoter	GET /api/v1/ug/kyc/voter	Voters ID
VerificationsApi	validateBvn	GET /v1/kyc/bvn	KYC - Validate BVN
VerificationsApi	verifyAge	GET /v1/kyc/age_verification	KYC - Age Verification
VerificationsApi	verifySelfieBvn	POST /v1/kyc/bvn/verify	KYV - Selfie BVN Verificatoin
VerificationsApi	verifySelfieNin	POST /api/v1/kyc/nin/verify	KYC - Selfie NIN Verification
VerificationsApi	verifySelfieVnin	POST /api/v1/kyc/vnin/verify	KYC - Selfie vNIN verification
WebHooksApi	deleteWebhook	DELETE /api/v1/webhook/delete	Delete Webhook
WebHooksApi	getWebhooks	GET /api/v1/webhook/fetch	Fetch All Webhooks
WebHooksApi	notifyWebhook	POST /api/v1/webhook/notify	Post Hook
WebHooksApi	subscribeService	POST /api/v1/webhook/subscribe	Subscribe to service
ZafKycApi	getId	GET /api/v1/za/kyc/id	KYC - Lookup ID
ZwKycApi	checkCredit	GET /api/v1/zw/kyc/fcb	Credit Check
ZwKycApi	verifyId	GET /api/v1/zw/kyc/nin	National ID Verification

Models

Author

This PHP package is automatically generated by Konfig:

konfig / dojah-php-sdk

Maintainers

Details