Create a business

curl --request POST \
  --url https://api.tradevu.co/v1/api/business \
  --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"

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.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({
    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', 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",
  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([
    '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"

	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("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")
  .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")

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  \"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 created 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"
  }
}

POST

api

business

Create a business

curl --request POST \
  --url https://api.tradevu.co/v1/api/business \
  --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"

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.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({
    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', 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",
  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([
    '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"

	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("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")
  .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")

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  \"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 created 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

x-api-key

string

header

required

Your business API key, generated from the dashboard. Required on every business-facing endpoint.

Body

application/json

name

string

required

Example:

"Example Nigeria Limited"

businessType

enum<string>

required

Nigerian business type. Determines which documents are required. LLP has the same document requirements as LLC.

Available options:

LLC,

LLP,

SoleProprietorship

registrationNumber

string

required

CAC registration number (or BN number for sole proprietorships).

Example:

"RC1234567"

string<email>

required

Example:

"[email protected]"

phoneNumber

string

required

Example:

"+2348012345678"

natureOfBusiness

object

required

Show child attributes

businessAddress

object

required

Show child attributes

proofOfAddress

object

required

Show child attributes

documents

object

required

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

physicalAddress

object

Show child attributes

businessDescription

string

activities

string[]

monthlyTransactionVolume

object

Show child attributes

hasWebsite

boolean

businessWebsite

string

sourceOfFund

object

Show child attributes

legalName

string

address

string

placeId

string

isHighRisk

boolean

TIN

string

tin

string

EIN

string

annualTurnover

string

monthlyPaymentsCount

string

maxTransferAmount

string

customerTypes

string

sourceOfFundsDescription

string

estimatedAnnualRevenue

string

averageMonthlyTransactionVolume

string

financialService

string

businessPurpose

string

supportingDocument

object

Show child attributes

AMLDocument

object

Show child attributes

flowOfFunds

object

Show child attributes

financialStatement

object

Show child attributes

Response

Business created.

message

string

Example:

"Business created successfully"

data

object

The created business record.

Overview

Webhooks

Quotes

Payment Collections

Transactions

Wallet

Sandbox

Banks

Payouts

Business Onboarding

Create a business

Authorizations

Body

Response