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

# Get EUDR Batch by ID | AgriBackup API Reference

> Fetch full details for a single EUDR batch including consolidated risk state, linked polygon IDs, and shipment reference IDs.

Returns the full detail record for a single EUDR batch, including its consolidated Copernicus risk state, lifecycle status, all linked polygon IDs, and any shipment reference IDs assigned via the Logistics endpoints. Use this endpoint to confirm a batch is `COMPLIANT` and ready for shipment linking, or to retrieve shipment associations for audit purposes.

## Request Headers

| Header      | Required | Description                            |
| ----------- | -------- | -------------------------------------- |
| `X-API-Key` | ✅        | Your live API key, e.g. `sk_live_...`. |

## Path Parameters

| Parameter | Type   | Required | Description                                                                |
| --------- | ------ | -------- | -------------------------------------------------------------------------- |
| `batchId` | string | ✅        | The unique batch identifier (UUID) returned when the batch was registered. |

## Response — 200 OK

| Field                   | Type             | Description                                                                          |
| ----------------------- | ---------------- | ------------------------------------------------------------------------------------ |
| `batchId`               | string           | Unique internal batch identifier (UUID).                                             |
| `batchCode`             | string           | Human-readable compliance code, e.g. `COFFEE-KEN-20260612-ABCDEF`.                   |
| `consolidatedRiskState` | string           | Aggregate risk state: `PENDING_RISK_ASSESSMENT`, `NONE`, `LOW`, `MEDIUM`, or `HIGH`. |
| `status`                | string           | Batch lifecycle status (e.g. `CREATED`).                                             |
| `polygonIds`            | array of strings | IDs of all farm polygons contributing to this batch.                                 |
| `shipmentIds`           | array of strings | Shipment reference IDs linked to this batch via the Logistics API.                   |

```json theme={null}
{
  "batchId": "uuid-1234",
  "batchCode": "COFFEE-KEN-20260612-ABCDEF",
  "consolidatedRiskState": "LOW",
  "status": "CREATED",
  "polygonIds": ["uuid-polygon-1", "uuid-polygon-2"],
  "shipmentIds": ["SHIP-OOCL-9988"]
}
```

## Error Responses

| Status | Meaning                                                     |
| ------ | ----------------------------------------------------------- |
| `403`  | Your API key does not have permission to access this batch. |
| `404`  | No batch found with the given `batchId`.                    |

## Code Examples

<CodeGroup>
  ```python Python theme={null}
  import agribackup
  from agribackup.rest import ApiException

  configuration = agribackup.Configuration(host="https://live.agribackup.com/api/v1")
  configuration.api_key['ApiKeyAuth'] = 'sk_live_YOUR_API_KEY'

  with agribackup.ApiClient(configuration) as api_client:
      try:
          api_instance = agribackup.EnterpriseBatchesApi(api_client)
          response = api_instance.get_batch_by_id(batch_id='uuid-1234')

          print("Batch Code:", response.batch_code)
          print("Risk State:", response.consolidated_risk_state)
          print("Polygon IDs:", response.polygon_ids)
          print("Shipment IDs:", response.shipment_ids)
      except ApiException as e:
          print("Error:", e)
  ```

  ```javascript Node.js theme={null}
  import { AgriBackupClient } from '@agribackup/sdk';

  const client = new AgriBackupClient({
    apiKey: 'sk_live_YOUR_API_KEY',
    baseUrl: 'https://live.agribackup.com/api/v1'
  });

  async function getBatch(batchId) {
    try {
      const response = await client.batches.getBatchById({ batchId });
      console.log('Batch Code:', response.batchCode);
      console.log('Risk State:', response.consolidatedRiskState);
      console.log('Polygon IDs:', response.polygonIds);
      console.log('Shipment IDs:', response.shipmentIds);
    } catch (error) {
      console.error('Error:', error.message);
    }
  }

  getBatch('uuid-1234');
  ```

  ```bash cURL theme={null}
  curl https://live.agribackup.com/api/v1/enterprise/eudr/batches/uuid-1234 \
    -H "X-API-Key: sk_live_YOUR_API_KEY"
  ```
</CodeGroup>


## OpenAPI

````yaml get /api/v1/enterprise/eudr/batches/{batchId}
openapi: 3.0.1
info:
  title: AgriBackup Enterprise EUDR API
  description: >-
    # Introduction


    AgriBackup is the cryptographic compliance engine for EU-bound commodity
    imports. Built on Deterministic Logic, Immutable Evidence, and
    High-Throughput Ingestion, our API provides Tier-1 enterprise routing for EU
    Deforestation Regulation (EUDR).


    ## The Integration Vector

    To integrate this Digital Trust Layer into your ERP, you must execute the
    following sequence:

    1. **Authentication:** Generate your `X-API-Key` from the client dashboard.

    2. **Telemetry:** Register your webhook URLs via `POST /webhooks`.

    3. **Ingestion:** Push your GeoJSON polygons via `POST /polygons`.

    4. **Logistics:** Lock the batch to a shipment via `POST /shipments/link`.


    ## Asynchronous Architecture

    Because satellite deforestation screening and Hedera DLT anchoring take
    time, ingestion endpoints return a `202 Accepted`. You must listen for the
    corresponding Webhook to confirm cryptographic execution.


    ## Base URLs

    * **Production:** `https://live.agribackup.com`

    * **Sandbox:** `https://sandbox.agribackup.com`
  contact:
    name: AgriBackup Architecture Team
    url: https://agribackup.com
    email: contact@agribackup.com
  license:
    name: Proprietary
    url: https://agribackup.com/terms
  version: v1.0
servers:
  - url: https://live.agribackup.com
    description: Production (Mainnet)
  - url: https://sandbox.agribackup.com
    description: Sandbox (Testnet)
security: []
tags:
  - name: Enterprise Risk Management
  - name: Enterprise Clearance Webhooks
    description: Asynchronous status receivers for TRACES NT
  - name: Enterprise Jobs
    description: Query status and metrics of asynchronous compliance jobs
  - name: Enterprise Suppliers
  - name: Enterprise Diagnostics
    description: Monitor API health, consensus ledger, and satellite systems availability
  - name: Enterprise Suppliers
    description: Map internal ERP vendor IDs to EU Operator UUIDs
  - name: Enterprise Webhooks
    description: Register endpoints for asynchronous compliance events
  - name: Enterprise Archival
    description: Endpoints for bulk compliance archiving and auditor extensibility
  - name: Enterprise Logistics
    description: Smart contract linking of batches to logistics shipments
  - name: Enterprise Declarations
    description: DDS generation with legal land tenure proofs
  - name: Enterprise Batches
  - name: Enterprise API Keys
  - name: Enterprise Diagnostics
  - name: Enterprise Logistics
  - name: Enterprise Jobs
  - name: Enterprise Evidence
    description: Cryptographic evidence ledger anchored on Hedera Hashgraph
  - name: Enterprise Declarations
  - name: Enterprise Credentials
  - name: Enterprise Evidence
  - name: Enterprise Risk Management
    description: Pre-assessment of country risk and satellite deforestation probabilities
  - name: Enterprise Batches
    description: Programmatic batch ingestion and management
  - name: Enterprise Polygons
  - name: Introduction
  - name: Enterprise Polygons
    description: Programmatic polygon ingestion and verification
  - name: Enterprise Archival
  - name: Enterprise Credentials
    description: Programmatic ingestion of vault-secured enterprise secrets
  - name: Enterprise API Keys
    description: Endpoints for managing B2B API Keys (Requires standard JWT login)
  - name: Enterprise Webhooks
paths:
  /api/v1/enterprise/eudr/batches/{batchId}:
    get:
      tags:
        - Enterprise Batches
      summary: Get batch by ID
      description: >-
        Returns the consolidated risk state and linked shipment IDs for a single
        EUDR batch.
      operationId: getBatchById
      parameters:
        - name: batchId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Batch details retrieved successfully
          headers:
            X-RateLimit-Limit:
              description: >-
                The maximum number of requests you're permitted to make per
                hour.
              schema:
                type: integer
                format: int32
            X-RateLimit-Remaining:
              description: >-
                The number of requests remaining in the current rate limit
                window.
              schema:
                type: integer
                format: int32
            X-RateLimit-Reset:
              description: >-
                The time at which the current rate limit window resets in UTC
                epoch seconds.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDetailResponse'
        '403':
          description: Forbidden
          headers:
            X-RateLimit-Limit:
              description: >-
                The maximum number of requests you're permitted to make per
                hour.
              schema:
                type: integer
                format: int32
            X-RateLimit-Remaining:
              description: >-
                The number of requests remaining in the current rate limit
                window.
              schema:
                type: integer
                format: int32
            X-RateLimit-Reset:
              description: >-
                The time at which the current rate limit window resets in UTC
                epoch seconds.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Batch not found
          headers:
            X-RateLimit-Limit:
              description: >-
                The maximum number of requests you're permitted to make per
                hour.
              schema:
                type: integer
                format: int32
            X-RateLimit-Remaining:
              description: >-
                The number of requests remaining in the current rate limit
                window.
              schema:
                type: integer
                format: int32
            X-RateLimit-Reset:
              description: >-
                The time at which the current rate limit window resets in UTC
                epoch seconds.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: Python
          source: >-
            import agribackup

            from agribackup.rest import ApiException


            # Initialize Client

            configuration =
            agribackup.Configuration(host="https://live.agribackup.com/api/v1")

            configuration.api_key['ApiKeyAuth'] = 'sk_live_YOUR_API_KEY'


            with agribackup.ApiClient(configuration) as api_client:
                try:
                    api_instance = agribackup.EnterpriseBatchesApi(api_client)
                    response = api_instance.get_batch_by_id()
                    print(response)
                except ApiException as e:
                    print("Exception when calling API: %s\n" % e)
        - lang: Node.js
          source: |-
            import { AgriBackupClient } from '@agribackup/sdk';

            // Initialize Client
            const client = new AgriBackupClient({
              apiKey: 'sk_live_YOUR_API_KEY',
              baseUrl: 'https://live.agribackup.com/api/v1'
            });

            async function execute() {
              try {
                const response = await client.batches.getBatchById();
                console.log(response);
              } catch (error) {
                console.error(error);
              }
            }
        - lang: Java
          source: |-
            import com.agribackup.client.*;
            import com.agribackup.client.api.*;
            import com.agribackup.client.model.*;

            public class Example {
                public static void main(String[] args) {
                    ApiClient defaultClient = Configuration.getDefaultApiClient();
                    defaultClient.setBasePath("https://live.agribackup.com/api/v1");
                    defaultClient.setApiKey("sk_live_YOUR_API_KEY");

                    EnterpriseBatchesApi apiInstance = new EnterpriseBatchesApi(defaultClient);
                    try {
                        Object result = apiInstance.getBatchById();
                        System.out.println(result);
                    } catch (ApiException e) {
                        System.err.println("Exception when calling API: " + e.getResponseBody());
                    }
                }
            }
        - lang: C#
          source: |-
            using System;
            using System.Threading.Tasks;
            using AgriBackup.SDK.Api;
            using AgriBackup.SDK.Client;
            using AgriBackup.SDK.Model;

            class Program {
                static async Task Main() {
                    Configuration config = new Configuration();
                    config.BasePath = "https://live.agribackup.com/api/v1";
                    config.AddApiKey("ApiKeyAuth", "sk_live_YOUR_API_KEY");

                    var apiInstance = new EnterpriseBatchesApi(config);
                    try {
                        var result = await apiInstance.GetBatchByIdAsync();
                        Console.WriteLine(result);
                    } catch (ApiException e) {
                        Console.WriteLine("Exception when calling API: " + e.Message);
                    }
                }
            }
components:
  schemas:
    BatchDetailResponse:
      required:
        - batchCode
        - batchId
        - consolidatedRiskState
        - polygonIds
        - shipmentIds
        - status
      type: object
      properties:
        batchId:
          type: string
          description: Internal database ID of the batch
          example: uuid-1234
        batchCode:
          type: string
          description: Unique compliance code for this batch
          example: COFFEE-KEN-20260612-ABCDEF
        consolidatedRiskState:
          type: string
          description: Consolidated deterministic risk state
          example: COMPLIANT
          enum:
            - PENDING_RISK_ASSESSMENT
            - NONE
            - LOW
            - MEDIUM
            - HIGH
        status:
          type: string
          description: Batch lifecycle status
          example: CREATED
        shipmentIds:
          type: array
          description: Linked shipment reference IDs
          items:
            type: string
            description: Linked shipment reference IDs
        polygonIds:
          type: array
          description: Polygon IDs contributing to this batch
          items:
            type: string
            description: Polygon IDs contributing to this batch
      description: Detailed view of a single EUDR batch
    ApiError:
      required:
        - code
        - details
        - message
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: VALIDATION_FAILED
        message:
          type: string
          description: Human-readable error message
          example: Invalid polygon coordinates
        details:
          type: array
          description: Detailed list of validation errors, if applicable
          items:
            $ref: '#/components/schemas/ApiErrorDetail'
      description: Standard error format for all Enterprise API failures
    ApiErrorDetail:
      required:
        - code
        - field
        - issue
      type: object
      properties:
        code:
          type: string
          description: Programmatic error code for automated branch logic
          example: INVALID_COORDINATE_CLOSURE
        field:
          type: string
          description: The field or property that caused the error
          example: features[0].properties.area
        issue:
          type: string
          description: A description of the issue with the field
          example: Area must be specified in hectares and cannot be negative
      description: Detailed error information for a specific field
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: Enterprise API Key provided via the AgriBackup developer console.
      name: X-API-Key
      in: header

````