API Endpoints
The complete reference to every endpoint of the Know Your Customer Limited Public API v2, the KYB API for verifying companies from live registry data across 147 jurisdictions, resolving beneficial ownership, and screening for AML: every endpoint, parameter, request body, and response, generated from the OpenAPI specification. New to the API? Start with the Guide or the Quickstart. Before you build, read API Scope & Limitations for what the API does and does not do; the Data Dictionary for field-level detail; and Integration Patterns for the common ways to put the endpoints together. For event webhooks, which are configured outside this core endpoint surface, see Webhooks.
Skip the HTML. Fetch the whole reference as one machine-readable document at /developers/llms-full.md (with a short index at /developers/llms.md). It has auth, the case model, the end-to-end flow, ownership, documents, AML, and the error model in one file built for agents.
Import the collection and environment into Postman, then set your sandbox clientId and clientSecret, run Authentication > Obtain an access token, and paste the returned access_token into the bearerToken variable. For your own tooling, a matching set of environment variables:
SANDBOX_BASE_URL=https://api.knowyourcustomer.dev
SANDBOX_TOKEN_URL=https://api.knowyourcustomer.dev/connect/token
SANDBOX_CLIENT_ID=your-sandbox-client-id
SANDBOX_CLIENT_SECRET=your-sandbox-client-secret
SANDBOX_SCOPE=PublicApiAll API Endpoints
The KYC Public API v2 provides 33 endpoints across authentication, company KYB verification, individual KYC, document management, AML screening, live monitoring, and reporting. Base URLs: https://api.knowyourcustomer.dev (sandbox), https://api.knowyourcustomer.com (production Europe), https://api-asia.knowyourcustomer.com (production Asia).
Authentication
| Method | Path | Description |
|---|---|---|
| POST | /connect/token | Obtain an OAuth2 access token using client credentials. Send grant_type=client_credentials, client_id, client_secret, scope=PublicApi. Returns access_token (JWT, 1-hour expiry). |
Company KYB (core)
| Method | Path | Description |
|---|---|---|
| POST | /v2/Companies/search | Search a company registry by name and country (ISO code). Returns a list of matching companies with registration numbers for use in case creation. |
| POST | /v2/Companies | Create a company KYB case. Provide country (ISO), registrationNumber, and/or name. Returns a caseCommonId used for all subsequent calls. |
| GET | /v2/Companies | List all company cases in your account, with pagination. Returns case status, jurisdiction, and creation date. |
| GET | /v2/Companies/{caseCommonId} | Get a company case and its current processing status. Returns full entity data: legal name, registration number, status, registered address, officers, shareholders, and case state. |
| GET | /v2/Companies/{caseCommonId}/members | Get all controlling entities, shareholders, UBOs, and PSCs linked to a company case. Returns the recursive ownership tree. |
| GET | /v2/Companies/{caseCommonId}/org-chart | Get the full beneficial ownership org-chart as a structured JSON tree, showing multi-level ownership from corporate parents to ultimate individual beneficial owners. |
| PATCH | /v2/Companies/{caseCommonId}/status | Close or reopen a case and record a decision (Approved or Rejected). |
| GET | /v2/Companies/{caseCommonId}/audittrail | Get the complete audit trail for a case. |
Documents
| Method | Path | Description |
|---|---|---|
| GET | /v2/Companies/{caseCommonId}/documents/rules/mandatory | Get the list of mandatory company documents required for the jurisdiction (registry extract, certificate of incorporation, etc.). |
| GET | /v2/Companies/{caseCommonId}/documents | List all documents held against a company case. |
| POST | /v2/Companies/{caseCommonId}/documents/upload | Upload a company document (multipart/form-data). Used for jurisdictions requiring manual document upload. |
| GET | /v2/Documents/{documentId} | Download a specific document by ID. Returns the registry extract, certificate of incorporation, annual return, or other registry document. |
AML Screening
| Method | Path | Description |
|---|---|---|
| GET | /v2/Companies/{caseCommonId}/amlchecks | Get AML, sanctions, PEP, and adverse-media screening results for a company case. Returns hits with match details and risk classification. |
| GET | /v2/Individuals/{caseCommonId}/amlchecks | Get AML screening results for an individual UBO or director. |
Individual KYC (UBOs & Directors)
| Method | Path | Description |
|---|---|---|
| GET | /v2/Individuals/{caseCommonId} | Get an individual member case (UBO, director, or shareholder). |
| GET | /v2/Individuals/{caseCommonId}/documents/mandatory | Get mandatory identity documents for an individual case. |
| POST | /v2/Individuals/{caseCommonId}/documents/upload | Upload an identity document for an individual (passport, ID card). |
| POST | /v2/Individuals/documents/prevalidate | Prevalidate a document image before upload to check quality and readability. |
| PATCH | /v2/Individuals/{caseCommonId}/status | Close or reopen an individual KYC case. |
| GET | /v2/Individuals/{caseCommonId}/report | Download an individual KYC report PDF. |
Case Steps & Management
| Method | Path | Description |
|---|---|---|
| GET | /v2/CaseSteps/{caseCommonId} | List all processing steps for a case (registry lookup, document fetch, AML screening, review). |
| GET | /v2/CaseSteps/{caseCommonId}/details/{stepId} | Get the detail of a single case step. |
| GET | /v2/CaseComments | List case comments for audit and review workflow. |
| POST | /v2/CaseComments | Add a comment to a case. |
| PUT | /v2/AssignUser/{caseCommonId}/assign/{userId} | Assign a case to a specific user. |
Live Monitoring (Perpetual KYB)
| Method | Path | Description |
|---|---|---|
| GET | /v2/Companies/{caseCommonId}/lm-alerts | Get live-monitoring alerts for a company case. Alerts are generated when registry or screening data changes post-onboarding. |
| POST | /v2/Companies/{caseCommonId}/lm-alerts-action | Action a live-monitoring alert (dismiss, investigate, escalate). |
Reports
| Method | Path | Description |
|---|---|---|
| GET | /v2/Companies/{caseCommonId}/report | Download the complete KYB report PDF for a company case, suitable for compliance audit files. |
| GET | /v2/Companies/{caseCommonId}/org-chart-pdf | Download the beneficial ownership org-chart as a PDF. |
Reference Data
| Method | Path | Description |
|---|---|---|
| GET | /v2/Jurisdictions | List all 147 supported jurisdictions with their ISO country codes. |
| GET | /v2/CompanyTypes | List supported company types per jurisdiction. |
| GET | /v2/Version | Get the current API version. |
Interactive API Explorer
Browse every endpoint with full request/response schemas, try live calls against the sandbox, and see example payloads below.