Add a Company Applicant to a BOI Submission

Post Company Applicant Details

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

if value is given then only 'first_name', 'last_name' are required in complete payload

boolean
required

if value is true then only 'first_name', 'last_name' and 'Email' is required in complete payload

string
enum
required

CASE 1: If the value is in ['US', 'CA', 'MX'], then 'state' and 'zipcode' are required.

CASE 2: If the value is 'US Territories', then only 'zipcode' is required.

string
enum
required

CASE 1: If value is 'state_issued_drivers_license', then 'identifying_document_country_jurisdiction' is required, and if 'identifying_document_country_jurisdiction' is 'US', then 'identifying_document_state' is required.

CASE 2: If value is 'state_local_tribe_issued_id', then 'identifying_document_country_jurisdiction' is required, and if 'identifying_document_country_jurisdiction' is 'US', then either 'identifying_document_state' is required or 'identifying_document_local_tribe' is required.

CASE 3: If value is 'us_passport', then 'identifying_document_country_jurisdiction' is optional.

CASE 4: If value is 'foreign_passport', then 'identifying_document_country_jurisdiction' is required, and 'US' will not be an option.

Allowed:
string
enum
required

if value is 'Other' then only 'identifying_document_other_local_tribal_description' is required

string
required
length between 1 and 100
string
required
length between 1 and 100
string | null
string | null
date | null
string | null
enum
Allowed:
string | null
string | null
string | null
string | null
string | null
string | null
enum
string | null
string | null
string | null
string | null
Responses

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