# Ramp Docs Documentation

> Documentation for Ramp Docs

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Getting Started with Ramp Docs](https://ramp-docs.transfi.com/docs/getting-started.md): The TransFi Ramp API enables developers to integrate the Ramp Widget and access supported features such as listing supported fiats, cryptos, payment methods, and order details. It is organized around REST.
- [Authentication](https://ramp-docs.transfi.com/docs/authentication.md): To call our API endpoints, you must include the Authorization header in each request. This header is obtained by authenticating with the system.
- [Setup Your Partner Account](https://ramp-docs.transfi.com/docs/setup-your-partner-account.md): This area is for apps and businesses that want to integrate TransFi. If you want to buy or sell cryptocurrency, please go to our widget instead!
- [Widget V2 Integration](https://ramp-docs.transfi.com/docs/widget-v2-integration.md)
- [Widget Integration](https://ramp-docs.transfi.com/docs/widget-integration.md): Before proceeding, ensure that you have set up a partner account with us. If you have not yet done so, please follow this guide to create a partner account in less than 30 seconds and copy your Staging API KEY.
- [Customizing Integration](https://ramp-docs.transfi.com/docs/customizing-integration.md): Before proceeding, ensure that you have set up a partner account with us. If you have not yet done so, please follow this guide to create a partner account in less than 30 seconds and copy your Staging API KEY.
- [Testing Widget Integration](https://ramp-docs.transfi.com/docs/testing-widget-integration.md): Before proceeding, ensure that you have set up a partner account with us. If you have not yet done so, please follow this guide to create a partner account in less than 30 seconds and copy your Staging API KEY.
- [Production keys and going live](https://ramp-docs.transfi.com/docs/production-keys-and-going-live.md): Once you have tested the TransFi widget within your app, its time to go live.
- [Invite Team Member](https://ramp-docs.transfi.com/docs/invite-team-member.md): You can invite your other team member to get the dashboard access and grant specific permission based on their role. !
- [Postman collection](https://ramp-docs.transfi.com/docs/postman-collection.md): The easiest way to get started using our API is to use our Postman Collection. Postman is a free client application that enables you to make calls using API easily. To make integrating with our API easier, we have created Postman Collection of all our endpoints so that you can test our APIs more easily.
- [Webhook Schema](https://ramp-docs.transfi.com/docs/webhook-schema.md): This section describes the structure of the webhooks that you will receive.
- [Respond to a webhook request](https://ramp-docs.transfi.com/docs/respond-to-a-webhook-request.md)
- [Webhook Signature](https://ramp-docs.transfi.com/docs/webhook-signature.md)
- [Webhook Retry](https://ramp-docs.transfi.com/docs/webhook-retry.md)
- [Users](https://ramp-docs.transfi.com/docs/users.md): This section provides a list of possible events that can be received as webhooks.
- [Onramp](https://ramp-docs.transfi.com/docs/onramp.md): This section provides a list of possible events that can be received as webhooks for Onramp transactions.
- [Offramp](https://ramp-docs.transfi.com/docs/offramp.md): This section provides a list of possible events that can be received as webhooks for Collections.
- [Headless Payout](https://ramp-docs.transfi.com/docs/headless-payout.md)
- [Configuring a Webhook Listener](https://ramp-docs.transfi.com/docs/configuring-a-webhook-listener.md)
- [React native](https://ramp-docs.transfi.com/docs/react-native.md): Before proceeding, ensure that you have set up a partner account with us. If you have not yet done so, please follow this guide to create a partner account in less than 30 seconds and copy your Staging API KEY.
- [Flutter](https://ramp-docs.transfi.com/docs/flutter.md): Before proceeding, ensure that you have set up a partner account with us. If you have not yet done so, please follow this guide to create a partner account in less than 30 seconds and copy your Staging API KEY.
- [Android](https://ramp-docs.transfi.com/docs/android.md): Before proceeding, ensure that you have set up a partner account with us. If you have not yet done so, please follow this guide to create a partner account in less than 30 seconds and copy your Staging API KEY.
- [iOS](https://ramp-docs.transfi.com/docs/ios.md): Before proceeding, ensure that you have set up a partner account with us. If you have not yet done so, please follow this guide to create a partner account in less than 30 seconds and copy your Staging API KEY.
- [Error codes](https://ramp-docs.transfi.com/docs/error-codes.md): Whenever a request fails (the HTTP status code is 4xx or 5xx), the API returns a JSON object with below fields:
- [Supported Countries](https://ramp-docs.transfi.com/docs/supported-countries.md): The following countries are permitted to conduct transactions on our platform.
- [High Risk Countries](https://ramp-docs.transfi.com/docs/high-risk-countries.md): The following countries are classified as high-risk for onboarding or conducting any transactions on our platform, in line with our internal compliance policies and applicable international sanctions regulations. Each transaction will be manually reviewed by the compliance team.
- [Prohibited Countries](https://ramp-docs.transfi.com/docs/prohibited-countries.md): The following countries are strictly prohibited from onboarding or making any transactions on our platform, as per internal compliance policies and applicable international sanctions.
- [KYC levels for Individual User](https://ramp-docs.transfi.com/docs/kyc-levels-for-individual-user.md)
- [Submit KYC](https://ramp-docs.transfi.com/docs/submit-kyc.md)
- [KYC Sharing with Sumsub](https://ramp-docs.transfi.com/docs/kyc-sharing-with-sumsub.md)
- [KYC Status Overview](https://ramp-docs.transfi.com/docs/kyc-status-overview.md)
- [Supported Documents](https://ramp-docs.transfi.com/docs/supported-documents.md)

## API Reference
- [Fiat currencies](https://ramp-docs.transfi.com/reference/get-buy-fiat.md): This section provides API to get all supported fiat currencies for On Ramp.
- [Crypto currencies](https://ramp-docs.transfi.com/reference/get-buy-crypto.md): This section provides API to get all supported crypto currencies for On Ramp.
- [Quotes](https://ramp-docs.transfi.com/reference/get-buy-quotes.md): This section provides API to get the exchange rates for On Ramp.
- [All Payment Methods](https://ramp-docs.transfi.com/reference/get-buy-payment-methods.md): This API to get all supported payment methods for On Ramp in specific currency.
- [Payment Methods](https://ramp-docs.transfi.com/reference/get-buy-payment-method.md): This API to get all supported payment methods for On Ramp in specific currency.
- [All Orders](https://ramp-docs.transfi.com/reference/get-buy-orders.md): This API to get all orders created for buy transactions.
- [Specific Order](https://ramp-docs.transfi.com/reference/get-buy-order.md): This section provides API to get specific buy order details.
- [Currency Pairs](https://ramp-docs.transfi.com/reference/get-buy-currency-pair.md): This section provides API to get supported fiat-crypto currency pairs.
- [Crypto currencies](https://ramp-docs.transfi.com/reference/get-sell-crypto.md): This section provides API to get all supported crypto currencies for Off Ramp.
- [Fiat currencies](https://ramp-docs.transfi.com/reference/get-sell-fiat.md): This section provides API to get all supported fiat currencies for Off Ramp.
- [Quotes](https://ramp-docs.transfi.com/reference/get-sell-quotes.md): This section provides API to get the exchange rates for Off Ramp.
- [All Payment Methods](https://ramp-docs.transfi.com/reference/get-sell-payment-methods.md): This section provides API to get all supported payment methods for Off Ramp.
- [Payment Methods](https://ramp-docs.transfi.com/reference/get-sell-payment-method.md): This section provides API to get all supported payment methods for Off Ramp in specific currency.
- [All Orders](https://ramp-docs.transfi.com/reference/get-sell-orders.md): This section provides API to get all orders created for sell transactions.
- [Specific Order](https://ramp-docs.transfi.com/reference/get-sell-order.md): This section provides API to get specific sell order details.
- [Currency Pairs](https://ramp-docs.transfi.com/reference/get-sell-currency-pair.md): This section provides API to get supported crypto-fiat currency pairs.

## Changelog
- [Ramp Widget (v2)](https://ramp-docs.transfi.com/changelog/ramp-widget-session-api-v2.md)
- [Widget Integration: Signed URLs for Sensitive Information](https://ramp-docs.transfi.com/changelog/widget-integration-signed-urls-for-sensitive-information.md)
- [Role-Based Access Controls](https://ramp-docs.transfi.com/changelog/role-based-access-controls.md)