DocumentService

Send Document

Launches a document into its route, transitioning it from DRAFT to ON_APPROVAL or ON_SIGN depending on the first step. Set a draft route with SetDocumentRoute first (or rely on the document type’s default policy route).

initial_action lets the owner act on the first step while sending: SEND_ONLY (default) just launches; APPROVE_FIRST_STEP approves the owner’s first approval step; SIGN_FIRST_STEP signs it and requires a signature — the same bring-your-own-signature contract as SignDocument.

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 document has no route, is already sent, or the signature is missing/malformed for SIGN_FIRST_STEP.

POST

developer

documents

{document_id}

_send

Send Document

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

import requests

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

payload = {
    "document_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>', signature: '<string>'})
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'document_id' => '<string>',
    'signature' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"document_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))

}

HttpResponse<String> response = Unirest.post("https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_send")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document_id\": \"<string>\",\n  \"signature\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document_id\": \"<string>\",\n  \"signature\": \"<string>\"\n}"

response = http.request(request)
puts response.read_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).

initial_action

enum<string>

Defaults to SEND_ONLY.

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

SEND_INITIAL_ACTION_UNSPECIFIED,

SEND_INITIAL_ACTION_SEND_ONLY,

SEND_INITIAL_ACTION_APPROVE_FIRST_STEP,

SEND_INITIAL_ACTION_SIGN_FIRST_STEP

sign_method

enum<string>

Required only for SIGN_FIRST_STEP.

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

SIGN_METHOD_UNSPECIFIED,

SIGN_METHOD_NCALAYER,

SIGN_METHOD_EGOV_MOBILE

signature

string

Base64-encoded CMS/ЭЦП signature — required only for SIGN_FIRST_STEP.

Ответ

document

object

The document after launching into its route.

Show child attributes

Send Document

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

import requests

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

payload = {
    "document_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>', signature: '<string>'})
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'document_id' => '<string>',
    'signature' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"document_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))

}

HttpResponse<String> response = Unirest.post("https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_send")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document_id\": \"<string>\",\n  \"signature\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.doodocs.kz/api/developer/v1/documents/{document_id}/_send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document_id\": \"<string>\",\n  \"signature\": \"<string>\"\n}"

response = http.request(request)
puts response.read_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

Send Document

Авторизации

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

Тело

Ответ