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. 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-специфікацією)

{
  "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

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

...

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 (посилання на сторінку з API-специфікацією)Description of the REST API response structure, example

{
  "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

...