GET
https://api-sandbox.cscs.ng
/
v1
/
lookup
Universal investor lookup
curl --request GET \
  --url https://api-sandbox.cscs.ng/v1/lookup \
  --header 'Idempotency-Key: <idempotency-key>'
{
  "status": true,
  "matches": [
    {
      "status": "active",
      "investorId": "8a15d7c4-14b2-4f8c-aef3-12cfe4df1a60",
      "name": "John Doe",
      "accountType": "I",
      "chn": "CA123456789X",
      "accountDetails": [
        {
          "cscsNo": "0000000123",
          "memberCode": "ABC1234"
        }
      ]
    }
  ]
}

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"

​
chn
string

Lookup by CHN. Provide this alone, or use a different single lookup strategy. Both legacy and current CHN formats are accepted for search.

Example:

"CA123456789X"

​
cscsNo
string

Lookup by CSCS number. Provide this alone, or use a different single lookup strategy. Values are always 10 digits and are zero-padded when needed.

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

"0000000123"

​
bankAccountNumber
string

Lookup by bank account. Must be sent together with bankSortCode and not combined with another lookup strategy.

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

"0123456789"

​
bankSortCode
string

Companion field for bank account lookups. Must be sent together with bankAccountNumber.

Example:

"044150149"

Response

Universal lookup result (may return multiple matches across categories)

​
status
boolean
required
Example:

true

​
matches
object[]
required

Investor matches across supported categories. BVN lookups exclude dependant/minor matches.