> For the complete documentation index, see [llms.txt](https://docs.violet.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.violet.io/api-reference/merchants/onboarding/get-vc-urls.md).

# Get Violet Connect URLs

This API lets you generate pre-formatted Violet Connect URLs that merchants can use to complete specific onboarding steps. You can request URLs for individual steps like setting up payouts, configuring commission rates, or creating a Stripe Express Account — or fetch all available onboarding links at once.

Use the step query parameter to retrieve a link for a specific part of the Violet Connect flow:

* `PAYOUTS`
* `COMMISSION_RATE`
* `CREATE_STRIPE_EXPRESS_ACCOUNT`

If no step is provided, the API will return URLs for all steps.\
You can also pass an optional state parameter to include custom state information in the returned links.

This endpoint is especially useful when you want to send merchants directly into a specific part of onboarding, like immediately prompting them to select a banking country to create a Stripe Express Account.

{% openapi src="/files/ykudwksFKcF1SxkOmNZl" path="/merchants/{merchant\_id}/violet\_connect\_urls" method="get" expanded="true" %}
[merchant-service.yaml](https://3937396275-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8lXIp71Ct5qCUhXjko2q%2Fuploads%2Fgit-blob-247261bff470e8e872c7a1803ef78263c444666d%2Fmerchant-service.yaml?alt=media\&token=af8d30f8-3162-478f-b5d0-3c8b10e4cb67)
{% endopenapi %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.violet.io/api-reference/merchants/onboarding/get-vc-urls.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.