# AgriBackup

## Docs

- [AgriBackup Enterprise EUDR API Reference](https://docs.agribackup.com/api-reference/introduction.md): Complete reference for the AgriBackup REST API. Authenticate with a Bearer token, submit JSON requests, and receive JSON responses across all EUDR compliance endpoints.
- [Authentication: API Keys, Environments, and Errors](https://docs.agribackup.com/authentication.md): Authenticate every AgriBackup request with an API key. Understand live vs sandbox prefixes, base URL resolution, and handling auth errors.
- [Async Architecture: Jobs, Webhooks, and Idempotency](https://docs.agribackup.com/concepts/async-architecture.md): Learn why AgriBackup uses 202 Accepted responses, how to track jobs and consume webhooks, and when to use Idempotency-Key headers.
- [Cryptographic Evidence: Hedera Proofs and HMAC Signatures](https://docs.agribackup.com/concepts/cryptographic-evidence.md): Retrieve and verify Hedera DLT transaction IDs, Merkle state proofs, and HMAC signatures for batch, polygon, and shipment entities.
- [EUDR Compliance: Requirements and AgriBackup's Approach](https://docs.agribackup.com/concepts/eudr-compliance.md): Understand what the EU Deforestation Regulation requires from commodity importers and how AgriBackup satisfies each obligation programmatically.
- [Register a Consolidated EUDR Batch Programmatically](https://docs.agribackup.com/guides/batch-registration.md): Group COMPLIANT polygon IDs into an EUDR batch, trigger a Copernicus risk assessment, and manage the batch lifecycle through update and delete operations.
- [Generate and File a Due Diligence Statement to TRACES NT](https://docs.agribackup.com/guides/dds-generation.md): Upload land tenure documents, generate a TRACES NT-compliant DDS, submit it to the EU portal, retrieve the finalized XML payload, and revoke if needed.
- [Link an EUDR Batch to a Shipment via Bill of Lading](https://docs.agribackup.com/guides/logistics-linking.md): Lock a compliant EUDR batch to a shipment on the Hedera ledger using a Bill of Lading reference, and roll back the smart-contract link when needed.
- [Upload GeoJSON Polygons for Deforestation Screening](https://docs.agribackup.com/guides/polygon-ingestion.md): Submit GeoJSON farm polygons for satellite deforestation screening, poll the async job, and verify EUDR compliance status before linking them to a batch.
- [Set Up Webhooks to Receive EUDR Compliance Events](https://docs.agribackup.com/guides/webhooks-setup.md): Register an HTTPS endpoint, verify HMAC-SHA256 signatures, handle EUDR compliance events, rotate webhook secrets, and manage failed deliveries in the DLQ.
- [AgriBackup: Enterprise REST API for EUDR Compliance](https://docs.agribackup.com/introduction.md): AgriBackup automates EU Deforestation Regulation compliance—satellite polygon verification, Hedera DLT anchoring, and TRACES NT filing in one API.
- [Quickstart: Run the Full EUDR Compliance Lifecycle](https://docs.agribackup.com/quickstart.md): Install an AgriBackup SDK and execute all four compliance steps—polygon ingest, batch register, shipment link, and DDS filing—in minutes.
- [AgriBackup API Environments: Production and Sandbox](https://docs.agribackup.com/reference/environments.md): Learn how to switch between the AgriBackup production and sandbox environments, configure API keys, and avoid cross-environment mistakes.
- [AgriBackup API Error Codes and HTTP Status Reference](https://docs.agribackup.com/reference/error-codes.md): Decode every HTTP status code and error object the AgriBackup API returns, with handling guidance for each failure category.
- [AgriBackup EUDR API: Frequently Asked Questions (FAQ)](https://docs.agribackup.com/reference/faq.md): Answers to common questions about EUDR compliance, polygon verification, DDS filing, webhooks, and the AgriBackup API.
- [AgriBackup API Rate Limits, Headers, and Throttling](https://docs.agribackup.com/reference/rate-limits.md): Understand how AgriBackup enforces rate limits, read response headers to track your quota, and implement backoff strategies to stay within bounds.
- [Delete and Revoke an API Key](https://docs.agribackup.com/sdks/enterprise-api-keys/delete-an-api-key.md): Permanently revoke and delete an AgriBackup enterprise API key by ID. All requests using the deleted key will immediately fail with 401.
- [Generate a New API Key for Your Organization](https://docs.agribackup.com/sdks/enterprise-api-keys/generate-a-new-api-key.md): Create a scoped API key for your AgriBackup enterprise organization. The raw key value is returned exactly once — store it securely immediately.
- [List All API Keys for Your Organization](https://docs.agribackup.com/sdks/enterprise-api-keys/list-api-keys.md): Retrieve metadata for every active API key registered to your AgriBackup enterprise organization. Raw key values are never returned.
- [Rotate an Existing API Key](https://docs.agribackup.com/sdks/enterprise-api-keys/rotate-an-api-key.md): Invalidate an existing AgriBackup API key and issue a replacement with identical scopes. The new raw key is returned exactly once.
- [Download the Bulk Compliance Archive ZIP](https://docs.agribackup.com/sdks/enterprise-archival/download-bulk-archive-zip.md): Download the completed bulk compliance archive as a cryptographically sealed ZIP file once an archive generation job has finished processing.
- [Generate a Bulk Compliance Archive Report](https://docs.agribackup.com/sdks/enterprise-archival/generate-bulk-archive-report.md): Trigger an asynchronous job to compile all DDS XML payloads, Hedera state proofs, and land tenure document hashes into a single cryptographic ZIP archive.
- [Delete an EUDR Batch | AgriBackup API Reference](https://docs.agribackup.com/sdks/enterprise-batches/delete-an-eudr-batch.md): Permanently delete a registered EUDR batch by ID. Blocked if the batch is cryptographically linked to a shipment or TRACES NT submission.
- [Get EUDR Batch by ID | AgriBackup API Reference](https://docs.agribackup.com/sdks/enterprise-batches/get-batch-by-id.md): Fetch full details for a single EUDR batch including consolidated risk state, linked polygon IDs, and shipment reference IDs.
- [List EUDR Batches | AgriBackup API Reference](https://docs.agribackup.com/sdks/enterprise-batches/list-batches.md): Retrieve a cursor-paginated list of all registered EUDR batches for your organisation, with optional filtering by update timestamp.
- [Register Consolidated EUDR Batch Async | AgriBackup](https://docs.agribackup.com/sdks/enterprise-batches/register-a-consolidated-eudr-batch-async.md): Create a new EUDR batch linked to verified polygon IDs. Returns 202 Accepted with a jobId. Triggers Copernicus satellite risk assessment automatically.
- [Update an EUDR Batch | AgriBackup API Reference](https://docs.agribackup.com/sdks/enterprise-batches/update-an-eudr-batch.md): Partially update a registered EUDR batch — quantity, commodity description, HS code, or harvest date — before it is locked to a shipment or TRACES NT.
- [Receive a TRACES NT Clearance Status Webhook Event](https://docs.agribackup.com/sdks/enterprise-clearance-webhooks/receive-traces-nt-clearance-webhook.md): Inbound event from AgriBackup when TRACES NT posts a DDS clearance decision — validated, rejected, or pending — for a compliance declaration.
- [Check TRACES NT Credential Delegation Status](https://docs.agribackup.com/sdks/enterprise-credentials/check-traces-nt-credential-delegation-status.md): Verify that your stored TRACES NT credentials are valid and the connection to the EU TRACES NT SOAP API is active and ready for DDS submission.
- [Ingest TRACES NT Credentials into Vault](https://docs.agribackup.com/sdks/enterprise-credentials/ingest-traces-nt-credentials-into-vault.md): Securely store your TRACES NT API token or password in AgriBackup's HashiCorp Vault. Required before submitting Due Diligence Statements.
- [Revoke and Purge TRACES NT Credentials](https://docs.agribackup.com/sdks/enterprise-credentials/revoke-and-purge-traces-nt-credentials.md): Permanently delete your organization's TRACES NT credentials from AgriBackup's Vault, revoking DDS submission delegation immediately.
- [Generate a Due Diligence Statement (DDS)](https://docs.agribackup.com/sdks/enterprise-declarations/generate-due-diligence-statement-dds.md): Compile a TRACES NT-compliant Due Diligence Statement from a verified batch, embedding cryptographic land tenure proofs and batch provenance into the output XML.
- [List All Generated Due Diligence Statements](https://docs.agribackup.com/sdks/enterprise-declarations/list-generated-due-diligence-statements.md): Retrieve a paginated list of all Due Diligence Statements generated within your organization, including their current lifecycle status and TRACES NT references.
- [Retrieve the Finalized DDS XML Payload](https://docs.agribackup.com/sdks/enterprise-declarations/retrieve-finalized-dds-payload.md): Fetch the complete, finalized TRACES NT V3-compliant XML payload and Hedera consensus timestamp for a specific Due Diligence Statement by its reference ID.
- [Revoke a Submitted Due Diligence Statement](https://docs.agribackup.com/sdks/enterprise-declarations/revoke-a-submitted-dds.md): Permanently revoke a submitted DDS to invalidate an erroneous or superseded declaration, triggering a withdrawal notification to TRACES NT and locking the record.
- [Submit a DDS to TRACES NT for EU Clearance](https://docs.agribackup.com/sdks/enterprise-declarations/submit-dds-to-traces-nt.md): Transmit a generated Due Diligence Statement to the EU's TRACES NT system and receive an official submission reference number for border clearance tracking.
- [Upload a Legal Land Tenure Document](https://docs.agribackup.com/sdks/enterprise-declarations/upload-legal-land-tenure-document.md): Upload a legal land tenure document as multipart/form-data to generate a SHA-256 hash stored in the compliance vault and referenceable in DDS generation.
- [Check Infrastructure and Service Dependency Health](https://docs.agribackup.com/sdks/enterprise-diagnostics/check-infrastructure-and-service-dependency-health.md): Query the live operational status of the AgriBackup API and its critical dependencies: Hedera Hashgraph DLT, Copernicus Sentinel-2, and HashiCorp Vault.
- [Retrieve Batch Cryptographic Evidence](https://docs.agribackup.com/sdks/enterprise-evidence/retrieve-batch-cryptographic-evidence.md): Fetch Hedera DLT-anchored cryptographic evidence for a batch, including transaction IDs, consensus timestamp, Merkle root hash, and state proofs of inclusion.
- [Retrieve Polygon Cryptographic Evidence](https://docs.agribackup.com/sdks/enterprise-evidence/retrieve-polygon-cryptographic-evidence.md): Fetch Hedera DLT-anchored cryptographic evidence for a farm boundary polygon, including transaction IDs, consensus timestamp, Merkle root hash, and state proofs.
- [Retrieve Shipment Cryptographic Evidence](https://docs.agribackup.com/sdks/enterprise-evidence/retrieve-shipment-cryptographic-evidence.md): Fetch Hedera DLT-anchored cryptographic evidence for a shipment, proving the batch-to-shipment smart contract lock was executed and recorded on the public ledger.
- [Halt an In-Progress Asynchronous Ingestion Job](https://docs.agribackup.com/sdks/enterprise-jobs/halt-asynchronous-ingestion-processing.md): Immediately stop an in-progress asynchronous compliance job before it reaches a terminal state, preventing further satellite analysis or Hedera anchoring.
- [Retrieve Async Job Status and Compliance Metrics](https://docs.agribackup.com/sdks/enterprise-jobs/retrieve-job-status-and-metrics.md): Poll the status and real-time processing metrics of an asynchronous compliance job, including phase, record counts, Hedera transaction ID, and structured errors.
- [Link Batch to Shipment Async | AgriBackup EUDR](https://docs.agribackup.com/sdks/enterprise-logistics/cryptographically-link-a-batch-to-a-shipment-async.md): Invoke the Hedera smart contract to cryptographically lock a compliant EUDR batch to a logistics shipment. Returns 202 Accepted with a jobId.
- [Unlink Batch from Shipment EVM Rollback | AgriBackup](https://docs.agribackup.com/sdks/enterprise-logistics/unlink-a-batch-from-a-shipment-evm-rollback.md): Asynchronously roll back the Hedera smart contract lock to free a batch from a cancelled shipment. Returns 202 Accepted with a jobId.
- [Delete Polygon | AgriBackup EUDR API](https://docs.agribackup.com/sdks/enterprise-polygons/delete-polygon.md): Permanently delete a farm boundary polygon by ID. Deletion is blocked if the polygon is linked to an active batch or shipment on the Hedera ledger.
- [Get Polygon Compliance Status | AgriBackup](https://docs.agribackup.com/sdks/enterprise-polygons/get-polygon-compliance-status.md): Synchronously fetch the EUDR compliance status of a single polygon by ID before linking it to a shipment. Returns PENDING, COMPLIANT, or HIGH_RISK.
- [Ingest GeoJSON Polygons Async | AgriBackup](https://docs.agribackup.com/sdks/enterprise-polygons/ingest-geojson-polygons-async.md): Submit up to 5,000 GeoJSON farm-boundary polygons for satellite deforestation screening. Returns 202 Accepted with a jobId for async tracking.
- [List Verified Polygons | AgriBackup EUDR API](https://docs.agribackup.com/sdks/enterprise-polygons/list-verified-polygons.md): Retrieve a cursor-paginated list of your organisation's verified farm polygons, filterable by compliance status and last-updated timestamp.
- [Assess Deforestation Risk for a Coordinate Point](https://docs.agribackup.com/sdks/enterprise-risk-management/assess-risk-by-coordinate-pre-assessment.md): Run a pre-assessment EUDR risk check on a lat/lon coordinate using Sentinel-2 satellite analysis and Country Risk Matrix lookups.
- [Assess Deforestation Risk for a GeoJSON Polygon](https://docs.agribackup.com/sdks/enterprise-risk-management/assess-risk-by-polygon-pre-assessment.md): Run a pre-assessment EUDR risk check on a GeoJSON polygon using Country Risk Matrix lookups and Sentinel-2 satellite deforestation analysis.
- [Get a Specific Supplier Mapping by ID](https://docs.agribackup.com/sdks/enterprise-suppliers/get-supplier-mapping.md): Retrieve the full details of a single ERP vendor-to-EU Operator UUID mapping registered to your AgriBackup organization by its vendor ID.
- [List All Supplier Mappings for Your Organization](https://docs.agribackup.com/sdks/enterprise-suppliers/list-supplier-mappings.md): Retrieve all ERP vendor-to-EU Operator UUID mappings registered to your AgriBackup enterprise organization for EUDR supply chain traceability.
- [Register a New Supplier Mapping](https://docs.agribackup.com/sdks/enterprise-suppliers/register-supplier-mapping.md): Bind an internal ERP vendor ID to an official EU TRACES NT Operator UUID to enable EUDR supply chain traceability for that supplier.
- [Acknowledge and Permanently Delete a DLQ Message](https://docs.agribackup.com/sdks/enterprise-webhooks/acknowledge-and-delete-a-dlq-message.md): Permanently acknowledge and remove a single failed webhook payload from the Dead-Letter Queue after manual review or out-of-band remediation.
- [Acknowledge and Bulk Delete Multiple DLQ Messages](https://docs.agribackup.com/sdks/enterprise-webhooks/acknowledge-and-delete-multiple-dlq-messages.md): Bulk-acknowledge and permanently remove a set of failed webhook payloads from the Dead-Letter Queue after out-of-band remediation.
- [Permanently Delete an EUDR Webhook Registration](https://docs.agribackup.com/sdks/enterprise-webhooks/delete-a-webhook-registration.md): Permanently deregister a webhook endpoint. AgriBackup will stop delivering compliance events to the target URL immediately after deletion.
- [List Active Webhook Subscriptions and Endpoints](https://docs.agribackup.com/sdks/enterprise-webhooks/list-active-webhook-subscriptions.md): Retrieve all active webhook registrations for your organization. Signing secrets are redacted from all list responses for security.
- [Register a Webhook Endpoint for EUDR Compliance Events](https://docs.agribackup.com/sdks/enterprise-webhooks/register-webhook-endpoint.md): Register an enterprise HTTPS URL to receive signed, asynchronous EUDR compliance events such as shipment.linked, polygon.verified, and dds.validated.
- [Replay a Single Message from the EUDR Webhook DLQ](https://docs.agribackup.com/sdks/enterprise-webhooks/replay-a-dlq-message-to-the-primary-exchange.md): Re-enqueue a single permanently failed webhook payload for redelivery after resolving the endpoint availability issue that caused the original failure.
- [Bulk Replay Multiple Messages from the Webhook DLQ](https://docs.agribackup.com/sdks/enterprise-webhooks/replay-multiple-dlq-messages-to-the-primary-exchange.md): Re-enqueue a batch of permanently failed webhook payloads for redelivery by supplying a list of event IDs in a single bulk operation.
- [List Permanently Failed EUDR Webhook DLQ Payloads](https://docs.agribackup.com/sdks/enterprise-webhooks/retrieve-permanently-failed-webhook-payloads.md): Pull compliance event payloads that exhausted all delivery retry attempts from the Dead-Letter Queue for inspection and manual remediation.
- [Rotate the HMAC-SHA256 Signing Secret for a Webhook](https://docs.agribackup.com/sdks/enterprise-webhooks/rotate-webhook-secret.md): Regenerate the HMAC-SHA256 signing secret for a webhook subscription. The new secret is returned once and must be stored immediately.
- [Cryptographic Handshake Ping for Webhook Validation](https://docs.agribackup.com/sdks/enterprise-webhooks/webhook-cryptographic-handshake-ping.md): Deliver a signed webhook.ping test event to validate HMAC-SHA256 signature verification on a registered endpoint without triggering live compliance data.

## OpenAPI Specs

- [openapi](https://docs.agribackup.com/openapi.json)