cURL
curl https://app.instantcompliance.ai/api/v1/designated-services \
-H "Authorization: Bearer ic_live_..."
import requests
url = "https://app.instantcompliance.ai/api/v1/designated-services"
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/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/designated-services",
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/designated-services"
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/designated-services")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.instantcompliance.ai/api/v1/designated-services")
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{
"object": "list",
"data": [
{
"code": "PRO-FORMATION",
"label": "Company or trust formation",
"description": "Setting up new companies, trusts, partnerships, or other legal entities for clients.",
"category": "PROFESSIONAL",
"category_label": "Professional Services"
},
{
"code": "RE-BROKER",
"label": "Real estate agency (brokering sales)",
"description": "Brokering the sale, purchase, or transfer of real estate for a client — i.e. acting as a real-estate agent (including buyer's and seller's agents).",
"category": "REAL_ESTATE",
"category_label": "Real Estate"
}
]
}{
"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": "rate_limited",
"message": "Rate limit exceeded. Slow down and retry shortly.",
"details": {
"limit": 60,
"window_seconds": 60
}
}
}API reference
List designated services
The catalog of designated-service codes accepted by the
designatedServices field on POST /customers — discover valid
codes programmatically instead of hardcoding the table from the
DesignatedServices schema docs.
The catalog is static application data derived from the AML/CTF
Act’s designated-services tables: it is the same for every
organisation, changes only with legislation, and needs no
pagination. In addition to these codes, designatedServices also
accepts custom services encoded as
OTHER__<LOW|MEDIUM|HIGH>__<label> — for a service not in the
catalog, with the risk tier of your choosing.
Requires the customers:read scope.
GET
/
designated-services
cURL
curl https://app.instantcompliance.ai/api/v1/designated-services \
-H "Authorization: Bearer ic_live_..."
import requests
url = "https://app.instantcompliance.ai/api/v1/designated-services"
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/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/designated-services",
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/designated-services"
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/designated-services")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.instantcompliance.ai/api/v1/designated-services")
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{
"object": "list",
"data": [
{
"code": "PRO-FORMATION",
"label": "Company or trust formation",
"description": "Setting up new companies, trusts, partnerships, or other legal entities for clients.",
"category": "PROFESSIONAL",
"category_label": "Professional Services"
},
{
"code": "RE-BROKER",
"label": "Real estate agency (brokering sales)",
"description": "Brokering the sale, purchase, or transfer of real estate for a client — i.e. acting as a real-estate agent (including buyer's and seller's agents).",
"category": "REAL_ESTATE",
"category_label": "Real Estate"
}
]
}{
"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": "rate_limited",
"message": "Rate limit exceeded. Slow down and retry shortly.",
"details": {
"limit": 60,
"window_seconds": 60
}
}
}The catalog of designated services, grouped by category. Each entry
carries the stable
code you pass in designatedServices on the
customer and entity endpoints, plus a human label and description.
Codes are stable identifiers — cache them freely, but fetch this list
when building a picker so newly enabled services appear without a code
change on your side.
Unknown or non-designated codes sent to any write endpoint are rejected
with 422 validation_failed — nothing is silently dropped, so a typo
surfaces immediately instead of producing a thinner service set.
