OPEN BANKING DOCSGet customers by application ID
Retrieve all customers associated with an application
X-API-Key<token>
In: header
Path Parameters
appIdstring
Application UUID
Format
uuidQuery Parameters
page?integer
Page number
Default
1Range
1 <= valuepageSize?integer
Number of items per page
Default
20Range
1 <= value <= 100kycLevel?string
Filter by KYC level
Value in
"TIER_1" | "TIER_2" | "TIER_3"kycStatus?string
Filter by KYC status
Value in
"PENDING" | "VERIFIED" | "REJECTED" | "UNDER_REVIEW"Header Parameters
X-API-Keystring
API key for the application
X-App-Idstring
UUID of the application
Format
uuidResponse Body
curl -X GET "https://virtual-accounts-api.vantacrest.com/company/v1/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/customers?page=1&pageSize=20&kycLevel=TIER_1&kycStatus=PENDING" \ -H "X-API-Key: string" \ -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"dateOfBirth": "2019-08-24",
"address": {
"street": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string"
},
"bvn": "string",
"nin": "string",
"kycLevel": "TIER_1",
"kycStatus": "PENDING",
"walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
"appId": "28c365d5-df94-4a54-8217-3ce51d068868",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}{
"success": true,
"message": "string",
"data": {},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": true,
"message": "string",
"data": {},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": true,
"message": "string",
"data": {},
"timestamp": "2019-08-24T14:15:22Z"
}