pyprembly 0.0.2

Python bindings for the Prembly IdentityPass API

Prembly Identitypass

The 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 Contents

• Prembly Identitypass

  • Table of Contents

  • Install

  • Documentation

  • Getting Started

    • Configuration

    • Country and Available method

      • Nigeria

      • Ghana

      • Kenya

      • Sierra Leone

      • South Africa

      • Uganda

    • Global

    • FACE VALIDATION

    • RADAR

    • DOCUMENT

    • Calling Endpoints

    • Exceptions

      • MissingAuthKeyError

      • MissingRequiredDataError

      • APIConnectionError

      • InvalidMethodError

Install

pip install pyprembly

Note: This is currently under active development

Documentation

Getting Started

The package supports all Prembly Identitypass API endpoints for the following countries:

• Nigeria

• Kenya

• Ghana

• Sierra Leone

• South Africa

• Uganda

Configuration

To use pyprembly you will need to set the following in your environment variable

PREMBLY_APP_ID="your application id"

PREMBLY_X_API_KEY="your x_app_key id"

PREMBLY_ENVIRONMENT="environment default to test"

Visit Prembly to get both app id and x-api-key

Country and Available method

The available method of the DataVerification class are as follow:

Nigeria

from pyprembly.data.nigeria import DataVerification

Ghana

from pyprembly.data.ghana import DataVerification

Kenya

from pyprembly.data.kenya import DataVerification

Sierra Leone

from pyprembly.data.sierra_leone import DataVerification

South Africa

from pyprembly.data.south_africa import DataVerification

Uganda

from pyprembly.data.uganda import DataVerification

Global

from pyprembly.business import DataVerification

FACE VALIDATION

from pyprembly.face import DataVerification

RADAR

from pyprembly.radar import DataVerification

DOCUMENT

from pyprembly.radar import DataVerification

Calling Endpoints

To make a simple API call:

from pypyprembly.data.nigeria import DataVerification



try:

    DataVerification().bank_account_verification()

except MissingAuthKeyError as e :

    do something

except MissingRequiredDataError as e:

    do something

except APIConnectionError as e:

    do something

In this case you must have store your API keys in an environment variable.Alternatively you can also do

from pyprembly.data.nigeria import DataVerification



DataVerification(

    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.

Exceptions

There are only three exceptions that you can encounter while making API call.

MissingAuthKeyError

MissingAuthKeyError tells that pyprembly could not find either your APP_ID or X_API_KEY in your environment variable or in class initialization. Class initialization approach:

MissingRequiredDataError

MissingRequiredDataError tells that you do not provide a required data for the current method call.

APIConnectionError

APIConnectionError tells that there is an issue communicating with Prembly API, it can happen due to poor internet connection or system permission

InvalidMethodError

InvalidMethodError tells that the method used for calling the endpoint is not valid