# Sphinx API Docs

## Docs

- [Create Case](https://docs.sphinxhq.com/api-reference/cases/create-case.md): Create a new case for a customer. You can either provide an existing customer_id or create a new customer inline. By default, the case is automatically started after creation (equivalent to calling POST /cases/{id}/start/). Set auto_start=false to create without starting.
- [Delete Case](https://docs.sphinxhq.com/api-reference/cases/delete-case.md): Delete a specific case by ID
- [Get Case](https://docs.sphinxhq.com/api-reference/cases/get-case.md): Retrieve a specific case by ID
- [List Cases](https://docs.sphinxhq.com/api-reference/cases/list-cases.md): List all cases
- [Start or Rerun Case](https://docs.sphinxhq.com/api-reference/cases/start-or-rerun-case.md): Starts processing for a case. If the case is already running, returns 202 with `action_taken="noop_already_running"`; no new work is triggered. If the case is already completed (DECIDED/SUBMITTING/SUBMITTED), the default behavior is 202 with `action_taken="noop_already_started"` — pass `allow_restar…
- [Sync Case Documents](https://docs.sphinxhq.com/api-reference/cases/sync-case-documents.md): Trigger a document sync for this case. The case must have sync_platforms configured. Returns 202 once the sync is initiated.
- [Update Case](https://docs.sphinxhq.com/api-reference/cases/update-case.md): Partially update an existing case. Only the provided fields are updated (PATCH semantics). Updatable fields: webhook_url, delete_after, metadata, sync_platforms, external_id.
- [Create Check](https://docs.sphinxhq.com/api-reference/checks/create-check.md): Create a new check. The check will be automatically processed after creation.
- [Delete Check](https://docs.sphinxhq.com/api-reference/checks/delete-check.md): Delete a specific check by ID
- [Get Check](https://docs.sphinxhq.com/api-reference/checks/get-check.md): Retrieve a specific check by ID
- [List Checks](https://docs.sphinxhq.com/api-reference/checks/list-checks.md): List all checks
- [Create Customer](https://docs.sphinxhq.com/api-reference/customers/create-customer.md): Create a new customer with flexible data structure
- [Delete Customer](https://docs.sphinxhq.com/api-reference/customers/delete-customer.md): Delete a specific customer by ID
- [Get Customer](https://docs.sphinxhq.com/api-reference/customers/get-customer.md): Retrieve a specific customer by ID
- [List Customers](https://docs.sphinxhq.com/api-reference/customers/list-customers.md): List all customers
- [Update Customer](https://docs.sphinxhq.com/api-reference/customers/update-customer.md): Partially update an existing customer identified by external_id. Only fields included in the request body are updated; omitted fields are left unchanged. If the customer has sync_platforms configured, changes are automatically synced to the external platform (e.g. Salesforce).
- [Update Customer](https://docs.sphinxhq.com/api-reference/customers/update-customer-1.md): Partially update an existing customer identified by external_id. Only fields included in the request body are updated; omitted fields are left unchanged. If the customer has sync_platforms configured, changes are automatically synced to the external platform (e.g. Salesforce).
- [Delete Document](https://docs.sphinxhq.com/api-reference/documents/delete-document.md): Delete a specific document by ID
- [Get Document](https://docs.sphinxhq.com/api-reference/documents/get-document.md): Retrieve a specific document by ID
- [List Documents](https://docs.sphinxhq.com/api-reference/documents/list-documents.md): List all documents
- [Upload Document](https://docs.sphinxhq.com/api-reference/documents/upload-document.md): Upload a document. To use it in a case, pass its ID in a Case or Check create request.
- [OAuth2 client credentials token endpoint](https://docs.sphinxhq.com/api-reference/oauth/oauth2-client-credentials-token-endpoint.md): Exchange client_id + client_secret for a short-lived Bearer access token.
- [Post apionboardingpresigned upload](https://docs.sphinxhq.com/api-reference/onboarding/post-apionboardingpresigned-upload.md): Return a presigned S3 PUT URL for uploading HAR recordings or screenshots.
- [Post apionboardingsessions](https://docs.sphinxhq.com/api-reference/onboarding/post-apionboardingsessions.md): Create an OnboardingSession record after the extension finishes uploading.
- [Frequently Asked Questions](https://docs.sphinxhq.com/faq.md): Common questions about how Sphinx works.
- [Quickstart](https://docs.sphinxhq.com/index.md): The easiest way to get Sphinx working your cases
- [Case Model](https://docs.sphinxhq.com/models/case.md): A Case is a container for all checks and documents related to a single customer investigation.
- [Check Model](https://docs.sphinxhq.com/models/check.md): A Check represents a specific verification process, such as a PEP or sanctions screening.
- [Customer Model](https://docs.sphinxhq.com/models/customer.md): A Customer represents an individual or a company that is the subject of a screening case.
- [Document Model](https://docs.sphinxhq.com/models/document.md): A Document represents a file, such as an ID or proof of address, associated with a case or check.
- [Sphinx Models](https://docs.sphinxhq.com/models/introduction.md): Understanding the core data structures of the Sphinx API

## OpenAPI Specs

- [api_schema](https://docs.sphinxhq.com/api_schema.yaml)
- [openapi](https://docs.sphinxhq.com/api-reference/openapi.json)