Account Onboarding Endpoints

account/submit-extended-info/shareholder-info/edit

This endpoint is used to edit an existing shareholder linked to your VoPay account. You will need to provide the Shareholder ID, which you can get from the GET /account/shareholder-info endpoint

post/account/submit-extended-info/shareholder-info/edit

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/submit-extended-info/shareholder-info/edit
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ShareHolderIDstring required

Unique ID of your shareholder

ShareholderFullNamestring required

Shareholder First name and last name

ShareholderDOBstring required

Shareholder's date of birth, in date format YYYY-MM-DD. For example: 1960-01-15

ShareholderOwnershipinteger required

Percentage of ownership only if is greater than 20%

ShareholderOccupationstring required

Shareholder's occupation

ShareholderAddress1string required

Shareholder's address line 1

ShareholderAddress2string

Shareholder's address line 2

ShareholderCitystring required

Shareholder's city

ShareholderProvincestring required

Shareholder's province specified using two character abbreviations (eg. BC, AB)

ShareholderCountrystring required

Shareholder's country specified using full country name or ISO 3166-1 alpha-2 code.

ShareholderPostalCodestring required

Shareholder's postal code

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Messagestring

Contains a description of the successful message

Changes

No recorded changes to this operation across all 1 revision of this API.