Package: pyprembly
Prembly Identitypass PyPI versionThe Python library for the Prembly Identitypass API.The Python library provides easy access to Prembly Identitypass API's from Django, Flask, and other Python apps. It abstracts the complexity involved in direct integration and allows you to make quick calls to the APIs.Table of ContentsPrembly Identitypass PyPI versionTable of ContentsInstallDocumentationGetting StartedConfigurationCountry and Available methodNigeriaGhanaKenyaSierra LeoneSouth AfricaUgandaRwandaGlobalFACE VALIDATIONRADARDOCUMENTCalling EndpointsExceptionsMissingAuthKeyErrorMissingRequiredDataErrorAPIConnectionErrorInvalidMethodErrorInstallpip install pypremblyNote: This is currently under active developmentDocumentationGetting StartedThe package supports all Prembly Identitypass API endpoints for the following countries:NigeriaKenyaGhanaSierra LeoneSouth AfricaUgandaRwandaConfigurationTo use pyprembly you will need to set the following in your environment variablePREMBLY_APP_ID="your application id"PREMBLY_X_API_KEY="your x_app_key id"PREMBLY_ENVIRONMENT="environment default to test"VisitPremblyto get both app id and x-api-keyCountry and Available methodThe available method of theDataVerificationclass are as follow:Nigeriafrompyprembly.data.nigeriaimportDataVerificationAvailable methods are :SNMETHOD NAMEDESCRIPTION1cacVerify a business using rc_number2cac_with_nameVerify a business using rc_number3cac_advanceVerify a business using rc_number : return advance result4bvn_numberVerify a Bank Verification Number (BVN)5bvn_with_faceVerify a Bank Verification Number (BVN) using image and number6phone_numberVerify a Phone Number7banks_codeGet all banks code8bank_accountVerify bank account number9bank_account_comparisonVerify bank account number and compare name with customer name10all_bank_with_statementGet all available banking institution that bank statement can be retrieve11advance_bank_accountVerify bank account number : return advance result12bank_account_with_nameVerify bank account number13voters_card_imageVerify voters card ID image14voters_card_lookupVerify voters card number15basic_drivers_licenseVVerify drivers license16advance_drivers_licenseVerify drivers license : return advance result17image_drivers_licenseVerify drivers license ID image18drivers_license_imageVerify drivers license ID image19international_passportVerify international passport20international_passport_imageVerify international passport image21international_passport_with_faceVerify international passport image22international_passport_asyncVerify international passport in an asynchronous manner23credit_bureauGet Credit bureau statement24credit_bureau_customer_Verify advance credit details of a user25credit_bureau_commercialVerify advance credit details of a business26credit_bureau_commercial_basicVerify basic credit details of a business27credit_bureau_statementVerify basic credit details of a business28nin_slipVerify a National Identification Number(NIN) Slip29nin_lookupVerify a National Identification Number(NIN) with phone number and (NIN) number30nin_virtualVerify a National Identification Number(NIN) with NIN and virtual number31nin_faceVerify a National Identification Number(NIN) with user's image32stamp_dutyVerify a stamp  duty reference number33vehicle_verificationVerify a vehicle number plate34tax_identification_numberVerify tax identification numberGhanafrompyprembly.data.ghanaimportDataVerificationAvailable methods are:SNMETHOD NAMEDESCRIPTION1drivers_licenseVerify user drivers license2ssnitVerify SSNIT3voters_cardVerify voters card4international_passportVerify user passportKenyafrompyprembly.data.kenyaimportDataVerificationAvailable methods are:SNMETHOD NAMEDESCRIPTION1drivers_licenseVerify user drivers license2international_passportVerify user passport3serial_numberVerify user serial number4national_identity_number_newVerify user national identity number5alien_idVerify and authenticate foreign residentSierra Leonefrompyprembly.data.sierra_leoneimportDataVerificationAvailable methods are:SNMETHOD NAMEDESCRIPTION1drivers_licenseVerify user drivers license2voters_cardVerify voters cardSouth Africafrompyprembly.data.south_africaimportDataVerificationAvailable methods are:SNMETHOD NAMEDESCRIPTION1national_idVerify user national id card2companyVerify a businessUgandafrompyprembly.data.ugandaimportDataVerificationAvailable methods are:SNMETHOD NAMEDESCRIPTION1companyVerify a businessRwandafrompyprembly.data.rwandaimportDataVerificationAvailable methods are:SNMETHOD NAMEDESCRIPTION1passportVerify Rwandan passport2national_idVerify national identity card issued to RwandanGlobalfrompyprembly.businessimportDataVerificationSNMETHOD NAMEDESCRIPTION1search_with_emailVerify a company using email2search_with_nameVerify a company using  name3search_with_stringVerify a company4search_interpol_ban_listSearch an interpol ban list5search_companySearch for a company using email6verify_companyVerify a company information7vin_verificationVerify a VIN/CAR Identification Number8card_bin_verificationVerify a card BIN (Bank Identification Number)9email_verificationVerify an email addressFACE VALIDATIONfrompyprembly.faceimportDataVerificationSNMETHOD NAMEDESCRIPTION1age_and_genderGet the age range and gender of a person in an image2comparisonCompare two face images3enrollmentEnroll user4authenticationAuthenticate user using face5face_idVerify user identity user  against their registered image using their id card(Voters card, National ID, Card etc)6liveliness_checkAuthenticate user with liveliness check on faceRADARfrompyprembly.radarimportDataVerificationSNMETHOD NAMEDESCRIPTION1phone_intelligenceGet deep insight about a phone number2email_intelligenceGet deep insight about an email3ip_intelligenceGet deep insight about an IPDOCUMENTfrompyprembly.radarimportDataVerificationSNMETHOD NAMEDESCRIPTION1verifyVerify document imageCalling EndpointsTo make a simple API call:frompypyprembly.data.nigeriaimportDataVerificationtry:DataVerification().bank_account_verification()exceptMissingAuthKeyErrorase:dosomethingexceptMissingRequiredDataErrorase:dosomethingexceptAPIConnectionErrorase:dosomethingIn this case you must have store your API keys in an environment variable.Alternatively you can also dofrompyprembly.data.nigeriaimportDataVerificationDataVerification(prembly_app_id='your app id',prembly_x_api_key='your x api key',api_version='v2',environment='live').bank_account_verification()We recommend that you store your app id and x api key in an environment variable as PREMBLY_APP_ID and PREMBLY_X_API_KEY respectively.ExceptionsThere are only three exceptions that you can encounter while making API call.MissingAuthKeyErrorMissingAuthKeyErrortells that pyprembly could not find either your APP_ID or X_API_KEY in your environment variable or in class initialization. Class initialization approach:MissingRequiredDataErrorMissingRequiredDataErrortells that you do not provide a required data for the current method call.APIConnectionErrorAPIConnectionErrortells that there is an issue communicating with Prembly API, it can happen due to poor internet connection or system permissionInvalidMethodErrorInvalidMethodErrortells that the method used for  calling the endpoint is not valid0.0.4 (2023-4-17)LONG DESCRIPTION path not found fixed0.0.3 (2023-4-3)Added Rwanda Dataverification classAdded verification of Rwandan passportAdded verification of Rwandan national identityAdded verification of  Social Security and National Insurance Trust(SSNIT) with face to Ghana DataVerification class0.0.2 (2023-3-18)Added alien (foreign resident) verification method to kenya Dataverification class