# Slate

- [Introduction to Slate's Legal Recovery API Platform](https://docs.slate.inc/docs/introduction.md): Slate is API infrastructure for legal recovery workflows, keeping accounts synced, compliant, and secure between creditors and law firms.
- [API Authentication: OAuth 2.0 Client Credentials](https://docs.slate.inc/docs/authentication.md): Authenticate with Slate using the OAuth 2.0 client credentials grant. Exchange your client ID and secret for a Bearer token, then send it on every request.
- [Cursor-Based Pagination for Slate API List Endpoints](https://docs.slate.inc/docs/pagination.md): Slate list endpoints use cursor-based pagination. Pass a cursor token from the previous response to retrieve the next page of results.
- [Accounts API: Place and Sync Debt Inventory in Slate](https://docs.slate.inc/docs/accounts-overview.md): The Accounts API is the core of Slate. Upsert accounts by crid, track balances and lifecycle state, and place accounts with firms.
- [Files and Document Requests: Slate API File Management](https://docs.slate.inc/docs/files-and-requests.md): Upload files to Slate via presigned S3 URLs, then assemble them into evidence bundles with exhibit ordering to generate final court-ready PDFs.
- [E-Signatures and E-Notary Transactions in Slate API](https://docs.slate.inc/docs/signatures-overview.md): Create signature requests from Slate documents, bundle them into a signing transaction, retrieve a signing URL, and track the ceremony to completion.
- [Quality Control Checklists and Workflows in Slate API](https://docs.slate.inc/docs/quality-control-overview.md): Define reusable checklists, attach them to workflow processes, and run structured approve/reject QC reviews with role-based item assignments.
- [Sync Your Full Account Inventory with the Slate API](https://docs.slate.inc/docs/guide-sync-accounts.md): Follow these steps to upsert accounts into Slate, store returned UUIDs, apply partial updates, and keep your full inventory continuously in sync.
- [Upload Evidence Files to Slate Using Presigned URLs](https://docs.slate.inc/docs/guide-upload-file.md): Learn how to create a file upload session, transfer your file to S3 via a presigned URL, verify upload status, and reference the file id in Slate.
- [End-to-End Walkthrough: Account to Signed Document](https://docs.slate.inc/docs/guide-create-signature-workflow.md): Walk through the full Slate integration path: create an account, open a file request, and let Slate users complete, QC, and sign the document.
- [Automatically Redact Sensitive Data in PDF Documents](https://docs.slate.inc/docs/guide-redact-document.md): Learn how to submit a PDF redaction job with custom rules, poll the lightweight status endpoint, and download the redacted output file from Slate.
- [Run a Quality Control Review Workflow in Slate API](https://docs.slate.inc/docs/guide-qc-workflow.md): Step-by-step guide to building a QC checklist and process, creating review requests, and submitting approval or rejection decisions in Slate.
- [List accounts](https://docs.slate.inc/api-reference/accounts/list-accounts.md): Returns a page of accounts for the caller's owner, newest-updated first by default. Narrow with `filter[...]` (e.g. `filter[crid]` to resolve one of your accounts to its Slate `accountId`). Use `cursor` to page; `nextCursor` is empty on the last page.
- [Create or update an account (upsert)](https://docs.slate.inc/api-reference/accounts/upsert-account.md): Idempotently creates the account if none exists for your `(owner, crid)`, or updates the existing one, from the snapshot in the request body. Re-sending the same `crid` updates the same account. On create, Slate assigns and returns the account's `accountId`. Send the account's *current* full state;…
- [Get an account](https://docs.slate.inc/api-reference/get-an-account.md): Returns the full account aggregate — identity, status, balance, current placement, and any legal record — by its Slate `accountId`.
- [Update an account](https://docs.slate.inc/api-reference/update-an-account.md): Partially updates the account — send only the fields that changed, e.g. `{"currentBalance": "192.68"}` or `{"status": "CLOSED"}`. Omitted fields are left unchanged. This is the single endpoint for targeted updates (balance, status, placement, legal, and other mutable fields); identity fields cannot…
- [List entities on an account](https://docs.slate.inc/api-reference/list-entities-on-an-account.md): Returns the active entities (customers) on the account, with their addresses.
- [Create a entity on an account](https://docs.slate.inc/api-reference/create-a-entity-on-an-account.md): Adds a entity to the account. Addresses supplied in the body are created with the entity; when an address is written, an `ADDRESS_CHANGE` event is published for the matter.
- [Get a entity](https://docs.slate.inc/api-reference/get-a-entity.md): Returns a entity on the account by its `entityId`.
- [Update a entity](https://docs.slate.inc/api-reference/update-a-entity.md): Partially updates a entity — send only the fields that changed. Updating an address publishes an `ADDRESS_CHANGE` event for the matter.
- [Deactivate a entity](https://docs.slate.inc/api-reference/deactivate-a-entity.md): Soft-deletes (deactivates) a entity on the account.
- [List creditors](https://docs.slate.inc/api-reference/list-creditors.md): Returns the creditors managed by the caller's owner.
- [Create a creditor](https://docs.slate.inc/api-reference/create-a-creditor.md): Creates a creditor under the caller's owner and returns it with its Slate-assigned `creditorId`; reference it from account writes via the account's `creditorId` field.
- [Get a creditor](https://docs.slate.inc/api-reference/get-a-creditor.md): Returns a creditor managed by the caller's owner, by its Slate `creditorId`.
- [List firms](https://docs.slate.inc/api-reference/list-firms.md): Returns the service firms managed by the caller's owner.
- [Create a firm](https://docs.slate.inc/api-reference/create-a-firm.md): Creates a service firm under the caller's owner and returns it with its Slate-assigned `firmId`; place accounts with it via a placement's `firmId` field.
- [Get a firm](https://docs.slate.inc/api-reference/get-a-firm.md): Returns a firm managed by the caller's owner, by its Slate `firmId`.
- [List requests](https://docs.slate.inc/api-reference/requests/list-requests.md): Return a paginated list of evidence and claims requests, with optional filtering and ordering.
- [Create a request](https://docs.slate.inc/api-reference/files/create-request.md): Create a new evidence or claims request.
- [Get a request](https://docs.slate.inc/api-reference/requests/get-a-request.md): Return the full details of a single request.
- [Update a request](https://docs.slate.inc/api-reference/requests/update-a-request.md): Partially update a request. Only the fields you supply are changed.
- [Delete a request](https://docs.slate.inc/api-reference/requests/delete-a-request.md): Permanently delete a request.
- [Add an exhibit](https://docs.slate.inc/api-reference/exhibits/add-an-exhibit.md): Attach a new exhibit to the request.
- [Update an exhibit](https://docs.slate.inc/api-reference/exhibits/update-an-exhibit.md): Partially update an exhibit. Only the fields you supply are changed.
- [Delete an exhibit](https://docs.slate.inc/api-reference/exhibits/delete-an-exhibit.md): Remove an exhibit from the request.
- [Update a template on a request](https://docs.slate.inc/api-reference/requests/update-a-template-on-a-request.md): Update a template attached to a request, for example to mark it as pending delete or to restore it.
- [Delete a template from a request](https://docs.slate.inc/api-reference/requests/delete-a-template-from-a-request.md): Remove a template from a request.
- [Generate a PDF from a template](https://docs.slate.inc/api-reference/requests/generate-a-pdf-from-a-template.md): Generate a PDF file from a single template on the request and return a time-limited download URL.
- [Generate a PDF from a request](https://docs.slate.inc/api-reference/requests/generate-a-pdf-from-a-request.md): Generate a PDF file from the entire request and return a time-limited download URL.
- [Approve a request and finalize its PDF](https://docs.slate.inc/api-reference/requests/approve-a-request-and-finalize-its-pdf.md): Finalize the request's generated PDF and return the resulting file's metadata.
- [List files](https://docs.slate.inc/api-reference/files/list-files.md): Return a paginated list of a matter's files and media, with optional filtering and ordering.
- [Get a file](https://docs.slate.inc/api-reference/files/get-a-file.md): Retrieve a single file by ID.
- [Create a file upload session](https://docs.slate.inc/api-reference/files/create-a-file-upload-session.md): Create a file record and return a pre-signed upload URL and the fields to submit the file with.
- [Concatenate files into a single PDF](https://docs.slate.inc/api-reference/files/concatenate-files-into-a-single-pdf.md): Combine the provided files into a new PDF and return a time-limited download URL.
- [Archive a file](https://docs.slate.inc/api-reference/files/archive-a-file.md): Archive a file so it no longer appears in active listings.
- [Request a bulk file download](https://docs.slate.inc/api-reference/bulk-downloads/request-a-bulk-file-download.md): Creates a bulk download job with 'pending' status and enqueus it. The worker streams the requested files into a single zip which can be downloaded.
- [Get bulk download job status](https://docs.slate.inc/api-reference/bulk-downloads/get-bulk-download-job-status.md)
- [List redaction jobs](https://docs.slate.inc/api-reference/redactions/list-redaction-jobs.md): Return a paginated list of redaction jobs, with optional filtering and ordering.
- [Submit a redaction job](https://docs.slate.inc/api-reference/redactions/submit-a-redaction-job.md): Create a new redaction job with status `pending` and start the asynchronous redaction process.
- [Get a redaction job](https://docs.slate.inc/api-reference/redactions/get-a-redaction-job.md): Return the full metadata for a redaction job. For lightweight polling use `GET /v1/redactions/{redactionId}/status`. For file access use `GET /v1/redactions/{redactionId}/file`.
- [Get redaction job status](https://docs.slate.inc/api-reference/redactions/get-redaction-job-status.md): Return a lightweight status snapshot for polling. Includes just the fields needed to advance a job from pending or processing to a terminal state.
- [Get a download URL for the redacted PDF](https://docs.slate.inc/api-reference/redactions/get-a-download-url-for-the-redacted-pdf.md): Return a time-limited download URL for the redacted output. Use `?download=false` for inline viewing in a browser tab and `?download=true` to force the browser save dialog. Only valid once the job is `completed`.
- [List signature requests](https://docs.slate.inc/api-reference/list-signature-requests.md): Retrieve a paginated list of signature requests with basic metadata.
- [Create a signature request](https://docs.slate.inc/api-reference/create-a-signature-request.md): Create a new signature request for a document.
- [Get a signature request](https://docs.slate.inc/api-reference/get-a-signature-request.md): Retrieve the full details of a single signature request by ID.
- [Update a signature request](https://docs.slate.inc/api-reference/update-a-signature-request.md): Update a signature request. Currently used to reject a request by setting its status to `rejected`.
- [Delete a signature request](https://docs.slate.inc/api-reference/delete-a-signature-request.md): Remove a signature request from the system.
- [Get an upload URL for a completed signed file](https://docs.slate.inc/api-reference/get-an-upload-url-for-a-completed-signed-file.md): Generate a pre-signed URL for uploading the completed signed file (e.g. DOCX or WPD).
- [List signature transactions](https://docs.slate.inc/api-reference/list-signature-transactions.md): Returns signature transactions the authenticated user is party to, optionally filtered by status.
- [Create a signature transaction](https://docs.slate.inc/api-reference/signatures/create-transaction.md): Create a new signature transaction to initiate and carry out the signing process.
- [Get a signature transaction](https://docs.slate.inc/api-reference/get-a-signature-transaction.md): Retrieve the full details of a single signature transaction.
- [Update a signature transaction](https://docs.slate.inc/api-reference/update-a-signature-transaction.md): Update a signature transaction, for example to mark the notary as ready.
- [Get a signing URL for a signature transaction](https://docs.slate.inc/api-reference/get-a-signing-url-for-a-signature-transaction.md): Get a short-lived signing URL that can be used to start a signing session.
- [List all QC checklists](https://docs.slate.inc/api-reference/list-all-qc-checklists.md): Retrieve a paginated list of all QC checklists with basic metadata.
- [Create a new checklist with items](https://docs.slate.inc/api-reference/create-a-new-checklist-with-items.md): Create a checklist with items
- [Get a QC checklist and items](https://docs.slate.inc/api-reference/get-a-qc-checklist-and-items.md): Gets a single QC checklist with checklist items
- [Update a QC Checklist and items](https://docs.slate.inc/api-reference/update-a-qc-checklist-and-items.md): Updates a QC Checklist and items
- [Create a QC checklist group](https://docs.slate.inc/api-reference/create-a-qc-checklist-group.md): Creates a new group on a review-type QC checklist
- [List all QC requests](https://docs.slate.inc/api-reference/list-all-qc-requests.md): Retrieve a paginated list of all QC requests with basic metadata. Uses file_requests for document data.
- [Create a one-off QC request](https://docs.slate.inc/api-reference/create-a-one-off-qc-request.md): Creates a QC request directly from a review checklist, with no associated document. Uses `crid` (a free-typed Creditor Reference ID) instead of a `file_requests` row.
- [Get a QC Request](https://docs.slate.inc/api-reference/get-a-qc-request.md): Gets a single QC Request with checklist items. Uses file_requests for document data.
- [Update a QC Request](https://docs.slate.inc/api-reference/update-a-qc-request.md): Updates a QC Request as approved/rejected. Uses file_requests for document data.
- [Undo a QC Request review](https://docs.slate.inc/api-reference/undo-a-qc-request-review.md): Resets an approved or rejected QC Request back to pending, returning it to the QC queue.
- [List all QC requests and checklists for reporting](https://docs.slate.inc/api-reference/list-all-qc-requests-and-checklists-for-reporting.md): Retrieve a paginated list of all QC requests with extended metadata for reporting. Uses file_requests for document data.
- [List QC processes](https://docs.slate.inc/api-reference/list-qc-processes.md): Retrieve a paginated list of all QC processes with basic metadata.
- [Create a new process](https://docs.slate.inc/api-reference/create-a-new-process.md): Create a new quality check process linked to a checklist
- [Update a QC Process](https://docs.slate.inc/api-reference/update-a-qc-process.md): Updates a QC Process name, archival, or checklist
- [List users](https://docs.slate.inc/api-reference/users/list-users.md): Retrieve a paginated list of users for a given owner, with optional filtering and ordering.
- [Get a user](https://docs.slate.inc/api-reference/get-a-user.md): Retrieve a single user, including download URLs for the signature and notary seal images. Allowed for the user themselves or a caller with the manage permission.
- [Create or update a user](https://docs.slate.inc/api-reference/create-or-update-a-user.md): Create or update a user's profile. When signatureKey or notarySealKey are supplied (the keys returned by POST /v1/users/{userId}/images), the stored image references are updated; upload the images to their upload URLs before saving so the saved profile references images that already exist. Allowed f…
- [Update a user's activation state](https://docs.slate.inc/api-reference/update-a-users-activation-state.md): Activate or deactivate a user. Deactivated users cannot authenticate, sign, or be selected, but remain visible in historical records.
- [Request an image upload URL](https://docs.slate.inc/api-reference/request-an-image-upload-url.md): Request a presigned upload URL and a freshly generated key for the user's signature or notary seal image. Each request produces a new key, so uploads never overwrite a previous image. Upload the image to the returned URL first, then save the profile via PUT /v1/users/{userId} (passing the returned k…

## OpenAPI Specs

- [openapi](/api-reference/accounts/openapi.yaml)
- [openapi](/api-reference/files/openapi.yaml)
- [openapi](/api-reference/qc/openapi.yaml)
- [openapi](/api-reference/signatures/openapi.yaml)
- [openapi](/api-reference/users/openapi.yaml)