Properties of a REST API method document

Purpose

This WS designed to get current user's person verification status & data and relationship verification status.

Logic

Service logic

1. Get person_id and applicant_person_id from token

2. Get person verification details from mpi.person_verifications table

3. Get relationship from mpi.confidant_person_relationships table where:

   1. person_id=person_id from token

   2. confidant_person_id = applicant_person_id

   3. AND is_active=true

4. Render a response according to specification

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorization

• 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_verification:details_pis')

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

• Check that token contains person_id

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

Validate person

• Get person_id from token (x-person-id header)

• Validate patient status is active (status = ‘active' & is_active = 'true’)

  • in case of error - return 404 ('Person not found')

• If person_id and applicant_person_id from token not equal check confidant person relationship record exists in mpi.confidant_person_relationships

  • in case of error - return 404 ('Confidant person relationship not found')

Processing

N/A

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used