> ## Documentation Index
> Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Set up Cashfree Merchant Onboarding APIs for your platform with API keys, sandbox access, webhooks, and KYC document flows for sub-merchant lifecycles.

Embedded Payments by Cashfree is an end-to-end payment product for your platform to facilitate direct payments between your businesses and their customers. You can use Embedded Payments to provide your businesses a seamless onboarding experience and a fully compliant payments module within your platform.

Merchant Onboarding APIs is a feature of Embedded Payments through which you can onboard your merchants to your platform. Through the merchant onboarding APIs, you can perform various actions such as adding a merchant, updating the merchant's details, fetching the merchant's status, and creating onboarding links.

## View end points

| Environment    | Base URL                                                                               |
| :------------- | :------------------------------------------------------------------------------------- |
| Test           | [https://api-sandbox.cashfree.com/partners](https://api-sandbox.cashfree.com/partners) |
| Production     | [https://api.cashfree.com/partners](https://api.cashfree.com/partners)                 |
| Latest version | v3, 2023-01-01                                                                         |

The table below provides the list of Merchant Onboarding APIs along with their description.

**Merchant Onboarding APIs**

| API name                                                                                                                               | Description                                                                                                                                                 |
| :------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Create Merchant](/api-reference/platforms/latest/merchant-onboarding/create-merchant)                                                 | Use this API to create a sub-merchant account. You can provide additional basic details. KYC documents are then required to activate the account.           |
| [Update Merchant](/api-reference/platforms/latest/merchant-onboarding/update-merchant)                                                 | Use this API to update a sub-merchant account. You can provide basic details only if the account is not yet active.                                         |
| [Get Merchant Status](/api-reference/platforms/latest/merchant-onboarding/get-merchant-status)                                         | Use this API to get Merchant onboarding details for the sub-merchant account.                                                                               |
| [Create Onboarding Link](/api-reference/platforms/latest/merchant-onboarding/create-embeddable-onboarding-link-does-not-require-login) | Use this API to create a pre-built onboarding link for the sub-merchant account. Embed within your platform and Merchant can fill their KYC per compliance. |

**Get started in the test environment**

To get started with Merchant Onboarding API requests, you must follow the steps below:

1. Create an account on the Test Environment using this [signup link](https://test.cashfree.com/partner-ui/authentication/signup?product=embedded)
2. Once logged in, go to the **Developers** section and click **Generate API Key**.  Copy and download the API keys for future reference. You can also add a webhook endpoint to use the merchant activation status webhook.