# Підписання: базовий API

# Запуск процесу підписання АЕД POST /api/v1/signature

##### **REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-get"><table class="colwidths-given docutils align-default" style="width: 78.8095%; height: 415.45px;"><colgroup><col style="width: 27.5262%;"></col><col style="width: 72.4454%;"></col></colgroup><tbody><tr class="row-odd" style="height: 35.2px;"><td style="height: 35.2px;">**URL**

</td><td style="height: 35.2px;">[https://des-client.stage.akcyz.edin.ua](https://des-client.stage.akcyz.edin.ua)

</td></tr><tr class="row-even" style="height: 29.6px;"><td style="height: 29.6px;">Метод запиту

</td><td style="height: 29.6px;">POST

</td></tr><tr class="row-odd" style="height: 29.6px;"><td style="height: 29.6px;">URL запиту

</td><td style="height: 29.6px;">**/api/v1/signature**

</td></tr><tr class="row-even" style="height: 29.6px;"><td style="height: 29.6px;">**Headers**

</td><td style="height: 29.6px;"> </td></tr><tr class="row-odd" style="height: 35.2px;"><td style="height: 35.2px;">Authorization

</td><td style="height: 35.2px;">Bearer

</td></tr><tr class="row-even" style="height: 29.6px;"><td style="height: 29.6px;">Content-Type

</td><td style="height: 29.6px;">application/json

</td></tr><tr style="height: 29.6px;"><td style="height: 29.6px;">**REQUEST**

</td><td style="height: 29.6px;"> </td></tr><tr style="height: 30.4px;"><td rowspan="3" style="height: 197.05px;">Request body schema

</td><td class="sc-fPXMVe ieWpnN" style="height: 30.4px;"><div><span class="sc-Nxspf sc-gmPhUn lmPAIU hWrcDp">**documentId** (<span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string</span><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF"> &lt;guid&gt;) обов'язково - Ідентифікатор АЕД</span></span></div></td></tr><tr style="height: 120.25px;"><td style="height: 120.25px;"><div><div><span class="sc-Nxspf sc-gmPhUn lmPAIU hWrcDp">**<span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">signatureType</span>**<span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF"> (string) обов'язково  - Тип підпису:</span></span><div><span class="sc-Nxspf lmPAIU">Enum:</span></div>

- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"SignBySender"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"SignByCustodian"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"SignByRecipient"</span>

</div></div></td></tr><tr style="height: 46.4px;"><td style="height: 46.4px;"><div><div><span class="sc-Nxspf sc-gmPhUn lmPAIU hWrcDp">**<span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">requestDeduplicationId</span>**<span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv"> (</span><span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv"><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string</span><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF"> &lt;guid&gt;</span>) необов'язково - Ідентифікатор дедубликації запитів на підпис АЕД</span></span></div></div></td></tr></tbody></table>

</div>**JSON приклад запиту**

```json
{
  "documentId": "34a13eb1-62a9-4bbd-a12a-285347701b07",
  "signatureType": "SignBySender",
  "requestDeduplicationId": "34a13eb1-62a9-4bbd-a12a-285347701b07"
}
```

##### **RESPONSE**

<span style="color: rgb(45, 194, 107);">Статус 200.</span>

**Response schema:**

<table class="sc-dAbbOL krDyRf" id="bkmrk-signaturerequestid-s" style="width: 78.8095%; height: 92.4px;"><tbody><tr class="" style="height: 32.4px;"><td class="sc-dLMFU sc-eldPxv fAoVKb evxOdD" style="width: 33.5255%; height: 32.4px;" title="signatureRequestId"><span class="property-name">signatureRequestId</span></td><td class="sc-fPXMVe ieWpnN" style="width: 66.4442%; height: 32.4px;"><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string</span><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF"> &lt;guid&gt;</span></div></div></td></tr><tr class="" style="height: 30.4px;"><td class="sc-dLMFU sc-eldPxv fAoVKb evxOdD" style="width: 33.5255%; height: 30.4px;" title="signatureStatus"><span class="property-name">signatureStatus</span></td><td class="sc-fPXMVe ieWpnN" style="width: 66.4442%; height: 30.4px;"><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string </span><span class="sc-Nxspf lmPAIU">Enum:</span></div><div>

- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Pending"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Signed"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Rejected"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Error"</span>

</div></div></td></tr><tr class="last " style="height: 29.6px;"><td class="sc-dLMFU sc-eldPxv fAoVKb evxOdD" style="width: 33.5255%; height: 29.6px;" title="signatureStatusMessage"><span class="property-name">signatureStatusMessage</span></td><td class="sc-fPXMVe ieWpnN" style="width: 66.4442%; height: 29.6px;"><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string</span></div></div></td></tr></tbody></table>

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

```json
{
  "signatureRequestId": "string",
  "signatureStatus": "Pending",
  "signatureStatusMessage": "string"
}
```

# Отримання результату підпису АЕД GET /api/v1/signature/{signatureRequestId}

##### **REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-get"><table class="colwidths-given docutils align-default" style="width: 78.8095%;"><colgroup><col style="width: 27.5262%;"></col><col style="width: 72.4454%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td>[https://des-client.stage.akcyz.edin.ua](https://des-client.stage.akcyz.edin.ua)

</td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/v1/signature/{signatureRequestId}**

</td></tr><tr><td>PATH параметри

</td><td>**signatureRequestId** (string) обов'язково - ідентифікатор запиту на підпис АЕД

<span class="sc-Nxspf lmPAIU">Example: </span><span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">34a13eb1-62a9-4bbd-a12a-285347701b07</span>

</td></tr><tr class="row-even"><td>**Headers**

</td><td> </td></tr><tr class="row-odd"><td>Authorization

</td><td>Bearer

</td></tr><tr class="row-even"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>##### **RESPONSE**

<span style="color: rgb(45, 194, 107);">Статус 200.</span>

**Response schema:**

<table class="sc-dAbbOL krDyRf" id="bkmrk-signaturerequestid-s" style="width: 78.6905%;"><tbody><tr class=""><td class="sc-dLMFU sc-eldPxv fAoVKb evxOdD" style="width: 36.3875%;" title="signatureRequestId"><span class="property-name">signatureRequestId</span></td><td class="sc-fPXMVe ieWpnN" style="width: 63.5686%;"><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string</span><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF"> &lt;guid&gt;</span></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv fAoVKb evxOdD" style="width: 36.3875%;" title="signatureStatus"><span class="property-name">signatureStatus</span></td><td class="sc-fPXMVe ieWpnN" style="width: 63.5686%;"><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string </span><span class="sc-Nxspf lmPAIU">Enum:</span></div><div>

- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Pending"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Signed"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Rejected"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Error"</span>

</div></div></td></tr><tr class="last "><td class="sc-dLMFU sc-eldPxv fAoVKb evxOdD" style="width: 36.3875%;" title="signatureStatusMessage"><span class="property-name">signatureStatusMessage</span></td><td class="sc-fPXMVe ieWpnN" style="width: 63.5686%;"><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string</span></div></div></td></tr></tbody></table>

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

```json
{
  "signatureRequestId": "string",
  "signatureStatus": "Pending",
  "signatureStatusMessage": "string"
}
```

# Обробка нотифікації про підпис АЕД POST /api/v1/signature/notification

##### **REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-get"><table class="colwidths-given docutils align-default" style="width: 82.0238%; height: 707.6px;"><colgroup><col style="width: 27.4634%;"></col><col style="width: 72.5093%;"></col></colgroup><tbody><tr class="row-odd" style="height: 35.2px;"><td style="height: 35.2px;">**URL**

</td><td style="height: 35.2px;">[https://des-client.stage.akcyz.edin.ua](https://des-client.stage.akcyz.edin.ua)

</td></tr><tr class="row-even" style="height: 29.6px;"><td style="height: 29.6px;">Метод запиту

</td><td style="height: 29.6px;">POST

</td></tr><tr class="row-odd" style="height: 29.6px;"><td style="height: 29.6px;">URL запиту

</td><td style="height: 29.6px;">**/api/v1/signature/notification**

</td></tr><tr class="row-even" style="height: 29.6px;"><td style="height: 29.6px;">**Headers**

</td><td style="height: 29.6px;"> </td></tr><tr class="row-odd" style="height: 35.2px;"><td style="height: 35.2px;">Authorization

</td><td style="height: 35.2px;">Bearer

</td></tr><tr class="row-even" style="height: 29.6px;"><td style="height: 29.6px;">Content-Type

</td><td style="height: 29.6px;">application/json

</td></tr><tr style="height: 29.6px;"><td style="height: 29.6px;">**REQUEST**

</td><td style="height: 29.6px;"> </td></tr><tr style="height: 120.25px;"><td rowspan="9" style="height: 489.2px;">Request body schema

</td><td class="sc-fPXMVe ieWpnN" style="height: 120.25px;"><div><span class="sc-Nxspf sc-gmPhUn lmPAIU hWrcDp">**notificationType** (<span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string</span><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">) - тип повідомлення. </span></span><span class="sc-Nxspf lmPAIU">Enum:</span><div>

- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"SignatureProcessStartedNotification"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"SignatureSuccessNotification"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"SignatureErrorNotification"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"SignatureApprovalNotification"</span>

</div></div></td></tr><tr style="height: 48.25px;"><td style="height: 48.25px;"><div><div><span class="sc-Nxspf sc-gmPhUn lmPAIU hWrcDp"><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">**signatureRequestId** (string </span></span><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">&lt;guid&gt;) - </span>Ідентифікатор запросу на підпис документу</div></div></td></tr><tr style="height: 32.4px;"><td style="height: 32.4px;"><div><div><span class="sc-Nxspf sc-gmPhUn lmPAIU hWrcDp"><span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">**hash** (</span><span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv"><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string</span>) - хеш документа</span></span></div></div></td></tr><tr style="height: 33.4px;"><td style="height: 33.4px;"><div><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">**signature** (string) - </span>підпис документа</div></div></div></td></tr><tr style="height: 31.4px;"><td class="sc-fPXMVe ieWpnN" style="height: 31.4px;"><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">**errorMessage** (string) - </span>повідомлення про помилку</div></div></td></tr><tr style="height: 29.6px;"><td style="height: 29.6px;"><div><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">**errorDescription** (string) - </span>детальне повідомлення про помилку</div></div></div></td></tr><tr style="height: 29.6px;"><td style="height: 29.6px;"><div><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">**eExciseDocumentId** (string</span><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF"> &lt;guid&gt;) - </span>Ідентифікатор документу в еАкцизі</div></div></div></td></tr><tr style="height: 77.65px;"><td style="height: 77.65px;"><div><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">**approvalType** (string) - Тип квитанції. </span><span class="sc-Nxspf lmPAIU">Enum:</span></div><div>

- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Approval1"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Approval2"</span>

</div></div></div></td></tr><tr style="height: 86.65px;"><td style="height: 86.65px;"><div><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">**approvalResult** (string) - Результат обробки в еАкциз. </span><span class="sc-Nxspf lmPAIU">Enum:</span></div><div>

- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Success"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Failure"</span>

</div></div></div></td></tr></tbody></table>

</div>**JSON приклад запиту:**

```json
{
  "notificationType": "SignatureProcessStartedNotification",
  "signatureRequestId": "34a13eb1-62a9-4bbd-a12a-285347701b07",
  "hash": "string",
  "signature": "string",
  "errorMessage": "string",
  "errorDescription": "string",
  "eExciseDocumentId": "34a13eb1-62a9-4bbd-a12a-285347701b07",
  "approvalType": "Approval1",
  "approvalResult": "Success"
}
```

##### **RESPONSE**

<span style="color: rgb(45, 194, 107);">Статус 200.</span>

**Response schema:**

<table class="sc-dAbbOL krDyRf" id="bkmrk-signaturerequestid-s" style="width: 78.8095%; height: 92.4px;"><tbody><tr class="" style="height: 32.4px;"><td class="sc-dLMFU sc-eldPxv fAoVKb evxOdD" style="width: 50.0614%;" title="signatureRequestId"><span class="property-name">signatureRequestId</span></td><td class="sc-fPXMVe ieWpnN" style="width: 50.0614%;"><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string</span><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF"> &lt;guid&gt;</span></div></div></td></tr><tr class="" style="height: 30.4px;"><td class="sc-dLMFU sc-eldPxv fAoVKb evxOdD" style="width: 50.0614%;" title="signatureStatus"><span class="property-name">signatureStatus</span></td><td class="sc-fPXMVe ieWpnN" style="width: 50.0614%;"><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string </span><span class="sc-Nxspf lmPAIU">Enum:</span></div><div>

- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Pending"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Signed"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Rejected"</span>
- <span class="sc-Nxspf sc-ddjGPC lmPAIU dEQDjv">"Error"</span>

</div></div></td></tr><tr class="last " style="height: 29.6px;"><td class="sc-dLMFU sc-eldPxv fAoVKb evxOdD" style="width: 50.0614%;" title="signatureStatusMessage"><span class="property-name">signatureStatusMessage</span></td><td class="sc-fPXMVe ieWpnN" style="width: 50.0614%;"><div><div><span class="sc-Nxspf sc-gFAWRd lmPAIU iHgalF">string</span></div></div></td></tr></tbody></table>

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

```json
{
  "signatureRequestId": "string",
  "signatureStatus": "Pending",
  "signatureStatusMessage": "string"
}
```