Update an entity
curl --request PATCH \
--url https://app.instantcompliance.ai/api/v1/entities/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"abn": "<string>",
"acn": "<string>",
"address": "<string>",
"registrationNumber": "<string>",
"contact": {
"customerId": "<string>",
"fullName": "<string>",
"email": "jsmith@example.com",
"kycRequired": true
},
"risk": {
"isNewCustomer": true,
"isDesignatedService": true,
"handlesCashOrCrypto": true,
"metFaceToFace": true,
"operatesCashBusiness": true,
"unusualTransactions": true,
"unexplainedWealth": true,
"falseIdentityIndicators": true,
"complexStructure": true
}
}
'import requests
url = "https://app.instantcompliance.ai/api/v1/entities/{id}"
payload = {
"name": "<string>",
"abn": "<string>",
"acn": "<string>",
"address": "<string>",
"registrationNumber": "<string>",
"contact": {
"customerId": "<string>",
"fullName": "<string>",
"email": "jsmith@example.com",
"kycRequired": True
},
"risk": {
"isNewCustomer": True,
"isDesignatedService": True,
"handlesCashOrCrypto": True,
"metFaceToFace": True,
"operatesCashBusiness": True,
"unusualTransactions": True,
"unexplainedWealth": True,
"falseIdentityIndicators": True,
"complexStructure": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
abn: '<string>',
acn: '<string>',
address: '<string>',
registrationNumber: '<string>',
contact: {
customerId: '<string>',
fullName: '<string>',
email: 'jsmith@example.com',
kycRequired: true
},
risk: {
isNewCustomer: true,
isDesignatedService: true,
handlesCashOrCrypto: true,
metFaceToFace: true,
operatesCashBusiness: true,
unusualTransactions: true,
unexplainedWealth: true,
falseIdentityIndicators: true,
complexStructure: true
}
})
};
fetch('https://app.instantcompliance.ai/api/v1/entities/{id}', 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://app.instantcompliance.ai/api/v1/entities/{id}",
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' => '<string>',
'abn' => '<string>',
'acn' => '<string>',
'address' => '<string>',
'registrationNumber' => '<string>',
'contact' => [
'customerId' => '<string>',
'fullName' => '<string>',
'email' => 'jsmith@example.com',
'kycRequired' => true
],
'risk' => [
'isNewCustomer' => true,
'isDesignatedService' => true,
'handlesCashOrCrypto' => true,
'metFaceToFace' => true,
'operatesCashBusiness' => true,
'unusualTransactions' => true,
'unexplainedWealth' => true,
'falseIdentityIndicators' => true,
'complexStructure' => true
]
]),
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://app.instantcompliance.ai/api/v1/entities/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"abn\": \"<string>\",\n \"acn\": \"<string>\",\n \"address\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"contact\": {\n \"customerId\": \"<string>\",\n \"fullName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"kycRequired\": true\n },\n \"risk\": {\n \"isNewCustomer\": true,\n \"isDesignatedService\": true,\n \"handlesCashOrCrypto\": true,\n \"metFaceToFace\": true,\n \"operatesCashBusiness\": true,\n \"unusualTransactions\": true,\n \"unexplainedWealth\": true,\n \"falseIdentityIndicators\": true,\n \"complexStructure\": true\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.instantcompliance.ai/api/v1/entities/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"abn\": \"<string>\",\n \"acn\": \"<string>\",\n \"address\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"contact\": {\n \"customerId\": \"<string>\",\n \"fullName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"kycRequired\": true\n },\n \"risk\": {\n \"isNewCustomer\": true,\n \"isDesignatedService\": true,\n \"handlesCashOrCrypto\": true,\n \"metFaceToFace\": true,\n \"operatesCashBusiness\": true,\n \"unusualTransactions\": true,\n \"unexplainedWealth\": true,\n \"falseIdentityIndicators\": true,\n \"complexStructure\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.instantcompliance.ai/api/v1/entities/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"abn\": \"<string>\",\n \"acn\": \"<string>\",\n \"address\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"contact\": {\n \"customerId\": \"<string>\",\n \"fullName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"kycRequired\": true\n },\n \"risk\": {\n \"isNewCustomer\": true,\n \"isDesignatedService\": true,\n \"handlesCashOrCrypto\": true,\n \"metFaceToFace\": true,\n \"operatesCashBusiness\": true,\n \"unusualTransactions\": true,\n \"unexplainedWealth\": true,\n \"falseIdentityIndicators\": true,\n \"complexStructure\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"external_id": "crm-ent-311",
"type": "COMPANY",
"name": "Acme Holdings Pty Ltd",
"origin": "AUSTRALIAN",
"abn": "12345678901",
"acn": "123456789",
"country_of_formation": "AUS",
"registration_number": null,
"kyb_status": "IN_PROGRESS",
"kyb_started_at": "2026-06-23T01:00:00Z",
"kyb_completed_at": null,
"contact": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"external_id": "crm-7741",
"full_name": "Jane Doe",
"email": "jane@example.com",
"kyc_status": "PENDING",
"kyc_required": true
},
"aml": {
"status": "CLEAR",
"screened_at": "2026-06-23T01:12:00Z",
"last_reviewed_at": null,
"flags": {
"pep": false,
"sanctions": false,
"adverse_media": false,
"terrorism": false
}
},
"added_via": "INTEGRATION",
"created_at": "2026-06-22T22:14:00Z",
"updated_at": "2026-06-23T01:12:05Z"
}{
"error": {
"code": "unauthorized",
"message": "Invalid or revoked API key."
}
}{
"error": {
"code": "forbidden_scope",
"message": "This API key does not have the required scope. customers:write",
"details": {
"required_scope": "customers:write"
}
}
}{
"error": {
"code": "not_found",
"message": "Customer not found."
}
}{
"error": {
"code": "validation_failed",
"message": "Invalid customer payload.",
"details": {
"issues": {
"email": [
"Must be a valid email address."
]
}
}
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded. Slow down and retry shortly.",
"details": {
"limit": 60,
"window_seconds": 60
}
}
}Entities
Update an entity
Partial update of a record you have ingested. Identity fields
(name, abn, acn, registrationNumber) are frozen once the
entity’s KYB has been verified — attempting to change them returns
422 validation_failed. type and origin are immutable.
Passing contact replaces the entity’s contact person (same
shapes as on create). Omitted fields are left untouched; an
explicit null clears a clearable field (abn, acn,
address, registrationNumber).
PATCH
/
entities
/
{id}
Update an entity
curl --request PATCH \
--url https://app.instantcompliance.ai/api/v1/entities/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"abn": "<string>",
"acn": "<string>",
"address": "<string>",
"registrationNumber": "<string>",
"contact": {
"customerId": "<string>",
"fullName": "<string>",
"email": "jsmith@example.com",
"kycRequired": true
},
"risk": {
"isNewCustomer": true,
"isDesignatedService": true,
"handlesCashOrCrypto": true,
"metFaceToFace": true,
"operatesCashBusiness": true,
"unusualTransactions": true,
"unexplainedWealth": true,
"falseIdentityIndicators": true,
"complexStructure": true
}
}
'import requests
url = "https://app.instantcompliance.ai/api/v1/entities/{id}"
payload = {
"name": "<string>",
"abn": "<string>",
"acn": "<string>",
"address": "<string>",
"registrationNumber": "<string>",
"contact": {
"customerId": "<string>",
"fullName": "<string>",
"email": "jsmith@example.com",
"kycRequired": True
},
"risk": {
"isNewCustomer": True,
"isDesignatedService": True,
"handlesCashOrCrypto": True,
"metFaceToFace": True,
"operatesCashBusiness": True,
"unusualTransactions": True,
"unexplainedWealth": True,
"falseIdentityIndicators": True,
"complexStructure": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
abn: '<string>',
acn: '<string>',
address: '<string>',
registrationNumber: '<string>',
contact: {
customerId: '<string>',
fullName: '<string>',
email: 'jsmith@example.com',
kycRequired: true
},
risk: {
isNewCustomer: true,
isDesignatedService: true,
handlesCashOrCrypto: true,
metFaceToFace: true,
operatesCashBusiness: true,
unusualTransactions: true,
unexplainedWealth: true,
falseIdentityIndicators: true,
complexStructure: true
}
})
};
fetch('https://app.instantcompliance.ai/api/v1/entities/{id}', 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://app.instantcompliance.ai/api/v1/entities/{id}",
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' => '<string>',
'abn' => '<string>',
'acn' => '<string>',
'address' => '<string>',
'registrationNumber' => '<string>',
'contact' => [
'customerId' => '<string>',
'fullName' => '<string>',
'email' => 'jsmith@example.com',
'kycRequired' => true
],
'risk' => [
'isNewCustomer' => true,
'isDesignatedService' => true,
'handlesCashOrCrypto' => true,
'metFaceToFace' => true,
'operatesCashBusiness' => true,
'unusualTransactions' => true,
'unexplainedWealth' => true,
'falseIdentityIndicators' => true,
'complexStructure' => true
]
]),
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://app.instantcompliance.ai/api/v1/entities/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"abn\": \"<string>\",\n \"acn\": \"<string>\",\n \"address\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"contact\": {\n \"customerId\": \"<string>\",\n \"fullName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"kycRequired\": true\n },\n \"risk\": {\n \"isNewCustomer\": true,\n \"isDesignatedService\": true,\n \"handlesCashOrCrypto\": true,\n \"metFaceToFace\": true,\n \"operatesCashBusiness\": true,\n \"unusualTransactions\": true,\n \"unexplainedWealth\": true,\n \"falseIdentityIndicators\": true,\n \"complexStructure\": true\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.instantcompliance.ai/api/v1/entities/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"abn\": \"<string>\",\n \"acn\": \"<string>\",\n \"address\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"contact\": {\n \"customerId\": \"<string>\",\n \"fullName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"kycRequired\": true\n },\n \"risk\": {\n \"isNewCustomer\": true,\n \"isDesignatedService\": true,\n \"handlesCashOrCrypto\": true,\n \"metFaceToFace\": true,\n \"operatesCashBusiness\": true,\n \"unusualTransactions\": true,\n \"unexplainedWealth\": true,\n \"falseIdentityIndicators\": true,\n \"complexStructure\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.instantcompliance.ai/api/v1/entities/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"abn\": \"<string>\",\n \"acn\": \"<string>\",\n \"address\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"contact\": {\n \"customerId\": \"<string>\",\n \"fullName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"kycRequired\": true\n },\n \"risk\": {\n \"isNewCustomer\": true,\n \"isDesignatedService\": true,\n \"handlesCashOrCrypto\": true,\n \"metFaceToFace\": true,\n \"operatesCashBusiness\": true,\n \"unusualTransactions\": true,\n \"unexplainedWealth\": true,\n \"falseIdentityIndicators\": true,\n \"complexStructure\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"external_id": "crm-ent-311",
"type": "COMPANY",
"name": "Acme Holdings Pty Ltd",
"origin": "AUSTRALIAN",
"abn": "12345678901",
"acn": "123456789",
"country_of_formation": "AUS",
"registration_number": null,
"kyb_status": "IN_PROGRESS",
"kyb_started_at": "2026-06-23T01:00:00Z",
"kyb_completed_at": null,
"contact": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"external_id": "crm-7741",
"full_name": "Jane Doe",
"email": "jane@example.com",
"kyc_status": "PENDING",
"kyc_required": true
},
"aml": {
"status": "CLEAR",
"screened_at": "2026-06-23T01:12:00Z",
"last_reviewed_at": null,
"flags": {
"pep": false,
"sanctions": false,
"adverse_media": false,
"terrorism": false
}
},
"added_via": "INTEGRATION",
"created_at": "2026-06-22T22:14:00Z",
"updated_at": "2026-06-23T01:12:05Z"
}{
"error": {
"code": "unauthorized",
"message": "Invalid or revoked API key."
}
}{
"error": {
"code": "forbidden_scope",
"message": "This API key does not have the required scope. customers:write",
"details": {
"required_scope": "customers:write"
}
}
}{
"error": {
"code": "not_found",
"message": "Customer not found."
}
}{
"error": {
"code": "validation_failed",
"message": "Invalid customer payload.",
"details": {
"issues": {
"email": [
"Must be a valid email address."
]
}
}
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded. Slow down and retry shortly.",
"details": {
"limit": 60,
"window_seconds": 60
}
}
}Partial update of an entity you have ingested. Omitted fields are left
untouched; an explicit
null clears a clearable field (abn, acn,
address, registrationNumber).
- Identity freeze: once the entity’s KYB is verified,
name,abn,acn, andregistrationNumberare frozen — changing them returns422 validation_failed. Those values came from the registry check and must not silently drift. - Immutable:
typeandorigincan never change. Create a new record if the entity was ingested with the wrong type. - Contact: passing
contactreplaces the entity’s contact person — the samecustomerId/ inlinefullName+emailshapes as on create.
Authorizations
Bearer API key issued from Settings → Developers in your
Instant Compliance organisation. Format: ic_live_….
Headers
Caller-supplied unique key for safe retries. Repeat the same key within 24 hours and we replay the original response instead of repeating the side effect. Reusing the key with a different request body returns 409 idempotency_conflict.
Maximum string length:
255Path Parameters
Entity identifier. Accepts either Instant Compliance's UUID
(550e8400-…) or your own external_id.
Body
application/json
Required string length:
1 - 255Maximum string length:
500Maximum string length:
64The entity's primary contact person — the individual who acts for
the entity and receives the KYB portal link when your team starts
verification. Provide either customerId (an existing
individual) or fullName + email (inline create/reuse) —
not both.
Show child attributes
Show child attributes
Optional risk pre-answers. Your back-office team will complete the full risk assessment in-app before triggering KYC; these values seed it.
Show child attributes
Show child attributes
Response
Updated entity record.
Instant Compliance customer UUID (entities are customers too).
Entity customer types accepted by /entities. SMSF is treated
as a type of trust and OTHER as a company for verification
purposes, but the type you post round-trips back unchanged.
Immutable after creation.
Available options:
COMPANY, TRUST, PARTNERSHIP, SMSF, OTHER The entity's legal name.
Where the entity is formed. AUSTRALIAN (the default) uses
ABN/ACN identifiers; INTERNATIONAL uses countryOfFormation +
registrationNumber. Immutable after creation.
Available options:
AUSTRALIAN, INTERNATIONAL Available options:
NOT_STARTED, PENDING, IN_PROGRESS, VERIFIED, FAILED, NOT_REQUIRED, AWAITING_RESUBMISSION Show child attributes
Show child attributes
How the record entered Instant Compliance.
Available options:
ADMIN_MANUAL, AI_EXTRACTED, CONTACT_PORTAL, BULK_IMPORT, INTEGRATION, SYSTEM ISO 3166-1 alpha-3. AUS for Australian entities; the country
of formation for international entities.
Registry number recorded for international entities.
The entity's current contact person, or null when none is set.
Show child attributes
Show child attributes