GET
/
customers
{
  "status": "00",
  "message": "The process was completed successully",
  "data": {
    "customer_id": "1234567890",
    "first_name": "Ado",
    "middle_name": "John",
    "surname": "Sule",
    "gender": "M",
    "email": "adojohn@example.com",
    "bvn": "22112345678",
    "phone": "2347031234567",
    "image": "{{base64String2}}",
    "proof_of_id": {
      "document_type": "Driver's licence",
      "document": "{{base64String2}}"
    },
    "proof_of_address": {
      "document_type": "Utility bill",
      "document": "{{base64String2}}"
    },
    "address": {
      "street": "456 Johnson Street",
      "area": "Akobo",
      "city": "Ilesa",
      "local_government": "Ilesa West",
      "country": "NG"
    },
    "next_of_kin": {
      "first_name": "Ado",
      "middle_name": "John",
      "surname": "Sule",
      "gender": "M",
      "email": "adajoanne@example.com",
      "phone": "+2347031234567",
      "relationship": "Sibling",
      "address": {
        "street": "456 Johnson Street",
        "area": "Akobo",
        "city": "Ilesa",
        "local_government": "Ilesa West",
        "country": "NG"
      }
    },
    "custom_properties": [
      {
        "id": "Some random ID",
        "description": "Some random text",
        "type": "Some random type",
        "value": "Some value"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

connection-id
string

Connection ID for the target bank

idempotency-key
string
required

Unique key to ensure idempotency of the request

signature
string
required

SHA-256 signature of client_secret + ";" + idempotency-key

Response

Successful response

status
string

Response status code

Example:

"00"

message
string

A human-readable message describing the response

Example:

"The process was completed successully"

data
object
I