v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13125317428.7 KB
accounts

Request verification code to start phone verification.

post/{merchantId}/accounts/{accountId}/requestphoneverification

Path parameters

merchantIdstring required

Required. The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

accountIdstring required

Required. The ID of the account.

Request body

phoneRegionCodestring

Required. Two letter country code for the phone number, for example CA for Canadian numbers. See the ISO 3166-1 alpha-2 officially assigned codes.

phoneVerificationMethod'PHONE_VERIFICATION_METHOD_UNSPECIFIED' | 'SMS' | 'PHONE_CALL'

Verification method to receive verification code.

phoneNumberstring

Phone number to be verified.

languageCodestring

Language code IETF BCP 47 syntax (for example, en-US). Language code is used to provide localized SMS and PHONE_CALL. Default language used is en-US if not provided.

Response

Successful response