# Create an Onboarding Link

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

## Request

```curl
curl https://api.stripe.com/v1/terminal/onboarding_links \
  -u "<<YOUR_SECRET_KEY>>" \
  -d "link_options[apple_terms_and_conditions][allow_relinking]=true" \
  -d "link_options[apple_terms_and_conditions][merchant_display_name]=My First Store" \
  -d link_type=apple_terms_and_conditions
```

### Response

```json
{
  "object": "terminal.onboarding_link",
  "link_options": {
    "apple_terms_and_conditions": {
      "allow_relinking": true,
      "merchant_display_name": "My First Store"
    }
  },
  "link_type": "apple_terms_and_conditions",
  "redirect_url": "https://register.apple.com/tap-to-pay-on-iphone/merchantLandingPage"
}
```

## Returns

Returns an `OnboardingLink` object if creation succeeds.

## Parameters

- [`link_options`](https://docs.stripe.com/api/terminal/onboarding-link/create.md?query=link_options) (object, required)
  Specific fields needed to generate the desired link type.

- `link_type` (enum, required)
  The type of link being generated.

- `on_behalf_of` (string, optional)
  Stripe account ID to generate the link for.