Verification

Overview

The Verification class provides methods for verifying various Paystack entities including bank accounts and card BINs. This helps you validate customer information before processing payments.

Methods

resolveAccount

Resolves a bank account number to an account name. This is useful for confirming the account details before initiating a transfer.

const result = await paystack.verification.resolveAccount({
  account_number: "0123456789",
  bank_code: "058"
});

if (result.data) {
  console.log(result.data.data.account_name);
  console.log(result.data.data.account_number);
}

const result = await paystack.verification.resolveAccount({
  account_number: "0123456789",
  bank_code: "058"
});

if (result.data) {
  console.log(result.data.data.account_name);
  console.log(result.data.data.account_number);
}

Parameters

string

required

The bank account number you want to verify

string

required

The bank code of the bank where the account is held. You can get this from the listBanks method

Response

boolean

Indicates whether the request was successful

string

A message describing the result

object

The account details

Show data properties

string

The account number that was resolved

string

The name on the account

validateAccount

Validates a customer’s account number using their identity information. This provides enhanced verification beyond simple name resolution.

const result = await paystack.verification.validateAccount({
  account_name: "John Doe",
  account_number: "0123456789",
  account_type: "personal",
  bank_code: "058",
  country_code: "NG",
  document_type: "identityNumber",
  document_number: "1234567890"
});

if (result.data) {
  console.log(result.data.data.verified);
  console.log(result.data.data.verificationMessage);
}

const result = await paystack.verification.validateAccount({
  account_name: "John Doe",
  account_number: "0123456789",
  account_type: "personal",
  bank_code: "058",
  country_code: "NG",
  document_type: "identityNumber",
  document_number: "1234567890"
});

if (result.data) {
  console.log(result.data.data.verified);
  console.log(result.data.data.verificationMessage);
}

Parameters

string

required

The name on the account

string

required

The bank account number to validate

enum

required

The type of account. Options: personal, business

string

required

The bank code where the account is held

string

required

The country code (e.g., “NG” for Nigeria, “GH” for Ghana)

enum

required

The type of document being used for verification. Options: identityNumber, passportNumber, businessRegistrationNumber

string

The document number (optional depending on requirements)

Response

boolean

Indicates whether the request was successful

string

A message describing the result

object

The validation result

Show data properties

boolean

Whether the account was successfully verified

string

A message describing the verification result

resolveCardBin

Resolves a card BIN (Bank Identification Number) to get card and bank details. The first 6 digits of a card number make up the BIN.

const result = await paystack.verification.resolveCardBin({
  card_bin: "539983"
});

if (result.data) {
  console.log(result.data.data.bank);
  console.log(result.data.data.brand);
  console.log(result.data.data.card_type);
  console.log(result.data.data.country_name);
}

const result = await paystack.verification.resolveCardBin({
  card_bin: "539983"
});

if (result.data) {
  console.log(result.data.data.bank);
  console.log(result.data.data.brand);
  console.log(result.data.data.card_type);
  console.log(result.data.data.country_name);
}

Parameters

string

required

The first 6 digits of the card number

Response

boolean

Indicates whether the request was successful

string

A message describing the result

object

The card BIN details

Show data properties

string

The card BIN that was resolved

string

The card brand (e.g., “Visa”, “Mastercard”)

string

The card sub-brand

string

The country code where the card was issued

string

The country name where the card was issued

string

The type of card (e.g., “DEBIT”, “CREDIT”)

string

The bank that issued the card

number

The ID of the linked bank in Paystack’s system

Error Handling

All methods return a result object with data and error properties. Always check for errors:

const result = await paystack.verification.resolveAccount({
  account_number: "0123456789",
  bank_code: "058"
});

if (result.error) {
  console.error('Verification failed:', result.error.flatten());
} else if (result.data) {
  console.log('Account name:', result.data.data.account_name);
}

Miscellaneous

Get list of supported banks for verification

Paystack Verification API

Official Paystack Verification API documentation

Core

Modules

Overview

Methods

resolveAccount

Parameters

Response

validateAccount

Parameters

Response

resolveCardBin

Parameters

Response

Error Handling

Miscellaneous

Paystack Verification API

​Overview

​Methods

​resolveAccount

​Parameters

​Response

​validateAccount

​Parameters

​Response

​resolveCardBin

​Parameters

​Response

​Error Handling

​Related Resources

Miscellaneous

Paystack Verification API

Overview

Methods

resolveAccount

Parameters

Response

validateAccount

Parameters

Response

resolveCardBin

Parameters

Response

Error Handling

Related Resources