DocumentService

Sign Document

Applies a signature on behalf of the key’s owner for one of their active signing slots. Signing is NOT performed server-side: the caller must supply a valid base64 CMS/ЭЦП signature that they produced with their own key (NCALayer or eGov Mobile). The server validates it and records it through the signing workflow.

Required scope: documents:write

Error Codes:

DEVELOPER.SCOPE_INSUFFICIENT: The key lacks the documents:write scope.
DOCUMENT_NOT_FOUND: No document with that id is accessible to the key.
INVALID_ARGUMENT: The signature is malformed, or the participant is not an active signing slot of the key owner.

POST

developer

documents

{document_id}

_sign

Sign Document

curl --request POST \
  --url https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_sign \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "document_id": "<string>",
  "participant_id": "<string>",
  "signature": "<string>"
}
'

import requests

url = "https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_sign"

payload = {
    "document_id": "<string>",
    "participant_id": "<string>",
    "signature": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({document_id: '<string>', participant_id: '<string>', signature: '<string>'})
};

fetch('https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_sign', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_sign"

	payload := strings.NewReader("{\n  \"document_id\": \"<string>\",\n  \"participant_id\": \"<string>\",\n  \"signature\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "document": {
    "completed_at": "2023-11-07T05:31:56Z",
    "create_time": "2023-11-07T05:31:56Z",
    "date": "<string>",
    "department_id": "<string>",
    "files": [
      {
        "file_id": "<string>",
        "file_type": "FILE_TYPE_UNSPECIFIED"
      }
    ],
    "id": "<string>",
    "initiator_employee_id": "<string>",
    "number": "<string>",
    "organization_id": "<string>",
    "route": {
      "active": true,
      "id": "<string>",
      "status": "ROUTE_STATUS_UNSPECIFIED",
      "steps": [
        {
          "id": "<string>",
          "index": 123,
          "participants": [
            {
              "employee_id": "<string>",
              "id": "<string>",
              "key_type": "<string>",
              "status": "PARTICIPANT_STATUS_UNSPECIFIED"
            }
          ],
          "rule": "STEP_RULE_UNSPECIFIED",
          "status": "STEP_STATUS_UNSPECIFIED",
          "step_type": "STEP_TYPE_UNSPECIFIED"
        }
      ]
    },
    "status": "DOCUMENT_STATUS_UNSPECIFIED",
    "subject_employee_ids": [
      "<string>"
    ],
    "title": "<string>",
    "type_id": "<string>",
    "update_time": "2023-11-07T05:31:56Z"
  }
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

Авторизации

X-API-Key

string

header

обязательно

Параметры пути

document_id

string

обязательно

Document id (UUID).

Тело

application/json

document_id

string

обязательно

Document id (UUID).

participant_id

string

обязательно

The active signing participant slot of the key owner (from the document's route).

sign_method

enum<string>

обязательно

The tool the signature was produced with.

Доступные опции:

SIGN_METHOD_UNSPECIFIED,

SIGN_METHOD_NCALAYER,

SIGN_METHOD_EGOV_MOBILE

signature

string

обязательно

Base64-encoded CMS/ЭЦП signature produced client-side with the owner's key.

Ответ

document

object

The document after the signature was recorded.

Show child attributes

Sign Document

curl --request POST \
  --url https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_sign \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "document_id": "<string>",
  "participant_id": "<string>",
  "signature": "<string>"
}
'

import requests

url = "https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_sign"

payload = {
    "document_id": "<string>",
    "participant_id": "<string>",
    "signature": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({document_id: '<string>', participant_id: '<string>', signature: '<string>'})
};

fetch('https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_sign', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_sign"

	payload := strings.NewReader("{\n  \"document_id\": \"<string>\",\n  \"participant_id\": \"<string>\",\n  \"signature\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "document": {
    "completed_at": "2023-11-07T05:31:56Z",
    "create_time": "2023-11-07T05:31:56Z",
    "date": "<string>",
    "department_id": "<string>",
    "files": [
      {
        "file_id": "<string>",
        "file_type": "FILE_TYPE_UNSPECIFIED"
      }
    ],
    "id": "<string>",
    "initiator_employee_id": "<string>",
    "number": "<string>",
    "organization_id": "<string>",
    "route": {
      "active": true,
      "id": "<string>",
      "status": "ROUTE_STATUS_UNSPECIFIED",
      "steps": [
        {
          "id": "<string>",
          "index": 123,
          "participants": [
            {
              "employee_id": "<string>",
              "id": "<string>",
              "key_type": "<string>",
              "status": "PARTICIPANT_STATUS_UNSPECIFIED"
            }
          ],
          "rule": "STEP_RULE_UNSPECIFIED",
          "status": "STEP_STATUS_UNSPECIFIED",
          "step_type": "STEP_TYPE_UNSPECIFIED"
        }
      ]
    },
    "status": "DOCUMENT_STATUS_UNSPECIFIED",
    "subject_employee_ids": [
      "<string>"
    ],
    "title": "<string>",
    "type_id": "<string>",
    "update_time": "2023-11-07T05:31:56Z"
  }
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

Обзор

Endpoints

Sign Document

Авторизации

Параметры пути

Тело

Ответ