@plasma-platform/service-apv v1.5.0

Full documentation
install:
npm i @plasma-platform/service-apv -S

Short documentation

Table of Contents

• APVService
  • messages
  • confirmPhoneByPinCode
    • Parameters
    • Examples
  • getPaginationHeaders
    • Parameters
    • Examples
  • updateApv
    • Parameters
    • Examples

APVService

• See: http://service-apv.templatemonsterdev.com/doc/

messages

object with class service messages

Type: object

confirmPhoneByPinCode

Apv - Confirm phone by pin-code

Parameters

• params object
  • params.phoneNumber number Phone number (required)
  • params.pinCode number Pin code to verify. Allowed values: {1000-9999} (required)

Examples

(async () => {
  const service = new APVService(url);
  const request = await service.confirmPhoneByPinCode(params);
})();

Returns Promise<any>

getPaginationHeaders

Apv - Get pagination headers Verification status: 0 - pending 1 - success 2 - failed 3 - skipped 4 - expired

Parameters

• params object
  • params.phoneNumber number? Phone number (required)
  • params.status number? Apv status filter (see status explanations). Allowed values: 0..4

Examples

(async () => {
  const service = new APVService(url);
  const request = await service.getPaginationHeaders(params);
})();

Returns Promise<any>

updateApv

Apv - Update apv Verification status: 0 - pending 1 - success 2 - failed 3 - skipped 4 - expired

Parameters

• params object
  • params.phoneNumber number Phone number (required)
  • params.status number Apv status filter (see status explanations). Allowed values: 0..4

Examples

(async () => {
  const service = new APVService(url);
  const request = await service.updateApv(params);
})();

Returns Promise<any>