​
Customer Management Guide

This guide covers everything you need to know about managing customers in your Open Banking application. Our customer management API provides secure access to customer data and allows for updating customer information. The following sections outline the key features and capabilities available to you:

​
Get Customer Details

Retrieve comprehensive customer information including personal details, contact information, identification documents, address, and next of kin details. 
curl -X GET ${API_BASE_URL}/customers \
  -H "Authorization: Bearer ${YOUR_ACCESS_TOKEN}" \
  -H "idempotency_key: ${IDEMPOTENCY_KEY}" \
  -H "signature: ${SIGNATURE}"

{
  "status": "success",
  "message": "Operation successful",
  "data": {
      "first_name": "hello",
      "middle_name": null,
      "surname": "dev",
      "gender": null,
      "email": "hellodevelo+1@gmail.com",
      "bvn": "234802325829",
      "phone": "2348023258292",
      "image": null,
      "proof_of_id": null,
      "proof_of_address": null,
      "address": {
          "street": null,
          "area": null,
          "city": null,
          "local_government": null,
          "country": null
      },
      "next_of_kin": null
  }
}
Make sure you send the scope customers.readonly while requesting for a token, failure to send the scope will lead to the issued access token not able to access this API.

​
Update Customer Information

Sparkle will not be supporting this API.

​
Next Steps

Now that you understand customer management operations, explore these related topics:
Always ensure proper consent and authorization before performing account operations. Implement robust error handling and security measures to protect customer data and maintain account integrity. Regular monitoring and compliance with regulatory requirements are essential for successful account management implementation.
⌘I