Create or update a business record
curl --request POST \
--url https://api.getcurrent.ca/v1/businesses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "<string>",
"name": "<string>",
"operatingNames": [
"<string>"
],
"jurisdiction": "<string>",
"registrationNumber": "<string>",
"businessNumber": "<string>",
"entityType": "<string>",
"registryStatus": "<string>",
"incorporationDate": "<string>",
"incorporationYear": 5499,
"registrations": [
{}
],
"street": "<string>",
"unit": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"addresses": [
{}
],
"people": [
{
"name": "<string>",
"role": "<string>",
"roles": [
"<string>"
],
"email": "<string>"
}
],
"website": "<string>",
"additionalWebsites": [
"<string>"
],
"phoneNumber": "<string>",
"email": "<string>",
"industry": "<string>",
"industryCategory": "<string>",
"naicsCode": "<string>",
"naicsCodeName": "<string>",
"businessDescription": "<string>",
"originationDate": "<string>",
"notes": "<string>",
"isMonitored": true,
"isArchived": true,
"expectedUpdatedAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.getcurrent.ca/v1/businesses"
payload = {
"externalId": "<string>",
"name": "<string>",
"operatingNames": ["<string>"],
"jurisdiction": "<string>",
"registrationNumber": "<string>",
"businessNumber": "<string>",
"entityType": "<string>",
"registryStatus": "<string>",
"incorporationDate": "<string>",
"incorporationYear": 5499,
"registrations": [{}],
"street": "<string>",
"unit": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"addresses": [{}],
"people": [
{
"name": "<string>",
"role": "<string>",
"roles": ["<string>"],
"email": "<string>"
}
],
"website": "<string>",
"additionalWebsites": ["<string>"],
"phoneNumber": "<string>",
"email": "<string>",
"industry": "<string>",
"industryCategory": "<string>",
"naicsCode": "<string>",
"naicsCodeName": "<string>",
"businessDescription": "<string>",
"originationDate": "<string>",
"notes": "<string>",
"isMonitored": True,
"isArchived": True,
"expectedUpdatedAt": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalId: '<string>',
name: '<string>',
operatingNames: ['<string>'],
jurisdiction: '<string>',
registrationNumber: '<string>',
businessNumber: '<string>',
entityType: '<string>',
registryStatus: '<string>',
incorporationDate: '<string>',
incorporationYear: 5499,
registrations: [{}],
street: '<string>',
unit: '<string>',
city: '<string>',
province: '<string>',
postalCode: '<string>',
country: '<string>',
addresses: [{}],
people: [{name: '<string>', role: '<string>', roles: ['<string>'], email: '<string>'}],
website: '<string>',
additionalWebsites: ['<string>'],
phoneNumber: '<string>',
email: '<string>',
industry: '<string>',
industryCategory: '<string>',
naicsCode: '<string>',
naicsCodeName: '<string>',
businessDescription: '<string>',
originationDate: '<string>',
notes: '<string>',
isMonitored: true,
isArchived: true,
expectedUpdatedAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.getcurrent.ca/v1/businesses', 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.getcurrent.ca/v1/businesses",
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([
'externalId' => '<string>',
'name' => '<string>',
'operatingNames' => [
'<string>'
],
'jurisdiction' => '<string>',
'registrationNumber' => '<string>',
'businessNumber' => '<string>',
'entityType' => '<string>',
'registryStatus' => '<string>',
'incorporationDate' => '<string>',
'incorporationYear' => 5499,
'registrations' => [
[
]
],
'street' => '<string>',
'unit' => '<string>',
'city' => '<string>',
'province' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'addresses' => [
[
]
],
'people' => [
[
'name' => '<string>',
'role' => '<string>',
'roles' => [
'<string>'
],
'email' => '<string>'
]
],
'website' => '<string>',
'additionalWebsites' => [
'<string>'
],
'phoneNumber' => '<string>',
'email' => '<string>',
'industry' => '<string>',
'industryCategory' => '<string>',
'naicsCode' => '<string>',
'naicsCodeName' => '<string>',
'businessDescription' => '<string>',
'originationDate' => '<string>',
'notes' => '<string>',
'isMonitored' => true,
'isArchived' => true,
'expectedUpdatedAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.getcurrent.ca/v1/businesses"
payload := strings.NewReader("{\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"operatingNames\": [\n \"<string>\"\n ],\n \"jurisdiction\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"businessNumber\": \"<string>\",\n \"entityType\": \"<string>\",\n \"registryStatus\": \"<string>\",\n \"incorporationDate\": \"<string>\",\n \"incorporationYear\": 5499,\n \"registrations\": [\n {}\n ],\n \"street\": \"<string>\",\n \"unit\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"addresses\": [\n {}\n ],\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"roles\": [\n \"<string>\"\n ],\n \"email\": \"<string>\"\n }\n ],\n \"website\": \"<string>\",\n \"additionalWebsites\": [\n \"<string>\"\n ],\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"industry\": \"<string>\",\n \"industryCategory\": \"<string>\",\n \"naicsCode\": \"<string>\",\n \"naicsCodeName\": \"<string>\",\n \"businessDescription\": \"<string>\",\n \"originationDate\": \"<string>\",\n \"notes\": \"<string>\",\n \"isMonitored\": true,\n \"isArchived\": true,\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("https://api.getcurrent.ca/v1/businesses")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"operatingNames\": [\n \"<string>\"\n ],\n \"jurisdiction\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"businessNumber\": \"<string>\",\n \"entityType\": \"<string>\",\n \"registryStatus\": \"<string>\",\n \"incorporationDate\": \"<string>\",\n \"incorporationYear\": 5499,\n \"registrations\": [\n {}\n ],\n \"street\": \"<string>\",\n \"unit\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"addresses\": [\n {}\n ],\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"roles\": [\n \"<string>\"\n ],\n \"email\": \"<string>\"\n }\n ],\n \"website\": \"<string>\",\n \"additionalWebsites\": [\n \"<string>\"\n ],\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"industry\": \"<string>\",\n \"industryCategory\": \"<string>\",\n \"naicsCode\": \"<string>\",\n \"naicsCodeName\": \"<string>\",\n \"businessDescription\": \"<string>\",\n \"originationDate\": \"<string>\",\n \"notes\": \"<string>\",\n \"isMonitored\": true,\n \"isArchived\": true,\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcurrent.ca/v1/businesses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"operatingNames\": [\n \"<string>\"\n ],\n \"jurisdiction\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"businessNumber\": \"<string>\",\n \"entityType\": \"<string>\",\n \"registryStatus\": \"<string>\",\n \"incorporationDate\": \"<string>\",\n \"incorporationYear\": 5499,\n \"registrations\": [\n {}\n ],\n \"street\": \"<string>\",\n \"unit\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"addresses\": [\n {}\n ],\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"roles\": [\n \"<string>\"\n ],\n \"email\": \"<string>\"\n }\n ],\n \"website\": \"<string>\",\n \"additionalWebsites\": [\n \"<string>\"\n ],\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"industry\": \"<string>\",\n \"industryCategory\": \"<string>\",\n \"naicsCode\": \"<string>\",\n \"naicsCodeName\": \"<string>\",\n \"businessDescription\": \"<string>\",\n \"originationDate\": \"<string>\",\n \"notes\": \"<string>\",\n \"isMonitored\": true,\n \"isArchived\": true,\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"business": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"name": "<string>",
"operatingNames": [
"<string>"
],
"jurisdiction": "<string>",
"registrationNumber": "<string>",
"businessNumber": "<string>",
"entityType": "<string>",
"sourceEntityType": "<string>",
"registryStatus": "<string>",
"incorporationDate": "<string>",
"incorporationYear": 123,
"registrations": [
{}
],
"address": {
"street": "<string>",
"unit": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"addresses": [
{}
],
"people": [
{
"name": "<string>",
"roles": [
"<string>"
],
"email": "<string>"
}
],
"website": "<string>",
"additionalWebsites": [
"<string>"
],
"phoneNumber": "<string>",
"email": "<string>",
"industry": "<string>",
"industryCategory": "<string>",
"naicsCode": "<string>",
"naicsCodeName": "<string>",
"businessDescription": "<string>",
"originationDate": "<string>",
"notes": "<string>",
"sourceUrls": [
"<string>"
],
"isMonitored": true,
"isArchived": true,
"verificationStatus": "verified",
"lastVerifiedAt": "2023-11-07T05:31:56Z",
"lastVerificationJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"latestVerificationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hasUnresolvedDiscrepancies": true,
"lastSearchedAt": "2023-11-07T05:31:56Z",
"lastSearchJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastScreenedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Businesses
Create or update a business record
Upsert a business record. The record is matched to an existing one by externalId (preferred), falling back to the registry natural key (jurisdiction + registrationNumber). If a match is found it is updated in place (only the fields you send are changed); otherwise a new record is created. Every changed field is written to an append-only audit trail. PUT is accepted as an alias for POST.
POST
/
businesses
Create or update a business record
curl --request POST \
--url https://api.getcurrent.ca/v1/businesses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "<string>",
"name": "<string>",
"operatingNames": [
"<string>"
],
"jurisdiction": "<string>",
"registrationNumber": "<string>",
"businessNumber": "<string>",
"entityType": "<string>",
"registryStatus": "<string>",
"incorporationDate": "<string>",
"incorporationYear": 5499,
"registrations": [
{}
],
"street": "<string>",
"unit": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"addresses": [
{}
],
"people": [
{
"name": "<string>",
"role": "<string>",
"roles": [
"<string>"
],
"email": "<string>"
}
],
"website": "<string>",
"additionalWebsites": [
"<string>"
],
"phoneNumber": "<string>",
"email": "<string>",
"industry": "<string>",
"industryCategory": "<string>",
"naicsCode": "<string>",
"naicsCodeName": "<string>",
"businessDescription": "<string>",
"originationDate": "<string>",
"notes": "<string>",
"isMonitored": true,
"isArchived": true,
"expectedUpdatedAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.getcurrent.ca/v1/businesses"
payload = {
"externalId": "<string>",
"name": "<string>",
"operatingNames": ["<string>"],
"jurisdiction": "<string>",
"registrationNumber": "<string>",
"businessNumber": "<string>",
"entityType": "<string>",
"registryStatus": "<string>",
"incorporationDate": "<string>",
"incorporationYear": 5499,
"registrations": [{}],
"street": "<string>",
"unit": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"addresses": [{}],
"people": [
{
"name": "<string>",
"role": "<string>",
"roles": ["<string>"],
"email": "<string>"
}
],
"website": "<string>",
"additionalWebsites": ["<string>"],
"phoneNumber": "<string>",
"email": "<string>",
"industry": "<string>",
"industryCategory": "<string>",
"naicsCode": "<string>",
"naicsCodeName": "<string>",
"businessDescription": "<string>",
"originationDate": "<string>",
"notes": "<string>",
"isMonitored": True,
"isArchived": True,
"expectedUpdatedAt": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalId: '<string>',
name: '<string>',
operatingNames: ['<string>'],
jurisdiction: '<string>',
registrationNumber: '<string>',
businessNumber: '<string>',
entityType: '<string>',
registryStatus: '<string>',
incorporationDate: '<string>',
incorporationYear: 5499,
registrations: [{}],
street: '<string>',
unit: '<string>',
city: '<string>',
province: '<string>',
postalCode: '<string>',
country: '<string>',
addresses: [{}],
people: [{name: '<string>', role: '<string>', roles: ['<string>'], email: '<string>'}],
website: '<string>',
additionalWebsites: ['<string>'],
phoneNumber: '<string>',
email: '<string>',
industry: '<string>',
industryCategory: '<string>',
naicsCode: '<string>',
naicsCodeName: '<string>',
businessDescription: '<string>',
originationDate: '<string>',
notes: '<string>',
isMonitored: true,
isArchived: true,
expectedUpdatedAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.getcurrent.ca/v1/businesses', 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.getcurrent.ca/v1/businesses",
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([
'externalId' => '<string>',
'name' => '<string>',
'operatingNames' => [
'<string>'
],
'jurisdiction' => '<string>',
'registrationNumber' => '<string>',
'businessNumber' => '<string>',
'entityType' => '<string>',
'registryStatus' => '<string>',
'incorporationDate' => '<string>',
'incorporationYear' => 5499,
'registrations' => [
[
]
],
'street' => '<string>',
'unit' => '<string>',
'city' => '<string>',
'province' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'addresses' => [
[
]
],
'people' => [
[
'name' => '<string>',
'role' => '<string>',
'roles' => [
'<string>'
],
'email' => '<string>'
]
],
'website' => '<string>',
'additionalWebsites' => [
'<string>'
],
'phoneNumber' => '<string>',
'email' => '<string>',
'industry' => '<string>',
'industryCategory' => '<string>',
'naicsCode' => '<string>',
'naicsCodeName' => '<string>',
'businessDescription' => '<string>',
'originationDate' => '<string>',
'notes' => '<string>',
'isMonitored' => true,
'isArchived' => true,
'expectedUpdatedAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.getcurrent.ca/v1/businesses"
payload := strings.NewReader("{\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"operatingNames\": [\n \"<string>\"\n ],\n \"jurisdiction\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"businessNumber\": \"<string>\",\n \"entityType\": \"<string>\",\n \"registryStatus\": \"<string>\",\n \"incorporationDate\": \"<string>\",\n \"incorporationYear\": 5499,\n \"registrations\": [\n {}\n ],\n \"street\": \"<string>\",\n \"unit\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"addresses\": [\n {}\n ],\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"roles\": [\n \"<string>\"\n ],\n \"email\": \"<string>\"\n }\n ],\n \"website\": \"<string>\",\n \"additionalWebsites\": [\n \"<string>\"\n ],\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"industry\": \"<string>\",\n \"industryCategory\": \"<string>\",\n \"naicsCode\": \"<string>\",\n \"naicsCodeName\": \"<string>\",\n \"businessDescription\": \"<string>\",\n \"originationDate\": \"<string>\",\n \"notes\": \"<string>\",\n \"isMonitored\": true,\n \"isArchived\": true,\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("https://api.getcurrent.ca/v1/businesses")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"operatingNames\": [\n \"<string>\"\n ],\n \"jurisdiction\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"businessNumber\": \"<string>\",\n \"entityType\": \"<string>\",\n \"registryStatus\": \"<string>\",\n \"incorporationDate\": \"<string>\",\n \"incorporationYear\": 5499,\n \"registrations\": [\n {}\n ],\n \"street\": \"<string>\",\n \"unit\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"addresses\": [\n {}\n ],\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"roles\": [\n \"<string>\"\n ],\n \"email\": \"<string>\"\n }\n ],\n \"website\": \"<string>\",\n \"additionalWebsites\": [\n \"<string>\"\n ],\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"industry\": \"<string>\",\n \"industryCategory\": \"<string>\",\n \"naicsCode\": \"<string>\",\n \"naicsCodeName\": \"<string>\",\n \"businessDescription\": \"<string>\",\n \"originationDate\": \"<string>\",\n \"notes\": \"<string>\",\n \"isMonitored\": true,\n \"isArchived\": true,\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcurrent.ca/v1/businesses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"operatingNames\": [\n \"<string>\"\n ],\n \"jurisdiction\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"businessNumber\": \"<string>\",\n \"entityType\": \"<string>\",\n \"registryStatus\": \"<string>\",\n \"incorporationDate\": \"<string>\",\n \"incorporationYear\": 5499,\n \"registrations\": [\n {}\n ],\n \"street\": \"<string>\",\n \"unit\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"addresses\": [\n {}\n ],\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"roles\": [\n \"<string>\"\n ],\n \"email\": \"<string>\"\n }\n ],\n \"website\": \"<string>\",\n \"additionalWebsites\": [\n \"<string>\"\n ],\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"industry\": \"<string>\",\n \"industryCategory\": \"<string>\",\n \"naicsCode\": \"<string>\",\n \"naicsCodeName\": \"<string>\",\n \"businessDescription\": \"<string>\",\n \"originationDate\": \"<string>\",\n \"notes\": \"<string>\",\n \"isMonitored\": true,\n \"isArchived\": true,\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"business": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"name": "<string>",
"operatingNames": [
"<string>"
],
"jurisdiction": "<string>",
"registrationNumber": "<string>",
"businessNumber": "<string>",
"entityType": "<string>",
"sourceEntityType": "<string>",
"registryStatus": "<string>",
"incorporationDate": "<string>",
"incorporationYear": 123,
"registrations": [
{}
],
"address": {
"street": "<string>",
"unit": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"addresses": [
{}
],
"people": [
{
"name": "<string>",
"roles": [
"<string>"
],
"email": "<string>"
}
],
"website": "<string>",
"additionalWebsites": [
"<string>"
],
"phoneNumber": "<string>",
"email": "<string>",
"industry": "<string>",
"industryCategory": "<string>",
"naicsCode": "<string>",
"naicsCodeName": "<string>",
"businessDescription": "<string>",
"originationDate": "<string>",
"notes": "<string>",
"sourceUrls": [
"<string>"
],
"isMonitored": true,
"isArchived": true,
"verificationStatus": "verified",
"lastVerifiedAt": "2023-11-07T05:31:56Z",
"lastVerificationJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"latestVerificationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hasUnresolvedDiscrepancies": true,
"lastSearchedAt": "2023-11-07T05:31:56Z",
"lastSearchJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastScreenedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Authorizations
bearerAuthapiKeyHeader
API key as Bearer token: Authorization: Bearer cur_live_xxxxx
Body
application/json
Fields to create or update. You must supply a match key: either externalId, or both jurisdiction and registrationNumber. On create, name is required. Only the fields you send are written — omitted fields are left unchanged. Array fields replace the stored value.
Your internal id (CRM record id). Unique per organization.
Maximum string length:
255Maximum string length:
500Canadian jurisdiction code (normalized server-side)
Maximum string length:
30Maximum string length:
30Full incorporation date (YYYY-MM-DD). Use incorporationYear instead when only the year is known.
Year of incorporation, when only the year is known. Recorded separately from incorporationDate so a year-only value isn't fabricated into a full date.
Required range:
1000 <= x <= 9999Show child attributes
Show child attributes
Industry or sector label.
Maximum string length:
200Higher-level industry category.
Maximum string length:
200NAICS industry code.
Maximum string length:
20Human-readable NAICS industry description.
Maximum string length:
200Free-text description of the business.
Maximum string length:
5000YYYY-MM-DD
Optimistic concurrency guard. If set and a matching record exists, the update is rejected with 409 when the record's current updatedAt differs from this value (i.e. it changed since you last read it). Omit to always overwrite. Ignored when a new record is created.
Response
Existing business updated
A business record.
Show child attributes
Show child attributes
Was this page helpful?
⌘I