AddressVerification
Table of Contents
Methods
- __construct() : mixed
- AddressVerification constructor.
- getAvailableVerifications() : array<string|int, mixed>|false
- Returns available address verifications for linking with phone number.
- getError() : CVoxImplantError
- Returns last error
- getFilledByUser() : int|false
- Returns ID of the user, who was the last to fill documents.
- getVerifications() : array<string|int, mixed>|false
- Returns account's address verifications.
- notifyUserWithVerifyResult() : void
- Notifies user, that sent documents, about the finishing of the verification process.
- setFilledByUser() : void
- Stores ID of the user, who was the last to fill documents.
Methods
__construct()
AddressVerification constructor.
public
__construct() : mixed
getAvailableVerifications()
Returns available address verifications for linking with phone number.
public
getAvailableVerifications(string $countryCode, string $categoryName[, string $regionCode = '' ]) : array<string|int, mixed>|false
Parameters
- $countryCode : string
-
The 2-letter country code.
- $categoryName : string
-
The phone category name.
- $regionCode : string = ''
-
The phone region code. Mandatory for verification type LOCAL.
Return values
array<string|int, mixed>|falsegetError()
Returns last error
public
getError() : CVoxImplantError
Return values
CVoxImplantErrorgetFilledByUser()
Returns ID of the user, who was the last to fill documents.
public
getFilledByUser() : int|false
Return values
int|false —User ID or false if not set.
getVerifications()
Returns account's address verifications.
public
getVerifications([string $countryCode = '' ][, string $phoneCategoryName = '' ][, string $phoneRegionCode = '' ][, null $verified = null ][, null $inProgress = null ]) : array<string|int, mixed>|false
Parameters
- $countryCode : string = ''
-
The 2-letter country code.
- $phoneCategoryName : string = ''
-
The phone category name.
- $phoneRegionCode : string = ''
-
The phone region code. Mandatory for verification type LOCAL.
- $verified : null = null
-
Return only verified addresses.
- $inProgress : null = null
-
Show only address verifications, that are in progress.
Return values
array<string|int, mixed>|falsenotifyUserWithVerifyResult()
Notifies user, that sent documents, about the finishing of the verification process.
public
notifyUserWithVerifyResult(array<string|int, mixed> $params) : void
Parameters
- $params : array<string|int, mixed>
-
Array of parameters of the callback.
Tags
setFilledByUser()
Stores ID of the user, who was the last to fill documents.
public
setFilledByUser(int $userId) : void
Parameters
- $userId : int
-
Id of the user.