Verify BVN (Open Banking v2)

Verify Bank Verification Number (BVN) via Keystone. Charges a per-call fee from the debit account to the settlement account. Idempotent per minute using idempotencyKey. Live requests require the VERIFY_BVN feature approval.

Authorization

X-API-Key<token>

In: header

Path Parameters

bvnstring

Bank Verification Number (11 digits)

Match^[0-9]{11}$

Header Parameters

X-API-Keystring

API key for the application

X-App-Idstring

UUID of the application

Formatuuid

Request Body

appIdstring

Application ID

Formatuuid

bvnstring

Bank Verification Number (11 digits)

Match^[0-9]{11}$

debitAccountNumberstring

Account number to debit fee from (must belong to appId)

Match^[0-9]{10}$

currencystring

Currency code

Value in"NGN" | "USD" | "EUR" | "GBP"

idempotencyKey?string | null

Optional idempotency key for duplicate prevention

Response Body

curl -X POST "https://virtual-accounts-api.vantacrest.com/company/v1/open-banking/v2/kyc/bvn/string/verify" \
  -H "X-API-Key: string" \
  -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Content-Type: application/json" \
  -d '{
    "appId": "28c365d5-df94-4a54-8217-3ce51d068868",
    "bvn": "string",
    "debitAccountNumber": "string",
    "currency": "NGN"
  }'

curl -X POST "https://virtual-accounts-api.vantacrest.com/company/v1/open-banking/v2/kyc/bvn/string/verify" \  -H "X-API-Key: string" \  -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "appId": "28c365d5-df94-4a54-8217-3ce51d068868",    "bvn": "string",    "debitAccountNumber": "string",    "currency": "NGN"  }'

{
  "data": {
    "verified": true,
    "bvnMasked": "string",
    "feeApplied": true,
    "feeAmount": 0,
    "feeCurrency": "string",
    "feeTransactionId": "string",
    "settlementStatus": "PENDING",
    "correlationId": "string"
  }
}

{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}