Overview

With this service, the calling apps can do KYC with the customer's bvn. This service will return maximum KYC information. Apps will forward 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.

Info
Before you proceed: Please read this.

Commercial model

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

OTP override: All providers of this service should implement OTP, but support the configuration of otp_override such that based on this configuration, they could be instructed to bypass the OTP requirement for an app.
SMS handler: All providers that need to do OTP validation need to have otp_api_key, and otp_api_secret configured. They will use this to call can use the Send SMS and Send Email service services on OnePipe to send their OTP.

...

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

App calls /transact with the right auth details
Provider responds with WaitingForOTP or PendingValidation as may be required
App calls /transact/validate to supply OTP if needed
Provider responds with any of the completion codes Successful or Failed.
To query the status of a transaction, the app can call /transact/query
Where the provider supports it, the app can call /transact/reverse to request a reversal

Gliffy

imageAttachmentId	att32243723
baseUrl	https://onepipe.atlassian.net/wiki
macroId	a9d3d285-2916-4123-9e93-236a130f390f
name	OnePipe 2.0 Collect Service
diagramAttachmentId	att32210953
containerId	32243713
timestamp	1581541309221

INTERFACE SPECIFICATION (APP → ONEPIPE)

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

Request (Transact)

Code Block

language	json

{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_bvn_max",
  "auth": {
    "type": null"bvn", 
    "secure": null,
    ""{{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": {
    	"bvn":"23632626327",     	"otpinclude_overrideimage": true
    }
  }
}

Response (when otp_override = false)

Code Block

language	json

{
    "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

language	json

{
    "status": "Successful",
    "message": "Transaction processed successfully",
    "data": {
        "provider_response_code": "00",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": {
            "bvnreference": "2233305555598776665556665",
            "first_namebvn": "John22333055555",
            "middlefirst_name": "JaneJohn",
            "lastmiddle_name": "DoeJane",
            "date_of_birthlast_name": "Doe",
            "dob": "091990-Dec12-199022",
            "phone_number_1number1": "07037608648",
            "phone_number_2number2": "",
            "registration_date": "1990-12-Sep-201522",
            "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

language	json

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

...

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_account_2`
auth.type	string	N/A	This can be set to `null`
auth.secure	string	N/A	This can be set to `null`
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

Breakdown of the details object

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

...

Field

...

Type

...

Requirement

...

Description

...

bvn

...

string

...

compulsory

...

Customer bvn to look up

...

otp_override

...

boolean

...

optional

...

Defaults to false. If set to true, request will not be validated by OTP.

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)

Request

Code Block

language	json

{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_bvn_max",
  "auth": {
    "type": null, 
    "secure": null,
    "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": {
    	"bvn":"23632626327",
    	"otp_override": 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

language	json

{
    "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": "22211234561",
	        "first_name": "BOYEBEST",
	        "middle_name": "ADEOYE",
	        "last_name": "ISRAEL",
	        "enrollment_bank": null,
            "dob": "21-Mar-1981",
            "registration_date": "18-Mar-2015",
            "enrolment_branch": null,
            "email": "boyebest@yahoo.com",
			"gender": "Male",
			"level_of_account": "Level 2 - Medium Level Accounts",
			"lga_of_origin": "Olorunda",
			"lga_of_residence": "Ido",
			"marital_status": "Married",
			"nin": "*",
			"name_on_card": "Boyebest Adeoye Israel",
			"nationality": "Nigeria",
			"phone_number1": "08073123456",
			"phone_number2": "08158498992",
			"residential_address": "1, Boyebest Lane, Oko Awo",
			"state_of_origin": "Osun State",
			"state_of_residence": "Oyo State",
			"watch_listed": "NO",
			"base64_image": "/9j/4AAQSkZJRgABAgAAAQABAAD/==",
			"response_code": "00",
			"response_message": "Success",
			"user_message": "Success"
        }
    }
}

Request (validate with otp)

...

language	json

...

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

Whenever a request is to be validated by OTP, the provider microservice should first call the provider, store response info in the database, send an OTP to the phone number attached to the BVN, then respond with WaitingForOTP.
On the OTP validation legphase, if user OTP is valid, provider should retrieve info from the database, then respond with a Successful response.
NB: Data should be erased from the DB.

Special notes for providers

...

Version	Old Version 7	New Version Current
Changes made by	Victor Irechukwu	Tobi Olajide
Saved on	Mar 03, 2020	Jul 29, 2020

Versions Compared

Key

Overview

Commercial model

Special configuration notes

Acceptable values for `auth.type`

Process flows

INTERFACE SPECIFICATION (APP → ONEPIPE)

Request (Transact)

Response (when otp_override = false)

Response (when otp_override = true)

Request (validate with otp)

Breakdown of the details object

Breakdown of the details object

Possible status response codes

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER)

Request

Response (when otp_override = false)

Response (when otp_override = true)

Request (validate with otp)

Possible status response codes

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)

Special notes for OTP override

Special notes for providers

Content Comparison

Versions Compared

Key

Overview

Commercial model

Special configuration notes

Acceptable values for auth.type

Process flows

INTERFACE SPECIFICATION (APP → ONEPIPE)

Request (Transact)

Response (when otp_override = false)

Response (when otp_override = true)

Request (validate with otp)

Breakdown of the details object

Breakdown of the details object

Possible status response codes

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER)

Request

Response (when otp_override = false)

Response (when otp_override = true)

Request (validate with otp)

Possible status response codes

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)

Special notes for OTP override

Special notes for providers

Acceptable values for `auth.type`