...

...

...

...

...

...

...

OTP Verification

Purpose

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

Specification

Logic

The user enters the phone number into the system.

As a result, an SMS is sent to the entered number with OTP code and the system returns the following response to the request:

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

...

1. Save generated verification code to DB

Preconditions

API paragraph not found

Global and configuration parameters

API paragraph not found

Input parameters

Attributes

Filters

None

Request structure

See on Apiary

Example

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --header "Authorization: Bearer c2778f3064753ea70de870a53795f5c9" \
     --data-binary "{
  \"phone_number\": \"+380508887700\"
}" \
'http://ehealth.com/api/verifications'

Authorize

Request to process the request using a token in the headers

...

Content-Type: application/json
Authorization: Bearer c2778f3064753ea70de870a53795f5c9

Validate request (JSON schema)

API paragraph not found

 {token}
api-key: {secret}

Validation data request

API paragraph not found

...

API paragraph not found

Response structure

See on Apiary

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
  }
}

...

API paragraph not found

HTTP status codes

Backward compatibility

API paragraph not found