Create a new beneficial owner for the business
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Fields
customer_id
Type: string
Required: Yes
ID of the Customer (business)address_line_one
Type: string
Required: Yes
Address line one.address_line_two
Type: string
Address line two.address_city
Type: string
Required: Yes
Address city.address_state
Type: string
Required: Yes
Address state.address_zip
Type: string
Required: Yes
Five digit zipcode or nine digit 'ZIP+4'.address_country_code
Type: string
Enum: ISO 3166-1 alpha-2 country code for the customer.name_prefix
Type: string
Prefix to the customer's name.name_first
Type: string
Customer's first name.name_middle
Type: string
Customer's middle name.name_last
Type: string
Customer's last name.name_suffix
Type: string
Suffix to the customer's name.passport
Type: object
Passport information. required if country is not USbeneficial_owner_id
Type: string
The ID associated to the beneficial owner for future requests. Canopy will generate this field if not provided on creation.verification_status
Type: string | null
Enum: Status of the verification process (uncertified, certified)phone_number
Type: string
Customer's phone number in E.164 format.email
Type: string
The Customer's email address.ssn
Type: string | null
Full nine digits of their social security number.date_of_birth
Type: string
Date of Birth in YYYY-MM-DD format
API Responses
- 200 Successful query of information for a specific beneficial owner
- 401 Unauthorized.
- 403 Forbidden.
- 404 Payment Processor not found
- 429 Too many requests.
- default Unexpected Error.
CURL Example
curl --request POST \
--url https://contact/%20sales%20to%20enable%20your%20sandbox/customers//beneficial_owners \
--header 'accept: application/json' \
--header 'content-type: application/json'