Update the Data

patch

https://app1.compliancely.com/api/v1/boi/{boir_id}/

Update BOI Data

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

boir_id

string

required

Body Params

webhook_urls

array of strings

length ≤ 3

Optional field

webhook_urls

alternate_name

array of strings

length ≤ 5

Optional

alternate_name

filing_type

string

enum

required

if value is not 'initial_report' then only 'existing_legal_name', 'existing_tax_identification_type', 'existing_country_jurisdiction', 'existing_tax_identification_number' fields are required otherwise not required

Allowed:

foreign_pooled_investment_vehicle

boolean

required

CASE 1: If the value is true, then no 'company applicants' are allowed, and only 1 'beneficial owner' is allowed.

CASE 2: If the value is false, then any number of 'beneficial owners' and 'company applicants' are allowed.

existing_reporting_company

boolean

required

if value is false then only 'company_applicants' are allowed

tax_identification_type

string

enum

required

if value is 'foreign' then only 'country_jurisdiction' is required

Allowed:

us_or_us_territory

string

enum

required

if value is 'US' then 'state' is required

country_or_jurisdiction_of_formation

string

required

length between 1 and 255

CASE 1: If the value is either 'US' or 'other foreign countries', then either 'state_of_formation' or 'tribal_jurisdiction_of_formation' is required.

CASE 2: If the value is 'US Territories', then 'state_of_formation' and 'tribal_jurisdiction_of_formation' are not required.

tribal_jurisdiction_of_formation

string

required

length ≤ 255

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

first_name

string

required

length between 1 and 100

last_name

string

required

length between 1 and 150

string

required

length between 1 and 500

existing_legal_name

string | null

existing_tax_identification_type

string | null

enum

Allowed:

existing_country_jurisdiction

string | null

existing_tax_identification_number

string | null

request_fincen_id

boolean

legal_name

string

required

length between 1 and 255

country_jurisdiction

string | null

tax_identification_number

string

required

length between 1 and 30

state_of_formation

string | null

tribal_jurisdiction_of_formation_description

string | null

address

string

required

length between 1 and 255

city

string

required

length between 1 and 100

state

string

required

length between 1 and 255

zip_code

string

required

length between 1 and 10

status

string

enum

Allowed:

rejection_reason

string | null

consent

boolean

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