Skip to content

@vitabletech/gbp-sdk


Constructors

Constructor

new VerificationsService(client): VerificationsService

Parameters

client

HttpClient

Returns

VerificationsService

Methods

complete()

complete(locationId, verificationId, request): Promise<CompleteVerificationResponse>

Completes a PENDING verification using a PIN.

Parameters

locationId

string

The location name.

verificationId

string

The verification ID.

request

CompleteVerificationRequest

The CompleteVerificationRequest containing the PIN.

Returns

Promise<CompleteVerificationResponse>


fetchVerificationOptions()

fetchVerificationOptions(locationId, request): Promise<FetchVerificationOptionsResponse>

Reports all eligible verification options for a location in a specific language.

Parameters

locationId

string

The location to verify.

request

FetchVerificationOptionsRequest

The FetchVerificationOptionsRequest containing language code and optional context.

Returns

Promise<FetchVerificationOptionsResponse>


getVoiceOfMerchantState()

getVoiceOfMerchantState(locationId): Promise<VoiceOfMerchantState>

Gets the VoiceOfMerchant state.

Parameters

locationId

string

The location to get VoiceOfMerchant state for.

Returns

Promise<VoiceOfMerchantState>


list()

list(locationId): Promise<ListVerificationsResponse>

List verifications of a location, ordered by create time.

Parameters

locationId

string

The location to list verifications for.

Returns

Promise<ListVerificationsResponse>


verify()

verify(locationId, request): Promise<VerifyLocationResponse>

Starts the verification process for a location.

Parameters

locationId

string

The location to verify.

request

VerifyLocationRequest

The VerifyLocationRequest containing method and language code.

Returns

Promise<VerifyLocationResponse>