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

# Get order batch job status

> The endpoint returns the state of a batch job and the outcome of every order in it.

While the job runs, `status` stays `pending` and `results` grows as orders are processed, so you can track progress. Once `status` is `completed`, every order has an entry in `results`: `created` for a new order, `existing` for one matched to an existing `order_number`, and `failed` with the validation errors for one that could not be created.



## OpenAPI

````yaml GET /v1/orders/batch/{id}/
openapi: 3.0.1
info:
  title: Truv API
  description: Truv API Documentation
  termsOfService: https://www.truv.com/legal/terms-of-use
  contact:
    email: support@truv.com
  version: v1
servers:
  - url: https://prod.truv.com
security:
  - ClientID: []
    AccessKey: []
tags:
  - name: Users
  - name: Bridge Token
  - name: Companies and Data Providers
  - name: Key Management
  - name: Account Links
  - name: Data Refresh
  - name: Customization Templates
  - name: Webhooks
  - name: Orders
  - name: Tasks
  - name: VOIE Reports
  - name: VOA Reports
  - name: Income Insights Reports
  - name: DDS Reports
  - name: Employment
  - name: Identity
  - name: Shifts
  - name: Pay Statements
  - name: Tax Documents
  - name: Parsed Documents
  - name: Reports
  - name: Uploaded Documents
  - name: Bank Accounts
  - name: Bank Statements
  - name: Deposit Switch Reports
  - name: Insurance Reports
  - name: Income Report
  - name: Scoring Attributes
  - name: Accounts
  - name: Transactions
  - name: Recurring Transactions
  - name: Document Collections
paths:
  /v1/orders/batch/{id}/:
    parameters:
      - name: id
        in: path
        required: true
        description: Batch job ID received from the POST request
        schema:
          type: string
        example: 9f2c1b7e4a3d4e8fa1b2c3d4e5f60718
    get:
      tags:
        - Orders
      summary: Get order batch job status
      description: >-
        The endpoint returns the state of a batch job and the outcome of every
        order in it.


        While the job runs, `status` stays `pending` and `results` grows as
        orders are processed, so you can track progress. Once `status` is
        `completed`, every order has an entry in `results`: `created` for a new
        order, `existing` for one matched to an existing `order_number`, and
        `failed` with the validation errors for one that could not be created.
      operationId: orders_batch_status
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderBatchJob'
        '401':
          description: HTTP 401 Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: HTTP 403 Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: HTTP 404 Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
components:
  schemas:
    OrderBatchJob:
      type: object
      properties:
        id:
          type: string
          description: Batch job ID. Use it to poll the job status.
          example: 9f2c1b7e4a3d4e8fa1b2c3d4e5f60718
        status:
          type: string
          description: >-
            `pending` while orders are still being created, then `completed`
            once every order has an outcome, or `failed` if the whole job could
            not run.
          enum:
            - pending
            - completed
            - failed
          example: completed
        order_count:
          type: integer
          description: Number of orders submitted in the request.
          example: 3
        created_count:
          type: integer
          description: >-
            Number of orders that are usable, counting both `created` and
            `existing`.
          example: 2
        failed_count:
          type: integer
          description: Number of orders that could not be created.
          example: 1
        results:
          type: array
          description: >-
            Outcome of each submitted order, matched to its position in the
            request.
          items:
            $ref: '#/components/schemas/OrderBatchResult'
        errors:
          type: array
          nullable: true
          description: >-
            Why the job as a whole could not run. Set only when `status` is
            `failed`, and `null` otherwise — errors for individual orders are in
            `results[].errors` instead.
          items:
            type: object
            properties:
              detail:
                type: array
                description: Messages describing the failure.
                items:
                  type: string
          example:
            - detail:
                - The batch could not be processed.
        created_at:
          type: string
          format: date-time
          description: Time the batch was accepted.
          example: '2026-08-10T09:14:22.881Z'
        updated_at:
          type: string
          format: date-time
          description: Time the batch was last updated.
          example: '2026-08-10T09:15:04.203Z'
    Error401:
      description: ''
      type: object
      properties:
        error:
          description: ''
          type: object
          properties:
            code:
              description: ''
              type: string
              example: authentication_failed
            message:
              description: ''
              type: string
              example: No such token
    Error403:
      description: ''
      type: object
      properties:
        error:
          description: ''
          type: object
          properties:
            code:
              description: ''
              type: string
              example: not_authenticated
            message:
              description: ''
              type: string
              example: Authentication credentials were not provided.
    Error404:
      description: ''
      type: object
      properties:
        detail:
          description: ''
          type: string
          example: Not Found.
    OrderBatchResult:
      type: object
      properties:
        index:
          type: integer
          description: Zero-based position of the order in the request.
          example: 0
        status:
          type: string
          description: >-
            `created` for a new order, `existing` when an order with the same
            `order_number` already existed, `failed` when the order could not be
            created.
          enum:
            - created
            - existing
            - failed
          example: created
        order_id:
          type: string
          nullable: true
          maxLength: 32
          description: ID of the created or existing order. Absent when the order failed.
          example: 39aa1486ccca4bc19cda071ffc1ba392
        order_number:
          type: string
          nullable: true
          maxLength: 512
          description: Your identifier for the order, if one was sent.
          example: CASE-001
        bridge_token:
          type: string
          nullable: true
          maxLength: 32
          description: Bridge token of the order.
          example: e4100fccdae94691b4414c7306220c06
        share_url:
          type: string
          nullable: true
          maxLength: 512
          description: Verification link to share with the applicant.
          example: >-
            https://cdn.truv.com/employment.html?bridge_token=e4100fccdae94691b4414c7306220c06
        short_share_url:
          type: string
          nullable: true
          maxLength: 512
          description: Shortened verification link to share with the applicant.
          example: https://truv.com/s/BIlEyh1A
        errors:
          type: object
          nullable: true
          description: >-
            Why this order could not be created, keyed by field. Set only when
            `status` is `failed`.
          example:
            last_name:
              - This field is required.
  securitySchemes:
    ClientID:
      type: apiKey
      description: Client ID
      name: X-Access-Client-Id
      in: header
    AccessKey:
      type: apiKey
      description: Client Access Key
      name: X-Access-Secret
      in: header

````