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

# Start Stripe Connect onboarding for authenticated partner

> 
Creates a Stripe Express connected account for the authenticated partner and generates an onboarding link.

**Authentication:** Requires valid Partner API Key in Authorization header (Bearer token).

**When to use:**
- After partner is approved (status: ACTIVE)
- When partner needs to connect/reconnect their Stripe account
- To enable payouts to the partner's bank account

**Flow:**
1. Call this endpoint to get an onboarding URL
2. Redirect partner to the URL in a browser
3. Partner completes Stripe KYC (business details, bank account, etc.)
4. Stripe redirects to your configured return_url with success/failure
5. Call `GET /partners/stripe-connect/verify` to check status

**Response:**
- `url`: Stripe Connect onboarding URL - open in browser or WebView
    



## OpenAPI

````yaml /partner-docs/openapi.json post /partners/stripe-connect/onboard
openapi: 3.0.0
info:
  title: Tickify Partner API
  description: >2-

        API documentation for the Tickify Partner Platform.

        Getting Started:
    1. Register as a partner and wait for approval from the Tickify team.
        2. Once approved, request an API key from the Tickify team. A Tickify admin will generate and securely share your API key with you.
        3. Use your API key to authenticate partner API requests.
        4. Generate an access token using the /partner/auth/token endpoint in the Auth documentation.
        5. Use the access token for authenticated requests where required.

        **API Keys:**
    - Test keys use the 

    `tk_test_` prefix. These keys work in sandbox mode and never charge real
    payment methods.

    - Live keys use the 

    `tk_live_` prefix. These keys process real payments and require completed
    Stripe Connect onboarding.

    - Both key types follow the same API behavior — only the payment environment
    differs.

    - To test checkout flows without real charges, use 

    `tk_test_` keys and include test card numbers in your Stripe integration.
        
  version: '1.0'
  contact: {}
servers:
  - url: http://localhost:3000
    description: Local Development
  - url: https://api-staging.tickify.io
    description: Staging
  - url: https://api.tickify.io
    description: Production
security: []
tags: []
paths:
  /partners/stripe-connect/onboard:
    post:
      tags:
        - Partners
      summary: Start Stripe Connect onboarding for authenticated partner
      description: >-

        Creates a Stripe Express connected account for the authenticated partner
        and generates an onboarding link.


        **Authentication:** Requires valid Partner API Key in Authorization
        header (Bearer token).


        **When to use:**

        - After partner is approved (status: ACTIVE)

        - When partner needs to connect/reconnect their Stripe account

        - To enable payouts to the partner's bank account


        **Flow:**

        1. Call this endpoint to get an onboarding URL

        2. Redirect partner to the URL in a browser

        3. Partner completes Stripe KYC (business details, bank account, etc.)

        4. Stripe redirects to your configured return_url with success/failure

        5. Call `GET /partners/stripe-connect/verify` to check status


        **Response:**

        - `url`: Stripe Connect onboarding URL - open in browser or WebView
            
      operationId: PartnersController_onboardPartnerStripe
      parameters: []
      responses:
        '200':
          description: Onboarding URL generated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    format: uri
                    example: https://connect.stripe.com/setup/s/abc123...
                    description: Stripe Connect onboarding URL - open in browser or WebView
        '401':
          description: Invalid or missing partner API key
        '404':
          description: Partner not found or not active
        '422':
          description: Validation failed or partner not found
      security:
        - access-token: []
        - partner-api-key: []
components:
  securitySchemes:
    access-token:
      scheme: bearer
      bearerFormat: JWT
      type: http
    partner-api-key:
      type: apiKey
      in: header
      name: x-partner-key
      description: Partner API Key (tk_live_... or tk_test_...)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.