# Coincover Developer Docs

- [Welcome to CoinCover](https://developer.coincover.com/index.md): Pick the product you're integrating with and follow its guide.
- [Overview](https://developer.coincover.com/wallet-provider-recovery/overview.md): Backup and recovery for institutional digital asset wallets, integrated with your wallet platform — for providers backing up their customers' wallets.
- [API integration guide](https://developer.coincover.com/wallet-provider-recovery/api-integration-guide.md): End-to-end integration of the Partner Key Service for wallet providers.
- [Testing & sandbox](https://developer.coincover.com/wallet-provider-recovery/testing.md): Walking through every recovery scenario before you ship — for wallet providers on the Partner Key Service.
- [Overview](https://developer.coincover.com/institutional-recovery/overview.md): How to integrate CoinCover recovery for your institution — through a supported wallet platform, our API, or the CLI.
- [Back up key material](https://developer.coincover.com/institutional-recovery/back-up-key-material.md): Encrypt your own recovery material client-side and store it with CoinCover, using an RSA key.
- [Add a backup key](https://developer.coincover.com/institutional-recovery/add-a-backup-key.md)
- [CLI integration guide](https://developer.coincover.com/institutional-recovery/cli-integration-guide.md)
- [CLI reference](https://developer.coincover.com/institutional-recovery/cli-reference.md)
- [Testing](https://developer.coincover.com/institutional-recovery/testing.md)
- [Overview](https://developer.coincover.com/retail-recovery/overview.md): Identity-verified backup and recovery for end users of consumer wallets.
- [Integration guide](https://developer.coincover.com/retail-recovery/integration-guide.md): End-to-end integration of Recover for Retail.
- [UI components](https://developer.coincover.com/retail-recovery/ui-components.md): Embedding the Identity SDK in your wallet app for retail recovery.
- [Testing & sandbox](https://developer.coincover.com/retail-recovery/testing.md): Simulating verification outcomes without real customers.
- [Partners](https://developer.coincover.com/partner-guides/overview.md): How CoinCover backup and recovery integrates with the wallet and custody platforms we partner with.
- [BitGo](https://developer.coincover.com/partner-guides/bitgo.md): Backup and recovery across the BitGo self-custody wallet integration pathways — API-created and UI-created wallets.
- [Fireblocks](https://developer.coincover.com/partner-guides/fireblocks.md): Backup and recovery across the Fireblocks MPC workspace — the workspace backup and the owner's device key share backup.
- [Utila](https://developer.coincover.com/partner-guides/utila.md): Backup and recovery for the Utila MPC wallet — a single API-based backup flow and key-return recovery.
- [Fordefi](https://developer.coincover.com/partner-guides/fordefi.md): Backup and recovery for the Fordefi self-custody MPC wallet — a console-based backup flow and key-return recovery.
- [Copper](https://developer.coincover.com/partner-guides/copper.md): Backup and recovery for the Copper Unlimited MPC wallet — an offline key ceremony, recovery through CoinCover Control, and the self-service Copper Recovery tool.
- [Validating key signatures](https://developer.coincover.com/guides/validating-key-signatures.md): How CoinCover attests key assignment, and how to verify those signatures against our published JWKS.
- [Get started with CoinCover Control](https://developer.coincover.com/guides/control/get-started.md): From your invitation to your first sign-in — creating your account, setting up two-factor authentication, and completing identity verification.
- [Set up your Access Control List](https://developer.coincover.com/guides/control/approval-control-list.md): Decide who can approve the recovery of a backup, and how that Access Control List changes — by a majority vote of its own members.
- [Approve or reject an Access Control List change](https://developer.coincover.com/guides/control/approve-list-change.md): As a member of an Access Control List, review and vote on a proposed change to who can approve a backup's recovery.
- [Recover key material through CoinCover Control](https://developer.coincover.com/guides/control/recover-key-material.md): Get your backed-up key material released — raise the request, provide a GPG key, and collect the material once your approvers have approved it.
- [Create a GPG key pair](https://developer.coincover.com/guides/control/create-gpg-key.md): Generate the GPG key pair you use to encrypt a recovery, and decrypt the package CoinCover returns.
- [Approve or reject a recovery request](https://developer.coincover.com/guides/control/approve-recovery-request.md): As a member of an Access Control List, review a recovery request, re-verify your identity, and cast your vote.
- [Vault sync](https://developer.coincover.com/guides/vault-sync.md): Link a Fireblocks workspace to CoinCover Control so the derivation paths for every vault and address are ready before a recovery is ever needed.
- [Partner - Assign a new key with environment specification](https://developer.coincover.com/api-reference/keys/partner--assign-a-new-key-with-environment-specification.md): Creates a new key pair with the enclave, shards the private key, and securely stores the encrypted key shards. Includes key environment specification: HOT (online generation/storage) or COLD (offline generation/storage). Partner-only endpoint.
- [Partner - Store secure encrypted data](https://developer.coincover.com/api-reference/backups/partner--store-secure-encrypted-data.md): Stores base64-encoded encrypted data with checksum validation and padding type specification. The data is verified using the enclave before storage. Partner-only endpoint. The checksum is required and must be the SHA-256 of the plaintext.
- [Partner - Store secure encrypted files](https://developer.coincover.com/api-reference/backups/partner--store-secure-encrypted-files.md): Stores encrypted files securely. The key environment is determined from the provided key. The file must already be encrypted on the partner side; CoinCover applies no additional server-side encryption. Maximum payload 10MB. Partner-only endpoint.
- [Assign a new key](https://developer.coincover.com/api-reference/keys/assign-a-new-key.md): Creates a new key pair with the enclave, shards the private key, and securely stores the encrypted key shards. organisation and package are optional; key_environment defaults to HOT if omitted.
- [Verify a key's integrity](https://developer.coincover.com/api-reference/keys/verify-a-keys-integrity.md): Verifies that a key's shards can be reconstructed and that the key pair is valid.
- [Store secure encrypted data](https://developer.coincover.com/api-reference/backups/store-secure-encrypted-data.md): Stores base64-encoded encrypted data with optional checksum validation and padding type specification. The data is verified using the enclave before storage. Supplying the SHA-256 of the plaintext as the checksum is recommended.
- [Store secure encrypted files](https://developer.coincover.com/api-reference/backups/store-secure-encrypted-files.md): Stores an already-encrypted file. CoinCover applies no additional server-side encryption.
- [Verify a backup's integrity](https://developer.coincover.com/api-reference/backups/verify-a-backups-integrity.md): Verifies that a backup is valid by checking the encrypted data.
- [Start identity verification](https://developer.coincover.com/api-reference/verification/start-identity-verification.md): Initiates a new identity verification workflow and returns a Verification ID. The user will use this verification_id to spin up a front-end SDK that will guide the user through the identity verification workflow.
- [Get verification status](https://developer.coincover.com/api-reference/verification/get-verification-status.md): Retrieves the current status of a biometric verification. The status can be in multiple states: 'pending' (initial state), 'approved' (all verifications passed), 'declined' (verifications failed), or 'review' (marked for manual review).
- [Simulate biometric verification events](https://developer.coincover.com/api-reference/verification/simulate-biometric-verification-events.md): Simulates biometric verification events for testing in non-production environments.
- [Generate a cryptographic key](https://developer.coincover.com/api-reference/keys/generate-a-cryptographic-key.md): Generates a new cryptographic key for a user. Requires a user identifier and a verification_id that exists in the identity_verifications table and belongs to the user associated with the organisation. This endpoint calls the hot-keys orchestrator partner-assign-key endpoint.
- [Store encrypted backup data](https://developer.coincover.com/api-reference/backups/store-encrypted-backup-data.md): Stores encrypted backup data securely. Accepts multiple backup items in a single request via the backup array (limited to a maximum of 3 items). Requires a verification_id that exists in the identity_verifications table and belongs to the user associated with the organisation. Each backup item's ite…
- [Recover encrypted backup data](https://developer.coincover.com/api-reference/backups/recover-encrypted-backup-data.md): Recovers previously stored backup data. Requires successful identity verification (verification_id must be approved/successful). Requires a GPG public key for encrypting the recovered data. Returns an array of backup recovery results, each containing recovery information or error details. This endpo…
- [Changelog](https://developer.coincover.com/changelog/changelog.md): New features, fixes, and improvements to CoinCover.

## OpenAPI Specs

- [institutional.openapi](/specs/institutional.openapi.json)
- [retail.openapi](/specs/retail.openapi.json)
- [wallet-provider.openapi](/specs/wallet-provider.openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.