Customer

Aggregated API endpoint for customer

Onboard Individual Customer (Investor/Borrower)

POST {{baseUrl}}/api/v2/client/customers/onboard_individual

Headers

Name	Type	Description
client-id*	String	Developer generated client id
api-key*	String	Developer generated api key

Request Body

Name	Type	Description
first_name*	string
last_name*	string
gender*	string
date_of_birth*	string
educational_qualification	string
customer_unique_identifier*	string
next_of_kin_first_name	string
next_of_kin_last_name	string
next_of_kin_email	string
next_of_kin_phone_number	string
next_of_kin_gender	string
relationship_with_next_kin	string
next_of_kin_dial_code	string
next_of_kin_street	string
next_of_kin_city	string
next_of_kin_state	string
next_of_kin_country	string
phone_number*	string
email*	string
bank_code	string
bank_account_number	string
bank_account_name	string
bank_name	string
routing_number	string
swift_code	string
address*	string
postal_code	string
city	string
state	string
country_code*	string
customer_category	string
customer_onboarding_type*	integer
partner_date_registered	string
tax_identification_number	string
create_wallet*	boolean
customer_documents	Array	Array of documents to be uploaded during signup eg [{ "document_type_code": "", "base64_file_string": "", "filename_with_extension": "alexa.png" }]
photo_url	string

201: Created Response for borrower

{
    "borrower_id": id,
    "first_name": "firstname",
    "last_name": "lastname",
    "company_name": "",
    "borrower_phone": "phonenumber",
    "sso_user_id": "userid",
    "bvn": "bvn",
    "message": "Onboarding successful",
    "status": true,
    "status_code": 201
}

201: Created Response for investor

{
    "funder_id": id,
    "first_name": "firstname",
    "company_name": "",
    "phone_number": "phonenumber",
    "email": "email",
    "last_name": "lastname",
    "funder_type": "fundertype",
    "sso_user_id": "userid",
    "message": "Onboarding successful",
    "status": true,
    "status_code": 201
}

Onboard Corporate Customer

POST {{baseUrl}}/api/v2/client/customers/onboard_corporate

Headers

Name	Type	Description
client-id*	string	Developer generated client id
api-key*	string	Developer generated api key

Request Body

Name	Type	Description
company_name*	string
business_registration_number*	string
business_registration_date*	string
corporate_customer_people*	Array	Array of people to be added e.g [ { "first_name": "antonio", "last_name": "banderas", "middle_name": "", "email": "[e-mail]", "gender": "male", "date_of_birth": "1992-04-14", "address": "neisndf", "city": "neodnrtb", "state": "nasmddi", "phone_number": "09182834494", "country_code": "NG", "person_type": 1, "identity_number": "22397319289", "individual_tax_identification-number": "", "educational_qualification": "Emeritus" } ]
phone_number*	string
email*	string
bank_code	string
bank_account_number	string
bank_account_name	string
bank_name	string
routing_number	string
swift_code	string
address*	string
postal_code	string
city	string
state	string
country_code*	string
customer_category	string
customer_onboarding_type*	integer
partner_date_registered	string
tax_identification_number	string
create_wallet*	boolean
customer_documents	Array	Array of documents to be uploaded during signup eg [{ "document_type_code": "", "base64_file_string": "", "filename_with_extension": "alexa.png" }]
photo_url	string

201: Created Response for borrower

{
    "borrower_id": id,
    "first_name": "",
    "last_name": "",
    "company_name": "companyname",
    "borrower_phone": "phonenumber",
    "sso_user_id": "userid",
    "bvn": null,
    "message": "Onboarding successful",
    "status": true,
    "status_code": 201
}

201: Created Response for investor

{
    "funder_id": id,
    "first_name": "",
    "company_name": "companyname",
    "phone_number": "phonenumber",
    "email": "email",
    "last_name": "",
    "funder_type": "fundertype",
    "sso_user_id": "userid",
    "message": "Onboarding successful",
    "status": true,
    "status_code": 201
}

Get Customer

GET {{baseUrl}}/api/v2/client/customers

Query Parameters

Name	Type	Description
email	string
phone_number	string
customer_type	string
from_date	date
to_date	date
customer_id	number

Headers

Name	Type	Description
client-id*	string	Developer generated client id
api-key*	string	Developer generated api key

200: OK

{
    // Response
}

Load Customer Stock Data

POST {{baseUrl}}/api/v2/client/customers/data/stock

Query Parameters

Name	Type	Description
phone_number	string	customer's phone number
email	string	customer's email
identity_number	string	customer's identity number used in onboarding

Headers

Name	Type	Description
client-id*	string	Developer generated client id
api-key*	string	Developer generated api key

Request Body

Name	Type	Description
data*	Array	{ "data": [ { "product_id": "2023-04-09T23:05:13.458Z", "product_category": "string", "minimum_stock_quantity": 0, "total_quantity": 0, "available_quantity": 0, "reserved_quantity": 0, "unit_price": 0, "tax_amount": 0, "discount_amount": 0, "net_price": 0, "stock_level": "string", "date": "2023-12-12T18:00:50.026Z" } ] }

200: OK

{ 
  "message": "string",
  "status": true,
  "status_code": 0
}

Load Customer Orders Data

POST {{baseUrl}}/api/v2/client/customers/data/orders

Query Parameters

Name	Type	Description
phone_number	string	customer's phone number
email	string	customer's email
identity_number	string	customer's identity number used in onboarding

Headers

Name	Type	Description
client-id*	string	Developer generated client id
api-key*	string	Developer generated api key

Request Body

Name	Type	Description
data*	Array	{ "data": [ { "order_id": "string", "order_sub_amount": 0, "discount_amount": 0, "tax_amount": 0, "order_amount": 0, "order_date": "2023-04-09T23:58:04.110Z", "order_currency": "string", "payment_type": "string", "customer_rating": "string", "customer_category": "string", "store_name": "string", "address": "string", "city": "string", "state": "string", "country": "string", "gps_location": "string", "is_credit": true, "total_items": 0, "order_items": [ { "product_id": "string", "product_category": "string", "product_rating": "string", "unit_price": 0, "quantity": 0, "amount": 0 } ] } ] }

200: OK

{ 
  "message": "string",
  "status": true,
  "status_code": 0
}