Purpose

Use this method to obtain full information about Person Request.

Key features

1. Only authenticated and authorized user can use person request

2. Service returns only person request related to the same legal entity as the user.

Specification

Logic

API paragraph not found

Preconditions

API paragraph not found

Global and configurable parameters

...

Input parameters

Filters

No

Dictionaries

API paragraph not found

Request structure

...

Dictionaries

• GENDER

• DOCUMENT_TYPE

• ADDRESS_TYPE

• COUNTRY

• SETTLEMENT_TYPE

• STREET_TYPE

• PHONE_TYPE

• AUTHENTICATION_METHOD

• CONFIDANT_PERSON_TYPE

• PREFERRED_WAY_COMMUNICATION

• DOCUMENT_RELATIONSHIP_TYPE

Request structure

See on Apiary

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:read')

   1. Return 403 in case invalid scope(s)

...

Auth_methods

...

Headers

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9{{access_token}}

api-key:uXhEczJ56adsfh3Ri9SUkc4en

Request data validation

API paragraph not found

Processing

API paragraph not found::{{secret}}

Response structure

...

Example:

Expand
title Response example
Code Block { "meta": { "code": 201, "url": "https://example.com/resource", "type": "object", "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810" }, "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" }, "urgent": { "authentication_method_current": [ { "type": "OTP", "phone_number": "+38093*****85" } ], "documents": [ { "type": "PASSPORT", "url": "https://storage.ehealth.world" } ] } }

Post-processing processes

...

HTTP status codes

Backward compatibility

...