Content Comparison

Purpose

This method is designed to verify that provided in the declaration request phone number is valid and is in service. Final stage

Specification

Logic

To confirm the verification, you must enter the phone number and OTP (one-time code) in the system

...

Verify code

• Search active code for phone number

• Check code expiration period

• Compare codes

Matched

• Deactivate code

• Add phone number to verified_phones

Not matched

• Deactivate code

• Invoke Send verification code

• Return error

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 \
     --request PATCH \
     --header "Content-Type: application/json" \
     --header "Authorization: Bearer c2778f3064753ea70de870a53795f5c9" \
     --data-binary "{
  \"code\": 3782
}" \
'http://ehealth.com/api/verifications/{phone_number}/actions/complete'

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

Verify code

• Search active code for phone number

• Check code expiration period

• Compare codes

Matched

• Deactivate code

• Add phone number to verified_phones

Not matched

• Deactivate code

• Invoke Send verification code

• Return error

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "7d23bebb-1cf3-4221-bf21-18aada444756",
    "status": "NEW",
    "code_expired_at": "2017-07-10T12:20:16.300597Z",
    "active": true
  }
}

Post-processing processes

API paragraph not found

HTTP status codes

Backward compatibility

API paragraph not found