logoOPEN BANKING DOCS

Get customer by ID

Retrieve detailed information for a specific customer

GET
/customers/{customerId}
X-API-Key<token>

In: header

Path Parameters

customerIdstring

Customer UUID

Formatuuid

Header Parameters

X-API-Keystring

API key for the application

X-App-Idstring

UUID of the application

Formatuuid

Response Body

curl -X GET "https://virtual-accounts-api.vantacrest.com/company/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -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"
}