Table of Contents | ||||
---|---|---|---|---|
|
Purpose
This method is designed to check if the phone number is verified in the system
Specification
Link | |
Resource | /api/verifications/{{phone_number}} |
Scope | otp:read |
Components | |
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
Search requested phone number in verified_phones table
Return 200 (VERIFIED) if phone number found
Return 422 (UNVERIFIED) if phone number
...
Preconditions
API paragraph not found
Global and configuration parameters
...
not found
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
phone_number | (required)StringString | Required | +380508887700 |
Filters
None
Request structure
Example
...
title | Request example |
---|
...
API paragraph not found
Authorize
Request to process the request using a token in the headers
Headers
Example
Expand | ||
---|---|---|
| ||
|
...
API paragraph not found
Validation data request
API paragraph not found
Processing
API paragraph not found
Response structure
If the entered number is verified in the system
...
Expand | ||
---|---|---|
| ||
|
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
...