VOvobiz
Sub-Accounts

Update a sub-account

Update the name or status of a sub-account, or change its kyc_mode.

Promoting an existing sub-account to customer_use requires the sub-account to already have an email (otherwise 400). On any kyc_mode change, kyc_calls_blocked is re-derived from the sub-account's current KYC state.

put/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}

Request

Path parameters

auth_idstring required
Example:MA_XXXXXX

Your account Auth ID

sub_auth_idstring required

Request body

namestring
enabledboolean
kyc_mode'personal_use' | 'customer_use'

Change the verification mode. Promoting to customer_use requires the sub-account to have an email.

Response

Sub-account updated

namestring required
emailunknown required
phoneunknown required
descriptionunknown required
permissionsunknown required
rate_limitinteger required
idstring required
parent_account_idstring required
parent_auth_idstring required
auth_idstring required
auth_tokenstring required
api_idstring required
email_verifiedboolean required
enabledboolean required
createdstring required
modifiedstring required
is_activeboolean required
created_atstring required
updated_atstring required
last_usedunknown required
accountstring required
resource_uristring required

Changes

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