---
title: "Create a Company Onboarding"
method: POST
path: "/2024-11/company_onboardings"
tags: ["Companies"]
---

# Create a Company Onboarding

`POST /2024-11/company_onboardings`

## Request

- Base URL: `https://enterprise-api.easyship.com`
- URL: `https://enterprise-api.easyship.com/2024-11/company_onboardings`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://enterprise-api.easyship.com/oauth2/token` scopes: `enterprise.company`

Create a Company Onboarding.

Required authorization scope: `enterprise.company:write`

## Request body

- CompanyOnboardingCreate
  - `external_id` ExternalId, required (unresolved $ref)
  - `country_alpha2` CountryAlpha2, required (unresolved $ref)
  - `name` string, nullable: Company name. Optional field that can be used to pre-fill the company name in the onboarding form.
  - `owner` object, nullable: Company owner information. Optional field that will be used to pre-fill the company owner in the onboarding form.
    - `email` Email (unresolved $ref)
    - `first_name` FirstName (unresolved $ref)
    - `last_name` LastName (unresolved $ref)
  - `address` object, nullable: Company address information. Optional field that will be used to pre-fill the company address in the onboarding form.
    - `line_1` Line1 (unresolved $ref)
    - `line_2` Line2 (unresolved $ref)
    - `city` City (unresolved $ref)
    - `state` State (unresolved $ref)
    - `postal_code` PostalCode (unresolved $ref)
    - `contact_phone` ContactPhone (unresolved $ref)

## Response `201`

Company onboarding created

- CompanyOnboardingSingle: Company Onboarding Detail
  - `company_onboarding` CompanyOnboarding
    - `app_access` AppAccess, required
      - `url` string, uri: App Access redirect URL with one time token
      - `expires_at` string, datetime: Expiry time for URI
    - `completed_at` string, date-time, nullable, required: When the onboarding was completed
    - `created_at` string, date-time, required: When the Company Onboarding was created
    - `easyship_company_id` string, nullable, required: Easyship Company ID of the onboarded Company. Only present after the Company Onboarding is completed.
    - `external_id` string, required: External identifier of the Company to onboard.
  - `meta` Meta
    - `request_id` string: An unique ID represent the request.

## Other responses

- `422`: Company Onboarding already exists

---

[API](https://skmtc.dev/easyship/apis/easyship-enterprise-api.md) - [All operations](https://skmtc.dev/easyship/apis/easyship-enterprise-api/llms.txt) - [OpenAPI document](https://skmtc.dev/easyship/apis/easyship-enterprise-api/revisions/e22015413521?raw)