Project description

dojah-python-sdk@4.1.0

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

Requirements

Python >=3.7

Installing

pip install dojah-python-sdk==4.1.0

Getting Started

from pprint import pprint
from dojah_client import Dojah, ApiException

dojah = Dojah(
    # Defining the host is optional and defaults to https://api.dojah.io
    # See configuration.py for a list of all supported configuration parameters.
    host="https://api.dojah.io",
    # Configure API key authorization: apikeyAuth
    authorization="YOUR_API_KEY",
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_key_prefix = {'apikeyAuth': 'Bearer'},
    # Configure API key authorization: appIdAuth
    app_id="YOUR_API_KEY",
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_key_prefix = {'appIdAuth': 'Bearer'},
)

try:
    # Get AML Info
    get_screening_info_response = dojah.aml.get_screening_info(
        profile_id="WC7117469",  # optional
    )
    pprint(get_screening_info_response.headers)
    pprint(get_screening_info_response.status)
    pprint(get_screening_info_response.round_trip_time)
except ApiException as e:
    print("Exception when calling AMLApi.get_screening_info: %s\n" % e)
    pprint(e.body)
    pprint(e.headers)
    pprint(e.status)
    pprint(e.reason)
    pprint(e.round_trip_time)

Async

async support is available by prepending a to any method.

import asyncio
from pprint import pprint
from dojah_client import Dojah, ApiException

dojah = Dojah(
    # Defining the host is optional and defaults to https://api.dojah.io
    # See configuration.py for a list of all supported configuration parameters.
    host="https://api.dojah.io",
    # Configure API key authorization: apikeyAuth
    authorization="YOUR_API_KEY",
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_key_prefix = {'apikeyAuth': 'Bearer'},
    # Configure API key authorization: appIdAuth
    app_id="YOUR_API_KEY",
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_key_prefix = {'appIdAuth': 'Bearer'},
)


async def main():
    try:
        # Get AML Info
        get_screening_info_response = await dojah.aml.aget_screening_info(
            profile_id="WC7117469",  # optional
        )
        pprint(get_screening_info_response.headers)
        pprint(get_screening_info_response.status)
        pprint(get_screening_info_response.round_trip_time)
    except ApiException as e:
        print("Exception when calling AMLApi.get_screening_info: %s\n" % e)
        pprint(e.body)
        pprint(e.headers)
        pprint(e.status)
        pprint(e.reason)
        pprint(e.round_trip_time)


asyncio.run(main())

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AMLApi	get_screening_info	GET /api/v1/aml/screening/info	Get AML Info
AMLApi	screen_aml	POST /api/v1/aml/screening/platform	AML Screening
AuthenticationApi	get_sender_id	GET /api/v1/messaging/sender_ids	Messaging - Get Sender IDs
AuthenticationApi	get_sms_status	GET /v1/messaging/sms/get_status	Messaging - Get SMS Status
AuthenticationApi	request_sender_id	POST /api/v1/messaging/sender_id	Messaging - Request Sender ID
AuthenticationApi	send_otp	POST /api/v1/messaging/otp	Messaging - Send OTP
AuthenticationApi	send_sms	POST /api/v1/messaging/sms	Messaging - Send SMS
AuthenticationApi	validate_otp	GET /api/v1/messaging/otp/validate	Messaging - Validate OTP
DocumentAnalysisApi	analyze_document	POST /api/v1/document/analysis	KYC - Document Analysis
FraudApi	get_email_reputation	GET /api/v1/kyc/email	Email Reputation
FraudApi	get_ip_reputation	GET /api/v1/fraud/ip	IP Reputation
FraudApi	screen_phone	GET /api/v1/fraud/phone	Phone Screening
FraudApi	screen_user	GET /api/v1/fraud/user	User Screening
GHKYCApi	get_drivers_license	GET /api/v1/gh/kyc/dl	Driver's License
GHKYCApi	get_passport	GET /api/v1/gh/kyc/passport	Passport
GHKYCApi	get_ssnit	GET /api/v1/gh/kyc/ssnit	SSNIT
GHKYCApi	get_voter	GET /api/v1/gh/kyc/voter	Voter ID Lookup
GeneralApi	get_banks	GET /v1/general/banks	General - Get Banks
GeneralApi	get_bin	GET /v1/general/bin	General Resolve BIN
GeneralApi	get_nuban	GET /api/v1/general/account	General Resolve NUBAN
GlobalKYCApi	ca_ekyc	GET /api/v1/ca/kyc	Canada Ekyc
GlobalKYCApi	get_us_ssn	GET /api/v1/us/kyc	US SSN
GlobalKYCApi	uk_two_plus_two	GET /api/v1/uk/kyc	UK 2+2
KEKYCApi	get_national_id	GET /api/v1/ke/kyc/id	KYC - National ID
KEKYCApi	get_passport	GET /api/v1/ke/kyc/passport	KYC - Passport
KYBApi	business_detail	GET /api/v1/kyb/business/detail	Business Detail
KYBApi	business_search	GET /api/v1/kyb/business/search	Business Search
KYBApi	get_cac	GET /api/v1/kyc/cac	KYC - Get CAC
KYBApi	get_tin	GET /api/v1/kyc/tin	KYC - Fetch Tin
KYCApi	check_liveness	POST /api/v1/ml/liveness	Liveness Check
KYCApi	get_accounts	GET /api/v1/kyc/accounts	KYC - Fetch Accounts
KYCApi	get_address_verification	GET /api/v1/kyc/address	Fetch Address Verification Data
KYCApi	get_bvn_from_nuban	GET /api/v1/kyc/nuban/bvn	Lookup BVN from NUBAN
KYCApi	get_vin	GET /api/v1/kyc/vin	KYC - Get VIN
KYCApi	submit_address	POST /api/v1/kyc/address	Submit Address
MLApi	verify_photo_id_with_selfie	POST /api/v1/kyc/photoid/verify	KYC - Selfie Photo ID Verification
NigeriaKYCApi	get_basic_bvn	GET /api/v1/kyc/bvn	KYC - Get Basic BVN Info
NigeriaKYCApi	get_basic_bvn1	GET /api/v1/kyc/bvn/basic	KYC - Lookup BVN Basic 1
NigeriaKYCApi	get_basic_phone_number	GET /api/v1/kyc/phone_number/basic	KYC Lookup Phone Number Basic
NigeriaKYCApi	get_drivers_license	GET /api/v1/kyc/dl	KYC - Get Drivers License Info
NigeriaKYCApi	get_nin	GET /api/v1/kyc/nin	KYC - Get NIN Info
NigeriaKYCApi	get_normal_bvn	GET /api/v1/kyc/bvn/full	KYC - Lookup BVN Normal
NigeriaKYCApi	get_nuban	GET /api/v1/kyc/nuban	KYC - Get NUBAN Information
NigeriaKYCApi	get_passport	GET /api/v1/kyc/passport	KYC - Passport
NigeriaKYCApi	get_phone_number	GET /api/v1/kyc/phone_number	KYC - Lookup Phone Number
NigeriaKYCApi	get_premium_bvn	GET /api/v1/kyc/bvn/advance	KYC - Lookup BVN Premium
NigeriaKYCApi	get_vnin	GET /api/v1/kyc/vnin	Lookup VNIN
PurchaseApi	send_airtime	POST /v1/purchase/airtime	Purchase - Send Airtime
ServicesApi	get_wallet_balance	GET /api/v1/balance	Get Dojah Wallet Balance
TZKYCApi	get_nin	GET /api/v1/tz/kyc/nin	Lookup TZ NIN
UGKYCApi	get_voter	GET /api/v1/ug/kyc/voter	Voters ID
VerificationsApi	validate_bvn	GET /v1/kyc/bvn	KYC - Validate BVN
VerificationsApi	verify_age	GET /v1/kyc/age_verification	KYC - Age Verification
VerificationsApi	verify_selfie_bvn	POST /v1/kyc/bvn/verify	KYV - Selfie BVN Verificatoin
VerificationsApi	verify_selfie_nin	POST /api/v1/kyc/nin/verify	KYC - Selfie NIN Verification
VerificationsApi	verify_selfie_vnin	POST /api/v1/kyc/vnin/verify	KYC - Selfie vNIN verification
WebHooksApi	delete_webhook	DELETE /api/v1/webhook/delete	Delete Webhook
WebHooksApi	get_webhooks	GET /api/v1/webhook/fetch	Fetch All Webhooks
WebHooksApi	notify_webhook	POST /api/v1/webhook/notify	Post Hook
WebHooksApi	subscribe_service	POST /api/v1/webhook/subscribe	Subscribe to service
ZAFKYCApi	get_id	GET /api/v1/za/kyc/id	KYC - Lookup ID
ZWKYCApi	check_credit	GET /api/v1/zw/kyc/fcb	Credit Check
ZWKYCApi	verify_id	GET /api/v1/zw/kyc/nin	National ID Verification

Documentation For Models

Author

This Python package is automatically generated by Konfig

Project details

These details have not been verified by PyPI

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Release history Release notifications | RSS feed

This version

4.1.0

Jul 28, 2023

4.0.0

May 25, 2023

3.0.0

Feb 15, 2023

2.0.0

Feb 8, 2023

1.0.0

Feb 3, 2023

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dojah_python_sdk-4.1.0.tar.gz (200.0 kB view hashes)

Uploaded Jul 28, 2023 Source

Built Distribution

dojah_python_sdk-4.1.0-py3-none-any.whl (912.6 kB view hashes)

Uploaded Jul 28, 2023 Python 3

Hashes for dojah_python_sdk-4.1.0.tar.gz

Hashes for dojah_python_sdk-4.1.0.tar.gz
Algorithm	Hash digest
SHA256	`0b3e09427530ecdc181a131af1560cbfe90b6119ea9c08513cfd1bc95c277700`
MD5	`20fb4947eeded204094695b597c24624`
BLAKE2b-256	`575c2c37a157a403a70b4490fdf65a9ec035bad69697352419273813dbd3f8bb`

Hashes for dojah_python_sdk-4.1.0-py3-none-any.whl

Hashes for dojah_python_sdk-4.1.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`dadfa777f4f614bfed1dd490f99fa4fc99021b4cffc2ef7dad4223a113ee9aa8`
MD5	`428f9fd466ffe4dc390e15140e8bc212`
BLAKE2b-256	`b4f22f18467284d39560fb7a4e8b921e313e149e0d2d24df4e7470e86c94fa63`