---
title: "Create an Onboarding Link"
method: POST
path: "/v1/terminal/onboarding_links"
---

# Create an Onboarding Link

`POST /v1/terminal/onboarding_links`

Creates a new `OnboardingLink` object that contains a redirect\_url used for onboarding onto Tap to Pay on iPhone.

## Response `200`

Successful response.

- TerminalOnboardingLink — Returns redirect links used for onboarding onto Tap to Pay on iPhone.
  - `link_options` TerminalOnboardingLinkLinkOptions, required — Link type options associated with the current onboarding link object.
    - `apple_terms_and_conditions` TerminalOnboardingLinkAppleTermsAndConditions — Options associated with the Apple Terms and Conditions link type.
      - `allow_relinking` boolean, nullable — Whether the link should also support users relinking their Apple account.
      - `merchant_display_name` string, required — The business name of the merchant accepting Apple's Terms and Conditions.
  - `link_type` 'apple_terms_and_conditions', required — The type of link being generated.
  - `object` 'terminal.onboarding_link', required
  - `on_behalf_of` string, nullable — Stripe account ID to generate the link for.
  - `redirect_url` string, required — The link passed back to the user for their onboarding.

## Other responses

- `default` — Error response.

---

[API](https://skmtc.net/stripe/apis/stripe-api-2.md) · [All operations](https://skmtc.net/stripe/apis/stripe-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/stripe-api-2/versions/3653ad45bbec/schema)