Sign in

v1

latestOpenAPI 3.0.02026-07-24276673.3 KB
Locations

Onboard a location - Prefill

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

post/v1/locations/{id}/onboard/prefill

Path parameters

idstring required

Headers

x-api-keystring required

Request body

isCompanyOfficerConfirmedboolean

Confirmation that the details provided are of a company officer (always set to true for now)

firstNamestring

First name of the applicant

lastNamestring

Last name of the applicant

phonestring

Phone number of the applicant (company preferred, otherwise personal)

emailstring

Email address of the applicant

officerRolestring

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'
primaryIdNumberstring

Document number on the applicant's primary ID

primaryIdIssuingEntitystring

If the issuer is a state, provide state and country, otherwise provide country.

primaryIdExpirationDatestring

Date of expiration on the applicant's primary ID

secondaryIdType'current_lease' | 'home_vehicle_insurance' | 'mortgage_deed' | 'us_state' | 'vehicle_registration' | 'voter_card'
submissionType'individual' | 'business'
legalBusinessNamestring

Legal name of the business

placeOfRegistrationstring

If the business is in the United States, then "county, state" is required -- otherwise just "country".

businessTypestring

The NAICS definition of the business. Learn more: https://www.census.gov/naics/?58967?yearbck=2022

redirectUrlstring

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.

Example request

{
  "firstName": "Ada",
  "lastName": "Lovelace",
  "phone": "+19356836245",
  "email": "ada@example.com",
  "officerRole": "CEO",
  "primaryIdNumber": "123456789",
  "primaryIdIssuingEntity": "US",
  "primaryIdExpirationDate": "2045-01-01",
  "secondaryIdAddress": {
    "line1": "123 Main St",
    "line2": "Apt 1",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94107",
    "country": "US"
  },
  "legalBusinessName": "Ada's Apples",
  "placeOfRegistration": "Kent County, DE",
  "businessType": "Agriculture",
  "redirectUrl": "https://usestable.com/after-onboarding-completed"
}

Response

Success

idstring required
expiresAtstring required
urlstring required