Update a business
curl --request PATCH \
--url https://api.tradevu.co/v1/api/business/{businessId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Example Nigeria Limited",
"registrationNumber": "RC1234567",
"email": "[email protected]",
"phoneNumber": "+2348012345678",
"natureOfBusiness": {
"nature": "Retail and distribution",
"code": "retail"
},
"businessAddress": {
"houseNumber": "12",
"street": "Adeola Odeku Street",
"city": "Lagos",
"state": "Lagos",
"zipCode": "101233",
"subdivision": "<string>"
},
"proofOfAddress": {
"url": "https://example.com/documents/certificate.pdf",
"key": "business/certificate.pdf"
},
"documents": {},
"businessDescription": "<string>",
"activities": [
"<string>"
],
"monthlyTransactionVolume": {
"amount": "5000000"
},
"hasWebsite": true,
"businessWebsite": "<string>",
"legalName": "<string>",
"address": "<string>",
"placeId": "<string>",
"isHighRisk": true,
"TIN": "<string>",
"tin": "<string>",
"EIN": "<string>",
"annualTurnover": "<string>",
"monthlyPaymentsCount": "<string>",
"maxTransferAmount": "<string>",
"customerTypes": "<string>",
"sourceOfFundsDescription": "<string>",
"estimatedAnnualRevenue": "<string>",
"averageMonthlyTransactionVolume": "<string>",
"financialService": "<string>",
"businessPurpose": "<string>"
}
'import requests
url = "https://api.tradevu.co/v1/api/business/{businessId}"
payload = {
"name": "Example Nigeria Limited",
"registrationNumber": "RC1234567",
"email": "[email protected]",
"phoneNumber": "+2348012345678",
"natureOfBusiness": {
"nature": "Retail and distribution",
"code": "retail"
},
"businessAddress": {
"houseNumber": "12",
"street": "Adeola Odeku Street",
"city": "Lagos",
"state": "Lagos",
"zipCode": "101233",
"subdivision": "<string>"
},
"proofOfAddress": {
"url": "https://example.com/documents/certificate.pdf",
"key": "business/certificate.pdf"
},
"documents": {},
"businessDescription": "<string>",
"activities": ["<string>"],
"monthlyTransactionVolume": { "amount": "5000000" },
"hasWebsite": True,
"businessWebsite": "<string>",
"legalName": "<string>",
"address": "<string>",
"placeId": "<string>",
"isHighRisk": True,
"TIN": "<string>",
"tin": "<string>",
"EIN": "<string>",
"annualTurnover": "<string>",
"monthlyPaymentsCount": "<string>",
"maxTransferAmount": "<string>",
"customerTypes": "<string>",
"sourceOfFundsDescription": "<string>",
"estimatedAnnualRevenue": "<string>",
"averageMonthlyTransactionVolume": "<string>",
"financialService": "<string>",
"businessPurpose": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Example Nigeria Limited',
registrationNumber: 'RC1234567',
email: '[email protected]',
phoneNumber: '+2348012345678',
natureOfBusiness: {nature: 'Retail and distribution', code: 'retail'},
businessAddress: {
houseNumber: '12',
street: 'Adeola Odeku Street',
city: 'Lagos',
state: 'Lagos',
zipCode: '101233',
subdivision: '<string>'
},
proofOfAddress: {
url: 'https://example.com/documents/certificate.pdf',
key: 'business/certificate.pdf'
},
documents: {},
businessDescription: '<string>',
activities: ['<string>'],
monthlyTransactionVolume: {amount: '5000000'},
hasWebsite: true,
businessWebsite: '<string>',
legalName: '<string>',
address: '<string>',
placeId: '<string>',
isHighRisk: true,
TIN: '<string>',
tin: '<string>',
EIN: '<string>',
annualTurnover: '<string>',
monthlyPaymentsCount: '<string>',
maxTransferAmount: '<string>',
customerTypes: '<string>',
sourceOfFundsDescription: '<string>',
estimatedAnnualRevenue: '<string>',
averageMonthlyTransactionVolume: '<string>',
financialService: '<string>',
businessPurpose: '<string>'
})
};
fetch('https://api.tradevu.co/v1/api/business/{businessId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Example Nigeria Limited',
'registrationNumber' => 'RC1234567',
'email' => '[email protected]',
'phoneNumber' => '+2348012345678',
'natureOfBusiness' => [
'nature' => 'Retail and distribution',
'code' => 'retail'
],
'businessAddress' => [
'houseNumber' => '12',
'street' => 'Adeola Odeku Street',
'city' => 'Lagos',
'state' => 'Lagos',
'zipCode' => '101233',
'subdivision' => '<string>'
],
'proofOfAddress' => [
'url' => 'https://example.com/documents/certificate.pdf',
'key' => 'business/certificate.pdf'
],
'documents' => [
],
'businessDescription' => '<string>',
'activities' => [
'<string>'
],
'monthlyTransactionVolume' => [
'amount' => '5000000'
],
'hasWebsite' => true,
'businessWebsite' => '<string>',
'legalName' => '<string>',
'address' => '<string>',
'placeId' => '<string>',
'isHighRisk' => true,
'TIN' => '<string>',
'tin' => '<string>',
'EIN' => '<string>',
'annualTurnover' => '<string>',
'monthlyPaymentsCount' => '<string>',
'maxTransferAmount' => '<string>',
'customerTypes' => '<string>',
'sourceOfFundsDescription' => '<string>',
'estimatedAnnualRevenue' => '<string>',
'averageMonthlyTransactionVolume' => '<string>',
'financialService' => '<string>',
'businessPurpose' => '<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}"
payload := strings.NewReader("{\n \"name\": \"Example Nigeria Limited\",\n \"registrationNumber\": \"RC1234567\",\n \"email\": \"[email protected]\",\n \"phoneNumber\": \"+2348012345678\",\n \"natureOfBusiness\": {\n \"nature\": \"Retail and distribution\",\n \"code\": \"retail\"\n },\n \"businessAddress\": {\n \"houseNumber\": \"12\",\n \"street\": \"Adeola Odeku Street\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos\",\n \"zipCode\": \"101233\",\n \"subdivision\": \"<string>\"\n },\n \"proofOfAddress\": {\n \"url\": \"https://example.com/documents/certificate.pdf\",\n \"key\": \"business/certificate.pdf\"\n },\n \"documents\": {},\n \"businessDescription\": \"<string>\",\n \"activities\": [\n \"<string>\"\n ],\n \"monthlyTransactionVolume\": {\n \"amount\": \"5000000\"\n },\n \"hasWebsite\": true,\n \"businessWebsite\": \"<string>\",\n \"legalName\": \"<string>\",\n \"address\": \"<string>\",\n \"placeId\": \"<string>\",\n \"isHighRisk\": true,\n \"TIN\": \"<string>\",\n \"tin\": \"<string>\",\n \"EIN\": \"<string>\",\n \"annualTurnover\": \"<string>\",\n \"monthlyPaymentsCount\": \"<string>\",\n \"maxTransferAmount\": \"<string>\",\n \"customerTypes\": \"<string>\",\n \"sourceOfFundsDescription\": \"<string>\",\n \"estimatedAnnualRevenue\": \"<string>\",\n \"averageMonthlyTransactionVolume\": \"<string>\",\n \"financialService\": \"<string>\",\n \"businessPurpose\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.tradevu.co/v1/api/business/{businessId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Example Nigeria Limited\",\n \"registrationNumber\": \"RC1234567\",\n \"email\": \"[email protected]\",\n \"phoneNumber\": \"+2348012345678\",\n \"natureOfBusiness\": {\n \"nature\": \"Retail and distribution\",\n \"code\": \"retail\"\n },\n \"businessAddress\": {\n \"houseNumber\": \"12\",\n \"street\": \"Adeola Odeku Street\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos\",\n \"zipCode\": \"101233\",\n \"subdivision\": \"<string>\"\n },\n \"proofOfAddress\": {\n \"url\": \"https://example.com/documents/certificate.pdf\",\n \"key\": \"business/certificate.pdf\"\n },\n \"documents\": {},\n \"businessDescription\": \"<string>\",\n \"activities\": [\n \"<string>\"\n ],\n \"monthlyTransactionVolume\": {\n \"amount\": \"5000000\"\n },\n \"hasWebsite\": true,\n \"businessWebsite\": \"<string>\",\n \"legalName\": \"<string>\",\n \"address\": \"<string>\",\n \"placeId\": \"<string>\",\n \"isHighRisk\": true,\n \"TIN\": \"<string>\",\n \"tin\": \"<string>\",\n \"EIN\": \"<string>\",\n \"annualTurnover\": \"<string>\",\n \"monthlyPaymentsCount\": \"<string>\",\n \"maxTransferAmount\": \"<string>\",\n \"customerTypes\": \"<string>\",\n \"sourceOfFundsDescription\": \"<string>\",\n \"estimatedAnnualRevenue\": \"<string>\",\n \"averageMonthlyTransactionVolume\": \"<string>\",\n \"financialService\": \"<string>\",\n \"businessPurpose\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tradevu.co/v1/api/business/{businessId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Example Nigeria Limited\",\n \"registrationNumber\": \"RC1234567\",\n \"email\": \"[email protected]\",\n \"phoneNumber\": \"+2348012345678\",\n \"natureOfBusiness\": {\n \"nature\": \"Retail and distribution\",\n \"code\": \"retail\"\n },\n \"businessAddress\": {\n \"houseNumber\": \"12\",\n \"street\": \"Adeola Odeku Street\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos\",\n \"zipCode\": \"101233\",\n \"subdivision\": \"<string>\"\n },\n \"proofOfAddress\": {\n \"url\": \"https://example.com/documents/certificate.pdf\",\n \"key\": \"business/certificate.pdf\"\n },\n \"documents\": {},\n \"businessDescription\": \"<string>\",\n \"activities\": [\n \"<string>\"\n ],\n \"monthlyTransactionVolume\": {\n \"amount\": \"5000000\"\n },\n \"hasWebsite\": true,\n \"businessWebsite\": \"<string>\",\n \"legalName\": \"<string>\",\n \"address\": \"<string>\",\n \"placeId\": \"<string>\",\n \"isHighRisk\": true,\n \"TIN\": \"<string>\",\n \"tin\": \"<string>\",\n \"EIN\": \"<string>\",\n \"annualTurnover\": \"<string>\",\n \"monthlyPaymentsCount\": \"<string>\",\n \"maxTransferAmount\": \"<string>\",\n \"customerTypes\": \"<string>\",\n \"sourceOfFundsDescription\": \"<string>\",\n \"estimatedAnnualRevenue\": \"<string>\",\n \"averageMonthlyTransactionVolume\": \"<string>\",\n \"financialService\": \"<string>\",\n \"businessPurpose\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Business updated 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
Update a business
Updates one or more fields on a business you created. Any field you send is reset to Pending status for re-review.
PATCH
/
api
/
business
/
{businessId}
Update a business
curl --request PATCH \
--url https://api.tradevu.co/v1/api/business/{businessId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Example Nigeria Limited",
"registrationNumber": "RC1234567",
"email": "[email protected]",
"phoneNumber": "+2348012345678",
"natureOfBusiness": {
"nature": "Retail and distribution",
"code": "retail"
},
"businessAddress": {
"houseNumber": "12",
"street": "Adeola Odeku Street",
"city": "Lagos",
"state": "Lagos",
"zipCode": "101233",
"subdivision": "<string>"
},
"proofOfAddress": {
"url": "https://example.com/documents/certificate.pdf",
"key": "business/certificate.pdf"
},
"documents": {},
"businessDescription": "<string>",
"activities": [
"<string>"
],
"monthlyTransactionVolume": {
"amount": "5000000"
},
"hasWebsite": true,
"businessWebsite": "<string>",
"legalName": "<string>",
"address": "<string>",
"placeId": "<string>",
"isHighRisk": true,
"TIN": "<string>",
"tin": "<string>",
"EIN": "<string>",
"annualTurnover": "<string>",
"monthlyPaymentsCount": "<string>",
"maxTransferAmount": "<string>",
"customerTypes": "<string>",
"sourceOfFundsDescription": "<string>",
"estimatedAnnualRevenue": "<string>",
"averageMonthlyTransactionVolume": "<string>",
"financialService": "<string>",
"businessPurpose": "<string>"
}
'import requests
url = "https://api.tradevu.co/v1/api/business/{businessId}"
payload = {
"name": "Example Nigeria Limited",
"registrationNumber": "RC1234567",
"email": "[email protected]",
"phoneNumber": "+2348012345678",
"natureOfBusiness": {
"nature": "Retail and distribution",
"code": "retail"
},
"businessAddress": {
"houseNumber": "12",
"street": "Adeola Odeku Street",
"city": "Lagos",
"state": "Lagos",
"zipCode": "101233",
"subdivision": "<string>"
},
"proofOfAddress": {
"url": "https://example.com/documents/certificate.pdf",
"key": "business/certificate.pdf"
},
"documents": {},
"businessDescription": "<string>",
"activities": ["<string>"],
"monthlyTransactionVolume": { "amount": "5000000" },
"hasWebsite": True,
"businessWebsite": "<string>",
"legalName": "<string>",
"address": "<string>",
"placeId": "<string>",
"isHighRisk": True,
"TIN": "<string>",
"tin": "<string>",
"EIN": "<string>",
"annualTurnover": "<string>",
"monthlyPaymentsCount": "<string>",
"maxTransferAmount": "<string>",
"customerTypes": "<string>",
"sourceOfFundsDescription": "<string>",
"estimatedAnnualRevenue": "<string>",
"averageMonthlyTransactionVolume": "<string>",
"financialService": "<string>",
"businessPurpose": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Example Nigeria Limited',
registrationNumber: 'RC1234567',
email: '[email protected]',
phoneNumber: '+2348012345678',
natureOfBusiness: {nature: 'Retail and distribution', code: 'retail'},
businessAddress: {
houseNumber: '12',
street: 'Adeola Odeku Street',
city: 'Lagos',
state: 'Lagos',
zipCode: '101233',
subdivision: '<string>'
},
proofOfAddress: {
url: 'https://example.com/documents/certificate.pdf',
key: 'business/certificate.pdf'
},
documents: {},
businessDescription: '<string>',
activities: ['<string>'],
monthlyTransactionVolume: {amount: '5000000'},
hasWebsite: true,
businessWebsite: '<string>',
legalName: '<string>',
address: '<string>',
placeId: '<string>',
isHighRisk: true,
TIN: '<string>',
tin: '<string>',
EIN: '<string>',
annualTurnover: '<string>',
monthlyPaymentsCount: '<string>',
maxTransferAmount: '<string>',
customerTypes: '<string>',
sourceOfFundsDescription: '<string>',
estimatedAnnualRevenue: '<string>',
averageMonthlyTransactionVolume: '<string>',
financialService: '<string>',
businessPurpose: '<string>'
})
};
fetch('https://api.tradevu.co/v1/api/business/{businessId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Example Nigeria Limited',
'registrationNumber' => 'RC1234567',
'email' => '[email protected]',
'phoneNumber' => '+2348012345678',
'natureOfBusiness' => [
'nature' => 'Retail and distribution',
'code' => 'retail'
],
'businessAddress' => [
'houseNumber' => '12',
'street' => 'Adeola Odeku Street',
'city' => 'Lagos',
'state' => 'Lagos',
'zipCode' => '101233',
'subdivision' => '<string>'
],
'proofOfAddress' => [
'url' => 'https://example.com/documents/certificate.pdf',
'key' => 'business/certificate.pdf'
],
'documents' => [
],
'businessDescription' => '<string>',
'activities' => [
'<string>'
],
'monthlyTransactionVolume' => [
'amount' => '5000000'
],
'hasWebsite' => true,
'businessWebsite' => '<string>',
'legalName' => '<string>',
'address' => '<string>',
'placeId' => '<string>',
'isHighRisk' => true,
'TIN' => '<string>',
'tin' => '<string>',
'EIN' => '<string>',
'annualTurnover' => '<string>',
'monthlyPaymentsCount' => '<string>',
'maxTransferAmount' => '<string>',
'customerTypes' => '<string>',
'sourceOfFundsDescription' => '<string>',
'estimatedAnnualRevenue' => '<string>',
'averageMonthlyTransactionVolume' => '<string>',
'financialService' => '<string>',
'businessPurpose' => '<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}"
payload := strings.NewReader("{\n \"name\": \"Example Nigeria Limited\",\n \"registrationNumber\": \"RC1234567\",\n \"email\": \"[email protected]\",\n \"phoneNumber\": \"+2348012345678\",\n \"natureOfBusiness\": {\n \"nature\": \"Retail and distribution\",\n \"code\": \"retail\"\n },\n \"businessAddress\": {\n \"houseNumber\": \"12\",\n \"street\": \"Adeola Odeku Street\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos\",\n \"zipCode\": \"101233\",\n \"subdivision\": \"<string>\"\n },\n \"proofOfAddress\": {\n \"url\": \"https://example.com/documents/certificate.pdf\",\n \"key\": \"business/certificate.pdf\"\n },\n \"documents\": {},\n \"businessDescription\": \"<string>\",\n \"activities\": [\n \"<string>\"\n ],\n \"monthlyTransactionVolume\": {\n \"amount\": \"5000000\"\n },\n \"hasWebsite\": true,\n \"businessWebsite\": \"<string>\",\n \"legalName\": \"<string>\",\n \"address\": \"<string>\",\n \"placeId\": \"<string>\",\n \"isHighRisk\": true,\n \"TIN\": \"<string>\",\n \"tin\": \"<string>\",\n \"EIN\": \"<string>\",\n \"annualTurnover\": \"<string>\",\n \"monthlyPaymentsCount\": \"<string>\",\n \"maxTransferAmount\": \"<string>\",\n \"customerTypes\": \"<string>\",\n \"sourceOfFundsDescription\": \"<string>\",\n \"estimatedAnnualRevenue\": \"<string>\",\n \"averageMonthlyTransactionVolume\": \"<string>\",\n \"financialService\": \"<string>\",\n \"businessPurpose\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.tradevu.co/v1/api/business/{businessId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Example Nigeria Limited\",\n \"registrationNumber\": \"RC1234567\",\n \"email\": \"[email protected]\",\n \"phoneNumber\": \"+2348012345678\",\n \"natureOfBusiness\": {\n \"nature\": \"Retail and distribution\",\n \"code\": \"retail\"\n },\n \"businessAddress\": {\n \"houseNumber\": \"12\",\n \"street\": \"Adeola Odeku Street\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos\",\n \"zipCode\": \"101233\",\n \"subdivision\": \"<string>\"\n },\n \"proofOfAddress\": {\n \"url\": \"https://example.com/documents/certificate.pdf\",\n \"key\": \"business/certificate.pdf\"\n },\n \"documents\": {},\n \"businessDescription\": \"<string>\",\n \"activities\": [\n \"<string>\"\n ],\n \"monthlyTransactionVolume\": {\n \"amount\": \"5000000\"\n },\n \"hasWebsite\": true,\n \"businessWebsite\": \"<string>\",\n \"legalName\": \"<string>\",\n \"address\": \"<string>\",\n \"placeId\": \"<string>\",\n \"isHighRisk\": true,\n \"TIN\": \"<string>\",\n \"tin\": \"<string>\",\n \"EIN\": \"<string>\",\n \"annualTurnover\": \"<string>\",\n \"monthlyPaymentsCount\": \"<string>\",\n \"maxTransferAmount\": \"<string>\",\n \"customerTypes\": \"<string>\",\n \"sourceOfFundsDescription\": \"<string>\",\n \"estimatedAnnualRevenue\": \"<string>\",\n \"averageMonthlyTransactionVolume\": \"<string>\",\n \"financialService\": \"<string>\",\n \"businessPurpose\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tradevu.co/v1/api/business/{businessId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Example Nigeria Limited\",\n \"registrationNumber\": \"RC1234567\",\n \"email\": \"[email protected]\",\n \"phoneNumber\": \"+2348012345678\",\n \"natureOfBusiness\": {\n \"nature\": \"Retail and distribution\",\n \"code\": \"retail\"\n },\n \"businessAddress\": {\n \"houseNumber\": \"12\",\n \"street\": \"Adeola Odeku Street\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos\",\n \"zipCode\": \"101233\",\n \"subdivision\": \"<string>\"\n },\n \"proofOfAddress\": {\n \"url\": \"https://example.com/documents/certificate.pdf\",\n \"key\": \"business/certificate.pdf\"\n },\n \"documents\": {},\n \"businessDescription\": \"<string>\",\n \"activities\": [\n \"<string>\"\n ],\n \"monthlyTransactionVolume\": {\n \"amount\": \"5000000\"\n },\n \"hasWebsite\": true,\n \"businessWebsite\": \"<string>\",\n \"legalName\": \"<string>\",\n \"address\": \"<string>\",\n \"placeId\": \"<string>\",\n \"isHighRisk\": true,\n \"TIN\": \"<string>\",\n \"tin\": \"<string>\",\n \"EIN\": \"<string>\",\n \"annualTurnover\": \"<string>\",\n \"monthlyPaymentsCount\": \"<string>\",\n \"maxTransferAmount\": \"<string>\",\n \"customerTypes\": \"<string>\",\n \"sourceOfFundsDescription\": \"<string>\",\n \"estimatedAnnualRevenue\": \"<string>\",\n \"averageMonthlyTransactionVolume\": \"<string>\",\n \"financialService\": \"<string>\",\n \"businessPurpose\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Business updated 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
Same shape as CreateApiBusinessDto, minus name and registrationNumber, with every field optional. Send only the fields you want to change.
Example:
"Example Nigeria Limited"
Nigerian business type. Determines which documents are required. LLP has the same document requirements as LLC.
Available options:
LLC, LLP, SoleProprietorship CAC registration number (or BN number for sole proprietorships).
Example:
"RC1234567"
Example:
Example:
"+2348012345678"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Map of document key to { url, key }. Keys accept common aliases (cac_document, bank_statement, bn_form_1, combined_cac, cac_form_2, ...); unrecognized keys are rejected. See the Business Onboarding guide for the required set per businessType.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes