Skip to main content

Отримати документ ключа GET /api/external/company/pkey/form

REQUEST

URL


Метод запиту

GET

URL запиту

/api/external/company/pkey/form

URL параметри

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

employeeIpn (обов’язково) - ІПН/РНОКПП співробітника.

key (обов’язково) - UUID ключа.

formType (обов’язково) - Enum name з ESSRegFormType, наприклад, PK_FORM.

format (опційно) - binary або base64. Default: binary.

Authorization


Auth type

API key

Key / Value

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

Headers

 

Content-Type

application/json

RESPONSE

Такий самий, як у методі Отримання документа компанії:

  • format=binary — PDF bytes, Content-Type: application/pdf;
  • format=base64 — file object з formTypefileNamecontentTypecontentBase64.
CURL 
curl -X GET 'https://host/api/external/company/pkey/form?...' \
  -H 'x-system-id: 019eb581-307b-7562-8a1f-20227511e898' \
  -o pkey-form.pdf
Помилки 
HTTP type Опис
400 unknown_form_type Невідомий formType.
400 form_not_found Документ ключа не знайдений.
400 unknown_format format не binary і не base64.
403 company_access_denied Немає доступу до company.