Onboard a location - Prefill

post

https://api.usestable.com/v1/locations/{id}/onboard/prefill

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

Body required in the request

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)

string

Email address of the applicant

officerRole

string

Role of the officer (if the submissionType is a business)

primaryIdType

string

enum

Primary ID must include a picture of the applicant and their name Learn more: https://support.usestable.com/en/articles/8236386-what-is-a-primary-id

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

string

enum

The Secondary ID must include the name and address of the applicant. Learn more: https://support.usestable.com/en/articles/8236383-what-is-a-secondary-id

Allowed:

secondaryIdAddress

object

Address shown on the applicant's secondary ID

submissionType

string

enum

If applicant is a business, then set submissionType to business, otherwise individual

Additional notes: If submissionType is set to individual, then the following business related fields are cleared:

businessType
legalBusinessName
officerRole
placeOfRegistration

Allowed:

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.

Headers

x-api-key

string

required

Responses

200Success

400Bad Request

403Forbidden

404Not Found

500Internal Server Error