Skip to main content

Згенерувати PDF-форму для адміністратора компанії PATCH /api/external/company/employee/pkey/generate/draft

Цей метод можна викликати повторно. У такому випадку admin-форми будуть перестворені, а попередні варіанти цих форм — перезаписані.

REQUEST

URL

Метод запиту

PATCH

URL запиту

/api/external/company/employee/pkey/generate/draft

URL параметри

companyCode (обов’язково) - код Компанії;

pKeyUuid (обов’язково) - UUID ключа з відповіді на виклик метода створення чернетки ключа;

adminIpn (обов’язково) - ІПН/РНОКПП адміністратора або суперадміністратора компанії, який підписуватиме admin-форми.

 

Якщо ключ створюється для співробітника з роллю ADMIN, у adminIpn потрібно передати саме SUPER_ADMIN компанії.

Authorization

Auth type

 API key

Key / Value

 x-system-id - токен, отриманий при підключенні

Headers

  

Content-Type

application/json
RESPONSE

В тілі відповіді передається статус 200.

JSON  приклад відповіді:

{
  "pKey": {
    "uuid": "019ec000-0000-7000-8000-000000000001",
    "status": "COMPANY_GENERATED"
  },
  "forms": [
    {
      "type": "AFFILIATION_CONFIRMATION",
      "pdf": "JVBERi0x...",
      "hash": "HASH_OF_PDF"
    }
  ]
}

Опис полів відповіді:

Поле Тип Опис
pKey object Обʼєкт ESSPrivateKey, поля описані в розділі 2.3.
forms object[] PDF-документи, які потрібно підписати адміністратору/суперадміністратору.
forms[].type enum Тип форми: AFFILIATION_CONFIRMATION або POWER_OF_ATTORNEY.
forms[].pdf string PDF content у base64.
forms[].hash string/null Hash PDF для контролю цілісності.

Для ключа співробітника з роллю ADMIN у відповіді додатково буде POWER_OF_ATTORNEY.

CURL 
curl -X PATCH 'https://host/api/external/company/employee/pkey/generate/draft?...'   -H 'x-system-id: 019eb581-307b-7562-8a1f-20227511e898'
Помилки 
HTTP type Опис
400 invalid_pkey_uuid pKeyUuid має неправильний UUID-формат.
400 pkey_not_found Ключ не знайдений або не належить company.
400 pkey_wrong_status Ключ не у статусі COMPANY_GENERATED.
400 employee_not_found Співробітник-власник ключа не знайдений.
400 employee_not_active Співробітник-власник ключа не активний або не ідентифікований.
400 admin_not_found Адміністратор не знайдений.
400 admin_not_active Адміністратор не активний або не ідентифікований.
400 admin_wrong_role Переданий користувач не має ролі адміністратора/суперадміністратора.
400 admin_must_be_super_admin Для цього ключа потрібен підпис суперадміністратора.
403 company_access_denied Немає доступу до company.
403 company_wrong_status Компанія не ACTIVE.
Back to top