Versions Compared

Version Old Version 25 New Version Current
Changes made by

Ope Adeoye

Tobi Olajide (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

With this service, the calling apps can do KYC with the customer's bvn. This service will return maximum KYC information. Apps will collect the account number they will like to obtain information on and forward to OnePipe. If authorisation details are required by a provider, apps will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation.

...

At agreed settlement cycles, the host will debit the configured beneficiary account of the app for the use of this API and share that fee with all participants. Fees will be determined by the provider. Parties that share the fees are:

...

OnePipe

...

Host client

...

Provider

...

Special configuration notes

...

Model

How it works

Invoice

The host client will invoice the calling app periodically for all calls to the endpoint.

Acceptable values for auth.type

Type

Description

bvn

Specifies that encrypted value in auth.secure is a customer bvn.

Process flows

Sequence of calls

...

Info

For details on encryption using the Triple DES Algorithm, read this.

Request (Transact)

Code Block
languagejson
{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_bvn_max",
  "auth": {
    "type": "bvn", 
    "secure": "{{encrypted_bvn}}",
    "auth_provider": "Beeceptor",
    "route_mode": null
  },
  "transaction": {
    "mock_mode": "live", 
    "transaction_ref": "{{transaction_ref}}", 
    "transaction_desc": "A random transaction", 
    "transaction_ref_parent": null, 
    "amount": 0,
    "customer":{
    	"customer_ref": "{{customer_id}}",
    	"firstname": "Uju",
  		      "surname": "Usmanu",
    	"email": "ujuusmanu@gmail.com",
    	"mobile_no": "234802343132"
    },
    "meta":{
    	"a_key":"a_meta_value_1",
    	"another_key":"a_meta_value_2"
    },
    "details": {
        "include_image": true
    }
  }
}

Response (when otp_override = false)

Code Block
languagejson
{
    "status": "WaitingForOTP",
    "message": "Please enter the OTP sent to 2348022****08",
    "data": {
        "provider_response_code": "900T0",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": null
    }
}

Response (when otp_override = true)

Code Block
languagejson
{
    "status": "Successful",
    "message": "Transaction processed successfully",
    "data": {
        "provider_response_code": "00",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": {
            "bvnreference": "2233305555598776665556665",
            "firstbvn": "22333055555",
            "first_name": "John",
            "middle_name": "Jane",
            "last_name": "Doe",
            "dob": "1990-12-22",
            "phone_number_1number1": "07037608648",
            "phone_number_2number2": "",
            "registration_date": "1990-12-22",
            "enrollment_bank": "011",
            "enrollment_branch": "MATORI",
            "email": "john.doe@gmail.com",
            "gender": "Male",
            "level_of_account": "Level 2 - Medium Level Accounts",
            "lga_of_origin": "Owerri West",
            "lga_of_residence": "Ikeja",
            "marital_status": "Single",
            "nin": "77766492344",
            "name_on_card": "John Jane Doe",
            "nationality": "Nigeria",
            "residential_address": "34, Banjo Street, Ikeja, Lagos",
            "state_of_origin": "Imo State",
            "state_of_residence": "Lagos State",
            "title": "Mr",
            "watchlisted": "NO",
            "base64_image": "{{Base64Image}}",
            "meta":{}
        }
    }
}

Request (validate with otp)

Code Block
languagejson
{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_bvn_max",
	"auth": {
        "secure": "{{encrypted_otp}}",
        "auth_provider": "Beeceptor" 
    },
    "transaction": {
        "transaction_ref": "70713093460718"
    }
}

Request Payload Description

Breakdown of the details object

For this service, the details object will have the following:

Field

Type

Requirement

Description

requestinclude_refimage

stringboolean

compulsory

Takes unique value for every request made to OnePipe

request_type

string

compulsory

This should be set to the service lookup_bvn_max

auth.type

string

compulsory

This should be set to bvn

auth.secure

string

compulsory

This should be set to the encrypted bvn.

auth.provider

string

compulsory

This should be set to the name of the Provider

auth.route_mode

string

N/A

This can be set to null

transaction.mock_mode

string

optional

This can be set to either live or inspect. If left as null, value will fall back to the state of the service set on the console.

transaction.transaction_desc

string

optional

Description of your transaction

transaction.transaction_ref_parent

string

optional

Takes value of a (parent) transaction reference

transaction.customer.customer_ref

string

compulsory

Identifier for customer

transaction.customer.firstname

string

optional

First name of customer

transaction.customer.surname

string

optional

Surname of customer

transaction.customer.email

string

optional

Email address of customer

transaction.customer.mobile_no

string

optional

Phone number of customer

transaction.amount

big int

compulsory

This can be set to 0

transaction.transaction_ref

string

compulsory

Takes unique value for every transaction call to OnePipe.

transaction.meta

object

optional

Json object of your arbitrary transaction parameters

transaction.details

object

compulsory

Holds defined fields peculiar to this service

Acceptable values for auth.type

...

Type

...

Description

...

bvn

...

Specifies that encrypted value in auth.secure is a customer bvn.

Breakdown of the details object

For this service, the details object will have the following:

...

Field

...

Type

...

Requirement

...

Description

...

include_image

...

boolean

...

optional

...

Defaults to true. Used to instruct the microservice whether to include image of the BVN holder in its response or not.

Possible status response codes

For this service, these are the possible responses a client can receive

...

Status

...

Meaning

...

Successful

...

Standard success code

...

Failed

...

Standard failure code

...

WaitingForOTP

...

To signify that this provider has requested an OTP from the customer and it should be supplied.

...

PendingValidation

...

To signify that this provider needs some extra information to be provided. The response.message will contain the prompt.

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)

Info

Request payload from OnePipe to the provider microservice comes encrypted, using the Triple DES Algorithm. See details.

Request (Transact)

Code Block
languagejson
{
  "request_mode":"transact",
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_bvn_max",
  "auth": {
    "type": "bvn", 
    "secure": "{{decrypted_bvn}}",
    "auth_provider": "Beeceptor"
  },
  "transaction": {
    "mock_mode": "live", 
    "transaction_ref": "{{transaction_ref}}", 
    "transaction_desc": "A random transaction", 
    "transaction_ref_parent": null, 
    "amount": 0,
    "customer":{
    	"customer_ref": "{{customer_id}}",
    	"firstname": "Uju",
  		"surname": "Usmanu",
    	"email": "ujuusmanu@gmail.com",
    	"mobile_no": "234802343132"
    },
    "meta":{
    	"a_key":"a_meta_value_1",
    	"another_key":"a_meta_value_2"
    },
    "details": {
    	"include_image": true
    },
    "client_info": {
        "name": "TrustPay",
        "id": null,
        "bank_cbn_code": null,
        "bank_name": null,
        "console_url": null,
        "js_background_image": null,
        "css_url": null,
        "logo_url": "https://trustpay.onepipe.io/img/trustpay_logo_console.png",
        "footer_text": "Brought to you by <strong>SunTrust Bank</strong>",
        "options": [
            "BANK.TRANSFER",
            "CARD"
        ],
        "primary_color": "#b37038",
        "secondary_color": "#b37038",
        "primary_button_color": "#b37038",
        "modal_background_color": "linear-gradient(147.44deg, #d8903c 26.99%, #e69921 74.1%)",
        "payment_option_color": "rgba(76, 61, 47, 0.08)",
        "payment_option_active_color": "rgba(31, 31, 31, 0.25)",
        "app_color": "#b37038"
    },
    "app_info": {
      "name": "Victor Motors",
      "id": "5cdab3332b7d4100015f0db4",
      "beneficiary_account_no": "0001137069",
      "extras": {/*this will contain an array of provider override settings*/}
    }
  }
}

Response (when otp_override = false)

Set provider_response_code to 900T0

Code Block
languagejson
{
    "status": "WaitingForOTP",
    "message": "Please enter the OTP sent to 2348022****08",
    "data": {
        "provider_response_code": "10",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": null
    }
}

Response (when otp_override = true)

Code Block
{
    "status": "Successful",
    "message": "Operation was successful",
    "data": {
    	"provider_responde_code":"00",
    	"provider": "Polaris",
        "errors": null,
        "error": null,
        "provider_response": {
	        "bvn": "22333055555",
            "first_name": "John",
            "middle_name": "Jane",
            "last_name": "Doe",
            "dob": "yyyy-MM-dd-HH-mm-ss",
            "phone_number_1": "07037608648",
            "phone_number_2": "",
            "registration_date": "yyyy-MM-dd-HH-mm-ss",
            "enrollment_bank": "011",
            "enrollment_branch": "MATORI",
            "email": "john.doe@gmail.com",
            "gender": "Male",
            "level_of_account": "Level 2 - Medium Level Accounts",
            "lga_of_origin": "Owerri West",
            "lga_of_residence": "Ikeja",
            "marital_status": "Single",
            "nin": "77766492344",
            "name_on_card": "John Jane Doe",
            "nationality": "Nigeria",
            "residential_address": "34, Banjo Street, Ikeja, Lagos",
            "state_of_origin": "Imo State",
            "state_of_residence": "Lagos State",
            "title": "Mr",
            "watchlisted": "NO",
            "base64_image": "{{Base64Image}}"
        }
    }
}

Request (validate with otp)

...

languagejson

...

optional

Defaults to true. Used to instruct the microservice whether to include image of the BVN holder in its response or not.

Possible status response codes

For this service, these are the possible responses a client can receive

Status

Meaning

Successful

Standard success code

Failed

Standard failure code

WaitingForOTP

To signify that this provider has requested an OTP from the customer and it should be supplied.

PendingValidation

To signify that this provider needs some extra information to be provided. The response.message will contain the prompt.

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)

Read this closely.

Special notes for OTP override

...