API Reference

Onboard a location - Prefill

post
https://api.usestable.com/v1/locations//onboard/prefill

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Body required in the request

boolean

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

string

First name of the applicant

string

Last name of the applicant

string

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

string

Email address of the applicant

string

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

string
enum
string

Document number on the applicant's primary ID

string

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

string

Date of expiration on the applicant's primary ID

string
enum
Allowed:
secondaryIdAddress
object
string
enum
Allowed:
string

Legal name of the business

string

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

string

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

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
string
required
Responses

Updated 6 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago