Service specification

Даний метод розроблений для перевірки чи веріфікований номер телефону в системі та потребує скоуп otp:read.

Користувач передає номер телефону в параметрах запиту до системи та отримує у відповідь

...

Якщо введений номер веріфікований в системі

...

Purpose

This method is designed to check if the phone number is verified in the system

Specification

Logic

1. Search requested phone number in verified_phones table

2. Return 200 (VERIFIED) if phone number found

3. Return 422 (UNVERIFIED) if phone number not found

Preconditions

API paragraph not found

Global and configuration parameters

API paragraph not found

Input parameters

Filters

None

Request structure

See on Apiary

Example

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

Authorize

Request to process the request using a token in the headers

Headers

Example

Content-Type: application/json
Authorization: Bearer c2778f3064753ea70de870a53795f5c9

Validate request (JSON schema)

API paragraph not found

Validation data request

API paragraph not found

Processing

API paragraph not found

Response structure

See on Apiary

If the entered number is verified in the system

Example:

{
  "data": {
    "phone_number": "{{phone_number}}"

...

  },

...

"meta": {

...

  "code": 200,

...

  "request_id": "xxx",

...

  "type": "object",

...

  "url": "http://api-svc.verification/verifications/{{phone_number}}"

...

Якщо введений номер неверіфікований в системі

...

  }
}

If the entered number is not verified in the system

Example:

{
"error": {

...

"type": "not_found"

...

},

...

"meta": {

...

"code": 404,

...

"request_id": "xxx",

...

"type": "object",

...

"url": "http://api-svc.verification/verifications/{{phone_number}}"

...

Search requested phone number in verified_phones table

...

}
}

Post-processing processes

API paragraph not found

HTTP status codes

...

Backward compatibility

API paragraph not found