Skip to main content
GET
/
customers
/
{id}
Get a customer
curl --request GET \
  --url https://app.instantcompliance.ai/api/v1/customers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "external_id": "crm-7741",
  "type": "INDIVIDUAL",
  "full_name": "Jane Doe",
  "email": "jane@example.com",
  "kyc_status": "VERIFIED",
  "kyc_started_at": "2026-06-23T01:00:00Z",
  "kyc_completed_at": "2026-06-23T01:12:00Z",
  "identity": {
    "verified_legal_name": "JANE DOE",
    "verified_country": "AUS"
  },
  "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"
}
Look up an individual customer by Instant Compliance UUID or by your own external_id. We auto-detect the format.
# By UUID
curl https://app.instantcompliance.ai/api/v1/customers/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer ic_live_..."

# By external_id
curl https://app.instantcompliance.ai/api/v1/customers/crm-7741 \
  -H "Authorization: Bearer ic_live_..."

Response shape

See Data minimisation for what is and is not included in the response, and Customer lifecycle for how to interpret the status fields.

Cross-tenant isolation

A UUID that belongs to a different organisation returns 404 not_found — never data, never an “exists but you can’t see it” leak.

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers in your Instant Compliance organisation. Format: ic_live_….

Path Parameters

id
string
required

Customer identifier. Accepts either Instant Compliance's UUID (550e8400-…) or your own external_id.

Response

Customer record.

id
string<uuid>
required

Instant Compliance customer UUID.

type
enum<string>
required

v1 only ingests individuals. Entity types ship in v2.

Available options:
INDIVIDUAL,
SOLE_TRADER
full_name
string
required
kyc_status
enum<string>
required
Available options:
NOT_STARTED,
PENDING,
IN_PROGRESS,
VERIFIED,
FAILED,
NOT_REQUIRED,
AWAITING_RESUBMISSION
aml
object
required
added_via
enum<string>
required

How the record entered Instant Compliance.

Available options:
ADMIN_MANUAL,
AI_EXTRACTED,
CONTACT_PORTAL,
BULK_IMPORT,
INTEGRATION,
SYSTEM
created_at
string<date-time>
required
updated_at
string<date-time>
required
external_id
string | null
email
string<email> | null
kyc_started_at
string<date-time> | null
kyc_completed_at
string<date-time> | null
identity
object

Populated only when kyc_status = VERIFIED. Deliberately minimal — full date of birth and full address are never exposed.