Organisation
Update organisation information
Update the organisation information for the current organisation
POST
/
organisation
/
information
Update organisation information
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/organisation/information \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"name": {
"legalName": "Acme Corporation Ltd",
"tradingName": "Acme Corp"
},
"organisationType": "LimitedCompany",
"companyRegistrationNumber": "12345678",
"businessType": "LimitedCompany",
"registredOfficeAddress": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"correspondenceAddress": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"companyContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
},
"primaryContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
}
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/organisation/information"
payload = {
"name": {
"legalName": "Acme Corporation Ltd",
"tradingName": "Acme Corp"
},
"organisationType": "LimitedCompany",
"companyRegistrationNumber": "12345678",
"businessType": "LimitedCompany",
"registredOfficeAddress": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"correspondenceAddress": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"companyContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
},
"primaryContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
}
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: {legalName: 'Acme Corporation Ltd', tradingName: 'Acme Corp'},
organisationType: 'LimitedCompany',
companyRegistrationNumber: '12345678',
businessType: 'LimitedCompany',
registredOfficeAddress: {
line1: '123 Main Street',
line2: 'Apt 4B',
city: 'London',
county: 'Greater London',
postcode: 'SW1A 1AA',
countryCode: 'GB'
},
correspondenceAddress: {
line1: '123 Main Street',
line2: 'Apt 4B',
city: 'London',
county: 'Greater London',
postcode: 'SW1A 1AA',
countryCode: 'GB'
},
companyContactDetails: {name: 'HR Department', email: 'hr@acme.com', phone: '0161 123 4567'},
primaryContactDetails: {name: 'HR Department', email: 'hr@acme.com', phone: '0161 123 4567'}
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/organisation/information', 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.sandbox.flowpayroll.ai/v1/organisation/information",
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' => [
'legalName' => 'Acme Corporation Ltd',
'tradingName' => 'Acme Corp'
],
'organisationType' => 'LimitedCompany',
'companyRegistrationNumber' => '12345678',
'businessType' => 'LimitedCompany',
'registredOfficeAddress' => [
'line1' => '123 Main Street',
'line2' => 'Apt 4B',
'city' => 'London',
'county' => 'Greater London',
'postcode' => 'SW1A 1AA',
'countryCode' => 'GB'
],
'correspondenceAddress' => [
'line1' => '123 Main Street',
'line2' => 'Apt 4B',
'city' => 'London',
'county' => 'Greater London',
'postcode' => 'SW1A 1AA',
'countryCode' => 'GB'
],
'companyContactDetails' => [
'name' => 'HR Department',
'email' => 'hr@acme.com',
'phone' => '0161 123 4567'
],
'primaryContactDetails' => [
'name' => 'HR Department',
'email' => 'hr@acme.com',
'phone' => '0161 123 4567'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>",
"X-Org-Id: <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.sandbox.flowpayroll.ai/v1/organisation/information"
payload := strings.NewReader("{\n \"name\": {\n \"legalName\": \"Acme Corporation Ltd\",\n \"tradingName\": \"Acme Corp\"\n },\n \"organisationType\": \"LimitedCompany\",\n \"companyRegistrationNumber\": \"12345678\",\n \"businessType\": \"LimitedCompany\",\n \"registredOfficeAddress\": {\n \"line1\": \"123 Main Street\",\n \"line2\": \"Apt 4B\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"SW1A 1AA\",\n \"countryCode\": \"GB\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"123 Main Street\",\n \"line2\": \"Apt 4B\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"SW1A 1AA\",\n \"countryCode\": \"GB\"\n },\n \"companyContactDetails\": {\n \"name\": \"HR Department\",\n \"email\": \"hr@acme.com\",\n \"phone\": \"0161 123 4567\"\n },\n \"primaryContactDetails\": {\n \"name\": \"HR Department\",\n \"email\": \"hr@acme.com\",\n \"phone\": \"0161 123 4567\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<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.sandbox.flowpayroll.ai/v1/organisation/information")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": {\n \"legalName\": \"Acme Corporation Ltd\",\n \"tradingName\": \"Acme Corp\"\n },\n \"organisationType\": \"LimitedCompany\",\n \"companyRegistrationNumber\": \"12345678\",\n \"businessType\": \"LimitedCompany\",\n \"registredOfficeAddress\": {\n \"line1\": \"123 Main Street\",\n \"line2\": \"Apt 4B\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"SW1A 1AA\",\n \"countryCode\": \"GB\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"123 Main Street\",\n \"line2\": \"Apt 4B\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"SW1A 1AA\",\n \"countryCode\": \"GB\"\n },\n \"companyContactDetails\": {\n \"name\": \"HR Department\",\n \"email\": \"hr@acme.com\",\n \"phone\": \"0161 123 4567\"\n },\n \"primaryContactDetails\": {\n \"name\": \"HR Department\",\n \"email\": \"hr@acme.com\",\n \"phone\": \"0161 123 4567\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/organisation/information")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": {\n \"legalName\": \"Acme Corporation Ltd\",\n \"tradingName\": \"Acme Corp\"\n },\n \"organisationType\": \"LimitedCompany\",\n \"companyRegistrationNumber\": \"12345678\",\n \"businessType\": \"LimitedCompany\",\n \"registredOfficeAddress\": {\n \"line1\": \"123 Main Street\",\n \"line2\": \"Apt 4B\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"SW1A 1AA\",\n \"countryCode\": \"GB\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"123 Main Street\",\n \"line2\": \"Apt 4B\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"SW1A 1AA\",\n \"countryCode\": \"GB\"\n },\n \"companyContactDetails\": {\n \"name\": \"HR Department\",\n \"email\": \"hr@acme.com\",\n \"phone\": \"0161 123 4567\"\n },\n \"primaryContactDetails\": {\n \"name\": \"HR Department\",\n \"email\": \"hr@acme.com\",\n \"phone\": \"0161 123 4567\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"name": {
"legalName": "Acme Corporation Ltd",
"tradingName": "Acme Corp"
},
"organisationType": "LimitedCompany",
"companyRegistrationNumber": "12345678",
"businessType": "LimitedCompany",
"registredOfficeAddress": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"correspondenceAddress": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"companyContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
},
"primaryContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
},
"organisationId": "org_123",
"createdBy": "user_123",
"createdDate": "2025-01-01T00:00:00Z",
"updatedBy": "user_456",
"updatedDate": "2025-01-02T00:00:00Z"
},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}Authorizations
Access token obtained from OAuth2 client credentials flow
Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).
Body
application/json
Show child attributes
Show child attributes
Organisation type of the organisation
Available options:
Parent, Subsidiary, Independent, Franchise, Branch Example:
"LimitedCompany"
Company Registration Number (CRN), also known as a Companies House number, is a unique identifier assigned to a company when it's registered with Companies House. It's essentially a way to distinguish one company from another and verify its existence
Example:
"12345678"
Business type of the organisation
Available options:
LimitedCompany, LimitedLiabilityPartnership, SoleTrader, Partnership, Charity, PublicSector Example:
"LimitedCompany"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Update organisation information
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/organisation/information \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"name": {
"legalName": "Acme Corporation Ltd",
"tradingName": "Acme Corp"
},
"organisationType": "LimitedCompany",
"companyRegistrationNumber": "12345678",
"businessType": "LimitedCompany",
"registredOfficeAddress": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"correspondenceAddress": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"companyContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
},
"primaryContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
}
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/organisation/information"
payload = {
"name": {
"legalName": "Acme Corporation Ltd",
"tradingName": "Acme Corp"
},
"organisationType": "LimitedCompany",
"companyRegistrationNumber": "12345678",
"businessType": "LimitedCompany",
"registredOfficeAddress": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"correspondenceAddress": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"companyContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
},
"primaryContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
}
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: {legalName: 'Acme Corporation Ltd', tradingName: 'Acme Corp'},
organisationType: 'LimitedCompany',
companyRegistrationNumber: '12345678',
businessType: 'LimitedCompany',
registredOfficeAddress: {
line1: '123 Main Street',
line2: 'Apt 4B',
city: 'London',
county: 'Greater London',
postcode: 'SW1A 1AA',
countryCode: 'GB'
},
correspondenceAddress: {
line1: '123 Main Street',
line2: 'Apt 4B',
city: 'London',
county: 'Greater London',
postcode: 'SW1A 1AA',
countryCode: 'GB'
},
companyContactDetails: {name: 'HR Department', email: 'hr@acme.com', phone: '0161 123 4567'},
primaryContactDetails: {name: 'HR Department', email: 'hr@acme.com', phone: '0161 123 4567'}
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/organisation/information', 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.sandbox.flowpayroll.ai/v1/organisation/information",
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' => [
'legalName' => 'Acme Corporation Ltd',
'tradingName' => 'Acme Corp'
],
'organisationType' => 'LimitedCompany',
'companyRegistrationNumber' => '12345678',
'businessType' => 'LimitedCompany',
'registredOfficeAddress' => [
'line1' => '123 Main Street',
'line2' => 'Apt 4B',
'city' => 'London',
'county' => 'Greater London',
'postcode' => 'SW1A 1AA',
'countryCode' => 'GB'
],
'correspondenceAddress' => [
'line1' => '123 Main Street',
'line2' => 'Apt 4B',
'city' => 'London',
'county' => 'Greater London',
'postcode' => 'SW1A 1AA',
'countryCode' => 'GB'
],
'companyContactDetails' => [
'name' => 'HR Department',
'email' => 'hr@acme.com',
'phone' => '0161 123 4567'
],
'primaryContactDetails' => [
'name' => 'HR Department',
'email' => 'hr@acme.com',
'phone' => '0161 123 4567'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>",
"X-Org-Id: <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.sandbox.flowpayroll.ai/v1/organisation/information"
payload := strings.NewReader("{\n \"name\": {\n \"legalName\": \"Acme Corporation Ltd\",\n \"tradingName\": \"Acme Corp\"\n },\n \"organisationType\": \"LimitedCompany\",\n \"companyRegistrationNumber\": \"12345678\",\n \"businessType\": \"LimitedCompany\",\n \"registredOfficeAddress\": {\n \"line1\": \"123 Main Street\",\n \"line2\": \"Apt 4B\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"SW1A 1AA\",\n \"countryCode\": \"GB\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"123 Main Street\",\n \"line2\": \"Apt 4B\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"SW1A 1AA\",\n \"countryCode\": \"GB\"\n },\n \"companyContactDetails\": {\n \"name\": \"HR Department\",\n \"email\": \"hr@acme.com\",\n \"phone\": \"0161 123 4567\"\n },\n \"primaryContactDetails\": {\n \"name\": \"HR Department\",\n \"email\": \"hr@acme.com\",\n \"phone\": \"0161 123 4567\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<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.sandbox.flowpayroll.ai/v1/organisation/information")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": {\n \"legalName\": \"Acme Corporation Ltd\",\n \"tradingName\": \"Acme Corp\"\n },\n \"organisationType\": \"LimitedCompany\",\n \"companyRegistrationNumber\": \"12345678\",\n \"businessType\": \"LimitedCompany\",\n \"registredOfficeAddress\": {\n \"line1\": \"123 Main Street\",\n \"line2\": \"Apt 4B\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"SW1A 1AA\",\n \"countryCode\": \"GB\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"123 Main Street\",\n \"line2\": \"Apt 4B\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"SW1A 1AA\",\n \"countryCode\": \"GB\"\n },\n \"companyContactDetails\": {\n \"name\": \"HR Department\",\n \"email\": \"hr@acme.com\",\n \"phone\": \"0161 123 4567\"\n },\n \"primaryContactDetails\": {\n \"name\": \"HR Department\",\n \"email\": \"hr@acme.com\",\n \"phone\": \"0161 123 4567\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/organisation/information")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": {\n \"legalName\": \"Acme Corporation Ltd\",\n \"tradingName\": \"Acme Corp\"\n },\n \"organisationType\": \"LimitedCompany\",\n \"companyRegistrationNumber\": \"12345678\",\n \"businessType\": \"LimitedCompany\",\n \"registredOfficeAddress\": {\n \"line1\": \"123 Main Street\",\n \"line2\": \"Apt 4B\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"SW1A 1AA\",\n \"countryCode\": \"GB\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"123 Main Street\",\n \"line2\": \"Apt 4B\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"postcode\": \"SW1A 1AA\",\n \"countryCode\": \"GB\"\n },\n \"companyContactDetails\": {\n \"name\": \"HR Department\",\n \"email\": \"hr@acme.com\",\n \"phone\": \"0161 123 4567\"\n },\n \"primaryContactDetails\": {\n \"name\": \"HR Department\",\n \"email\": \"hr@acme.com\",\n \"phone\": \"0161 123 4567\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"name": {
"legalName": "Acme Corporation Ltd",
"tradingName": "Acme Corp"
},
"organisationType": "LimitedCompany",
"companyRegistrationNumber": "12345678",
"businessType": "LimitedCompany",
"registredOfficeAddress": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"correspondenceAddress": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"companyContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
},
"primaryContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
},
"organisationId": "org_123",
"createdBy": "user_123",
"createdDate": "2025-01-01T00:00:00Z",
"updatedBy": "user_456",
"updatedDate": "2025-01-02T00:00:00Z"
},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}