DOJAH APIs
Project description
dojah-python-sdk
Use Dojah to verify, onboard and manage user identity across Africa!
This Python package is automatically generated by the Konfig:
- API version: 1.0.0
- Package version: 3.0.0
Requirements.
Python >=3.6
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install dojah-python-sdk==3.0.0
(you may need to run pip
with root permission: sudo pip install dojah-python-sdk==3.0.0
)
Then import the package:
import dojah_client
Getting Started
Please follow the installation procedure and then run the following:
import time
import dojah_client
from pprint import pprint
from dojah_client.api import aml_api
from dojah_client.model.get_screening_info_response import GetScreeningInfoResponse
from dojah_client.model.screen_aml_request import ScreenAmlRequest
from dojah_client.model.screen_aml_response import ScreenAmlResponse
# Configure base path by assigning "server_index"
# configuration.server_index = 0 # https://api.dojah.io
# configuration.server_index = 1 # https://sandbox.dojah.io
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: apikeyAuth
configuration = dojah_client.Configuration(
api_key={'apikeyAuth': 'YOUR_API_KEY'},
# 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'
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikeyAuth'] = 'Bearer'
# Configure API key authorization: appIdAuth
configuration.api_key['appIdAuth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['appIdAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with dojah_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = aml_api.AMLApi(api_client)
reference_id = "c574a3c8-dc27-4013-8bbc-462e7ed87d55" # str | (optional)
try:
# Get AML Info
api_response = api_instance.get_screening_info(reference_id=reference_id)
pprint(api_response)
except dojah_client.ApiException as e:
print("Exception when calling AMLApi->get_screening_info: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.dojah.io
Class | Method | HTTP request | Description |
---|---|---|---|
AMLApi | get_screening_info | GET /v1/aml/screening/info | Get AML Info |
AMLApi | screen_aml | POST /api/v1/aml/screening | 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 /v1/messaging/otp | Messaging - Send OTP |
AuthenticationApi | send_sms | POST /api/v1/messaging/sms | Messaging - Send SMS |
AuthenticationApi | validate_otp | GET /v1/messaging/otp/validate | Messaging - Validate OTP |
FinancialApi | collect_status_from_pdf | POST /api/v1/financial/transactions/pdf | Collect Status via PDF Statement |
FinancialApi | collect_transactions | POST /v1/financial/transactions | Collect Transactions |
FinancialApi | get_account | GET /api/v1/financial/account_information | Get Account Information |
FinancialApi | get_account_analysis | GET /api/v1/financial/analysis | Get Account Analysis |
FinancialApi | get_account_subscriptions | GET /v1/financial/account_subscription | Get Account Subscriptions |
FinancialApi | get_account_transactions | GET /api/v1/financial/account_transactions | Get Account Transactions |
FinancialApi | get_basic_bvn | GET /v1/financial/bvn_information/basic | Get BVN Information Basic |
FinancialApi | get_earning_structure | GET /v1/financial/earning_structure | Get Earning Structure |
FinancialApi | get_full_bvn | GET /v1/financial/bvn_information/full | Get BVN Information Full |
FinancialApi | get_spending_pattern | GET /v1/financial/spending_pattern | Get Spending Pattern |
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 |
GeneralApi | get_banks | GET /v1/general/banks | General - Get Banks |
GeneralApi | get_bin | GET /v1/general/bin | General Resolve BIN |
GeneralApi | get_data_plans | GET /v1/purchase/data/plans | Purchase - Get Data Plans |
GeneralApi | get_nuban | GET /v1/general/account | General Resolve NUBAN |
GeneralApi | get_wallet_balance | GET /api/v1/balance | Get Dojah Wallet Balance |
GeneralApi | purchase_airtime | POST /v1/purchase/airtime | Purchase - Send Airtime |
GeneralApi | purchase_data | POST /v1/purchase/data | Purchase - Buy Data |
KEKYCApi | get_national_id | GET /api/v1/ke/kyc/id | KYC - National ID |
KYBApi | get_advanced_cac | GET /v1/kyc/cac/advance | KYC - Get CAC Advanced |
KYBApi | get_basic_cac | GET /v1/kyc/cac/basic | KYB - Get CAC 2 |
KYBApi | get_cac | GET /v1/kyc/cac | KYC - Get CAC |
KYBApi | get_tin | GET /v1/kyc/tin | KYC - Fetch Tin |
KYCApi | analyze_document | POST /api/v1/document/analysis | KYC - Document Analysis |
KYCApi | get_basic_bvn | GET /api/v1/kyc/bvn/basic | KYC - Get Basic BVN Info |
KYCApi | get_basic_phone_number | GET /v1/kyc/phone_number/basic | KYC Lookup Phone Number Basic |
KYCApi | get_drivers_license | GET /api/v1/kyc/dl | KYC - Get Drivers License Info |
KYCApi | get_email_reputation | GET /v1/kyc/email | KYC - Get Email Reputation |
KYCApi | get_full_bvn | GET /api/v1/kyc/bvn/full | KYC - Lookup BVN Basic |
KYCApi | get_nuban | GET /api/v1/kyc/nuban | KYC - Get NUBAN Information |
KYCApi | get_passport | GET /api/v1/kyc/passport | KYC - Passport |
KYCApi | get_phone_number | GET /api/v1/kyc/phone_number | KYC - Lookup Phone Number |
KYCApi | get_premium_bvn | GET /api/v1/kyc/bvn/advance | KYC - Lookup BVN Premium |
KYCApi | get_vin | GET /api/v1/kyc/vin | KYC - Get VIN |
KYCApi | get_vnin | GET /api/v1/kyc/vnin | Lookup VNIN |
KYCApi | validate_bvn | GET /api/v1/kyc/bvn | KYC - Validate BVN |
KYCApi | verify_age | GET /v1/kyc/age_verification | KYC - Age Verification |
KYCApi | verify_selfie_bvn | POST /v1/kyc/bvn/verify | KYC - Selfie BVN Verificatoin |
KYCApi | verify_selfie_nin | POST /v1/kyc/nin/verify | KYC - Selfie NIN Verification |
MLApi | get_document_analysis | POST /v1/document/analysis/dl | Document Analysis Drivers License |
MLApi | get_generic_ocr_text | POST /v1/ml/ocr/generic | Generic OCR Service |
MLApi | get_ocr_text | POST /v1/ml/ocr | BVN Ocr |
MLApi | verify_photo_id_with_selfie | POST /v1/kyc/photoid/verify | KYC - Selfie Photo ID Verification |
ServicesApi | categorize_transactions | POST /v1/ml/categorize_transaction | Categorize Transactions |
UGKYCApi | get_voter | GET /api/v1/ug/kyc/voter | Voters ID |
WalletApi | create_wallet | POST /v1/wallet/ngn/create | Create NGN Wallet |
WalletApi | credit_subwallet | POST /v1/wallet/ngn/credit | Credit Sub-wallet |
WalletApi | get_transaction | GET /v1/wallet/ngn/transaction | Retrieve Transaction Details |
WalletApi | get_wallet | GET /v1/wallet/ngn/retrieve | Retrieve Wallet Details |
WalletApi | get_wallets | GET /v1/wallet/ngn/accounts | Get Wallets |
WalletApi | transfer_funds | POST /v1/wallet/ngn/transfer | Transfer Funds |
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 |
Documentation For Models
- AnalyzeDocumentResponse
- AnalyzeDocumentResponseEntity
- AnalyzeDocumentResponseEntityDocumentImages
- AnalyzeDocumentResponseEntityDocumentType
- AnalyzeDocumentResponseEntityStatus
- AnalyzeDocumentResponseEntityTextDataInner
- CategorizeTransactionsRequest
- CategorizeTransactionsResponse
- CategorizeTransactionsResponseEntity
- CollectStatusFromPdfRequest
- CollectStatusFromPdfResponse
- CollectTransactionsRequest
- CollectTransactionsRequestTransactionsInner
- CollectTransactionsResponse
- CollectTransactionsResponseEntity
- CreateWalletRequest
- CreateWalletResponse
- CreateWalletResponseEntity
- CreditSubwalletRequest
- CreditSubwalletResponse
- CreditSubwalletResponseEntity
- DeleteWebhookResponse
- FinancialGetBasicBvnResponse
- FinancialGetBasicBvnResponseEntity
- FinancialGetFullBvnResponse
- FinancialGetFullBvnResponseEntity
- GeneralGetNubanResponse
- GeneralGetNubanResponseEntity
- GeneralGetWalletBalanceResponse
- GetAccountAnalysisResponse
- GetAccountAnalysisResponseEntity
- GetAccountAnalysisResponseEntityAccountBreakdown
- GetAccountAnalysisResponseEntityExpenseBreakdown
- GetAccountAnalysisResponseEntityFundsManagement
- GetAccountAnalysisResponseEntityInflowBreakdown
- GetAccountAnalysisResponseEntityTransactionRoutineBreakdown
- GetAccountResponse
- GetAccountSubscriptionsResponse
- GetAccountSubscriptionsResponseEntity
- GetAccountTransactionsResponse
- GetAccountTransactionsResponseEntity
- GetAccountTransactionsResponseEntityTransactionsInner
- GetAdvancedCacResponse
- GetBanksResponse
- GetBanksResponseEntityInner
- GetBasicBvnResponse
- GetBasicBvnResponseEntity
- GetBasicCacResponse
- GetBasicCacResponseEntity
- GetBasicPhoneNumberResponse
- GetBasicPhoneNumberResponseEntity
- GetBinResponse
- GetBinResponseEntity
- GetCacResponse
- GetCacResponseEntity
- GetDataPlansResponse
- GetDocumentAnalysisRequest
- GetDocumentAnalysisResponse
- GetDocumentAnalysisResponseEntity
- GetDocumentAnalysisResponseEntityData
- GetDriversLicenseResponse
- GetDriversLicenseResponseEntity
- GetEarningStructureResponse
- GetEarningStructureResponseEntity
- GetEmailReputationResponse
- GetEmailReputationResponseEntity
- GetEmailReputationResponseEntityDetails
- GetFullBvnResponse
- GetFullBvnResponseEntity
- GetGenericOcrTextRequest
- GetGenericOcrTextResponse
- GetKycDriversLicenseResponse
- GetKycDriversLicenseResponseEntity
- GetKycDriversLicenseResponseEntityPersonalDetails
- GetKycPassportResponse
- GetKycPassportResponseEntity
- GetNationalIdResponse
- GetNationalIdResponseEntity
- GetNubanResponse
- GetNubanResponseEntity
- GetOcrTextRequest
- GetOcrTextResponse
- GetOcrTextResponseEntity
- GetPassportResponse
- GetPassportResponseEntity
- GetPhoneNumber404Response
- GetPhoneNumberResponse
- GetPhoneNumberResponseEntity
- GetPremiumBvnResponse
- GetPremiumBvnResponseEntity
- GetScreeningInfoResponse
- GetScreeningInfoResponseEntity
- GetScreeningInfoResponseEntityResult
- GetSenderIdResponse
- GetSenderIdResponseEntityInner
- GetSmsStatusResponse
- GetSmsStatusResponseEntity
- GetSpendingPatternResponse
- GetSpendingPatternResponseEntity
- GetSpendingPatternResponseEntityPattern
- GetSpendingPatternResponseEntityPatternAirtimeData
- GetSpendingPatternResponseEntityPatternBankTransfer
- GetSpendingPatternResponseEntityPatternCharges
- GetSpendingPatternResponseEntityPatternFood
- GetSpendingPatternResponseEntityPatternOthers
- GetSsnitResponse
- GetSsnitResponseEntity
- GetTinResponse
- GetTinResponseEntity
- GetTransactionResponse
- GetTransactionResponseEntity
- GetVinResponse
- GetVinResponseEntity
- GetVninResponse
- GetVninResponseEntity
- GetVoterResponse
- GetVoterResponseEntity
- GetWalletBalanceResponse
- GetWalletBalanceResponseEntity
- GetWalletResponse
- GetWalletResponseEntity
- GetWalletsResponse
- GetWalletsResponseEntity
- GetWebhooksResponse
- GetWebhooksResponseEntityInner
- NotifyWebhookRequest
- NotifyWebhookRequestData
- NotifyWebhookResponse
- PurchaseAirtimeRequest
- PurchaseAirtimeResponse
- PurchaseAirtimeResponseEntity
- PurchaseAirtimeResponseEntityDataInner
- PurchaseDataRequest
- PurchaseDataResponse
- PurchaseDataResponseEntityInner
- RequestSenderIdRequest
- RequestSenderIdResponse
- RequestSenderIdResponseEntityInner
- ScreenAmlRequest
- ScreenAmlResponse
- ScreenAmlResponseEntity
- SendOtpRequest
- SendOtpResponse
- SendOtpResponseEntityInner
- SendSmsRequest
- SendSmsResponse
- SendSmsResponseEntity
- SubscribeServiceRequest
- SubscribeServiceResponse
- TransferFundsRequest
- TransferFundsResponse
- TransferFundsResponseEntity
- ValidateBvnResponse
- ValidateBvnResponseEntity
- ValidateBvnResponseEntityBvn
- ValidateBvnResponseEntityFirstName
- ValidateOtpResponse
- ValidateOtpResponseEntity
- VerifyAgeResponse
- VerifyAgeResponseEntity
- VerifyPhotoIdWithSelfieRequest
- VerifyPhotoIdWithSelfieResponse
- VerifyPhotoIdWithSelfieResponseEntity
- VerifyPhotoIdWithSelfieResponseEntitySelfie
- VerifySelfieBvnRequest
- VerifySelfieBvnResponse
- VerifySelfieBvnResponseEntity
- VerifySelfieBvnResponseEntitySelfieVerification
- VerifySelfieNinRequest
- VerifySelfieNinResponse
- VerifySelfieNinResponseEntity
- VerifySelfieNinResponseEntitySelfieVerification
Documentation For Authorization
apikeyAuth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
appIdAuth
- Type: API key
- API key parameter name: AppId
- Location: HTTP header
Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in dojah_client.apis and dojah_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1: Use specific imports for apis and models like:
from dojah_client.api.default_api import DefaultApi
from dojah_client.model.pet import Pet
Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:
import sys
sys.setrecursionlimit(1500)
import dojah_client
from dojah_client.apis import *
from dojah_client.models import *
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dojah_python_sdk-3.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbed03411e102f13ed36834dd84aea9c76a01abd58d15e84000688ff140e4dc3 |
|
MD5 | 484bcb2d42090e925093f56b2f3b8174 |
|
BLAKE2b-256 | 6d032e48df3e20cc19063e7cbfe1be66e35b99f4e5099320e3ccf9bef75c7f92 |