Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

Purpose

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

Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/otp-verification/find-verifications-by-phone-number

Resource

/api/verifications/{{phone_number}}

Scope

otp:read

Components

OTP Verification serviceSMS

Using Dictionaries

API paragraph not found

Using Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private/Internal

Public

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

...

Preconditions

API paragraph not found

Global and configuration parameters

...

  1. not found

Input parameters

Input parameter

Values

Type

Description

Example

phone_number

(required)StringString

Required

+380508887700

Filters

None

Request structure

See on Apiary

Example

...

titleRequest example

...

API paragraph not found

Authorize

Request to process the request using a token in the headers

Headers

Example

Expand
titleHeader example
Code Block
Content-Type: application/json
Authorization: Bearer c2778f3064753ea70de870a53795f5c9

...

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

...

Expand
titleResponse example (code: 404)
Code Block
{
"error": {
"type": "not_found"
},
"meta": {
"code": 404,
"request_id": "xxx",
"type": "object",
"url": "http://api-svc.verification/verifications/{{phone_number}}"
}
}

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code

Message

What caused the error

200

phone number found 

422

phone number is not found

Backward compatibility

...