GET
https://api-sandbox.cscs.ng
/
v1
/
investors
/
dependants
/
by-guardian
Discover dependant investors by guardian BVN
curl --request GET \
  --url https://api-sandbox.cscs.ng/v1/investors/dependants/by-guardian \
  --header 'Idempotency-Key: <idempotency-key>'
{
  "status": true,
  "matches": [
    {
      "status": "active",
      "investorId": "8a15d7c4-14b2-4f8c-aef3-12cfe4df1a60",
      "name": "Ada Doe",
      "accountType": "M",
      "birthDate": "2018-06-10",
      "bvnHolderName": "Jane Doe",
      "chn": "CA123456789X",
      "accountDetails": [
        {
          "cscsNo": "0000000123",
          "memberCode": "ABC1234"
        },
        {
          "cscsNo": "0000000456",
          "memberCode": "XYZ5678"
        }
      ]
    }
  ]
}

Headers

​
Idempotency-Key
string
required

Reuse the same key when retrying the same idempotent request.

Example:

"3e9cb40d-87b8-4a60-bffe-bdb7b5e65e9c"

Query Parameters

​
bvn
string

Lookup by BVN. Provide this alone, or use a different single lookup strategy.

Pattern: ^[0-9]{11}$
Example:

"12345678901"

Response

Grouped dependant lookup result

​
status
boolean
required
Example:

true

​
matches
object[]
required

Logical minor matches grouped by guardian BVN and child identity