Add a UBO
curl --request POST \
--url https://api.tradevu.co/v1/api/business/{businessId}/ubo \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "Jane",
"lastName": "Doe",
"phoneNumber": "+2348012345678",
"gender": "Female",
"meanOfIdentificationUrl": "<string>",
"idNumber": "<string>",
"address": {
"houseNumber": "12",
"street": "Adeola Odeku Street",
"city": "Lagos",
"state": "Lagos",
"zipCode": "101233",
"subdivision": "<string>"
},
"idDocumentFront": {
"url": "https://example.com/documents/certificate.pdf",
"key": "business/certificate.pdf"
},
"email": "[email protected]",
"title": "Director",
"dateOfBirth": "1990-01-01",
"percentageOwnership": "50",
"bvn": "<string>",
"bvnNumber": "<string>"
}
'import requests
url = "https://api.tradevu.co/v1/api/business/{businessId}/ubo"
payload = {
"firstName": "Jane",
"lastName": "Doe",
"phoneNumber": "+2348012345678",
"gender": "Female",
"meanOfIdentificationUrl": "<string>",
"idNumber": "<string>",
"address": {
"houseNumber": "12",
"street": "Adeola Odeku Street",
"city": "Lagos",
"state": "Lagos",
"zipCode": "101233",
"subdivision": "<string>"
},
"idDocumentFront": {
"url": "https://example.com/documents/certificate.pdf",
"key": "business/certificate.pdf"
},
"email": "[email protected]",
"title": "Director",
"dateOfBirth": "1990-01-01",
"percentageOwnership": "50",
"bvn": "<string>",
"bvnNumber": "<string>"
}
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({
firstName: 'Jane',
lastName: 'Doe',
phoneNumber: '+2348012345678',
gender: 'Female',
meanOfIdentificationUrl: '<string>',
idNumber: '<string>',
address: {
houseNumber: '12',
street: 'Adeola Odeku Street',
city: 'Lagos',
state: 'Lagos',
zipCode: '101233',
subdivision: '<string>'
},
idDocumentFront: {
url: 'https://example.com/documents/certificate.pdf',
key: 'business/certificate.pdf'
},
email: '[email protected]',
title: 'Director',
dateOfBirth: '1990-01-01',
percentageOwnership: '50',
bvn: '<string>',
bvnNumber: '<string>'
})
};
fetch('https://api.tradevu.co/v1/api/business/{businessId}/ubo', 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.tradevu.co/v1/api/business/{businessId}/ubo",
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([
'firstName' => 'Jane',
'lastName' => 'Doe',
'phoneNumber' => '+2348012345678',
'gender' => 'Female',
'meanOfIdentificationUrl' => '<string>',
'idNumber' => '<string>',
'address' => [
'houseNumber' => '12',
'street' => 'Adeola Odeku Street',
'city' => 'Lagos',
'state' => 'Lagos',
'zipCode' => '101233',
'subdivision' => '<string>'
],
'idDocumentFront' => [
'url' => 'https://example.com/documents/certificate.pdf',
'key' => 'business/certificate.pdf'
],
'email' => '[email protected]',
'title' => 'Director',
'dateOfBirth' => '1990-01-01',
'percentageOwnership' => '50',
'bvn' => '<string>',
'bvnNumber' => '<string>'
]),
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.tradevu.co/v1/api/business/{businessId}/ubo"
payload := strings.NewReader("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+2348012345678\",\n \"gender\": \"Female\",\n \"meanOfIdentificationUrl\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"address\": {\n \"houseNumber\": \"12\",\n \"street\": \"Adeola Odeku Street\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos\",\n \"zipCode\": \"101233\",\n \"subdivision\": \"<string>\"\n },\n \"idDocumentFront\": {\n \"url\": \"https://example.com/documents/certificate.pdf\",\n \"key\": \"business/certificate.pdf\"\n },\n \"email\": \"[email protected]\",\n \"title\": \"Director\",\n \"dateOfBirth\": \"1990-01-01\",\n \"percentageOwnership\": \"50\",\n \"bvn\": \"<string>\",\n \"bvnNumber\": \"<string>\"\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.tradevu.co/v1/api/business/{businessId}/ubo")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+2348012345678\",\n \"gender\": \"Female\",\n \"meanOfIdentificationUrl\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"address\": {\n \"houseNumber\": \"12\",\n \"street\": \"Adeola Odeku Street\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos\",\n \"zipCode\": \"101233\",\n \"subdivision\": \"<string>\"\n },\n \"idDocumentFront\": {\n \"url\": \"https://example.com/documents/certificate.pdf\",\n \"key\": \"business/certificate.pdf\"\n },\n \"email\": \"[email protected]\",\n \"title\": \"Director\",\n \"dateOfBirth\": \"1990-01-01\",\n \"percentageOwnership\": \"50\",\n \"bvn\": \"<string>\",\n \"bvnNumber\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tradevu.co/v1/api/business/{businessId}/ubo")
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 \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+2348012345678\",\n \"gender\": \"Female\",\n \"meanOfIdentificationUrl\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"address\": {\n \"houseNumber\": \"12\",\n \"street\": \"Adeola Odeku Street\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos\",\n \"zipCode\": \"101233\",\n \"subdivision\": \"<string>\"\n },\n \"idDocumentFront\": {\n \"url\": \"https://example.com/documents/certificate.pdf\",\n \"key\": \"business/certificate.pdf\"\n },\n \"email\": \"[email protected]\",\n \"title\": \"Director\",\n \"dateOfBirth\": \"1990-01-01\",\n \"percentageOwnership\": \"50\",\n \"bvn\": \"<string>\",\n \"bvnNumber\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "UBO added successfully",
"data": {}
}{
"statusCode": 400,
"message": "Invalid currency: XYZ",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/v1/api/balance/XYZ",
"request": {
"method": "GET",
"url": "/v1/api/balance/XYZ"
}
}Business Onboarding
Add a UBO
Adds an ultimate beneficial owner (UBO) to a business you created. Once the business has at least one director and one UBO, it’s automatically submitted for verification.
POST
/
api
/
business
/
{businessId}
/
ubo
Add a UBO
curl --request POST \
--url https://api.tradevu.co/v1/api/business/{businessId}/ubo \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "Jane",
"lastName": "Doe",
"phoneNumber": "+2348012345678",
"gender": "Female",
"meanOfIdentificationUrl": "<string>",
"idNumber": "<string>",
"address": {
"houseNumber": "12",
"street": "Adeola Odeku Street",
"city": "Lagos",
"state": "Lagos",
"zipCode": "101233",
"subdivision": "<string>"
},
"idDocumentFront": {
"url": "https://example.com/documents/certificate.pdf",
"key": "business/certificate.pdf"
},
"email": "[email protected]",
"title": "Director",
"dateOfBirth": "1990-01-01",
"percentageOwnership": "50",
"bvn": "<string>",
"bvnNumber": "<string>"
}
'import requests
url = "https://api.tradevu.co/v1/api/business/{businessId}/ubo"
payload = {
"firstName": "Jane",
"lastName": "Doe",
"phoneNumber": "+2348012345678",
"gender": "Female",
"meanOfIdentificationUrl": "<string>",
"idNumber": "<string>",
"address": {
"houseNumber": "12",
"street": "Adeola Odeku Street",
"city": "Lagos",
"state": "Lagos",
"zipCode": "101233",
"subdivision": "<string>"
},
"idDocumentFront": {
"url": "https://example.com/documents/certificate.pdf",
"key": "business/certificate.pdf"
},
"email": "[email protected]",
"title": "Director",
"dateOfBirth": "1990-01-01",
"percentageOwnership": "50",
"bvn": "<string>",
"bvnNumber": "<string>"
}
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({
firstName: 'Jane',
lastName: 'Doe',
phoneNumber: '+2348012345678',
gender: 'Female',
meanOfIdentificationUrl: '<string>',
idNumber: '<string>',
address: {
houseNumber: '12',
street: 'Adeola Odeku Street',
city: 'Lagos',
state: 'Lagos',
zipCode: '101233',
subdivision: '<string>'
},
idDocumentFront: {
url: 'https://example.com/documents/certificate.pdf',
key: 'business/certificate.pdf'
},
email: '[email protected]',
title: 'Director',
dateOfBirth: '1990-01-01',
percentageOwnership: '50',
bvn: '<string>',
bvnNumber: '<string>'
})
};
fetch('https://api.tradevu.co/v1/api/business/{businessId}/ubo', 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.tradevu.co/v1/api/business/{businessId}/ubo",
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([
'firstName' => 'Jane',
'lastName' => 'Doe',
'phoneNumber' => '+2348012345678',
'gender' => 'Female',
'meanOfIdentificationUrl' => '<string>',
'idNumber' => '<string>',
'address' => [
'houseNumber' => '12',
'street' => 'Adeola Odeku Street',
'city' => 'Lagos',
'state' => 'Lagos',
'zipCode' => '101233',
'subdivision' => '<string>'
],
'idDocumentFront' => [
'url' => 'https://example.com/documents/certificate.pdf',
'key' => 'business/certificate.pdf'
],
'email' => '[email protected]',
'title' => 'Director',
'dateOfBirth' => '1990-01-01',
'percentageOwnership' => '50',
'bvn' => '<string>',
'bvnNumber' => '<string>'
]),
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.tradevu.co/v1/api/business/{businessId}/ubo"
payload := strings.NewReader("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+2348012345678\",\n \"gender\": \"Female\",\n \"meanOfIdentificationUrl\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"address\": {\n \"houseNumber\": \"12\",\n \"street\": \"Adeola Odeku Street\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos\",\n \"zipCode\": \"101233\",\n \"subdivision\": \"<string>\"\n },\n \"idDocumentFront\": {\n \"url\": \"https://example.com/documents/certificate.pdf\",\n \"key\": \"business/certificate.pdf\"\n },\n \"email\": \"[email protected]\",\n \"title\": \"Director\",\n \"dateOfBirth\": \"1990-01-01\",\n \"percentageOwnership\": \"50\",\n \"bvn\": \"<string>\",\n \"bvnNumber\": \"<string>\"\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.tradevu.co/v1/api/business/{businessId}/ubo")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+2348012345678\",\n \"gender\": \"Female\",\n \"meanOfIdentificationUrl\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"address\": {\n \"houseNumber\": \"12\",\n \"street\": \"Adeola Odeku Street\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos\",\n \"zipCode\": \"101233\",\n \"subdivision\": \"<string>\"\n },\n \"idDocumentFront\": {\n \"url\": \"https://example.com/documents/certificate.pdf\",\n \"key\": \"business/certificate.pdf\"\n },\n \"email\": \"[email protected]\",\n \"title\": \"Director\",\n \"dateOfBirth\": \"1990-01-01\",\n \"percentageOwnership\": \"50\",\n \"bvn\": \"<string>\",\n \"bvnNumber\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tradevu.co/v1/api/business/{businessId}/ubo")
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 \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+2348012345678\",\n \"gender\": \"Female\",\n \"meanOfIdentificationUrl\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"address\": {\n \"houseNumber\": \"12\",\n \"street\": \"Adeola Odeku Street\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos\",\n \"zipCode\": \"101233\",\n \"subdivision\": \"<string>\"\n },\n \"idDocumentFront\": {\n \"url\": \"https://example.com/documents/certificate.pdf\",\n \"key\": \"business/certificate.pdf\"\n },\n \"email\": \"[email protected]\",\n \"title\": \"Director\",\n \"dateOfBirth\": \"1990-01-01\",\n \"percentageOwnership\": \"50\",\n \"bvn\": \"<string>\",\n \"bvnNumber\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "UBO added successfully",
"data": {}
}{
"statusCode": 400,
"message": "Invalid currency: XYZ",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/v1/api/balance/XYZ",
"request": {
"method": "GET",
"url": "/v1/api/balance/XYZ"
}
}Authorizations
Your business API key, generated from the dashboard. Required on every business-facing endpoint.
Path Parameters
Body
application/json
Example:
"Jane"
Example:
"Doe"
Example:
"+2348012345678"
Example:
"Female"
Available options:
IdCard, BioMetricResidencePermit, BirthCertificate, currentPassport, driverLicense, bvnNumber, nationalId Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"Director"
Example:
"1990-01-01"
Example:
"50"
Show child attributes
Show child attributes