URL Expired

The URL for this request expired after 30 days.

Fields

• customer_id
  string
  required
  ID of the Customer

• beneficial_owner_id
  string
  required
  ID of Beneficial Owner

• 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.

    USUSGBCAAFAXALDZASADAOAIAQAGARAMANAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCVKYCFTDCLCNCXCCCOKMCGCDCKCRCIHRCUCYCZDKDJDMDOECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKRKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSESLKSDSRSJSZSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEUMUYUZVUVEVNVGVIWFEHYEZMZW

• 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
  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:
  uncertified certified

• phone_number
  string
  Customer's phone number in E.164 format.

• email
  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

• 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.