> ## Documentation Index
> Fetch the complete documentation index at: https://platform.doodocs.kz/llms.txt
> Use this file to discover all available pages before exploring further.

# Ingest Records

> Accepts a batch of records for a given source and payload type and enqueues
them for asynchronous processing. Returns an ingest request id to correlate
the result.

The Idempotency-Key header is required: re-sending a batch with the same
key is rejected as a duplicate instead of creating a second load.

Required scope: ingest:write (super-administrator keys only).



## OpenAPI

````yaml /api-reference/openapi.yaml post /developer/v1/ingest/{source_type}
openapi: 3.0.3
info:
  description: >-
    Публичный Developer API Doodocs People. Аутентификация — заголовок
    X-API-Key.
  title: Doodocs People API
  version: 1.0.0
servers:
  - description: Production
    url: https://app.doodocs.kz/api
security:
  - ApiKeyAuth: []
tags:
  - description: ApiKeyService exposes Developer API key utilities.
    name: ApiKeyService
  - description: >-
      DocumentService is the public Developer API for documents: reading,
      creating,
       downloading, routing, and signing.

       Authentication: X-API-Key. Every call runs as the key's owner within the key's
       tenant — the owner's document permissions decide what is visible and which
       actions are allowed, exactly as they would in the web app. Fields that carry
       personal data of other participants (names, IIN, positions) are never exposed;
       participants are identified by id only.

       Typical flow: discover a template with ListDocumentTemplates /
       GetDocumentTemplate (to learn its variable_schema), create a draft with
       CreateDocument, set its route with SetDocumentRoute, launch it with
       SendDocument, then apply signatures with SignDocument as slots become active.

       To circulate a document produced elsewhere, upload it with FileService and
       pass the confirmed file_id to CreateDocument instead of a template.
    name: DocumentService
  - description: |-
      EmployeeService is the public Developer API for reading employees.

       Authentication: X-API-Key. The key's tenant and the key owner's data scope
       determine which employees and fields are visible; sensitive fields the caller
       may not view are omitted and listed in `redacted_fields`.
    name: EmployeeService
  - description: |-
      FileService uploads the files documents are created from.

       Authentication: X-API-Key. An upload belongs to the key's owner, and only
       their key can attach it to a document.

       Flow: CreateFileUpload reserves the file and returns a presigned POST form,
       the client sends the bytes straight to storage, ConfirmFileUpload marks the
       upload complete, and CreateDocument attaches it by id.
    name: FileService
  - description: IngestService accepts batches of external records into the tenant.
    name: IngestService
  - name: LoginService
  - description: |-
      WebhookService lets a tenant manage subscriptions to Developer API events.

       Authentication: X-API-Key with the webhooks:manage scope.
    name: WebhookService
paths:
  /developer/v1/ingest/{source_type}:
    post:
      tags:
        - IngestService
      summary: Ingest Records
      description: >-
        Accepts a batch of records for a given source and payload type and
        enqueues

        them for asynchronous processing. Returns an ingest request id to
        correlate

        the result.


        The Idempotency-Key header is required: re-sending a batch with the same

        key is rejected as a duplicate instead of creating a second load.


        Required scope: ingest:write (super-administrator keys only).
      operationId: IngestService_Ingest
      parameters:
        - description: 'External system the records come from: KEDO or 1C.'
          in: path
          name: source_type
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IngestRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngestResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: Default error response
components:
  schemas:
    IngestRequest:
      properties:
        create_missing:
          description: >-
            Create objects for records whose external_id is not known yet. When
            false,
             unknown records are skipped and only existing objects are updated.
          type: boolean
        payload_type:
          description: |-
            Record kind within the source, e.g. PERSONS, EMPLOYEES, DEPARTMENTS,
             ORGANIZATIONS, JOB_TITLES (KEDO) or EMPLOYEES_FULL, DEPARTMENTS (1C).
          type: string
        records:
          description: |-
            Records in the schema of the source/payload pair. Each carries an
             external_id — the object's identifier in the source system, used to match
             records to existing objects.
          items:
            type: object
          type: array
        source_type:
          description: 'External system the records come from: KEDO or 1C.'
          type: string
      required:
        - source_type
        - payload_type
        - records
      type: object
    IngestResponse:
      properties:
        ingest_request_id:
          description: Id of the accepted batch. Processing is asynchronous.
          readOnly: true
          type: string
        record_count:
          description: Number of records accepted for processing.
          format: int32
          readOnly: true
          type: integer
        status:
          description: Always ACCEPTED on a successful submit.
          readOnly: true
          type: string
      type: object
    Status:
      description: >-
        The `Status` type defines a logical error model that is suitable for
        different programming environments, including REST APIs and RPC APIs. It
        is used by [gRPC](https://github.com/grpc). Each `Status` message
        contains three pieces of data: error code, error message, and error
        details. You can find out more about this error model and how to work
        with it in the [API Design
        Guide](https://cloud.google.com/apis/design/errors).
      properties:
        code:
          description: >-
            The status code, which should be an enum value of
            [google.rpc.Code][google.rpc.Code].
          format: int32
          type: integer
        details:
          description: >-
            A list of messages that carry the error details.  There is a common
            set of message types for APIs to use.
          items:
            $ref: '#/components/schemas/GoogleProtobufAny'
          type: array
        message:
          description: >-
            A developer-facing error message, which should be in English. Any
            user-facing error message should be localized and sent in the
            [google.rpc.Status.details][google.rpc.Status.details] field, or
            localized by the client.
          type: string
      type: object
    GoogleProtobufAny:
      additionalProperties: true
      description: >-
        Contains an arbitrary serialized message along with a @type that
        describes the type of the serialized message.
      properties:
        '@type':
          description: The type of the serialized message.
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey

````