Properties of a REST API method document

Purpose

Describe the purpose of the API method, add Key points (if necessary)This method is designed to verify that provided in the declaration request phone number is valid and is in service. Final stage

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input

...

parameters

Attributes

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example

{
  "code": 3782
}

Headers

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

...

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

...

To confirm the verification, you must enter the phone number and OTP (one-time code) in the system

If the code entered by the user is correct, the system will send a reply:
{    "meta": {        "code": 200,         "url": "https://example.com/resource",         "type": "object",          "request_id": "req-adasdoijasdojsda" },  "data": {     "id": "7d23bebb-1cf3-4221-bf21-18aada444756",     "status": "VERIFIED",     "code_expired_at": "2017-07-10T12:20:16.300597Z",      "active": true     } }

Where:

1. id- request id

2. code_expired_at= the time until which the code is valid in the system

3. Active- code activity status in the system

   1. "TRUE" - if verification is possible:

      1. when creating a default query,

      2. if there were less than 4 attempts to use

      3. if the code has not expired (up to 300 seconds after creation)

   2.  "FALSE"  - if verification is impossible:

      1. if code has been already used

      2. if more then 3 repayment attemptes has been made

      3. if the verification deadline has expired, including successful verification

4. Status- displays the verification status

"status": "NEW"	"status": "VERIFIED"	"status": "UNVERIFIED"	"status": "EXPIRED"	"status": "CANCELED"
when creating a query, by default	upon successful completion	upon unsuccessful verification (more than 3 attempts)	the code has expired коду	installed by the provider, in case the SMS cannot be delivered

If the code entered by the user is incorrect, then:

If this is one of the first three incorrect attempts, the system will respond:
{   "error": {   "message": "Invalid verification code",   "type": "forbidden" },   "meta": {     "code": 403,     "request_id": "xxx",     "type": "object",     "url": "http://api-svc.verification/verifications/{{phone_number}}/actions/complete"    } }

If this is the fourth (or more) failed attempt to enter the code, the system will respond:
{   "error": {      "message": "Maximum attempts exceed",      "type": "forbidden"           },   "meta": {       "code": 403,       "request_id": "xxx",       "type": "object",       "url": "http://api-svc.verification/verifications/{{phone_number}}/actions/complete"           } }

If the correct code is entered after the expiration of the code (OTP_LIFETIME = 300 seconds) :
{   "data": {      "active": false,      "code_expired_at": "2020-03-13T15:14:45.640890Z",       "id": "6b5c534c-1664-4fdc-8128-96caaeb27089",       "status": "expired"   },  "meta": {      "code": 200,      "request_id": "xxx",      "type": "object",       "url": "http://api-svc.verification/verifications/{{phone_number}}/actions/complete"    } }

If an incorrect code is entered after the expiration of the code :

If an incorrect code is entered after the expiration of the code :
{   "error": {      "message": "Invalid verification code",      "type": "forbidden"    },    "meta": {      "code": 403,      "request_id": "xxx",      "type": "object",      "url": "http://api-svc.verification/verifications/{{phone_number}}/actions/complete"     } }

Verify code

• Search active code for phone number

• Check code expiration period

• Compare codes

Matched

• Deactivate code

• Add phone number to verified_phones

Not matched

• Deactivate code

• Invoke Send verification code

• Return error

Response structure examples

See on API-specification

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "7d23bebb-1cf3-4221-bf21-18aada444756",
    "status": "NEW",
    "code_expired_at": "2017-07-10T12:20:16.300597Z",
    "active": true
  }
}

HTTP status codes

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

...