# Contro

## Docs

- [Get balance](https://partner-docs.contro.dev/api-reference/partner--balance/get-balance.md): Get the partner's current balance
- [List balance transactions](https://partner-docs.contro.dev/api-reference/partner--balance/list-balance-transactions.md): List transactions on the partner's balance ledger
- [Create cardholder](https://partner-docs.contro.dev/api-reference/partner--cardholders/create-cardholder.md): Create a new cardholder with KYC data for this partner
- [Get cardholder](https://partner-docs.contro.dev/api-reference/partner--cardholders/get-cardholder.md): Get cardholder details
- [Get KYC status](https://partner-docs.contro.dev/api-reference/partner--cardholders/get-kyc-status.md): Get KYC verification status for a cardholder
- [Initiate KYC](https://partner-docs.contro.dev/api-reference/partner--cardholders/initiate-kyc.md): Initiate KYC verification for a cardholder with a specific card program
- [List cardholders](https://partner-docs.contro.dev/api-reference/partner--cardholders/list-cardholders.md): List cardholders for this partner
- [Update cardholder](https://partner-docs.contro.dev/api-reference/partner--cardholders/update-cardholder.md): Update cardholder information
- [Activate card](https://partner-docs.contro.dev/api-reference/partner--cards/activate-card.md): Activate a card
- [Cancel card](https://partner-docs.contro.dev/api-reference/partner--cards/cancel-card.md): Cancel a card permanently
- [Freeze card](https://partner-docs.contro.dev/api-reference/partner--cards/freeze-card.md): Freeze a card
- [Generate card reveal iframe URL](https://partner-docs.contro.dev/api-reference/partner--cards/generate-card-reveal-iframe-url.md): Generates a short-lived, single-use signed URL for embedding card details in an iframe. The URL expires after 60 seconds. Reduces PCI DSS scope to SAQ-A.
- [Get card](https://partner-docs.contro.dev/api-reference/partner--cards/get-card.md): Get card details
- [Get card transactions](https://partner-docs.contro.dev/api-reference/partner--cards/get-card-transactions.md): Get transaction history for a card
- [Issue card](https://partner-docs.contro.dev/api-reference/partner--cards/issue-card.md): Issue a new card for a cardholder
- [List cards](https://partner-docs.contro.dev/api-reference/partner--cards/list-cards.md): List cards for this partner
- [Reveal card PAN (encrypted)](https://partner-docs.contro.dev/api-reference/partner--cards/reveal-card-pan-encrypted.md): Returns RSA-encrypted card PAN, CVV, and expiry. Requires partner RSA public key to be configured. Your organization must be PCI DSS compliant to use this endpoint.
- [Unfreeze card](https://partner-docs.contro.dev/api-reference/partner--cards/unfreeze-card.md): Unfreeze a card
- [Update card limits](https://partner-docs.contro.dev/api-reference/partner--cards/update-card-limits.md): Update spending limits on a card
- [Upload file](https://partner-docs.contro.dev/api-reference/partner--files/upload-file.md): Upload a file for KYC verification. Send as multipart/form-data with a 'file' field and 'purpose' field.
- [Get go-live readiness checklist](https://partner-docs.contro.dev/api-reference/partner--go-live/get-go-live-readiness-checklist.md): Returns the partner's go-live readiness status across KYB, sandbox testing, webhooks, and balance.
- [Create KYC session](https://partner-docs.contro.dev/api-reference/partner--kyc-sessions/create-kyc-session.md): Create a hosted KYC web session. Returns a URL the user can visit to complete KYC via Sumsub.
- [Get KYC session](https://partner-docs.contro.dev/api-reference/partner--kyc-sessions/get-kyc-session.md): Get the status of a KYC web session
- [Reset sandbox balance](https://partner-docs.contro.dev/api-reference/partner--sandbox/reset-sandbox-balance.md): Reset the partner's sandbox ledger balance to a specified amount or the default sandbox balance.
- [Simulate a card transaction](https://partner-docs.contro.dev/api-reference/partner--sandbox/simulate-a-card-transaction.md): Simulate a card purchase in sandbox mode. Creates a real transaction record, deducts fees, and fires webhooks.
- [Simulate KYC approval](https://partner-docs.contro.dev/api-reference/partner--sandbox/simulate-kyc-approval.md): Instantly approve a cardholder's KYC in sandbox mode. Fires a webhook event.
- [Get usage summary](https://partner-docs.contro.dev/api-reference/partner--usage/get-usage-summary.md): Get usage summary for a billing period
- [List usage records](https://partner-docs.contro.dev/api-reference/partner--usage/list-usage-records.md): List detailed usage records
- [Get webhook config](https://partner-docs.contro.dev/api-reference/partner--webhooks/get-webhook-config.md): Get the partner's webhook configuration
- [List webhook events](https://partner-docs.contro.dev/api-reference/partner--webhooks/list-webhook-events.md): List webhook delivery events
- [Retry webhook event](https://partner-docs.contro.dev/api-reference/partner--webhooks/retry-webhook-event.md): Retry delivery of a failed webhook event
- [Update webhook config](https://partner-docs.contro.dev/api-reference/partner--webhooks/update-webhook-config.md): Update the partner's webhook configuration
- [Partner API reference](https://partner-docs.contro.dev/api-reference/partner/introduction.md): Technical reference for the Contro Partner API
- [Authentication](https://partner-docs.contro.dev/partner/authentication.md): Authenticate with the Contro Partner API using API keys
- [Balance](https://partner-docs.contro.dev/partner/balance.md): Monitor your prefunded partner balance
- [Cardholders](https://partner-docs.contro.dev/partner/cardholders.md): Create and manage cardholders for your card program
- [Cards](https://partner-docs.contro.dev/partner/cards.md): Issue and manage cards for your cardholders
- [Changelog](https://partner-docs.contro.dev/partner/changelog.md): Partner API release history and updates
- [Direct API](https://partner-docs.contro.dev/partner/direct-api-reveal.md): Retrieve encrypted card PAN, CVV, and expiry via API with RSA encryption
- [Embedded widget](https://partner-docs.contro.dev/partner/embedded-widget-reveal.md): Display card PAN, CVV, and expiry via a Contro-hosted iframe widget
- [Errors](https://partner-docs.contro.dev/partner/errors.md): Error format, HTTP status codes, and troubleshooting
- [Introduction](https://partner-docs.contro.dev/partner/introduction.md): Launch branded card programs with the Contro Partner API
- [KYC via Sumsub share token](https://partner-docs.contro.dev/partner/kyc-via-sumsub.md): Reuse existing Sumsub KYC verification when creating a cardholder
- [KYC via web link](https://partner-docs.contro.dev/partner/kyc-via-web-link.md): Use a Contro-hosted KYC page so your users complete verification without you handling sensitive data
- [Quickstart](https://partner-docs.contro.dev/partner/quickstart.md): Issue your first card in 5 steps
- [Reveal card data](https://partner-docs.contro.dev/partner/reveal-card-data.md): Choose the right method to access card PAN, CVV, and expiry for your integration
- [Sandbox & Testing](https://partner-docs.contro.dev/partner/sandbox.md): Test your card-issuing integration without affecting production data
- [SDKs](https://partner-docs.contro.dev/partner/sdk.md): Install and configure the Contro Partner SDK for Node.js or Python
- [Transactions](https://partner-docs.contro.dev/partner/transactions.md): Query card transaction history
- [Usage & billing](https://partner-docs.contro.dev/partner/usage-billing.md): Track API usage and billing for your partner account
- [Webhooks](https://partner-docs.contro.dev/partner/webhooks.md): Receive real-time event notifications via webhooks
- [balance.low](https://partner-docs.contro.dev/partner/webhooks/balance-low.md): Fired when your balance falls below the alert threshold
- [balance.top_up](https://partner-docs.contro.dev/partner/webhooks/balance-top-up.md): Fired when your balance is topped up
- [card.3ds_otp](https://partner-docs.contro.dev/partner/webhooks/card-3ds-otp.md): Fired when the card network requests a 3D Secure one-time passcode for a partner-issued card
- [card.issued](https://partner-docs.contro.dev/partner/webhooks/card-issued.md): Fired when a new card is issued
- [card.status.changed](https://partner-docs.contro.dev/partner/webhooks/card-status-changed.md): Fired when a card's status changes
- [card.transaction](https://partner-docs.contro.dev/partner/webhooks/card-transaction.md): Fired on card transaction lifecycle events
- [cardholder.created](https://partner-docs.contro.dev/partner/webhooks/cardholder-created.md): Fired when a new cardholder is created
- [cardholder.kyc.updated](https://partner-docs.contro.dev/partner/webhooks/cardholder-kyc-updated.md): Fired when a cardholder's KYC status changes
- [kyc_session.completed](https://partner-docs.contro.dev/partner/webhooks/kyc-session-completed.md): Fired when a KYC session is successfully completed
- [kyc_session.failed](https://partner-docs.contro.dev/partner/webhooks/kyc-session-failed.md): Fired when a KYC session fails verification

## OpenAPI Specs

- [partner-openapi](https://partner-docs.contro.dev/partner-openapi.json)
- [openapi](https://partner-docs.contro.dev/api-reference/openapi.json)

## Optional

- [Documentation](https://partner-docs.contro.dev)
- [Website](https://contro.me)