Purpose

Use this method to obtain list of Person Requests.

Key features

1. Only authenticated and authorized user can use person requests

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

Specification

Filters

See on Apiary

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).

Headers

• Content-Type:application/json

• Authorization:Bearer {{access_token}}

• api-key:{{secret}}

Processing

Prepare response

Service returns only person requests related to the same legal entity as the user

1. Extract client_id from token

2. Return entries filtered by client_id and query params.

Response structure

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "status": "APPROVED",
      "person": {
        "first_name": "Петро",
        "last_name": "Іванов",
        "second_name": "Миколайович"
      }
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes