Fetch all customers

Returns an array of all customers attached to your integration and the number of active customers that you have.

Response

This is expected response if the request is completed successfully.

{
    "message": {
      "status": "success",
      "message": "Customers retrieved successfully"
    },
    "data": {
        "customers": [
            {
              "id": "w6r90wokmfu",
              "business_name": "B54",
              "unique_id_type": "bvn",
              "unique_id": "123456780",
              "first_name": "John",
              "last_name": "Doe",
              "other_names": "Smith",
              "mother_maiden_name": "Jane",
              "gender": "male",
              "date_of_birth":"DD-MM-YYYY",
              "street": "12 Olaniyi street ",
              "city": "Ikeja",
              "state": "Lagos",
              "country": "Nigeria",
              "email": "[email protected]",
              "contact_number": "08000000007",
              "nin": "1234567890",
              "photo_id_type": "NIN slip",
              "occupation": "Software Developer",
              "office_street": "229 Herbert Macaulay",
              "office_city": "Yaba",
              "office_state": "Lagos",
              "office_country": "Nigeria",
              "address": "229 Herbert Macaulay Yaba Lagos Nigeria",
              "next_of_kin": "Arowojobe Stone Jeremiah" 
              "nin_slip": "https://fileLink",
              "proof_of_residence": "https://fileLink",
              "international_passport": "https://fileLink",
              "utility_slip": "https://fileLink",
              "drivers_license": "https://fileLink"
              "is_deleted": false,
              "created_at": "2021-04-28 11:22:07",
              "updated_at": "2021-04-28 11:22:07"
            }
        ],
      "no_of_active_customers": 1
    }
}

The `response` object

status _^string
This is the status of the request. It can be either success or error

message _^string
This is a message describing the outcome of the request sent to the server.

data _^object

customers _{^{array of object}}

Object

business_name _^string
This is the business name of the customer if they have a business.

unique_id_type _^string
This is the primary type of identifying and verifying the user's bio-information. In this context, the value is bvn.

unique_id _^string
This is the ID number that corresponds with the unique_id_type

first_name _^string
This is the first name of the customer.

last_name _^string
This is the last name of the customer.

other_names _^string
This can include other names of the customer if applicable.

mother_maiden_name _^string
This is the customer's mother's maiden name.

gender _^string
This is the gender of the customer. It must either be male or female

date_of_birth _^string
This is the date of birth of the customer. The format of the date must be in this format: DD-MM-YYYY

street _^string
This is the street on which the customer resides.

city _^string
This is the city in which the customer resides.

state _^string
This is the state in which the customer resides.

country _^string
This is the country in which the customer resides.

email _^string
This is the email address of the customer.

contact_number _^string
This is the contact (phone) number of the customer.

nin _^string
This is the National Identification Number.

photo_id_type _^string
This is the type of photo identification to be used. Its value can be NIN slip, International passport or Drivers license.

occupation _^string
This is the occupation of the customer.

office_street _^string
This is the street on which the customer's office is situated.

office_city _^string
This is the city in which the customer's office is situated.

office_state _^string
This is the state in which the customer's office is situated.

office_country _^string
This is the country in which the customer's office is situated.

address _^string
This is the address of the customer.

next_of_kin _^string
This is the name of the next of kin of the customer.

proof_of_residence _^string
This is the link to the image of the customer's proof of residence.

international_passport _^string
This is the link to the image of the customer's international passport.

utility_slip _^string
This is the link to the image of the customer's utility slip.

drivers_license _^string
This is the link to the image of the customer's driver's license.

id _^int
This is the ID of the customer.

is_deleted _^boolean
This indicates whether or not the customer has been deleted ot not.

metadata _^string
This includes the created_at and updated_at timestamps sent in a DateTime format.

Response

The response object

The `response` object