ЕСОЗ - публічна документація

Find Verifications by Phone Number

Owned by Petro Lymych
Last updated: Feb 25, 2023 by Pavlo Nosenko (UA SoE eHealth) (Unlicensed)
1 min read

Purpose

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

Specification

Link

GENERAL MIS API · Apiary

Resource

/api/verifications/{{phone_number}}

Scope

otp:read

Components

SMS

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 not found

Input parameters

Input parameter

Values

Type

Description

Example

Input parameter

Values

Type

Description

Example

phone_number

 

String

Required

+380508887700

Filters

None

Request structure

API paragraph not found

Authorize

Request to process the request using a token in the headers

Headers

Example

Content-Type: application/json Authorization: Bearer {token} api-key: {secret}

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

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

200

 

phone number found

422

 

phone number is not found

Backward compatibility

API paragraph not found

ЕСОЗ - публічна документація