> ## Documentation Index
> Fetch the complete documentation index at: https://docs.instantcompliance.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Push customers into Instant Compliance from your CRM and pull KYC / AML status back into your systems.

The Instant Compliance API lets your systems send customers — individuals
and entities — into Instant Compliance and read their KYC / KYB / AML
status back out. It is designed for **server-to-server integrations** —
CRMs (Salesforce, HubSpot, Pipedrive), automation platforms (Zapier,
Make, n8n), and internal back-office tooling.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Create your first key and ingest a customer in under five minutes.
  </Card>

  <Card title="API reference" icon="brackets-curly" href="/api-reference/introduction">
    Every endpoint, every parameter, every response — with live "Try it"
    code samples.
  </Card>

  <Card title="Zapier guide" icon="bolt" href="/guides/zapier-integration">
    Wire Instant Compliance into your no-code workflows.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Issue, rotate, and revoke API keys and choose the right scopes.
  </Card>
</CardGroup>

## What v1 does

* **Create or update an individual customer** in your Instant Compliance
  organisation. The customer lands tagged `INTEGRATION` with
  `kyc_status = NOT_STARTED`. No KYC is triggered, no credits are charged.
* **Create or update an entity customer** (company, trust, partnership,
  SMSF) on [`/entities`](/api-reference/entities/create) — including its
  identifiers (ABN/ACN or country + registration number) and contact
  person. The entity lands with `kyb_status = NOT_STARTED`; no KYB is
  triggered, no credits are charged.
* **Read a customer back** including a safe, integrator-friendly slice of
  its KYC / KYB and AML status fields.
* **Poll for status changes** using the `updated_since` filter on the
  list endpoints — perfect for syncing results into your CRM.

## What v1 does *not* do

These are coming in v2 and are intentionally out of scope today:

* **Trigger KYC / KYB checks via API.** Starting a real verification is
  the billable moment and stays a human action inside Instant Compliance
  (your back-office team completes the risk questions and clicks **Start
  Verification** in-app).
* **Outbound webhooks.** Subscribe to status changes by polling for now
  — webhook delivery (`customer.kyc_completed`, `aml.review_completed`)
  is on the roadmap.
* **UBO / beneficial-owner graphs.** Entities are ingested and their KYB
  status is readable, but ownership resolution happens in-app during KYB.
* **EDD** (Enhanced Due Diligence) source-of-funds / source-of-wealth.

## Base URL

```
https://app.instantcompliance.ai/api/v1
```

All endpoints accept and return `application/json`. All timestamps are
ISO-8601 UTC. All identifiers are UUIDs unless otherwise noted.

## Security defaults

* **HTTPS only.** Plaintext HTTP requests are rejected.
* **Org-scoped keys.** Every key belongs to exactly one organisation —
  cross-tenant data access is structurally impossible.
* **Least-privilege scopes.** Grant only the scopes your integration needs
  (`customers:write`, `customers:read`, `aml:read`).
* **Data minimisation.** Responses never include raw AML hit data, full
  date of birth, full address, document references, or moderator notes.
  See [Data minimisation](/concepts/data-minimisation) for the full
  deny-list.
