Properties of a REST API method document

Purpose

This method is designed to verify that provided in the declaration request phone number is valid and is in service. Initialization phase

Logic

The user enters the phone number into the system.

...

Generate verification code

1. Generate verification code using basic random (default) function or time-based algorithm

   • Verification code format - digits only ^[1-9][0-9]*$

   • Verification code length - configuration parameter (default = 4)

   • Verification code expiration period - configuration parameter (default = 15 min)

   • Set expiration period using configuration parameter

Deactivate active verification code

1. Search active verification code(s) for this phone number

   • If found - change status to INACTIVE

Save verification code

1. Save generated verification code to DB

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

Request structure

See on API-specification

{
  "phone_number": "+380508887700"
}

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

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

...