Update a Company Applicant By BOI ID

patch

https://app1.compliancely.com/api/v1/boi/{boir_id}/company-applicant/{company_applicant_id}/

Update Company Applicant Details with ID

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

boir_id

string

required

company_applicant_id

string

required

Body Params

fincen_id

string

required

length ≤ 100

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

send_email_to_fill

boolean

required

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

country_jurisdiction

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.

identifying_document_type

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:

identifying_document_local_tribe

string

enum

required

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

first_name

string

required

length between 1 and 100

last_name

string

required

length between 1 and 100

middle_name

string | null

suffix

string | null

date_of_birth

date | null

address_type

string | null

enum

Allowed:

address

string | null

city

string | null

state

string | null

zip_code

string | null

identifying_document_number

string | null

identifying_document_country_jurisdiction

string | null

enum

identifying_document_other_local_tribal_description

string | null

identifying_document_state

string | null

file_token

string | null

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error