BVN Number OTP

This API allows you to verify a user's identity by sending an OTP to their registered phone number and verifying the OTP against their BVN.

BVN Verification

POST https://api.getspendo.com/gateway/api/v1/verify/bvn

Headers

Name	Type	Description
apiKey*	String	The API key that you get from spendo's dashboard.

Request Body

Name	Type	Description
otp*	Integer	The OTP code that you want to send, represented as a string. This parameter is usually generated by your system or a third-party authentication provider.
number*	String	The user's BVN, represented as a string of 11 digits.

200 OTP successfully sent

{
  "success": true,
  "message": "OTP sent",
  "code": 0,
  "data": null
}

401 OTP not sent

{
  "success": false,
  "message": "Error sending OTP",
  "code": 0,
  "data": null
}

Good to know: You can use our API Method block to fully test all the API method.

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl --location --request POST 'https://api.getspendo.com/gateway/api/v1/verify/bvn' \
--header 'apiKey: test_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
  "number": "string",
  "otp": "string"
}'

Node

var axios = require('axios');
var data = JSON.stringify({
  "number": "string",
  "otp": "string"
});

var config = {
  method: 'post',
  url: 'https://api.getspendo.com/gateway/api/v1/verify/bvn',
  headers: { 
    'apiKey': 'test_api_key', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Python

import http.client
import json

conn = http.client.HTTPSConnection("api.getspendo.com")
payload = json.dumps({
  "number": "string",
  "otp": "string"
})
headers = {
  'apiKey': 'test_api_key',
  'Content-Type': 'application/json'
}
conn.request("POST", "/gateway/api/v1/verify/bvn", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.getspendo.com/gateway/api/v1/verify/bvn',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
  "number": "string",
  "otp": "string"
}',
  CURLOPT_HTTPHEADER => array(
    'apiKey: test_api_key',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"number\": \"string\",\n  \"otp\": \"string\"\n}");
Request request = new Request.Builder()
  .url("https://api.getspendo.com/gateway/api/v1/verify/bvn")
  .method("POST", body)
  .addHeader("apiKey", "test_api_key")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Javascript

var settings = {
  "url": "https://api.getspendo.com/gateway/api/v1/verify/bvn",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "apiKey": "test_api_key",
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "number": "string",
    "otp": "string"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});