Skip to main content
POST
cURL
Ingest an individual customer. The record lands in your organisation tagged INTEGRATION with kyc_status = NOT_STARTED. No KYC is triggered. No credits are charged. Your back-office team completes the risk questions in-app and starts verification when ready.

Idempotent upsert behaviour

This lets a Zapier “Create / Update Customer” action send the same event repeatedly without creating duplicates.

Retry safety

Pass Idempotency-Key (a UUID or any string ≤ 255 chars). Repeated calls with the same key within 24 hours replay the original response. See Idempotency.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

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: 255

Body

application/json
fullName
string
required
Required string length: 1 - 255
email
string<email>
required
Maximum string length: 255
externalId
string

Your CRM identifier. Strongly recommended for idempotent upsert + round-tripping.

Maximum string length: 255
type
enum<string>

Individual customer types — /customers only ingests these. Entity customers (companies, trusts, partnerships, SMSFs) live on /entities with their own EntityType.

Available options:
INDIVIDUAL,
SOLE_TRADER
phone
string | null
Maximum string length: 32
risk
object

Optional risk pre-answers. Your back-office team will complete the full risk assessment in-app before triggering KYC; these values seed it.

designatedServices
string[]

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

Real estate

Financial services

Other designated services

Maximum array length: 64
Maximum string length: 64
Example:

Response

Existing customer updated (idempotent upsert).

id
string<uuid>
required

Instant Compliance customer UUID.

type
enum<string>
required

Individual customer types — /customers only ingests these. Entity customers (companies, trusts, partnerships, SMSFs) live on /entities with their own EntityType.

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 | null

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