Dojah.Net 4.1.0

.NET 5.0 .NET Standard 2.0

dotnet add package Dojah.Net --version 4.1.0

NuGet\Install-Package Dojah.Net -Version 4.1.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Dojah.Net" Version="4.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Dojah.Net" Version="4.1.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Dojah.Net" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Dojah.Net --version 4.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Dojah.Net, 4.1.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Dojah.Net@4.1.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Dojah.Net&version=4.1.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Dojah.Net&version=4.1.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Dojah.Net - the C# library for the DOJAH Publilc APIs

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

This C# SDK is automatically generated by the Konfig:

API version: 1.0.0
SDK version: 4.1.0

Frameworks supported

.NET Core >=1.0
.NET Framework >=4.6
Mono/Xamarin >=vNext

Dependencies

RestSharp - 106.13.0 or later
Json.NET - 13.0.1 or later
JsonSubTypes - 1.8.0 or later
System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Dojah.Net.Api;
using Dojah.Net.Client;
using Dojah.Net.Model;

Getting Started

using System;
using System.Collections.Generic;
using System.Diagnostics;
using Dojah.Net.Client;
using Dojah.Net.Model;

namespace Example
{
    public class GetScreeningInfoExample
    {
        public static void Main()
        {

            DojahClient client = new DojahClient();
            // Configure custom BasePath if desired
            client.SetBasePath("https://api.dojah.io");
            // Configure API key authorization: apikeyAuth
            client.SetAuthorization("YOUR_API_KEY");
            // Configure API key authorization: appIdAuth
            client.SetAppId("YOUR_API_KEY");

            var profileId = "WC7117469";  // string |  (optional) 

            try
            {
                // Get AML Info
                Object result = client.AML.GetScreeningInfo(profileId);
                Console.WriteLine(result);
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling AMLApi.GetScreeningInfo: " + e.Message);
                Console.WriteLine("Status Code: "+ e.ErrorCode);
                Console.WriteLine(e.StackTrace);
            }
            catch (ClientException e)
            {
                Console.WriteLine(e.Response.StatusCode);
                Console.WriteLine(e.Response.RawContent);
                Console.WriteLine(e.InnerException);
            }
        }
    }
}

Documentation for 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

Documentation for Models

Product	Compatible and additional computed target framework versions.
.NET	net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- JsonSubTypes (>= 1.9.0)
- Newtonsoft.Json (>= 13.0.1)
- Polly (>= 7.2.3)
- RestSharp (>= 108.0.2)
- System.ComponentModel.Annotations (>= 5.0.0)
net5.0
- JsonSubTypes (>= 1.9.0)
- Newtonsoft.Json (>= 13.0.1)
- Polly (>= 7.2.3)
- RestSharp (>= 108.0.2)
- System.ComponentModel.Annotations (>= 5.0.0)
net7.0
- JsonSubTypes (>= 1.9.0)
- Newtonsoft.Json (>= 13.0.1)
- Polly (>= 7.2.3)
- RestSharp (>= 108.0.2)
- System.ComponentModel.Annotations (>= 5.0.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
4.1.0	232	7/28/2023
4.0.0	175	5/25/2023
3.0.0	264	2/15/2023
2.0.0	290	2/8/2023
1.0.0	300	2/3/2023

Minor update