Create a customer
curl --request POST \
--url http://localhost:5000/api/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"companyName": "<string>",
"registrationNumber": "<string>",
"countryOfIncorporationId": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateProvinceRegion": "<string>",
"postalCode": "<string>",
"addressCountryId": "<string>"
}
'import requests
url = "http://localhost:5000/api/v1/customers"
payload = {
"companyName": "<string>",
"registrationNumber": "<string>",
"countryOfIncorporationId": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateProvinceRegion": "<string>",
"postalCode": "<string>",
"addressCountryId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Authorization": "Bearer <token>",
"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>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
companyName: '<string>',
registrationNumber: '<string>',
countryOfIncorporationId: '<string>',
addressLine1: '<string>',
addressLine2: '<string>',
city: '<string>',
stateProvinceRegion: '<string>',
postalCode: '<string>',
addressCountryId: '<string>'
})
};
fetch('http://localhost:5000/api/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "5000",
CURLOPT_URL => "http://localhost:5000/api/v1/customers",
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([
'companyName' => '<string>',
'registrationNumber' => '<string>',
'countryOfIncorporationId' => '<string>',
'addressLine1' => '<string>',
'addressLine2' => '<string>',
'city' => '<string>',
'stateProvinceRegion' => '<string>',
'postalCode' => '<string>',
'addressCountryId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:5000/api/v1/customers"
payload := strings.NewReader("{\n \"companyName\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"countryOfIncorporationId\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"stateProvinceRegion\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"addressCountryId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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("http://localhost:5000/api/v1/customers")
.header("x-api-key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"companyName\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"countryOfIncorporationId\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"stateProvinceRegion\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"addressCountryId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5000/api/v1/customers")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyName\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"countryOfIncorporationId\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"stateProvinceRegion\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"addressCountryId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"companyName": "<string>",
"registrationNumber": "<string>",
"countryOfIncorporation": {
"alpha2": "<string>",
"name": "<string>"
},
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateProvinceRegion": "<string>",
"postalCode": "<string>",
"addressCountry": {
"alpha2": "<string>",
"name": "<string>"
},
"status": "DRAFT",
"createdAt": "<string>",
"updatedAt": "<string>"
}Customers
Create a customer
Create a new customer with basic company details in DRAFT status.
POST
/
api
/
v1
/
customers
Create a customer
curl --request POST \
--url http://localhost:5000/api/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"companyName": "<string>",
"registrationNumber": "<string>",
"countryOfIncorporationId": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateProvinceRegion": "<string>",
"postalCode": "<string>",
"addressCountryId": "<string>"
}
'import requests
url = "http://localhost:5000/api/v1/customers"
payload = {
"companyName": "<string>",
"registrationNumber": "<string>",
"countryOfIncorporationId": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateProvinceRegion": "<string>",
"postalCode": "<string>",
"addressCountryId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Authorization": "Bearer <token>",
"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>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
companyName: '<string>',
registrationNumber: '<string>',
countryOfIncorporationId: '<string>',
addressLine1: '<string>',
addressLine2: '<string>',
city: '<string>',
stateProvinceRegion: '<string>',
postalCode: '<string>',
addressCountryId: '<string>'
})
};
fetch('http://localhost:5000/api/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "5000",
CURLOPT_URL => "http://localhost:5000/api/v1/customers",
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([
'companyName' => '<string>',
'registrationNumber' => '<string>',
'countryOfIncorporationId' => '<string>',
'addressLine1' => '<string>',
'addressLine2' => '<string>',
'city' => '<string>',
'stateProvinceRegion' => '<string>',
'postalCode' => '<string>',
'addressCountryId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:5000/api/v1/customers"
payload := strings.NewReader("{\n \"companyName\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"countryOfIncorporationId\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"stateProvinceRegion\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"addressCountryId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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("http://localhost:5000/api/v1/customers")
.header("x-api-key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"companyName\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"countryOfIncorporationId\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"stateProvinceRegion\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"addressCountryId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5000/api/v1/customers")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyName\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"countryOfIncorporationId\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"stateProvinceRegion\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"addressCountryId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"companyName": "<string>",
"registrationNumber": "<string>",
"countryOfIncorporation": {
"alpha2": "<string>",
"name": "<string>"
},
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateProvinceRegion": "<string>",
"postalCode": "<string>",
"addressCountry": {
"alpha2": "<string>",
"name": "<string>"
},
"status": "DRAFT",
"createdAt": "<string>",
"updatedAt": "<string>"
}Authorizations
Nuvera API application secret key
RS256 per-request signed JWT
Body
application/json
Registered company name
Required string length:
1 - 200Company registration number
Maximum string length:
100Country of incorporation ID
Address line 1
Address line 2
City
State/Province/Region
Postal code
Address country ID
Response
default - application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
DRAFT, PENDING_REVIEW, CORRECTION_REQUESTED, APPROVED, REJECTED, SUSPENDED