Purpose

Use this method to approve previously created Person Request.

Key features

1. Only authenticated and authorized user can use this service

2. Only NEW person request can be activated

3. The request can be activated only by the employee who works in the same legal entity in which the request was made.

Specification

Logic

Image RemovedImage Added

approve_request.graphml

Preconditions

API paragraph not found

Global and configurable parameters

No

Input parameters

Filters

No

Dictionaries

API paragraph not found

Request structure

See on Apiary

Example:

{
  "verification_code": 6598
}

Authorize

1. Verify the validity of access token

   1. Return 401 in case validation fails.

2. Check scopes in order to perform this action (scope = 'person_request:write')

   1. Return 403 in case invalid scope(s).

Headers

Content-Type:application/json

...

api-key:uXhEczJ56adsfh3Ri9SUkc4en

Request data validation

1. Validate request using JSON schema

   1. In case validation failed - generate 422 error

JSON Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "verification_code": {
      "type": "string"
    }
  },
  "required": [
    "verification_code"
  ],
  "additionalProperties": false
}

Processing

Get person request details

Get person request from IL_DB.person_request

Determine authorization method

Get authorization_method from IL_DB.person_request

...

Invoke verification module to verify OTP

OTP Verification

Check uploaded documents

Invoke Media Content Storage to check documents exist

Media Content Storage

Generate printout form

Invoke MAN to render print form.

...

cURL example

curl --request POST \
     --header 'Accept: text/html' \
     --header 'Content-Type: application/json' \
     {:host}/templates/{:person_request_printout_id}/actions/render

...

MANResponse.$.data

Change person request

1. Change entity status in IL_DB.person_request to APPROVED

2. Set updated_at - now() (Get current date-time)

3. Set updated_by - user_id (Extract user from token)

Response structure

...

Example:

Expand
title Response example
Code Block { "meta": { "code": 201, "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": { "status": "SIGNED", "id": "eeebb86d-5cba-43c9-885b-6482ecaf826b", "person": { "id": "13001c60-45a0-4b5a-b425-9505e1de18bd", "first_name": "Петро", "last_name": "Іванов", "second_name": "Миколайович", "birth_date": "2009-07-05", "birth_country": "Україна", "birth_settlement": "Вінниця", "gender": "MALE", "email": "email@example.com", "no_tax_id": false, "tax_id": "3999869394", "secret": "secret", "documents": [ { "type": "BIRTH_CERTIFICATE", "number": "АА120518", "issued_by": "Рокитнянським РВ ГУ МВС Київської області", "issued_at": "2017-02-28", "expiration_date": "2027-02-28" } ], "addresses": [ { "type": "RESIDENCE", "country": "UA", "area": "Житомирська", "region": "Бердичівський", "settlement": "Київ", "settlement_type": "CITY", "settlement_id": "b075f148", "street_type": "STREET", "street": "вул. Ніжинська", "building": "15", "apartment": "23", "zip": "02090" } ], "phones": [ { "type": "MOBILE", "number": "+380503410870" } ], "authentication_methods": [ { "type": "THIRD_PERSON", "phone_number": "+380508887700", "value": "c282f8a9-e709-40aa-94b4-dde1402bf4b6", "alias": "husband" } ], "unzr": "20090705-00011", "emergency_contact": { "first_name": "Петро", "last_name": "Іванов", "second_name": "Миколайович", "phones": [ { "type": "MOBILE", "number": "+380503410870" } ] }, "confidant_person": [ { "relation_type": "PRIMARY", "first_name": "Петро", "last_name": "Іванов", "second_name": "Миколайович", "birth_date": "1972-10-26", "birth_country": "Україна", "birth_settlement": "Вінниця", "gender": "MALE", "tax_id": "2659719350", "secret": "secret", "unzr": "19900101-00099", "preferred_way_communication": "email", "documents_person": [ { "type": "PASSPORT", "number": "АА120518", "expiration_date": "2021-02-28", "issued_by": "Рокитнянським РВ ГУ МВС Київської області", "issued_at": "2017-02-28" } ], "documents_relationship": [ { "type": "BIRTH_CERTIFICATE", "number": "АА120518", "issued_by": "Рокитнянським РВ ГУ МВС Київської області", "issued_at": "2017-02-28" } ], "phones": [ { "type": "MOBILE", "number": "+380503410870" } ], "email": "emaill@example.com" } ], "preferred_way_communication": "email" }, "patient_signed": false, "process_disclosure_data_consent": true, "content": "Person content", "channel": "MIS", "authorize_with": "cc949559-5dfe-420f-ac05-065e443b2cc6" } }

Post-processing processes

API paragraph not found

HTTP status codes

Backward compatibility

API paragraph not found