4.1.0 • Published 2 years ago

dojah-typescript-sdk v4.1.0

Weekly downloads
-
License
Unlicense
Repository
github
Last release
2 years ago

dojah-typescript-sdk@4.1.0

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

Installing

npm

npm install dojah-typescript-sdk --save

yarn

yarn add dojah-typescript-sdk

Important note: this library can be used in both the client-side or server-side, but using it in client-side browser code is not recommended as you would expose security credentials.

Getting Started

import { Dojah } from "dojah-typescript-sdk";

const dojah = new Dojah({
  // Defining the base path is optional and defaults to https://api.dojah.io
  // basePath: "https://api.dojah.io",
  authorization: "API_KEY",
  appId: "API_KEY",
});

const getScreeningInfoResponse = await dojah.aml.getScreeningInfo({});

console.log(getScreeningInfoResponse);

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
AmlApigetScreeningInfoGET /api/v1/aml/screening/infoGet AML Info
AmlApiscreenAmlPOST /api/v1/aml/screening/platformAML Screening
AuthenticationApigetSenderIdGET /api/v1/messaging/sender_idsMessaging - Get Sender IDs
AuthenticationApigetSmsStatusGET /v1/messaging/sms/get_statusMessaging - Get SMS Status
AuthenticationApirequestSenderIdPOST /api/v1/messaging/sender_idMessaging - Request Sender ID
AuthenticationApisendOtpPOST /api/v1/messaging/otpMessaging - Send OTP
AuthenticationApisendSmsPOST /api/v1/messaging/smsMessaging - Send SMS
AuthenticationApivalidateOtpGET /api/v1/messaging/otp/validateMessaging - Validate OTP
DocumentAnalysisApianalyzeDocumentPOST /api/v1/document/analysisKYC - Document Analysis
FraudApigetEmailReputationGET /api/v1/kyc/emailEmail Reputation
FraudApigetIpReputationGET /api/v1/fraud/ipIP Reputation
FraudApiscreenPhoneGET /api/v1/fraud/phonePhone Screening
FraudApiscreenUserGET /api/v1/fraud/userUser Screening
GhKycApigetDriversLicenseGET /api/v1/gh/kyc/dlDriver\'s License
GhKycApigetPassportGET /api/v1/gh/kyc/passportPassport
GhKycApigetSsnitGET /api/v1/gh/kyc/ssnitSSNIT
GhKycApigetVoterGET /api/v1/gh/kyc/voterVoter ID Lookup
GeneralApigetBanksGET /v1/general/banksGeneral - Get Banks
GeneralApigetBinGET /v1/general/binGeneral Resolve BIN
GeneralApigetNubanGET /api/v1/general/accountGeneral Resolve NUBAN
GlobalKycApicaEkycGET /api/v1/ca/kycCanada Ekyc
GlobalKycApigetUsSsnGET /api/v1/us/kycUS SSN
GlobalKycApiukTwoPlusTwoGET /api/v1/uk/kycUK 2+2
KeKycApigetNationalIdGET /api/v1/ke/kyc/idKYC - National ID
KeKycApigetPassportGET /api/v1/ke/kyc/passportKYC - Passport
KybApibusinessDetailGET /api/v1/kyb/business/detailBusiness Detail
KybApibusinessSearchGET /api/v1/kyb/business/searchBusiness Search
KybApigetCacGET /api/v1/kyc/cacKYC - Get CAC
KybApigetTinGET /api/v1/kyc/tinKYC - Fetch Tin
KycApicheckLivenessPOST /api/v1/ml/livenessLiveness Check
KycApigetAccountsGET /api/v1/kyc/accountsKYC - Fetch Accounts
KycApigetAddressVerificationGET /api/v1/kyc/addressFetch Address Verification Data
KycApigetBvnFromNubanGET /api/v1/kyc/nuban/bvnLookup BVN from NUBAN
KycApigetVinGET /api/v1/kyc/vinKYC - Get VIN
KycApisubmitAddressPOST /api/v1/kyc/addressSubmit Address
MlApiverifyPhotoIdWithSelfiePOST /api/v1/kyc/photoid/verifyKYC - Selfie Photo ID Verification
NigeriaKycApigetBasicBvnGET /api/v1/kyc/bvnKYC - Get Basic BVN Info
NigeriaKycApigetBasicBvn1GET /api/v1/kyc/bvn/basicKYC - Lookup BVN Basic 1
NigeriaKycApigetBasicPhoneNumberGET /api/v1/kyc/phone_number/basicKYC Lookup Phone Number Basic
NigeriaKycApigetDriversLicenseGET /api/v1/kyc/dlKYC - Get Drivers License Info
NigeriaKycApigetNinGET /api/v1/kyc/ninKYC - Get NIN Info
NigeriaKycApigetNormalBvnGET /api/v1/kyc/bvn/fullKYC - Lookup BVN Normal
NigeriaKycApigetNubanGET /api/v1/kyc/nubanKYC - Get NUBAN Information
NigeriaKycApigetPassportGET /api/v1/kyc/passportKYC - Passport
NigeriaKycApigetPhoneNumberGET /api/v1/kyc/phone_numberKYC - Lookup Phone Number
NigeriaKycApigetPremiumBvnGET /api/v1/kyc/bvn/advanceKYC - Lookup BVN Premium
NigeriaKycApigetVninGET /api/v1/kyc/vninLookup VNIN
PurchaseApisendAirtimePOST /v1/purchase/airtimePurchase - Send Airtime
ServicesApigetWalletBalanceGET /api/v1/balanceGet Dojah Wallet Balance
TzKycApigetNinGET /api/v1/tz/kyc/ninLookup TZ NIN
UgKycApigetVoterGET /api/v1/ug/kyc/voterVoters ID
VerificationsApivalidateBvnGET /v1/kyc/bvnKYC - Validate BVN
VerificationsApiverifyAgeGET /v1/kyc/age_verificationKYC - Age Verification
VerificationsApiverifySelfieBvnPOST /v1/kyc/bvn/verifyKYV - Selfie BVN Verificatoin
VerificationsApiverifySelfieNinPOST /api/v1/kyc/nin/verifyKYC - Selfie NIN Verification
VerificationsApiverifySelfieVninPOST /api/v1/kyc/vnin/verifyKYC - Selfie vNIN verification
WebhooksApideleteWebhookDELETE /api/v1/webhook/deleteDelete Webhook
WebhooksApigetWebhooksGET /api/v1/webhook/fetchFetch All Webhooks
WebhooksApinotifyWebhookPOST /api/v1/webhook/notifyPost Hook
WebhooksApisubscribeServicePOST /api/v1/webhook/subscribeSubscribe to service
ZafKycApigetIdGET /api/v1/za/kyc/idKYC - Lookup ID
ZwKycApicheckCreditGET /api/v1/zw/kyc/fcbCredit Check
ZwKycApiverifyIdGET /api/v1/zw/kyc/ninNational ID Verification
4.1.0

2 years ago

4.0.0

2 years ago

3.0.0

2 years ago

2.0.0

2 years ago

1.2.0

2 years ago

1.1.0

2 years ago

1.0.0

2 years ago