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
...
Link
...
...
Resource
...
/api/verifications
...
Scope
...
API paragraph not found
...
Components
...
SMS
...
Using Dictionaries
...
API paragraph not found
...
Using Microservices
...
API paragraph not found
...
Protocol type
...
REST
...
Request type
...
POST
...
Sync/Async
...
Sync
...
Public/Private/Internal
...
Public
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:
...
id = хххх
status = NEW
code_expired_at = строк придатності коду
аctive= true
Service specification
Generate verification code
- 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
Deactivate active verification code
- Search active verification code(s) for this phone number
- If found - change status to INACTIVE
Save verification code
- Save generated verification code to DB
...
Input parameters
Attributes
...
Attribute
...
Values
...
Type
...
Description
...
Example
...
phone_number
...
String
...
Required
...
+380508887700
Filters
None
Request structure
Example
| Expand | ||
|---|---|---|
| ||
|
Authorize
Request to process the request using a token in the headers
Headers
Example
| Expand | ||
|---|---|---|
| ||
|
Validation data request
API paragraph not found
Processing
API paragraph not found
Response structure
Example:
| Expand | ||
|---|---|---|
| ||
|
Post-processing processes
API paragraph not found
HTTP status codes
...
HTTP status code
...
Message
...
What caused the error
...
200
...
Response
...
Backward compatibility
...