openapi: 3.0.3
info:
  title: Puzzle Api Accounts Onboarding API
  description: Puzzle Api
  version: '0'
servers:
- url: https://staging.southparkdata.com/rest/v0
tags:
- name: Onboarding
paths:
  /onboarding:
    post:
      operationId: initiatePrefilledOnboarding
      summary: Initiate Prefilled Onboarding
      description: Call this endpoint to pass some company information that is usually asked for during Puzzle's onboarding flow. A URL will be returned. When you redirect your user to this URL, the company information that was passed the original request will be prefilled for them in Puzzle's UI, allowing them to skip a few steps and create their Puzzle account more quickly.
      tags:
      - Onboarding
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                type:
                  type: string
                  enum:
                  - SAAS
                  - ECOMMERCE
                  - MARKETPLACE
                  - ADVERTISING
                  - SERVICES
                  - ENTERPRISE
                  - FINTECH
                  - FINTECH_CRYPTO
                  - VIRTUAL_GOODS
                  - CONSUMER
                  - NOT_SURE
                  - OTHER
                  - AGRICULTURE_AND_FARMING
                  - CONSTRUCTION
                  - HEALTHCARE
                  - HOME_SERVICES
                  - LEGAL
                  - MANUFACTURING
                  - MEDIA_AND_ENTERTAINMENT
                  - PROFESSIONAL_SERVICES
                  - RETAIL
                  - REAL_ESTATE
                  - RESTAURANT
                  - TRANSPORTATION
                  - WHOLESALE_TRADE
                  description: The value is normalized before matching, so any casing that maps onto a listed value is accepted.
                timeZone:
                  type: string
                  minLength: 1
                currentUserRole:
                  type: string
                  enum:
                  - Founder
                  - CompanyEmployee
                  - OutsourcedAccountantOrCFO
                orgType:
                  type: string
                  enum:
                  - CCorporation
                  - LLC
                  - Partnership
                  - SCorporation
                  - SoleProprietorship
                revenueModel:
                  type: string
                  enum:
                  - AnnualSubscription
                  - MonthlySubscription
                  - MultipleRevenueModels
                  - NotSure
                  - PreRevenue
                  - ServiceBased
                  - TransactionBased
                  - UsageBased
                  - Subscription
                  - AddOns
                  - TransactionBasedPhysical
                  - TransactionBasedOther
                  - Contracts
                  - HourlyBilling
                  - Marketplace
                  - Commission
                hasHistoricalData:
                  type: boolean
                phoneNumber:
                  type: string
                connectionInfo:
                  type: object
                  properties:
                    nativeCompanyId:
                      type: string
                      minLength: 1
                    authForwardToken:
                      type: string
                    createPushIntegrationConnection:
                      type: boolean
                  required:
                  - nativeCompanyId
              required:
              - name
              - type
              - timeZone
              - currentUserRole
              - orgType
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                required:
                - url