Update a Beneficial Owner By BOI ID

patch

https://app1.compliancely.com/api/v1/boi/{boir_id}/beneficial-owner/{beneficial_owner_id}/

Update a Beneficial Owner By BOI ID.

BOI Reporting supports beneficial ownership information filing: initiate, owners/applicants, documents, and final submit.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

beneficial_owner_id

string

required

boir_id

string

required

Body Params

exempt_entity

boolean

CASE 1. if value is true then 'first_name', 'last_name' are only required in complete payload

CASE 2. if value is false and 'fincen_id' is given then first_name, last_name are only required in complete payload

send_email_to_fill

boolean

if value is true and 'fincen_id' is not given and 'exempt_entity' is not given or false then only 'first_name', 'last_name', 'Email' is required

country_jurisdiction

string

enum

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

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

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

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

CASE 4: If the 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

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

first_name

string

length between 1 and 100

last_name

string

length between 1 and 100

fincen_id

string | null

middle_name

string | null

suffix

string | null

date_of_birth

date | null

address_type

string

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

enum

identifying_document_other_local_tribal_description

string | null

identifying_document_state

string | null

file_token

string | null

parent_information_for_minor_child

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

403Forbidden

500Internal Server Error