curl --request GET \
--url https://app.instantcompliance.ai/api/v1/entities/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.instantcompliance.ai/api/v1/entities/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.instantcompliance.ai/api/v1/entities/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.instantcompliance.ai/api/v1/entities/{id}")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
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": "rate_limited",
"message": "Rate limit exceeded. Slow down and retry shortly.",
"details": {
"limit": 60,
"window_seconds": 60
}
}
}Get an entity
curl --request GET \
--url https://app.instantcompliance.ai/api/v1/entities/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.instantcompliance.ai/api/v1/entities/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.instantcompliance.ai/api/v1/entities/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.instantcompliance.ai/api/v1/entities/{id}")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
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": "rate_limited",
"message": "Rate limit exceeded. Slow down and retry shortly.",
"details": {
"limit": 60,
"window_seconds": 60
}
}
}external_id — the format is detected automatically.
The response includes the entity’s kyb_status, its AML screening
block, and a summary of its current contact person (including whether
the contact’s own KYC is intended to run with the entity’s KYB).
Beneficial-owner / UBO detail is not exposed through the API — that
resolution happens in-app during KYB.Authorizations
Bearer API key issued from Settings → Developers in your
Instant Compliance organisation. Format: ic_live_….
Path Parameters
Entity identifier. Accepts either Instant Compliance's UUID
(550e8400-…) or your own external_id.
Response
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.
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.
AUSTRALIAN, INTERNATIONAL NOT_STARTED, PENDING, IN_PROGRESS, VERIFIED, FAILED, NOT_REQUIRED, AWAITING_RESUBMISSION Show child attributes
Show child attributes
How the record entered Instant Compliance.
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

