Update beneficial owner

put

https://Contact sales to enable your sandbox/customers/{customer_id}/beneficial_owners/{beneficial_owner_id}

Update information for the beneficial owner.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customer_id

string

required

ID of the Customer

beneficial_owner_id

string

required

ID of Beneficial Owner

Body Params

Update an existing beneficial owner

Passport information. required if country is not US

address_line_one

string

required

Address line one.

address_line_two

string

Address line two.

address_city

string

required

Address city.

address_state

string

required

Address state.

address_zip

string

required

Five digit zipcode or nine digit 'ZIP+4'.

address_country_code

string

enum

ISO 3166-1 alpha-2 country code for the customer.

name_prefix

string

Prefix to the customer's name.

name_first

string

Customer's first name.

name_middle

string

Customer's middle name.

name_last

string

Customer's last name.

name_suffix

string

Suffix to the customer's name.

passport

object

beneficial_owner_id

string

^(?!can_).*$

The ID associated to be with the beneficial owner for future requests. If not provided on creation, Canopy will generate this field.

verification_status

string | null

enum

Status of the verification process

Allowed:

phone_number

string

Customer's phone number in E.164 format.

string

The Customer's email address.

ssn

string | null

Full nine digits of their social security number.

date_of_birth

string

Date of Birth in YYYY-MM-DD format

Responses

401

Unauthorized.

403

Forbidden.

404

Payment Processor not found

429

Too many requests.

default

Unexpected Error.

Language

Credentials

OAuth2

URL

Loading…

Response

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

application/json

200Successful query of information for a specific beneficial owner