Purpose

This WS allows to check current verification status of the specified person.

Specification

...

Logic

Service returns verification info for a specified person:

• Get person from mpi.persons table

• Render a response according to specification

Input parameters

Request structure

Authorize

• Verify the validity of access token

  • Return (401, 'Invalid access token') in case of validation fails

• Verify that token is not expired

  • in case of error - return (401, 'Invalid access token')

• Check user scopes in order to perform this action (scope = 'person:read')

  • Return (403, 'Your scope does not allow to access this resource. Missing allowances: person:read') in case of invalid scope(s)

Headers

Наприклад:

• Content-Type:application/json

• Authorization:Bearer c2778f3064753ea70de870a53795f5c9

• api-key:uXhEczJ56adsfh3Ri9SUkc4en

Request data validation

Validate Patient

• Get Patient identifier from the URL

• Check it exists in DB

  • Return 404 ('not found') in case of error

Service logic

Service returns verification info for a specified person:

• Get person from mpi.persons table

• Render a response according to specification

Processing

API paragraph not found

Response structure

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "verification_status": "NOT_VERIFIED",
    "verification_reason": "MANUAL",
    "verification_comment": "Бракує даних паспорту пацієнта та його ІПН"
  }
}

Post-processing processes

API paragraph not found

HTTP status codes