Customer KYC package requirements
curl --request GET \
--url https://sandbox.elementpay.net/api/v1/partner/customers/requirements \
--header 'X-API-Key: <api-key>'import requests
url = "https://sandbox.elementpay.net/api/v1/partner/customers/requirements"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://sandbox.elementpay.net/api/v1/partner/customers/requirements', 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://sandbox.elementpay.net/api/v1/partner/customers/requirements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://sandbox.elementpay.net/api/v1/partner/customers/requirements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.elementpay.net/api/v1/partner/customers/requirements")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elementpay.net/api/v1/partner/customers/requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Customer requirements",
"data": {
"type": "individual",
"required_fields": [
"first_name",
"last_name",
"email",
"date_of_birth",
"country_of_residence",
"gender",
"phone",
"address",
"id_number",
"id_type"
],
"required_documents": [
{
"key": "identity",
"description": "Government photo ID (passport, license, national ID)"
},
{
"key": "address",
"description": "Proof of address (last 3 months)"
}
],
"optional_fields": [
"middle_name",
"liveness_check_id",
"proof_of_address_type",
"additional_id_number",
"additional_id_type"
],
"conditional_fields": [
{
"field": "additional_id_type",
"when": "country_of_residence == NG",
"required": true,
"description": "Nigeria BVN type (use bvn)",
"example": "bvn"
},
{
"field": "additional_id_number",
"when": "country_of_residence == NG",
"required": true,
"description": "Nigeria BVN number (11 digits)",
"example": "12345678901"
}
],
"products": {
"deposit_account": {
"notes": "deposit_account.status ready means KYC approved and partner may open deposit accounts — no automatic account open."
}
},
"notes": "Full individual package is required before submit. profile.address must include line1, city, and country. profile.id_number and profile.id_type are required. Nigeria residents must also include profile.additional_id_type (bvn) and profile.additional_id_number."
}
}
Customers
Customer KYC package requirements
Return the full KYC package for a customer type before create/submit.
GET
/
partner
/
customers
/
requirements
Customer KYC package requirements
curl --request GET \
--url https://sandbox.elementpay.net/api/v1/partner/customers/requirements \
--header 'X-API-Key: <api-key>'import requests
url = "https://sandbox.elementpay.net/api/v1/partner/customers/requirements"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://sandbox.elementpay.net/api/v1/partner/customers/requirements', 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://sandbox.elementpay.net/api/v1/partner/customers/requirements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://sandbox.elementpay.net/api/v1/partner/customers/requirements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.elementpay.net/api/v1/partner/customers/requirements")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elementpay.net/api/v1/partner/customers/requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Customer requirements",
"data": {
"type": "individual",
"required_fields": [
"first_name",
"last_name",
"email",
"date_of_birth",
"country_of_residence",
"gender",
"phone",
"address",
"id_number",
"id_type"
],
"required_documents": [
{
"key": "identity",
"description": "Government photo ID (passport, license, national ID)"
},
{
"key": "address",
"description": "Proof of address (last 3 months)"
}
],
"optional_fields": [
"middle_name",
"liveness_check_id",
"proof_of_address_type",
"additional_id_number",
"additional_id_type"
],
"conditional_fields": [
{
"field": "additional_id_type",
"when": "country_of_residence == NG",
"required": true,
"description": "Nigeria BVN type (use bvn)",
"example": "bvn"
},
{
"field": "additional_id_number",
"when": "country_of_residence == NG",
"required": true,
"description": "Nigeria BVN number (11 digits)",
"example": "12345678901"
}
],
"products": {
"deposit_account": {
"notes": "deposit_account.status ready means KYC approved and partner may open deposit accounts — no automatic account open."
}
},
"notes": "Full individual package is required before submit. profile.address must include line1, city, and country. profile.id_number and profile.id_type are required. Nigeria residents must also include profile.additional_id_type (bvn) and profile.additional_id_number."
}
}
Return the full KYC package for a customer type before create/submit.
Query
type—individual(default) orbusinesscountry— optional ISO code; sharpens corridor-specific conditional fields (e.g. NG BVN, US EIN)
data lists required_fields, required_documents, optional_fields, and conditional_fields. For business, nested officer fields are under field_shapes.officers (not top-level required_fields). Use this to build profile on POST /partner/customers and document uploads.
This is not the same as
GET /partner/order-requirements (quote field hints per corridor).Authorizations
Partner API key. Sandbox keys start with is_test_; production keys start with is_live_. Keys are not interchangeable across environments. Send on every request. Never expose in browser or mobile clients.
Query Parameters
individual or business
Available options:
individual, business Optional ISO country (e.g. US) for corridor-conditioned fields like tax_id