Paystack

The Paystack Developer Documentation

Welcome to the Paystack Developer Documentation.

You'll find comprehensive guides and documentation to help you start working with Paystack as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Discussion

User Verification

Paystack provides a number of tools that help you verify user information. Here's a list of identification and verification tools that Paystack currently provides:

  1. BVN Verification
  2. Resolve Bank Account Number
  3. Resolve Card BIN
  4. Phone number verification

BVN Verification

We provide a way for you to verify a user's identity using their Nigerian Bank Verification Number. Users supplies their BVN number and you call BVN Resolve endpoint with it.

Here is a sample request:

curl "https://api.paystack.co/bank/resolve_bvn/USERS_BVN" \
-H "Authorization: Bearer YOUR_SECRET_KEY" 
-X GET

It returns the following information about the user:

  • First name
  • Last name
  • Phone number
  • Date of birth
  • BVN number

To verify that user, you can withhold the information returned, then send an OTP to the BVN phone number which they can enter into your site or app to confirm they own the BVN. You can also prompt for their date of birth and confirm if it matches with the one returned with the BVN.

This service cost N10 per call, but you get 10 free calls per month. After exhausting the 10 free calls, registered businesses would have to top up your Paystack balance to continue using this service.

Starter businesses can only make 10 calls per month and cannot top up to continue using the service.

Resolve Bank Account Number

This endpoint takes an account number and bank code and returns the user's account name. With this, both you and your user can confirm that they are inputting the right account details.

curl "https://api.paystack.co/bank/resolve?account_number=0022728151&bank_code=063" \
-H "Authorization: Bearer YOUR_SECRET_KEY" \
-X GET

You can get the list of banks and their bank codes using this endpoint.

This service is free.

PLEASE NOTE: Currently, account numbers for Parallex bank cannot be resolved. We will update this as things change.

Resolve Card Bin

This endpoint takes the first 6 digits of a card PAN and returns information about the card.

curl "https://api.paystack.co/decision/bin/539983" \
-H "Authorization: Bearer YOUR_SECRET_KEY" \
-X GET

Details returned include the card brand (Mastercard, Visa, etc), card type (credit, debit), country name, country code and bank.

This service is free

Phone Number Verification

In collaboration with Truecaller, Paystack has an endpoint that you can be used to verify user's phone numbers.

The endpoint takes three parameters:

  1. The verification type - truecaller
  2. The user's phone number
  3. A callback url
curl -X POST \
  "https://api.paystack.co/verifications" \
  -H 'Authorization: Bearer SECRET_KEY' \
  -H 'content-type: application/json' \
  -F verification_type=truecaller \
  -F phone=2349012345678 \
  -F callback_url=https://linktopage.com/truecaller

When you submit the parameters to the endpoint, The user will get a notification on their phone from Truecaller to log in. Once they've logged in, you'll receive the user's Truecaller information at the callback url you specified in your api call.

Updated 2 days ago

User Verification


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.