npm package: @plasma-platform/service-apv
Description: APV Service API
Author: Kyrylo Voronoi
Latest version: 1.5.0

![version](https://badgen.net/npm/v/@plasma-platform/service-apv)
![nextVersion](https://badgen.net/npm/v/@plasma-platform/service-apv/next)
![downloads](https://badgen.net/npm/dt/@plasma-platform/service-apv)
![license](https://badgen.net/npm/license/@plasma-platform/service-apv)
![dependency](https://badgen.net/npm/dependents/@plasma-platform/service-apv)  

* * *

[Full documentation](https://templatemonster.gitlab.io/PlasmaPlatform/Frontend/plasma-platform/?path=/story/plasma-platform-sdk--service-apv)  
install:  
`npm i @plasma-platform/service-apv -S`  

# Short documentation

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [APVService](#apvservice)
    -   [messages](#messages)
    -   [confirmPhoneByPinCode](#confirmphonebypincode)
        -   [Parameters](#parameters)
        -   [Examples](#examples)
    -   [getPaginationHeaders](#getpaginationheaders)
        -   [Parameters](#parameters-1)
        -   [Examples](#examples-1)
    -   [updateApv](#updateapv)
        -   [Parameters](#parameters-2)
        -   [Examples](#examples-2)

## APVService

-   **See: <http://service-apv.templatemonsterdev.com/doc/>**

### messages

object with class service messages

Type: [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)

### confirmPhoneByPinCode

Apv - Confirm phone by pin-code

#### Parameters

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.phoneNumber` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Phone number (required)
    -   `params.pinCode` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Pin code to verify. Allowed values: {1000-9999} (required)

#### Examples

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

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>** 

### getPaginationHeaders

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

#### Parameters

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.phoneNumber` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Phone number (required)
    -   `params.status` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Apv status filter (see status explanations). Allowed values: 0..4

#### Examples

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

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>** 

### updateApv

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

#### Parameters

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.phoneNumber` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Phone number (required)
    -   `params.status` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Apv status filter (see status explanations). Allowed values: 0..4

#### Examples

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

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>**