...

Purpose

This method is used when you need to re-send SMS to a person or third personApiary.

Specification

Input parameters

Authorize

1. Verify the validity of access token

   • Check user scope authentication_method_request:write in order to perform this action

Request to process the request using a token in the headers.

Headers

• Content-Type:application/json

• Authorization:Bearer {{access_token}}

• Api-key:{{secret}}

Request data validation

Validate

1. Validate auth method. il.authentication_method_request.auth_methos_current.type = OTP

2. Check that authentication_method_request.status = NEW

Validate preson_id

• validate person.id UUID

  • in case error return 404

• search person by person.id in MPI or person.is_active = false

  • in case error return 404, "Such person doesn't exist"

• validate that person is active ( person.status = active)

  • in case error return 409, "Such person isn't active"

Processing

Generate verification code

Invoke Initialize OTP to generate one time password and send it to client number.

cURL example

curl -X POST \
  http://localhost:4000/verifications \
  -H 'content-type: application/json' \
  -d '{
  "phone_number": "+380958697084"
}'

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "7d23bebb-1cf3-4221-bf21-18aada444756",
    "status": "NEW",
    "code_expired_at": "2017-07-10T12:20:16.300597Z",
    "active": true
  }
}

HTTP status codes