Submit KYC documents
curl --request POST \
--url https://api.puplar.com/customers/{id}/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"id_number": "<string>",
"id_front": "<string>",
"id_back": "<string>",
"country": "<string>",
"dob": "<string>"
}
]
}
'import requests
url = "https://api.puplar.com/customers/{id}/documents"
payload = { "documents": [
{
"id_number": "<string>",
"id_front": "<string>",
"id_back": "<string>",
"country": "<string>",
"dob": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
documents: [
{
id_number: '<string>',
id_front: '<string>',
id_back: '<string>',
country: '<string>',
dob: '<string>'
}
]
})
};
fetch('https://api.puplar.com/customers/{id}/documents', 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.puplar.com/customers/{id}/documents",
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([
'documents' => [
[
'id_number' => '<string>',
'id_front' => '<string>',
'id_back' => '<string>',
'country' => '<string>',
'dob' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.puplar.com/customers/{id}/documents"
payload := strings.NewReader("{\n \"documents\": [\n {\n \"id_number\": \"<string>\",\n \"id_front\": \"<string>\",\n \"id_back\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.puplar.com/customers/{id}/documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documents\": [\n {\n \"id_number\": \"<string>\",\n \"id_front\": \"<string>\",\n \"id_back\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.puplar.com/customers/{id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"documents\": [\n {\n \"id_number\": \"<string>\",\n \"id_front\": \"<string>\",\n \"id_back\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "Success",
"data": {}
}{
"message": "Error message",
"data": {},
"errors": {}
}{
"message": "Error message",
"data": {},
"errors": {}
}{
"message": "Error message",
"data": {},
"errors": {}
}{
"message": "Error message",
"data": {},
"errors": {}
}{
"message": "Error message",
"data": {},
"errors": {}
}Customers
Submit KYC documents
Submit up to 3 KYC documents for a customer.
Test mode (sk_test_*): Simulated verification — no real BVN/NIN lookup. BVN 22222222222 or NIN 12345678901 → success; BVN 11111111111 or NIN 10000000000 → failure. Passport/driver license with id_front always succeeds in test. See guides/kyc.
POST
/
customers
/
{id}
/
documents
Submit KYC documents
curl --request POST \
--url https://api.puplar.com/customers/{id}/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"id_number": "<string>",
"id_front": "<string>",
"id_back": "<string>",
"country": "<string>",
"dob": "<string>"
}
]
}
'import requests
url = "https://api.puplar.com/customers/{id}/documents"
payload = { "documents": [
{
"id_number": "<string>",
"id_front": "<string>",
"id_back": "<string>",
"country": "<string>",
"dob": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
documents: [
{
id_number: '<string>',
id_front: '<string>',
id_back: '<string>',
country: '<string>',
dob: '<string>'
}
]
})
};
fetch('https://api.puplar.com/customers/{id}/documents', 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.puplar.com/customers/{id}/documents",
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([
'documents' => [
[
'id_number' => '<string>',
'id_front' => '<string>',
'id_back' => '<string>',
'country' => '<string>',
'dob' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.puplar.com/customers/{id}/documents"
payload := strings.NewReader("{\n \"documents\": [\n {\n \"id_number\": \"<string>\",\n \"id_front\": \"<string>\",\n \"id_back\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.puplar.com/customers/{id}/documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documents\": [\n {\n \"id_number\": \"<string>\",\n \"id_front\": \"<string>\",\n \"id_back\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.puplar.com/customers/{id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"documents\": [\n {\n \"id_number\": \"<string>\",\n \"id_front\": \"<string>\",\n \"id_back\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "Success",
"data": {}
}{
"message": "Error message",
"data": {},
"errors": {}
}{
"message": "Error message",
"data": {},
"errors": {}
}{
"message": "Error message",
"data": {},
"errors": {}
}{
"message": "Error message",
"data": {},
"errors": {}
}{
"message": "Error message",
"data": {},
"errors": {}
}Authorizations
Secret key: Authorization: Bearer sk_test_... or sk_live_.... Business and live/test mode are inferred from the key.
Path Parameters
Customer Id
Body
application/json
Required array length:
1 - 3 elementsShow child attributes
Show child attributes

