Skip to main content

Отримання документа компанії GET /api/external/company/form

REQUEST

URL

Метод запиту

GET

URL запиту

/api/external/company/form

URL параметри

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

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

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

Authorization

Auth type

 API key

Key / Value

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

Headers

  

Content-Type

application/json
RESPONSE

В тілі відповіді передається:

  • статус 200, якщо format=binary

PDF bytes з content type:

Content-Type: application/pdf
  • статус 200, якщо format=base64
{
  "formType": "OFFER_AGREEMENT_MANAGER",
  "fileName": "Договір-оферта (керівник/УО).pdf",
  "contentType": "application/pdf",
  "contentBase64": "JVBERi0x..."
}
Поле Тип Опис
formType string Enum name документа.
fileName string Імʼя файлу.
contentType string Завжди application/pdf.
contentBase64 string PDF у base64.
CURL binary
curl -X GET 'https://host/api/external/company/form?...' \
  -H 'x-system-id: 019eb581-307b-7562-8a1f-20227511e898' \
  -o company-form.pdf
CURL base 64
curl -X GET 'https://host/api/external/company/form?...' \
  -H 'x-system-id: 019eb581-307b-7562-8a1f-20227511e898'
Помилки
HTTP type Опис
400 unknown_form_type Невідомий formType.
400 form_not_found Документ не знайдений.
400 unknown_format format не binary і не base64.
403 company_access_denied Немає доступу до company.
Back to top