---
title: "Onboard a location - Prefill"
method: POST
path: "/v1/locations/{id}/onboard/prefill"
tags: ["Locations"]
---

# Onboard a location - Prefill

`POST /v1/locations/{id}/onboard/prefill`

Prefill a location's onboarding data with customer information and return a shared session.

## Path parameters

- `id` string, required

## Headers

- `x-api-key` string, required

## Request body

- OnboardLocationPrefillBody — An object representing the body of the onboarding prefill request.
  - `isCompanyOfficerConfirmed` boolean — Confirmation that the details provided are of a company officer (always set to true for now)
  - `firstName` string — First name of the applicant
  - `lastName` string — Last name of the applicant
  - `phone` string — Phone number of the applicant (company preferred, otherwise personal)
  - `email` string — Email address of the applicant
  - `officerRole` string — Role of the officer (if the `submissionType` is a business)
  - `primaryIdType` 'certificate_of_naturalization' | 'matricula_consular' | 'nexus' | 'passport' | 'uniformed_service' | 'us_access_card' | 'us_pr' | 'us_state' | 'us_university'
  - `primaryIdNumber` string — Document number on the applicant's primary ID
  - `primaryIdIssuingEntity` string — If the issuer is a state, provide state and country, otherwise provide country.
  - `primaryIdExpirationDate` string — Date of expiration on the applicant's primary ID
  - `secondaryIdType` 'current_lease' | 'home_vehicle_insurance' | 'mortgage_deed' | 'us_state' | 'vehicle_registration' | 'voter_card'
  - `secondaryIdAddress` Address
    - `line1` string, required — Required first line of the address
    - `line2` string — Optional second line of the address
    - `city` string, required — Full name of the city
    - `state` string, required — Two character state code if in the United States, otherwise the full name of the state Learn more: https://en.wikipedia.org/wiki/ISO_3166-2:US
    - `postalCode` string, required — Five digit postal code of the address
    - `country` string, required — ISO 3166-1 alpha-2 country code. Learn more: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
  - `submissionType` 'individual' | 'business'
  - `legalBusinessName` string — Legal name of the business
  - `placeOfRegistration` string — If the business is in the United States, then "county, state" is required -- otherwise just "country".
  - `businessType` string — The NAICS definition of the business. Learn more: https://www.census.gov/naics/?58967?yearbck=2022
  - `redirectUrl` string — Specify a URL to redirect the user to after the form is completed. If provided, the confirmation page will display a button that redirects the user to your specified URL. If not provided, the confirmation page will display a button that brings the user to the Stable login page.

## Response `200`

Success

- USPS1583SharedSession
  - `id` string, required
  - `expiresAt` string, required
  - `url` string, required

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/usestable/apis/stable-api.md) · [All operations](https://skmtc.net/usestable/apis/stable-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usestable/stable-api/revisions/c2ca8cbbc51e/schema)