# Sophic Engine

## Docs

- [Authentication](https://docs.engine.usesophic.com/api-reference/auth.md): Authenticate requests using Bearer tokens.
- [Best practices](https://docs.engine.usesophic.com/api-reference/best-practices.md): A list of best practices for a stable integration.
- [Create a claim for a person](https://docs.engine.usesophic.com/api-reference/create-a-claim-for-a-person.md): Submit a claim of any type for a person. The claim is created with pending status and will need verification.
- [Create a deposit](https://docs.engine.usesophic.com/api-reference/create-a-deposit.md): Create a deposit, funded by bank transfer. The deposit amount can be optionally advanced, to increase the account's buying power before the deposit is funded.
- [Create a file](https://docs.engine.usesophic.com/api-reference/create-a-file.md): Create a file from a signed upload. **Please use the `id` that was returned when the signed upload was requested.**
- [Create a person](https://docs.engine.usesophic.com/api-reference/create-a-person.md): Creates a person from claims with optional verification evidence. Supports both natural and legal persons.
- [Create a webhook](https://docs.engine.usesophic.com/api-reference/create-a-webhook.md): Create a new webhook.
- [Create a withdrawal](https://docs.engine.usesophic.com/api-reference/create-a-withdrawal.md): Initiates a withdrawal of cash out of the account.
- [Download a legal document version](https://docs.engine.usesophic.com/api-reference/download-a-legal-document-version.md): Downloads the file for a specific version of a legal document. This endpoint redirects to a signed download URL. Clients that cannot follow a redirect can make the request with ?redirect=false and manually open the URL in `download_url` to trigger the download. If you want to open the file inline, a…
- [Download the latest version of a legal document](https://docs.engine.usesophic.com/api-reference/download-the-latest-version-of-a-legal-document.md): Downloads the file for the latest version of a legal document (by effective date). This endpoint redirects to a signed download URL. Clients that cannot follow a redirect can make the request with ?redirect=false and manually open the URL in `download_url` to trigger the download. If you want to ope…
- [Errors](https://docs.engine.usesophic.com/api-reference/errors.md): Understand our error responses and debug failed requests.
- [Idempotency](https://docs.engine.usesophic.com/api-reference/idempotency.md): Prevent duplicate operations by using idempotency keys.
- [Issue an OAuth token](https://docs.engine.usesophic.com/api-reference/issue-an-oauth-token.md): Issue an OAuth token using client credentials.
- [List account transactions](https://docs.engine.usesophic.com/api-reference/list-account-transactions.md): Retrieve the account's transaction activity.
- [List authorities for a person](https://docs.engine.usesophic.com/api-reference/list-authorities-for-a-person.md): List all authorities for a person by ID, optionally including revoked authorities.
- [List cash balances](https://docs.engine.usesophic.com/api-reference/list-cash-balances.md): Retrieve an account's cash balances (one for each supported currency).
- [List claims for a person](https://docs.engine.usesophic.com/api-reference/list-claims-for-a-person.md): List claims for a person by ID. Each row exposes `status`, `archived_at` (set on pending rows replaced by a newer pending), `superseded_at` (set on verified rows replaced by a newer verified), plus a derived `lifecycle` (`active`, `in_flight`, or `historical`) computed from those three columns. By d…
- [List events](https://docs.engine.usesophic.com/api-reference/list-events.md): Retrieve events, optionally filtered by name, resource ID, or creation time.
- [List funding accounts](https://docs.engine.usesophic.com/api-reference/list-funding-accounts.md): Retrieve the funding bank accounts registered on the parent account. Funding accounts are automatically registered using the bank details from a deposit when received. These can be used to withdraw funds out of the account.
- [List instruments](https://docs.engine.usesophic.com/api-reference/list-instruments.md): Retrieve all instruments. Note that only instruments visible for your tenant will be returned.
- [List legal documents](https://docs.engine.usesophic.com/api-reference/list-legal-documents.md): Retrieve all available legal documents, optionally filtered by document type.
- [List on-the-run bills](https://docs.engine.usesophic.com/api-reference/list-on-the-run-bills.md): Returns the on-the-run treasury bill for each standard maturity period of the given issuer country that currently has a matching bill. Periods with no matching bill are omitted from the response.
- [List orders](https://docs.engine.usesophic.com/api-reference/list-orders.md): Retrieve all orders associated with the given account.
- [List pending orders](https://docs.engine.usesophic.com/api-reference/list-pending-orders.md): Retrieve all orders associated with the given account that are pending execution.
- [List positions](https://docs.engine.usesophic.com/api-reference/list-positions.md): List an account's positions, optionally filtered to only include open positions.
- [List versions of a legal document](https://docs.engine.usesophic.com/api-reference/list-versions-of-a-legal-document.md): Returns all versions of the given legal document, ordered by effective date descending (most recent first).
- [List webhooks](https://docs.engine.usesophic.com/api-reference/list-webhooks.md): List all webhooks.
- [Me](https://docs.engine.usesophic.com/api-reference/me.md): Retrieve the authenticated user or service.
- [Place an order](https://docs.engine.usesophic.com/api-reference/place-an-order.md): Places a buy-side or sell-side order. We currently support cash-based buy orders and unit-based sell orders only.
- [Request file upload](https://docs.engine.usesophic.com/api-reference/request-file-upload.md): Request a signed URL for uploading a file directly to storage. **The returned `id` is needed to create a file from the signed upload.**
- [Retrieve a customer](https://docs.engine.usesophic.com/api-reference/retrieve-a-customer.md): Retrieve a customer by ID.
- [Retrieve a deposit](https://docs.engine.usesophic.com/api-reference/retrieve-a-deposit.md): Retrieve a deposit by ID.
- [Retrieve a fee charge](https://docs.engine.usesophic.com/api-reference/retrieve-a-fee-charge.md): Retrieve a fee charge by ID.
- [Retrieve a legal document](https://docs.engine.usesophic.com/api-reference/retrieve-a-legal-document.md): Retrieve a legal document by ID.
- [Retrieve a legal document version](https://docs.engine.usesophic.com/api-reference/retrieve-a-legal-document-version.md): Retrieve a specific version of a legal document.
- [Retrieve a person](https://docs.engine.usesophic.com/api-reference/retrieve-a-person.md): Retrieve a person by ID.
- [Retrieve a person claim](https://docs.engine.usesophic.com/api-reference/retrieve-a-person-claim.md): Retrieve a single claim for a person by person ID and claim ID.
- [Retrieve a position](https://docs.engine.usesophic.com/api-reference/retrieve-a-position.md): Retrieve a position within an account.
- [Retrieve a withdrawal](https://docs.engine.usesophic.com/api-reference/retrieve-a-withdrawal.md): Retrieve a withdrawal by ID.
- [Retrieve an account](https://docs.engine.usesophic.com/api-reference/retrieve-an-account.md): Retrieve an account by ID or reference.
- [Retrieve an instrument](https://docs.engine.usesophic.com/api-reference/retrieve-an-instrument.md): Retrieve an instrument by ID or symbol. Note that the instrument has to be visible for your tenant to be accessible.
- [Retrieve an order](https://docs.engine.usesophic.com/api-reference/retrieve-an-order.md): Retrieve an order by ID.
- [Retrieve current valuation](https://docs.engine.usesophic.com/api-reference/retrieve-current-valuation.md): Retrieve an account's current valuation.
- [Retrieve earnings (P&L)](https://docs.engine.usesophic.com/api-reference/retrieve-earnings-p&l.md): Retrieve an account's earnings (P&L) for the requested period. Note the period supports full date-times, with timezone information.
- [Retrieve prices](https://docs.engine.usesophic.com/api-reference/retrieve-prices.md): Retrieve the price for the requested symbols as-of the given datetime, which defaults to now.
- [Retrieve valuation history](https://docs.engine.usesophic.com/api-reference/retrieve-valuation-history.md): Retrieve an account's valuation time series for the requested period. Suitable for charting an account's valuation over time.
- [Retrieve webhook](https://docs.engine.usesophic.com/api-reference/retrieve-webhook.md): Retrieve a webhook by ID.
- [Submit an onboarding application](https://docs.engine.usesophic.com/api-reference/submit-an-onboarding-application.md): Submits an onboarding application for compliance review. All referenced persons must already exist. The application is validated against the onboarding requirements for the given customer type.
- [Update a webhook](https://docs.engine.usesophic.com/api-reference/update-a-webhook.md): Update an existing webhook.
- [Update Position](https://docs.engine.usesophic.com/api-reference/update-position.md): Updates (a limited set of) settings for the given position.
- [Versioning](https://docs.engine.usesophic.com/api-reference/versioning.md): Learn about our versioning policy.
- [Environments](https://docs.engine.usesophic.com/docs/environments.md): Sandbox and live API environments. URLs, credentials, and behavioral differences
- [Introduction](https://docs.engine.usesophic.com/docs/intro.md): Guides and best practices for integrating with our API
- [Applications](https://docs.engine.usesophic.com/docs/onboarding/applications.md): Submit an onboarding application referencing persons, consents, and evidence
- [Claims](https://docs.engine.usesophic.com/docs/onboarding/claims.md): Typed, versioned data points attached to a person
- [Errors](https://docs.engine.usesophic.com/docs/onboarding/errors.md): Every validation error the onboarding endpoints return and how to fix it
- [Overview](https://docs.engine.usesophic.com/docs/onboarding/overview.md): Onboard customers through persons, claims, and onboarding applications
- [Persons](https://docs.engine.usesophic.com/docs/onboarding/persons.md): Natural and legal parties that fuel onboarding applications
- [Best Practices](https://docs.engine.usesophic.com/docs/orders/best-practices.md): Recommendations for building a reliable order integration
- [Errors](https://docs.engine.usesophic.com/docs/orders/errors.md): Common errors when placing orders and how to handle them
- [Order Lifecycle](https://docs.engine.usesophic.com/docs/orders/lifecycle.md): How orders move from placement to settlement or cancellation
- [Overview](https://docs.engine.usesophic.com/docs/orders/overview.md): Buy and sell instruments on behalf of your customers
- [Rollovers](https://docs.engine.usesophic.com/docs/orders/rollovers.md): How automatic rollovers work for treasury bill positions
- [Testing](https://docs.engine.usesophic.com/docs/orders/testing.md): Predefined order outcomes you can trigger in the sandbox environment
- [Best Practices](https://docs.engine.usesophic.com/docs/webhooks/best-practices.md): Recommendations for building a reliable webhook integration
- [Deliveries & Retries](https://docs.engine.usesophic.com/docs/webhooks/deliveries.md): How webhook deliveries are tracked and retried
- [Overview](https://docs.engine.usesophic.com/docs/webhooks/overview.md): Receive real-time event notifications
- [Verifying Signatures](https://docs.engine.usesophic.com/docs/webhooks/verifying-signatures.md): Validate that webhook requests are authentic before processing them

## OpenAPI Specs

- [openapi](https://api.engine.usesophic.com/openapi.json)