Package: dojah-python-sdk
dojah-python-sdk@4.1.0Use Dojah to verify, onboard and manage user identity across Africa!RequirementsPython >=3.7Installingpipinstalldojah-python-sdk==4.1.0Getting Startedfrompprintimportpprintfromdojah_clientimportDojah,ApiExceptiondojah=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: apikeyAuthauthorization="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: appIdAuthapp_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 Infoget_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)exceptApiExceptionase: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)Asyncasyncsupport is available by prependingato any method.importasynciofrompprintimportpprintfromdojah_clientimportDojah,ApiExceptiondojah=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: apikeyAuthauthorization="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: appIdAuthapp_id="YOUR_API_KEY",# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# api_key_prefix = {'appIdAuth': 'Bearer'},)asyncdefmain():try:# Get AML Infoget_screening_info_response=awaitdojah.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)exceptApiExceptionase: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 EndpointsAll URIs are relative tohttps://api.dojah.ioClassMethodHTTP requestDescriptionAMLApiget_screening_infoGET/api/v1/aml/screening/infoGet AML InfoAMLApiscreen_amlPOST/api/v1/aml/screening/platformAML ScreeningAuthenticationApiget_sender_idGET/api/v1/messaging/sender_idsMessaging - Get Sender IDsAuthenticationApiget_sms_statusGET/v1/messaging/sms/get_statusMessaging - Get SMS StatusAuthenticationApirequest_sender_idPOST/api/v1/messaging/sender_idMessaging - Request Sender IDAuthenticationApisend_otpPOST/api/v1/messaging/otpMessaging - Send OTPAuthenticationApisend_smsPOST/api/v1/messaging/smsMessaging - Send SMSAuthenticationApivalidate_otpGET/api/v1/messaging/otp/validateMessaging - Validate OTPDocumentAnalysisApianalyze_documentPOST/api/v1/document/analysisKYC - Document AnalysisFraudApiget_email_reputationGET/api/v1/kyc/emailEmail ReputationFraudApiget_ip_reputationGET/api/v1/fraud/ipIP ReputationFraudApiscreen_phoneGET/api/v1/fraud/phonePhone ScreeningFraudApiscreen_userGET/api/v1/fraud/userUser ScreeningGHKYCApiget_drivers_licenseGET/api/v1/gh/kyc/dlDriver's LicenseGHKYCApiget_passportGET/api/v1/gh/kyc/passportPassportGHKYCApiget_ssnitGET/api/v1/gh/kyc/ssnitSSNITGHKYCApiget_voterGET/api/v1/gh/kyc/voterVoter ID LookupGeneralApiget_banksGET/v1/general/banksGeneral - Get BanksGeneralApiget_binGET/v1/general/binGeneral Resolve BINGeneralApiget_nubanGET/api/v1/general/accountGeneral Resolve NUBANGlobalKYCApica_ekycGET/api/v1/ca/kycCanada EkycGlobalKYCApiget_us_ssnGET/api/v1/us/kycUS SSNGlobalKYCApiuk_two_plus_twoGET/api/v1/uk/kycUK 2+2KEKYCApiget_national_idGET/api/v1/ke/kyc/idKYC - National IDKEKYCApiget_passportGET/api/v1/ke/kyc/passportKYC - PassportKYBApibusiness_detailGET/api/v1/kyb/business/detailBusiness DetailKYBApibusiness_searchGET/api/v1/kyb/business/searchBusiness SearchKYBApiget_cacGET/api/v1/kyc/cacKYC - Get CACKYBApiget_tinGET/api/v1/kyc/tinKYC - Fetch TinKYCApicheck_livenessPOST/api/v1/ml/livenessLiveness CheckKYCApiget_accountsGET/api/v1/kyc/accountsKYC - Fetch AccountsKYCApiget_address_verificationGET/api/v1/kyc/addressFetch Address Verification DataKYCApiget_bvn_from_nubanGET/api/v1/kyc/nuban/bvnLookup BVN from NUBANKYCApiget_vinGET/api/v1/kyc/vinKYC - Get VINKYCApisubmit_addressPOST/api/v1/kyc/addressSubmit AddressMLApiverify_photo_id_with_selfiePOST/api/v1/kyc/photoid/verifyKYC - Selfie Photo ID VerificationNigeriaKYCApiget_basic_bvnGET/api/v1/kyc/bvnKYC - Get Basic BVN InfoNigeriaKYCApiget_basic_bvn1GET/api/v1/kyc/bvn/basicKYC - Lookup BVN Basic 1NigeriaKYCApiget_basic_phone_numberGET/api/v1/kyc/phone_number/basicKYC Lookup Phone Number BasicNigeriaKYCApiget_drivers_licenseGET/api/v1/kyc/dlKYC - Get Drivers License InfoNigeriaKYCApiget_ninGET/api/v1/kyc/ninKYC - Get NIN InfoNigeriaKYCApiget_normal_bvnGET/api/v1/kyc/bvn/fullKYC - Lookup BVN NormalNigeriaKYCApiget_nubanGET/api/v1/kyc/nubanKYC - Get NUBAN InformationNigeriaKYCApiget_passportGET/api/v1/kyc/passportKYC - PassportNigeriaKYCApiget_phone_numberGET/api/v1/kyc/phone_numberKYC - Lookup Phone NumberNigeriaKYCApiget_premium_bvnGET/api/v1/kyc/bvn/advanceKYC - Lookup BVN PremiumNigeriaKYCApiget_vninGET/api/v1/kyc/vninLookup VNINPurchaseApisend_airtimePOST/v1/purchase/airtimePurchase - Send AirtimeServicesApiget_wallet_balanceGET/api/v1/balanceGet Dojah Wallet BalanceTZKYCApiget_ninGET/api/v1/tz/kyc/ninLookup TZ NINUGKYCApiget_voterGET/api/v1/ug/kyc/voterVoters IDVerificationsApivalidate_bvnGET/v1/kyc/bvnKYC - Validate BVNVerificationsApiverify_ageGET/v1/kyc/age_verificationKYC - Age VerificationVerificationsApiverify_selfie_bvnPOST/v1/kyc/bvn/verifyKYV - Selfie BVN VerificatoinVerificationsApiverify_selfie_ninPOST/api/v1/kyc/nin/verifyKYC - Selfie NIN VerificationVerificationsApiverify_selfie_vninPOST/api/v1/kyc/vnin/verifyKYC - Selfie vNIN verificationWebHooksApidelete_webhookDELETE/api/v1/webhook/deleteDelete WebhookWebHooksApiget_webhooksGET/api/v1/webhook/fetchFetch All WebhooksWebHooksApinotify_webhookPOST/api/v1/webhook/notifyPost HookWebHooksApisubscribe_servicePOST/api/v1/webhook/subscribeSubscribe to serviceZAFKYCApiget_idGET/api/v1/za/kyc/idKYC - Lookup IDZWKYCApicheck_creditGET/api/v1/zw/kyc/fcbCredit CheckZWKYCApiverify_idGET/api/v1/zw/kyc/ninNational ID VerificationDocumentation For ModelsAmlScreenAmlRequestAmlScreenAmlResponseAmlScreenAmlResponseEntityAnalyzeDocumentResponseAnalyzeDocumentResponseEntityAnalyzeDocumentResponseEntityDocumentImagesAnalyzeDocumentResponseEntityDocumentTypeAnalyzeDocumentResponseEntityStatusAnalyzeDocumentResponseEntityTextDataAnalyzeDocumentResponseEntityTextDataItemAuthenticationSendOtpRequestAuthenticationSendOtpResponseAuthenticationSendOtpResponseEntityAuthenticationSendOtpResponseEntityItemAuthenticationValidateOtpResponseAuthenticationValidateOtpResponseEntityDeleteWebhookResponseFraudGetEmailReputationResponseFraudGetEmailReputationResponseEntityFraudGetEmailReputationResponseEntityAccountDetailsRegisteredFraudGetEmailReputationResponseEntityBreachDetailsFraudGetEmailReputationResponseEntityBreachDetailsBreachesFraudGetEmailReputationResponseEntityDetailsFraudGetEmailReputationResponseEntityDetailsProfilesFraudGetEmailReputationResponseEntityDomainDetailsFraudGetIpReputationResponseFraudGetIpReputationResponseEntityFraudGetIpReputationResponseEntityReportFraudGetIpReputationResponseEntityReportAnonymityFraudGetIpReputationResponseEntityReportBlacklistsFraudGetIpReputationResponseEntityReportInformationFraudGetIpReputationResponseEntityReportRiskScoreFraudScreenPhoneResponseFraudScreenPhoneResponseEntityFraudScreenPhoneResponseEntityAccountDetailsRegisteredFraudScreenUserResponseFraudScreenUserResponseEntityFraudScreenUserResponseEntityEmailCheckResultFraudScreenUserResponseEntityEmailCheckResultAccountDetailsRegisteredFraudScreenUserResponseEntityEmailCheckResultBreachDetailsFraudScreenUserResponseEntityEmailCheckResultBreachDetailsBreachesFraudScreenUserResponseEntityEmailCheckResultBreachDetailsBreachesItemFraudScreenUserResponseEntityEmailCheckResultDomainDetailsFraudScreenUserResponseEntityIpCheckResultFraudScreenUserResponseEntityIpCheckResultAnonymityFraudScreenUserResponseEntityIpCheckResultBlacklistsFraudScreenUserResponseEntityIpCheckResultIpDetailsFraudScreenUserResponseEntityIpCheckResultRiskScoreFraudScreenUserResponseEntityPhoneCheckResultFraudScreenUserResponseEntityPhoneCheckResultAccountDetailsRegisteredGeneralGetNubanResponseGeneralGetNubanResponseEntityGetBanksResponseGetBanksResponseEntityGetBanksResponseEntityItemGetBasicBvnResponseGetBasicBvnResponseEntityGetBinResponseGetBinResponseEntityGetDriversLicenseResponseGetDriversLicenseResponseEntityGetFullBvnResponseGetFullBvnResponseEntityGetKycDriversLicenseResponseGetKycDriversLicenseResponseEntityGetKycDriversLicenseResponseEntityPersonalDetailsGetKycPassportResponseGetKycPassportResponseEntityGetNationalIdResponseGetNationalIdResponseEntityGetNubanResponseGetNubanResponseEntityGetPassportResponseGetPassportResponseEntityGetPhoneNumber404ResponseGetPhoneNumber404ResponseEntityGetPhoneNumberResponseGetPhoneNumberResponseEntityGetPremiumBvnResponseGetPremiumBvnResponseEntityGetSenderIdResponseGetSenderIdResponseEntityGetSenderIdResponseEntityItemGetSmsStatusResponseGetSmsStatusResponseEntityGetSsnitResponseGetSsnitResponseEntityGetVinResponseGetVinResponseEntityGetVninResponseGetVninResponseEntityGetWalletBalanceResponseGetWalletBalanceResponseEntityGetWebhooksResponseGetWebhooksResponseEntityGetWebhooksResponseEntityItemKybGetCacResponseKybGetCacResponseEntityKybGetTinResponseKybGetTinResponseEntityKycCheckLivenessRequestKycSubmitAddressRequestKycSubmitAddressResponseKycSubmitAddressResponseEntityKycSubmitAddressResponseEntityDataKycSubmitAddressResponseEntityDataApplicantKycSubmitAddressResponseEntityDataNeighborKycSubmitAddressResponseEntityDataPhotosMlVerifyPhotoIdWithSelfieRequestNigeriaKycGetNinResponseNigeriaKycGetNinResponseEntityNigeriaKycGetNinResponseEntityNokAddress2NotifyWebhookRequestNotifyWebhookRequestDataNotifyWebhookResponsePurchaseAirtimeRequestPurchaseAirtimeResponsePurchaseAirtimeResponseEntityPurchaseAirtimeResponseEntityDataPurchaseAirtimeResponseEntityDataItemRequestSenderIdRequestRequestSenderIdResponseRequestSenderIdResponseEntityRequestSenderIdResponseEntityItemSendSmsRequestSendSmsResponseSendSmsResponseEntitySubscribeServiceRequestSubscribeServiceResponseValidateBvnResponseValidateBvnResponseEntityValidateBvnResponseEntityBvnValidateBvnResponseEntityFirstNameVerificationsVerifySelfieNinRequestVerificationsVerifySelfieVninRequestVerifyAgeResponseVerifyAgeResponseEntityVerifySelfieBvnRequestVerifySelfieBvnResponseVerifySelfieBvnResponseEntityVerifySelfieBvnResponseEntitySelfieVerificationZafKycGetIdResponseZafKycGetIdResponseEntityZwKycCheckCreditResponseZwKycCheckCreditResponseEntityZwKycVerifyIdResponseZwKycVerifyIdResponseEntityAuthorThis Python package is automatically generated byKonfig