curl --request PUT \
--url https://app.instantcompliance.ai/api/v1/entities/{id}/designated-services \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"service_codes": [
"PRO-FORMATION"
]
}
'import requests
url = "https://app.instantcompliance.ai/api/v1/entities/{id}/designated-services"
payload = { "service_codes": ["PRO-FORMATION"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({service_codes: ['PRO-FORMATION']})
};
fetch('https://app.instantcompliance.ai/api/v1/entities/{id}/designated-services', 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}/designated-services",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'service_codes' => [
'PRO-FORMATION'
]
]),
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}/designated-services"
payload := strings.NewReader("{\n \"service_codes\": [\n \"PRO-FORMATION\"\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.instantcompliance.ai/api/v1/entities/{id}/designated-services")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"service_codes\": [\n \"PRO-FORMATION\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.instantcompliance.ai/api/v1/entities/{id}/designated-services")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"service_codes\": [\n \"PRO-FORMATION\"\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
}
}
}Replace designated services
Replace the complete set of designated services provided to an
entity. Pass stable codes returned by GET /designated-services.
An empty service_codes array removes every current assignment.
Adding a designated service applies the same CDD, risk,
classification, and audit behaviour as the in-app editor — for
entities that includes upgrading kyb_status from NOT_REQUIRED
to NOT_STARTED — but it does not start a verification, send
a verification request, consume credits, or charge the
organisation or customer.
Requires the customers:write scope. Include an Idempotency-Key
header to make retries safe for 24 hours.
curl --request PUT \
--url https://app.instantcompliance.ai/api/v1/entities/{id}/designated-services \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"service_codes": [
"PRO-FORMATION"
]
}
'import requests
url = "https://app.instantcompliance.ai/api/v1/entities/{id}/designated-services"
payload = { "service_codes": ["PRO-FORMATION"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({service_codes: ['PRO-FORMATION']})
};
fetch('https://app.instantcompliance.ai/api/v1/entities/{id}/designated-services', 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}/designated-services",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'service_codes' => [
'PRO-FORMATION'
]
]),
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}/designated-services"
payload := strings.NewReader("{\n \"service_codes\": [\n \"PRO-FORMATION\"\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.instantcompliance.ai/api/v1/entities/{id}/designated-services")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"service_codes\": [\n \"PRO-FORMATION\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.instantcompliance.ai/api/v1/entities/{id}/designated-services")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"service_codes\": [\n \"PRO-FORMATION\"\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
}
}
}service_codes — the
same operation as the in-app editor: the designated flag is derived, the
entity’s risk rating is recomputed, classification stays in sync, and
the change is audited.
A designated service being added can upgrade kyb_status from
NOT_REQUIRED to NOT_STARTED (due diligence becomes owed). No KYB
is started and no credits are charged — your back-office team chooses
the KYB method and starts verification in-app.
An empty service_codes array is an explicit “no designated services”.
The path {id} accepts our UUID or your external_id.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.
255Path Parameters
Entity identifier. Accepts either Instant Compliance's UUID
(550e8400-…) or your own external_id.
Body
The specific designated service(s) provided to the customer, as
stable catalog codes. An empty array is an explicit "no designated
services". Unknown or non-designated codes are rejected with
422 validation_failed.
The catalog is also available programmatically via
GET /designated-services.
Professional services
| Code | Service |
|---|---|
PRO-FORMATION | Company or trust formation |
PRO-PURCHASE-SALE | Company or trust purchase/sale |
PRO-RESTRUCTURE | Business restructuring services |
PRO-REAL-ESTATE | Real estate professional services (conveyancing / legal) |
PRO-CLIENT-MONEY | Client money/assets management (incl. securities & virtual assets) |
PRO-FINANCING | Business financing arrangement services |
PRO-SHELF | Shelf company sales |
PRO-NOMINEE | Nominee director or shareholder services |
PRO-REGISTERED-OFFICE | Registered office address services |
Real estate
| Code | Service |
|---|---|
RE-BROKER | Real estate agency (brokering sales) |
RE-DEVELOPER | Property development sales |
Financial services
| Code | Service |
|---|---|
FIN-BANKING | Banking and deposit services |
FIN-REMITTANCE | Money transfer and remittance services |
FIN-CRYPTO | Cryptocurrency exchange services |
FIN-FX | Foreign currency exchange |
FIN-LOANS | Loans and financing services |
FIN-INVESTMENT | Investment and securities services |
FIN-ADVISORY | Financial advisory services (arranging designated services) |
FIN-INSURANCE | Insurance services (life insurance, sinking funds) |
FIN-SUPER | Superannuation fund management |
FIN-PENSION | Pension, annuity, or retirement account services |
FIN-STORED-VALUE | High-value stored value cards |
FIN-CUSTODIAL | Custodial and depository services |
FIN-PAYROLL | Payroll services for other businesses |
Other designated services
| Code | Service |
|---|---|
OTH-BULLION | Bullion trading (precious metals) |
OTH-GAMBLING | Gambling services |
OTH-HIGH-VALUE-GOODS | High-value goods dealing |
6464["PRO-FORMATION", "PRO-CLIENT-MONEY"]
Response
Updated entity record. designated_services is the complete
normalized set now assigned to the entity.
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 The specific designated service(s) provided to the customer, as
stable catalog codes. An empty array is an explicit "no designated
services". Unknown or non-designated codes are rejected with
422 validation_failed.
The catalog is also available programmatically via
GET /designated-services.
Professional services
| Code | Service |
|---|---|
PRO-FORMATION | Company or trust formation |
PRO-PURCHASE-SALE | Company or trust purchase/sale |
PRO-RESTRUCTURE | Business restructuring services |
PRO-REAL-ESTATE | Real estate professional services (conveyancing / legal) |
PRO-CLIENT-MONEY | Client money/assets management (incl. securities & virtual assets) |
PRO-FINANCING | Business financing arrangement services |
PRO-SHELF | Shelf company sales |
PRO-NOMINEE | Nominee director or shareholder services |
PRO-REGISTERED-OFFICE | Registered office address services |
Real estate
| Code | Service |
|---|---|
RE-BROKER | Real estate agency (brokering sales) |
RE-DEVELOPER | Property development sales |
Financial services
| Code | Service |
|---|---|
FIN-BANKING | Banking and deposit services |
FIN-REMITTANCE | Money transfer and remittance services |
FIN-CRYPTO | Cryptocurrency exchange services |
FIN-FX | Foreign currency exchange |
FIN-LOANS | Loans and financing services |
FIN-INVESTMENT | Investment and securities services |
FIN-ADVISORY | Financial advisory services (arranging designated services) |
FIN-INSURANCE | Insurance services (life insurance, sinking funds) |
FIN-SUPER | Superannuation fund management |
FIN-PENSION | Pension, annuity, or retirement account services |
FIN-STORED-VALUE | High-value stored value cards |
FIN-CUSTODIAL | Custodial and depository services |
FIN-PAYROLL | Payroll services for other businesses |
Other designated services
| Code | Service |
|---|---|
OTH-BULLION | Bullion trading (precious metals) |
OTH-GAMBLING | Gambling services |
OTH-HIGH-VALUE-GOODS | High-value goods dealing |
6464["PRO-FORMATION", "PRO-CLIENT-MONEY"]
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

