DocumentService

Create Document

Creates a draft document on behalf of the key’s owner (the owner becomes the initiator), either from a template (template_id) or from a file the caller uploaded with FileService (file_id). Route and sending are separate steps.

Send an Idempotency-Key header to make a retry safe: the first call with a given key creates the document, and any repeat of the same request returns that same document instead of creating a second one. Keys live 24 hours and are scoped to the API key that used them. Reusing a key with a different body is refused rather than silently replayed.

Required scope: documents:write

Error Codes:

DEVELOPER.SCOPE_INSUFFICIENT: The key lacks the documents:write scope.
INVALID_ARGUMENT: Neither or both of template_id and file_id, or invalid type or field values.
FILE_NOT_FOUND: No upload with that id belongs to the key owner.
FILE.INVALID_STATUS_TRANSITION: The upload was never confirmed.
FILE.ALREADY_LINKED: The upload is already attached to a document.
DOCUMENT_INITIATOR_NOT_FOUND: The key owner is not an employee of the tenant.
DEVELOPER.IDEMPOTENCY_KEY_CONFLICT: The Idempotency-Key was used with a different body.
DEVELOPER.IDEMPOTENCY_IN_PROGRESS: An earlier call with this key is still running.

POST

developer

documents

Create Document

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

import requests

url = "https://app.doodocs.kz/api/developer/v1/documents"

payload = {
    "title": "<string>",
    "type_id": "<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({title: '<string>', type_id: '<string>'})
};

fetch('https://app.doodocs.kz/api/developer/v1/documents', 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"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"type_id\": \"<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>"
}

Authorizations

X-API-Key

string

header

required

Body

application/json

title

string

required

Document title.

type_id

string

required

Document type id.

date

string

Document date, YYYY-MM-DD.

file_id

string

Id of a confirmed upload (FileService.ConfirmFileUpload) to build the document from, instead of a template. The file becomes the document's PDF and can be sent for signing as it is. Mutually exclusive with template_id.

number

string

Registration number to record on the document.

organization_id

string

Legal entity to attribute the document to.

subject_employee_ids

string[]

Employees the document is about (its subjects).

template_id

string

Template id and version the document is generated from. Discover these with ListDocumentTemplates (see DocumentTemplate.version). Required unless file_id is set.

template_values

object

Values for the template variables, keyed by variable id. Read the expected shape from the template's variable_schema (GetDocumentTemplate).

template_version

integer<int32>

Version of the template to use; take it from DocumentTemplate.version.

Response

document

object

The created draft document.

Show child attributes

Create Document

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

import requests

url = "https://app.doodocs.kz/api/developer/v1/documents"

payload = {
    "title": "<string>",
    "type_id": "<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({title: '<string>', type_id: '<string>'})
};

fetch('https://app.doodocs.kz/api/developer/v1/documents', 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"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"type_id\": \"<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>"
}

Overview

Endpoints

Create Document

Authorizations

Body

Response