Start verifying a person
curl --request POST \
--url https://api.paj.cash/pub/v2/kyc/sessions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"externalUserId": "acme-user-123",
"idNumber": "22222222222",
"idType": "BVN",
"country": "NG",
"consentVersion": "v1"
}
'import requests
url = "https://api.paj.cash/pub/v2/kyc/sessions"
payload = {
"externalUserId": "acme-user-123",
"idNumber": "22222222222",
"idType": "BVN",
"country": "NG",
"consentVersion": "v1"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalUserId: 'acme-user-123',
idNumber: '22222222222',
idType: 'BVN',
country: 'NG',
consentVersion: 'v1'
})
};
fetch('https://api.paj.cash/pub/v2/kyc/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paj.cash/pub/v2/kyc/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalUserId' => 'acme-user-123',
'idNumber' => '22222222222',
'idType' => 'BVN',
'country' => 'NG',
'consentVersion' => 'v1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paj.cash/pub/v2/kyc/sessions"
payload := strings.NewReader("{\n \"externalUserId\": \"acme-user-123\",\n \"idNumber\": \"22222222222\",\n \"idType\": \"BVN\",\n \"country\": \"NG\",\n \"consentVersion\": \"v1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paj.cash/pub/v2/kyc/sessions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalUserId\": \"acme-user-123\",\n \"idNumber\": \"22222222222\",\n \"idType\": \"BVN\",\n \"country\": \"NG\",\n \"consentVersion\": \"v1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paj.cash/pub/v2/kyc/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalUserId\": \"acme-user-123\",\n \"idNumber\": \"22222222222\",\n \"idType\": \"BVN\",\n \"country\": \"NG\",\n \"consentVersion\": \"v1\"\n}"
response = http.request(request)
puts response.read_body{
"status": "OTP_SENT",
"sessionId": "kys_9fa17c2e4b6d8a0c1e3f5a7b",
"customerId": "cus_8f2a6c1d9e4b7f03a5c8d2e6b1f4a790",
"externalUserId": "acme-user-123",
"tier": 1,
"declineCode": "ID_NOT_VERIFIED",
"expiresAt": "2023-11-07T05:31:56Z"
}KYC
Start verifying a person
Checks the BVN and sends a code to the phone on its record. Call this from your server, never from an app or browser. If this externalUserId is already verified with the same BVN, the customerId comes straight back and no code is sent.
POST
/
pub
/
v2
/
kyc
/
sessions
Start verifying a person
curl --request POST \
--url https://api.paj.cash/pub/v2/kyc/sessions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"externalUserId": "acme-user-123",
"idNumber": "22222222222",
"idType": "BVN",
"country": "NG",
"consentVersion": "v1"
}
'import requests
url = "https://api.paj.cash/pub/v2/kyc/sessions"
payload = {
"externalUserId": "acme-user-123",
"idNumber": "22222222222",
"idType": "BVN",
"country": "NG",
"consentVersion": "v1"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalUserId: 'acme-user-123',
idNumber: '22222222222',
idType: 'BVN',
country: 'NG',
consentVersion: 'v1'
})
};
fetch('https://api.paj.cash/pub/v2/kyc/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paj.cash/pub/v2/kyc/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalUserId' => 'acme-user-123',
'idNumber' => '22222222222',
'idType' => 'BVN',
'country' => 'NG',
'consentVersion' => 'v1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paj.cash/pub/v2/kyc/sessions"
payload := strings.NewReader("{\n \"externalUserId\": \"acme-user-123\",\n \"idNumber\": \"22222222222\",\n \"idType\": \"BVN\",\n \"country\": \"NG\",\n \"consentVersion\": \"v1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paj.cash/pub/v2/kyc/sessions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalUserId\": \"acme-user-123\",\n \"idNumber\": \"22222222222\",\n \"idType\": \"BVN\",\n \"country\": \"NG\",\n \"consentVersion\": \"v1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paj.cash/pub/v2/kyc/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalUserId\": \"acme-user-123\",\n \"idNumber\": \"22222222222\",\n \"idType\": \"BVN\",\n \"country\": \"NG\",\n \"consentVersion\": \"v1\"\n}"
response = http.request(request)
puts response.read_body{
"status": "OTP_SENT",
"sessionId": "kys_9fa17c2e4b6d8a0c1e3f5a7b",
"customerId": "cus_8f2a6c1d9e4b7f03a5c8d2e6b1f4a790",
"externalUserId": "acme-user-123",
"tier": 1,
"declineCode": "ID_NOT_VERIFIED",
"expiresAt": "2023-11-07T05:31:56Z"
}Checks a BVN and sends a code to the phone on its record. Call it from your
server. See Verifying your users for the whole flow.
Sending
consentVersion is your statement that the person saw that consent text
and agreed to it.
If this externalUserId is already linked to the same BVN, you get the existing
customerId straight back and no code is sent. If it’s linked to a different BVN,
the response is 409.Body
application/json