# Otim Documentation

## Docs

- [Documentation](https://docs.otim.com/docs/introduction.md): Otim enables any platform to launch their own financial products without partnering with a bank.
- [Getting Started](https://docs.otim.com/docs/getting-started.md): Create your Platform and make your first API call.
- [Changelog](https://docs.otim.com/docs/resources/changelog.md)
- [Platform](https://docs.otim.com/core-objects/platform.md): Top-level container for all objects on Otim.
- [Account](https://docs.otim.com/core-objects/account.md): Holds, routes, and earns yield on funds.
- [Entity](https://docs.otim.com/core-objects/entity.md): A verified person or business.
- [Counterparty](https://docs.otim.com/core-objects/counterparty.md): An external wallet or bank account for outbound transfers.
- [IBAN](https://docs.otim.com/core-objects/iban.md): A fiat deposit rail issued to a verified Entity.
- [Authentication](https://docs.otim.com/docs/api/authentication.md)
- [Pagination](https://docs.otim.com/docs/api/pagination.md)
- [Idempotency](https://docs.otim.com/docs/api/idempotency.md)
- [Transfer Types](https://docs.otim.com/docs/api/transfer-types.md)
- [Webhooks](https://docs.otim.com/docs/api/webhooks.md)
- [Sandbox & Testing](https://docs.otim.com/docs/api/sandbox.md)
- [Get Platform Settings](https://docs.otim.com/api-reference/get-platform-settings.md): Returns the current settings for your Platform, including auto-earn configuration, default chain, and webhook URL.
- [Update Platform Settings](https://docs.otim.com/api-reference/update-platform-settings.md): Updates your Platform settings. Any fields not included in the request body will remain unchanged.
- [Create Account](https://docs.otim.com/api-reference/create-account.md): Creates a new Account under an existing Entity. The Account is automatically provisioned on your Platform's default chain. If auto-earn is enabled in your Platform Settings, the Account will be configured to earn yield on idle balances.
- [List Accounts](https://docs.otim.com/api-reference/list-accounts.md): Returns a paginated list of Accounts on your Platform.
- [Get Account](https://docs.otim.com/api-reference/get-account.md): Returns the details of a single Account by ID, including current balances and auto-earn status.
- [Update Account](https://docs.otim.com/api-reference/update-account.md): Updates an Account's display name or metadata. Only the fields included in the request body will be changed.
- [Create Entity](https://docs.otim.com/api-reference/create-entity.md): Creates a new Entity and initiates the verification flow. The response includes links that the Entity can use to complete identity verification (KYC for individuals, KYB for businesses) and accept the terms of service.
- [List Entities](https://docs.otim.com/api-reference/list-entities.md): Returns a paginated list of Entities on your Platform.
- [Get Entity](https://docs.otim.com/api-reference/get-entity.md): Returns the details of a single Entity, including their current verification status. Use this endpoint to check whether an Entity has completed KYC/KYB and is eligible for fiat capabilities like IBANs.
- [Create Counterparty](https://docs.otim.com/api-reference/create-counterparty.md): Creates a new Counterparty under an existing Entity. A Counterparty represents an external party that funds can be sent to or received from. Counterparties can be either wallet addresses or bank accounts.
- [List Counterparties](https://docs.otim.com/api-reference/list-counterparties.md): Returns a paginated list of Counterparties on your Platform.
- [Get Counterparty](https://docs.otim.com/api-reference/get-counterparty.md): Returns the details of a single Counterparty by ID.
- [Update Counterparty](https://docs.otim.com/api-reference/update-counterparty.md): Updates a Counterparty's display name.
- [Delete Counterparty](https://docs.otim.com/api-reference/delete-counterparty.md): Permanently deletes a Counterparty. This cannot be undone. Any pending transfers to this Counterparty will fail.
- [Create IBAN](https://docs.otim.com/api-reference/create-iban.md): Issues a new IBAN for a verified Entity. The IBAN is linked to an Account, and any fiat deposited to it will be automatically converted and routed into that Account. The Entity must have completed verification (KYC/KYB) before an IBAN can be issued.
- [List IBANs](https://docs.otim.com/api-reference/list-ibans.md): Returns a paginated list of IBANs on your Platform.
- [Get IBAN](https://docs.otim.com/api-reference/get-iban.md): Returns the details of a single IBAN by ID.
- [Delete IBAN](https://docs.otim.com/api-reference/delete-iban.md): Deactivates and deletes an IBAN. Any future deposits to this IBAN will be rejected. This cannot be undone.
- [Create Transfer](https://docs.otim.com/api-reference/create-transfer.md): Creates a transfer from an Account. You can send funds to another Account on your Platform (book transfer) or to an external Counterparty (on-chain or wire transfer). Provide either `destinationAccountId` or `counterpartyId`, but not both.
- [List Transfers](https://docs.otim.com/api-reference/list-transfers.md): Returns a paginated list of transfers on your Platform.
- [Get Transfer](https://docs.otim.com/api-reference/get-transfer.md): Returns the details of a single transfer by ID.
- [Overview](https://docs.otim.com/sdk/overview.md)
- [Installation & Setup](https://docs.otim.com/sdk/installation-and-setup.md)
- [Getting Your Developer Keys](https://docs.otim.com/sdk/getting-your-developer-keys.md)
- [Create a Basic Settlement Orchestration](https://docs.otim.com/sdk/guides/create-basic-settlement.md)
- [Track an Orchestration](https://docs.otim.com/sdk/guides/track-orchestration.md)
- [Orchestrators](https://docs.otim.com/docs/developers/orchestrators/overview.md)
- [Instruction Lifecycle](https://docs.otim.com/docs/developers/system-architecture/protocol/instruction-flows/instruction-lifecycle.md)
- [Actions & Instructions](https://docs.otim.com/docs/concepts/actions-instructions.md)
- [OtimDelegate](https://docs.otim.com/docs/developers/system-architecture/protocol/core-contracts/otim-delegate.md)
- [InstructionStorage](https://docs.otim.com/docs/developers/system-architecture/protocol/core-contracts/instruction-storage.md)
- [ActionManager](https://docs.otim.com/docs/developers/system-architecture/protocol/core-contracts/action-manager.md)
- [Treasury](https://docs.otim.com/docs/developers/system-architecture/protocol/core-contracts/treasury.md)
- [Structure](https://docs.otim.com/docs/developers/system-architecture/protocol/action-contracts/structure.md)
- [Current Actions](https://docs.otim.com/docs/developers/system-architecture/protocol/action-contracts/current-actions.md)
- [Off-chain](https://docs.otim.com/docs/developers/system-architecture/off-chain/off-chain.md)
- [Deployed Addresses](https://docs.otim.com/docs/developers/deployed-addresses.md)
- [Security & Audits](https://docs.otim.com/docs/resources/security-and-audits.md)
- [Delegation & EIP-7702](https://docs.otim.com/docs/concepts/delegation.md)
- [How to Construct Instruction Activation and Deactivation EIP-712 Hashes](https://docs.otim.com/docs/resources/appendix/instruction-712-hashes.md)
- [Action ABI Reference](https://docs.otim.com/docs/resources/appendix/action-hash-abis.md)
- [API Errors](https://docs.otim.com/docs/resources/appendix/api-errors.md)

## OpenAPI Specs

- [openapi](https://docs.otim.com/api-reference/openapi.yaml)

## Optional

- [LinkedIn](https://linkedin.com/company/otim)
- [Blog](https://otim.com/blog)
- [X](https://x.com/otimlabs)
- [GitHub](https://github.com/otimlabs)