# API playground

The API playground at https://docs.complyance.io/api/ sends real requests to sandbox from the browser and generates cURL, JavaScript and Python for each one. This copy lists its operations. For every parameter, request body and response, read the OpenAPI document: [openapi.json](https://docs.complyance.io/openapi.json) (Complyance API, version 3.17.1).

All operations use the host `https://prod.gets.complyance.io`.

## Unify

Submit documents for any supported country.

- `POST /api/v3/unify`: Submit a document. [Open in the playground](https://docs.complyance.io/api/?operation=submitDocument) · [Docs](https://docs.complyance.io/api-reference/unify/submit-and-retrieve/)

## Documents

Follow submitted documents and retrieve received purchase invoices.

- `GET /api/v3/documents`: List purchase invoices. [Open in the playground](https://docs.complyance.io/api/?operation=listPurchaseInvoices) · [Docs](https://docs.complyance.io/api-reference/purchases/list/)
- `GET /api/v3/documents/{documentId}`: Get a document. [Open in the playground](https://docs.complyance.io/api/?operation=getDocument) · [Docs](https://docs.complyance.io/api-reference/unify/documents/)
- `GET /api/v3/documents/{documentId}/status`: Get a document's status. [Open in the playground](https://docs.complyance.io/api/?operation=getDocumentStatus) · [Docs](https://docs.complyance.io/api-reference/unify/documents/)

## Connect

Onboard and manage the companies in an ISV workspace.

- `GET /v3/connect/companies`: List companies. [Open in the playground](https://docs.complyance.io/api/?operation=listCompanies) · [Docs](https://docs.complyance.io/api-reference/connect/companies/#list-companies)
- `POST /v3/connect/companies`: Create a UAE company. [Open in the playground](https://docs.complyance.io/api/?operation=createCompany) · [Docs](https://docs.complyance.io/api-reference/connect/companies/#create-a-uae-company)
- `POST /v3/connect/companies/onboarding-jobs`: Onboard companies in bulk. [Open in the playground](https://docs.complyance.io/api/?operation=createOnboardingJob) · [Docs](https://docs.complyance.io/partner-platform/isv/companies/bulk-onboarding/)
- `GET /v3/connect/companies/{sourceName}`: Get a company source. [Open in the playground](https://docs.complyance.io/api/?operation=getCompany) · [Docs](https://docs.complyance.io/api-reference/connect/companies/#retrieve-update-or-archive-a-source)
- `PATCH /v3/connect/companies/{sourceName}`: Update a company source. [Open in the playground](https://docs.complyance.io/api/?operation=updateCompany) · [Docs](https://docs.complyance.io/api-reference/connect/companies/#retrieve-update-or-archive-a-source)
- `DELETE /v3/connect/companies/{sourceName}`: Archive a company source. [Open in the playground](https://docs.complyance.io/api/?operation=archiveCompany) · [Docs](https://docs.complyance.io/api-reference/connect/companies/#retrieve-update-or-archive-a-source)
- `POST /v3/connect/companies/{companyId}/branches`: Add a branch. [Open in the playground](https://docs.complyance.io/api/?operation=addBranch) · [Docs](https://docs.complyance.io/api-reference/connect/companies/#add-branches)
- `POST /v3/connect/companies/{companyId}/branches/bulk`: Add branches in bulk. [Open in the playground](https://docs.complyance.io/api/?operation=addBranches) · [Docs](https://docs.complyance.io/api-reference/connect/companies/#add-branches)
- `GET /v3/connect/invoices/counts`: Count documents. [Open in the playground](https://docs.complyance.io/api/?operation=countDocuments) · [Docs](https://docs.complyance.io/api-reference/connect/invoice-counts/)

## Credits

Preview. Read the credit pool and manage company allowances in an ISV workspace. Confirm availability and the supported environment with Complyance before using it for customer or production operations.

- `GET /v3/connect/credits/pool`: Read the credit pool. [Open in the playground](https://docs.complyance.io/api/?operation=getCreditPool) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)
- `GET /v3/connect/credits/allowances`: List company allowances. [Open in the playground](https://docs.complyance.io/api/?operation=listAllowances) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)
- `GET /v3/connect/credits/allowances/{companyId}`: Read a company's allowance. [Open in the playground](https://docs.complyance.io/api/?operation=getAllowance) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)
- `PUT /v3/connect/credits/allowances/{companyId}/current`: Create or replace the current allowance. [Open in the playground](https://docs.complyance.io/api/?operation=putCurrentAllowance) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)
- `PUT /v3/connect/credits/allowances/{companyId}/scheduled`: Create or replace the next allowance. [Open in the playground](https://docs.complyance.io/api/?operation=putScheduledAllowance) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)
- `DELETE /v3/connect/credits/allowances/{companyId}/scheduled`: Cancel the scheduled allowance. [Open in the playground](https://docs.complyance.io/api/?operation=cancelScheduledAllowance) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)
- `POST /v3/connect/credits/allowances/{companyId}/pause`: Pause the current allowance. [Open in the playground](https://docs.complyance.io/api/?operation=pauseAllowance) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)
- `POST /v3/connect/credits/allowances/{companyId}/resume`: Resume the current allowance. [Open in the playground](https://docs.complyance.io/api/?operation=resumeAllowance) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)
- `POST /v3/connect/credits/allowances/bulk`: Submit a bulk allowance job. [Open in the playground](https://docs.complyance.io/api/?operation=submitBulkAllowances) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)
- `GET /v3/connect/credits/allowances/bulk/{jobId}`: Read a bulk allowance job. [Open in the playground](https://docs.complyance.io/api/?operation=getBulkAllowanceJob) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)
- `GET /v3/connect/credits/transactions`: Read credit activity. [Open in the playground](https://docs.complyance.io/api/?operation=listCreditTransactions) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)
- `POST /v3/connect/credits/exports`: Request a CSV export. [Open in the playground](https://docs.complyance.io/api/?operation=createCreditExport) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)
- `GET /v3/connect/credits/exports/{exportId}`: Read an export. [Open in the playground](https://docs.complyance.io/api/?operation=getCreditExport) · [Docs](https://docs.complyance.io/api-reference/connect/credits/)

Source: https://docs.complyance.io/api/