REST API reference

The API does what the checker does, for programs: an ERP that checks supplier files as they arrive, a pipeline that fixes and saves them, a script that files the statement. It runs the same rules, fixes and converter as the web checker, so a file comes out the same either way. The whole API is described in OpenAPI 3.1 at /api/v1/openapi.json; point a client generator at it.

Keys

Create a key in Settings → API and MCP (Team or Consultant plan). Send it on every request:

Authorization: Bearer eudr_…

A key works in one workspace, with the role of the member who created it: a viewer's key can read projects but not save them. If that member leaves the workspace, the key stops working. Only a hash of the key is stored; it is shown once, when you create it.

Limits

Each plan with the API has a number of requests a minute, counted per billing workspace, and the plan's monthly allowance of distinct plots, shared with saved projects and supplier uploads. A plot counts once a month however often you send it. Every response carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; a 429 also carries Retry-After. GET /me shows both allowances.

Sending files

The examples use $EUDR_API for the base URL at the top of the reference and $EUDR_KEY for your key. Send the file as the body, or as multipart/form-data when it has several parts (a shapefile's .shp, .dbf and .prj). Options go in the query string.

curl -H "Authorization: Bearer $EUDR_KEY" \
  --data-binary @plots.geojson \
  "$EUDR_API/validate?commodity=cocoa"

curl -H "Authorization: Bearer $EUDR_KEY" \
  -F file=@farms.shp -F file=@farms.dbf -F file=@farms.prj \
  $EUDR_API/convert

Largest file: 50 MB. A GeoJSON file compresses about tenfold, so send large ones gzip-compressed with Content-Encoding: gzip.

Files sent to /validate, /fix, /convert, /report and /forest are processed in memory and not stored. Nothing from them is logged. Only the project endpoints store a file, as a saved version. For files that must not leave your computer at all, use the command-line tool.

Errors

Every error has the same shape, with a stable code to branch on and a message to show a person:

{ "error": { "code": "crs_required", "message": "…", "details": { "crsCandidates": […] } }, "requestId": "…" }

Reference

Base URL: https://eudrplot.com/api/v1 · OpenAPI 3.1: openapi.json

Files

Stateless: the file is processed and not stored.

POST `/validate`

Check a file. Every problem the Information System would reject the file for, and the weaker points of its evidence, with how to fix each. Non-GeoJSON files are converted first.

Parameter	In	Description
`filename` optional	query	The file's name, when sending raw bytes; its extension tells the format. Default plots.geojson.
`commodity` optional	query	The commodity. Only cattle changes the result. One of: cattle, cocoa, coffee, oil-palm, rubber, soya, wood.
`crs` optional	query	The coordinate system when the file does not declare it, e.g. EPSG:32630.
`country` optional	query	ISO alpha-2 country of the plots, so unlabelled UTM can be recognised.
`features` optional	query	Include the per-plot table. Default true.

Body: The file: its raw bytes as the body (GeoJSON, KML, KMZ, GPX, CSV or a zipped shapefile), or multipart/form-data with one or more files (a shapefile's .shp, .dbf and .prj). Content-Encoding: gzip is accepted. Largest file: 50 MB decompressed.

Responses:

200 OK ValidationResult
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
413 The file is too large.
415 Not a file format the checker reads.
422 The file could not be converted (e.g. crs_required, with likely EPSG codes), or the Information System refused it.
423 The workspace is read-only: payment is overdue.
429 Rate limit reached; see Retry-After.

curl -X POST "https://eudrplot.com/api/v1/validate" \
  -H "Authorization: Bearer $EUDR_KEY" \
  --data-binary @plots.geojson

POST `/fix`

Fix a file. Applies the automatic fixes, re-checks, and returns the fixed GeoJSON with a change log of every change (hectares before and after for geometry). Fixes that change a plot's area need acceptGeometryChanges and never pass the area guard.

Parameter	In	Description
`filename` optional	query	The file's name, when sending raw bytes; its extension tells the format. Default plots.geojson.
`fixes` optional	query	Comma-separated fix ids. Default: every bulk-safe fix.
`acceptGeometryChanges` optional	query	Allow fixes that change a plot's measured area (within the 2% guard).
`commodity` optional	query	The commodity. Only cattle changes the result. One of: cattle, cocoa, coffee, oil-palm, rubber, soya, wood.
`crs` optional	query	The coordinate system when the file does not declare it, e.g. EPSG:32630.
`country` optional	query	ISO alpha-2 country of the plots, so unlabelled UTM can be recognised.
`output` optional	query	file: answer with the GeoJSON itself instead of JSON. One of: json, file.

Responses:

200 The fixed file and what was done, or with output=file the GeoJSON itself (X-Changes-Applied, X-Fixes-Skipped and X-Errors-Remaining headers). FixResult
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
413 The file is too large.
415 Not a file format the checker reads.
422 The file could not be converted (e.g. crs_required, with likely EPSG codes), or the Information System refused it.
423 The workspace is read-only: payment is overdue.
429 Rate limit reached; see Retry-After.

curl -X POST "https://eudrplot.com/api/v1/fix" \
  -H "Authorization: Bearer $EUDR_KEY" \
  --data-binary @plots.geojson

POST `/convert`

Convert to GeoJSON. KML, KMZ, GPX, CSV or a shapefile to GeoJSON in WGS 84 degrees, with every decision listed. A file whose coordinate system cannot be determined gets 422 crs_required with the likely EPSG codes in details.crsCandidates.

Parameter	In	Description
`filename` optional	query	The file's name, when sending raw bytes; its extension tells the format. Default plots.geojson.
`crs` optional	query	The coordinate system when the file does not declare it, e.g. EPSG:32630.
`country` optional	query	ISO alpha-2 country of the plots, so unlabelled UTM can be recognised.
`output` optional	query	file: answer with the GeoJSON itself instead of JSON. One of: json, file.

Responses:

200 The GeoJSON and the conversion notes, or with output=file the GeoJSON itself. ConvertResult
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
413 The file is too large.
415 Not a file format the checker reads.
422 The file could not be converted (e.g. crs_required, with likely EPSG codes), or the Information System refused it.
423 The workspace is read-only: payment is overdue.
429 Rate limit reached; see Retry-After.

curl -X POST "https://eudrplot.com/api/v1/convert" \
  -H "Authorization: Bearer $EUDR_KEY" \
  --data-binary @plots.geojson

POST `/report`

PDF report. The PDF validation report the checker produces, stamped with the file's SHA-256 and the rule-set version. Optionally after the safe fixes and with the forest section.

Parameter	In	Description
`filename` optional	query	The file's name, when sending raw bytes; its extension tells the format. Default plots.geojson.
`fix` optional	query	Apply the bulk-safe fixes first; the report includes the change log.
`forest` optional	query	Include forest cover in 2020 and tree cover loss since.
`commodity` optional	query	The commodity. Only cattle changes the result. One of: cattle, cocoa, coffee, oil-palm, rubber, soya, wood.
`crs` optional	query	The coordinate system when the file does not declare it, e.g. EPSG:32630.
`country` optional	query	ISO alpha-2 country of the plots, so unlabelled UTM can be recognised.

Responses:

200 The PDF. X-File-Sha256, X-Errors and X-Warnings headers.
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
413 The file is too large.
415 Not a file format the checker reads.
422 The file could not be converted (e.g. crs_required, with likely EPSG codes), or the Information System refused it.
423 The workspace is read-only: payment is overdue.
429 Rate limit reached; see Retry-After.
502 A service we depend on (a forest map, the Information System) did not answer.

curl -X POST "https://eudrplot.com/api/v1/report" \
  -H "Authorization: Bearer $EUDR_KEY" \
  --data-binary @plots.geojson

POST `/forest`

Forest cover 2020 and loss since. Per plot: the share that was forest on 31 December 2020 on the JRC's GFC2020 V4 map, and tree cover lost since 2021 on land that was forest in 2020 (Hansen GFC v1.13). Risk indicators for the operator's own assessment, not a verdict. Only fixed map squares are requested from the map servers.

Parameter	In	Description
`filename` optional	query	The file's name, when sending raw bytes; its extension tells the format. Default plots.geojson.
`crs` optional	query	The coordinate system when the file does not declare it, e.g. EPSG:32630.
`country` optional	query	ISO alpha-2 country of the plots, so unlabelled UTM can be recognised.

Responses:

200 OK ForestResult
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
413 The file is too large.
415 Not a file format the checker reads.
422 The file could not be converted (e.g. crs_required, with likely EPSG codes), or the Information System refused it.
423 The workspace is read-only: payment is overdue.
429 Rate limit reached; see Retry-After.
502 A service we depend on (a forest map, the Information System) did not answer.

curl -X POST "https://eudrplot.com/api/v1/forest" \
  -H "Authorization: Bearer $EUDR_KEY" \
  --data-binary @plots.geojson

Reference

Rules and fixes.

GET `/rules`

List the rules.

Responses:

200 OK object
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
429 Rate limit reached; see Retry-After.

curl "https://eudrplot.com/api/v1/rules" \
  -H "Authorization: Bearer $EUDR_KEY"

GET `/rules/{id}`

One rule, by id or slug.

Parameter	In	Description
`id`	path

Responses:

200 OK Rule
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
404 Not found in this workspace.
429 Rate limit reached; see Retry-After.

curl "https://eudrplot.com/api/v1/rules/PROJECT_ID" \
  -H "Authorization: Bearer $EUDR_KEY"

GET `/fixes`

List the automatic fixes.

Responses:

200 OK object
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
429 Rate limit reached; see Retry-After.

curl "https://eudrplot.com/api/v1/fixes" \
  -H "Authorization: Bearer $EUDR_KEY"

Projects

Saved files with version history.

GET `/projects`

List projects.

Responses:

200 OK object
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
429 Rate limit reached; see Retry-After.

curl "https://eudrplot.com/api/v1/projects" \
  -H "Authorization: Bearer $EUDR_KEY"

POST `/projects`

Create a project from a file. Saves the file as version 1 (converted to GeoJSON first if needed). Counts its plots toward the month's allowance.

Parameter	In	Description
`name` optional	query	Project name. Default: the file name.
`filename` optional	query	The file's name, when sending raw bytes; its extension tells the format. Default plots.geojson.
`crs` optional	query	The coordinate system when the file does not declare it, e.g. EPSG:32630.
`country` optional	query	ISO alpha-2 country of the plots, so unlabelled UTM can be recognised.

Responses:

201 Created object
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
413 The file is too large.
415 Not a file format the checker reads.
422 The file could not be converted (e.g. crs_required, with likely EPSG codes), or the Information System refused it.
423 The workspace is read-only: payment is overdue.
429 Rate limit reached; see Retry-After.

curl -X POST "https://eudrplot.com/api/v1/projects" \
  -H "Authorization: Bearer $EUDR_KEY" \
  --data-binary @plots.geojson

GET `/projects/{id}`

A project, its versions and statements.

Parameter	In	Description
`id`	path

Responses:

200 OK object
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
404 Not found in this workspace.
429 Rate limit reached; see Retry-After.

curl "https://eudrplot.com/api/v1/projects/PROJECT_ID" \
  -H "Authorization: Bearer $EUDR_KEY"

POST `/projects/{id}/versions`

Save a new version.

Parameter	In	Description
`id`	path
`filename` optional	query	The file's name, when sending raw bytes; its extension tells the format. Default plots.geojson.
`crs` optional	query	The coordinate system when the file does not declare it, e.g. EPSG:32630.
`country` optional	query	ISO alpha-2 country of the plots, so unlabelled UTM can be recognised.

Responses:

201 Created object
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
404 Not found in this workspace.
409 Nothing changed since the last version.
413 The file is too large.
415 Not a file format the checker reads.
422 The file could not be converted (e.g. crs_required, with likely EPSG codes), or the Information System refused it.
423 The workspace is read-only: payment is overdue.
429 Rate limit reached; see Retry-After.

curl -X POST "https://eudrplot.com/api/v1/projects/PROJECT_ID/versions" \
  -H "Authorization: Bearer $EUDR_KEY" \
  --data-binary @plots.geojson

GET `/projects/{id}/versions/{number}`

Download a version's file.

Parameter	In	Description
`id`	path
`number`	path	Version number, or current.

Responses:

200 The GeoJSON. X-Version and X-File-Sha256 headers.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
404 Not found in this workspace.
429 Rate limit reached; see Retry-After.

curl "https://eudrplot.com/api/v1/projects/PROJECT_ID/versions/current" \
  -H "Authorization: Bearer $EUDR_KEY"

Statements

Due diligence statements in the EU Information System.

GET `/projects/{id}/dds`

Statements filed from a project.

Parameter	In	Description
`id`	path

Responses:

200 OK object
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
404 Not found in this workspace.
429 Rate limit reached; see Retry-After.

curl "https://eudrplot.com/api/v1/projects/PROJECT_ID/dds" \
  -H "Authorization: Bearer $EUDR_KEY"

POST `/projects/{id}/dds`

File a due diligence statement. Files a statement with the EU Information System (TRACES) from the project's current version, through the workspace's connection (Settings → EU Information System). Plots are grouped into producers. Checked against the Commission's rules before anything is sent. Reference and verification numbers arrive later: poll GET /dds/{id}.

Parameter	In	Description
`id`	path

Body: StatementRequest

Responses:

201 Filed object
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
404 Not found in this workspace.
422 The file could not be converted (e.g. crs_required, with likely EPSG codes), or the Information System refused it.
423 The workspace is read-only: payment is overdue.
429 Rate limit reached; see Retry-After.
502 A service we depend on (a forest map, the Information System) did not answer.

curl -X POST "https://eudrplot.com/api/v1/projects/PROJECT_ID/dds" \
  -H "Authorization: Bearer $EUDR_KEY" \
  -H "Content-Type: application/json" \
  --data @statement.json

GET `/dds/{id}`

A statement and its status. Fetches the status from the Information System when allowed (30 minutes after filing, then every 5 minutes) and the statement still waits for its numbers, or with refresh=true.

Parameter	In	Description
`id`	path
`refresh` optional	query	Fetch the status even when the numbers are known.

Responses:

200 OK object
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
404 Not found in this workspace.
429 Rate limit reached; see Retry-After.
502 A service we depend on (a forest map, the Information System) did not answer.

curl "https://eudrplot.com/api/v1/dds/STATEMENT_ID" \
  -H "Authorization: Bearer $EUDR_KEY"

POST `/dds/{id}/withdraw`

Withdraw a statement (within 72 hours).

Parameter	In	Description
`id`	path

Responses:

200 OK object
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
404 Not found in this workspace.
422 The file could not be converted (e.g. crs_required, with likely EPSG codes), or the Information System refused it.
429 Rate limit reached; see Retry-After.
502 A service we depend on (a forest map, the Information System) did not answer.

curl -X POST "https://eudrplot.com/api/v1/dds/STATEMENT_ID/withdraw" \
  -H "Authorization: Bearer $EUDR_KEY"

Monitoring

Weekly deforestation alerts on monitored projects, grouped into events and scored: confirmed, likely, unconfirmed or not relevant.

GET `/projects/{id}/monitoring`

Whether a project is monitored.

Parameter	In	Description
`id`	path

Responses:

200 OK object
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
404 Not found in this workspace.
429 Rate limit reached; see Retry-After.

curl "https://eudrplot.com/api/v1/projects/PROJECT_ID/monitoring" \
  -H "Authorization: Bearer $EUDR_KEY"

PUT `/projects/{id}/monitoring`

Switch weekly monitoring on or off. On: the project's current version is checked within ten minutes, then every Monday from 04:00 UTC, and again whenever a new version is saved. Counts the version's plots against the plan's monitored plots.

Parameter	In	Description
`id`	path

Body: object

Responses:

200 OK object
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
404 Not found in this workspace.
423 The workspace is read-only: payment is overdue.
429 Rate limit reached; see Retry-After.

curl -X PUT "https://eudrplot.com/api/v1/projects/PROJECT_ID/monitoring" \
  -H "Authorization: Bearer $EUDR_KEY" \
  -H "Content-Type: application/json" \
  --data '{"on": true}'

GET `/alerts`

Deforestation alerts. One case per plot with alerts on 2020 forest. An alert is an indicator to review, not a finding of deforestation.

Parameter	In	Description
`status` optional	query	open (default: new and reviewing), all, set_aside, new, reviewing, dismissed or confirmed.
`project` optional	query	Only this project's alerts.

Responses:

200 OK object
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
429 Rate limit reached; see Retry-After.

curl "https://eudrplot.com/api/v1/alerts" \
  -H "Authorization: Bearer $EUDR_KEY"

GET `/alerts/{id}`

An alert and its history.

Parameter	In	Description
`id`	path

Responses:

200 OK object
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
404 Not found in this workspace.
429 Rate limit reached; see Retry-After.

curl "https://eudrplot.com/api/v1/alerts/ALERT_ID" \
  -H "Authorization: Bearer $EUDR_KEY"

POST `/alerts/{id}/status`

Record a review. reviewing, or dismissed or confirmed with a note saying what was looked at and found. The note is kept with the alert for five years.

Parameter	In	Description
`id`	path

Body: object

Responses:

200 OK object
400 Bad request: a wrong option or an unreadable body.
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
404 Not found in this workspace.
423 The workspace is read-only: payment is overdue.
429 Rate limit reached; see Retry-After.

curl -X POST "https://eudrplot.com/api/v1/alerts/ALERT_ID/status" \
  -H "Authorization: Bearer $EUDR_KEY" \
  -H "Content-Type: application/json" \
  --data '{"status": "dismissed", "note": "What you looked at and found"}'

Account

The key's workspace, plan and allowance.

GET `/me`

The key's workspace, plan and allowance.

Responses:

200 OK Me
401 The key is missing, wrong or revoked.
402 The plan does not include this, or the month's plot allowance would be exceeded.
429 Rate limit reached; see Retry-After.

curl "https://eudrplot.com/api/v1/me" \
  -H "Authorization: Bearer $EUDR_KEY"

Schemas

Error

Field Type Description

error

object

Field	Type	Description
`code`	string	Stable, machine-readable: invalid_key, plan_required, rate_limited, too_large, crs_required, not_found…
`message`	string	A sentence for a person.
`details` optional	object	Extra data for some codes, e.g. crsCandidates.

requestId string Quote it to support.

Severity

error: the Information System rejects the file. warning: a likely problem. info: advice.

string: error, warning, info

OffsetRange

object or null

Position

object or null

Diagnostic

Field	Type	Description
`ruleId`	string	Permanent rule id, e.g. GEOM-003.
`slug`	string	The rule's page: /errors/{slug}.
`severity`	Severity
`title`	string
`message`	string	Specific to this finding.
`whyItMatters`	string
`howToFix`	string
`fixable`	boolean	An automatic fix exists for the rule.
`fixId`	string or null
`featureIndex`	integer or null
`jsonPath`	string	JSON pointer to the offending value.
`offset`	OffsetRange
`position`	Position
`ringIndex` optional	integer or null
`vertexIndex` optional	integer or null
`location` optional	number[] or null
`sources`	string[]	Official sources, as ids from the rule reference.
`data`	object
`docsUrl` optional	string

Summary

Field	Type	Description
`errors`	integer
`warnings`	integer
`infos`	integer
`featureCount`	integer	Plots in the file.
`vertexCount`	integer
`byteSize`	integer
`variant`	string	Type I or Type II file (EUDR GeoJSON File Description). One of: type-i, type-ii, unknown.
`passes`	boolean	True when there is no error-severity finding.

Plot

Field	Type	Description
`index`	integer
`jsonPath` optional	string
`geometryType`	string or null
`producerName`	string or null
`producerCountry`	string or null
`productionPlace` optional	string or null
`declaredArea` optional	any	The Area property as found.
`computedAreaHa`	number or null
`bbox`	number[] or null
`vertexCount`	integer

Conversion

Field	Type	Description
`format`	string	Source format. One of: kml, kmz, gpx, csv, shapefile, geojson.
`featureCount`	integer
`crs`	object or null
`reprojected`	boolean
`notes`	object[]	Every decision the converter made.

ValidationResult

Field	Type	Description
`file`	string
`fileHash`	string	SHA-256 of the checked GeoJSON, hex.
`ruleSetVersion`	string
`checkedAt`	string (date-time)
`summary`	Summary
`diagnostics`	Diagnostic[]
`diagnosticsTruncated` optional	integer	How many findings were left out, when capped.
`features` optional	Plot[]	Per-plot table; omitted with features=false.
`conversion` optional	Conversion

ChangeLog

Field Type Description

generatedAt string (date-time)

ruleSetVersion string

sourceHash optional string

resultHash optional string

filename optional string

entries object[]

skipped object[] Fixes not applied, and why. Never silently dropped.

summary

object

Field	Type	Description
`changesApplied`	integer
`fixesSkipped`	integer
`plotsAffected`	integer
`areaChangeHa`	number	Net change in measured hectares.

FixResult

Field	Type	Description
`changed`	boolean
`changeLog`	ChangeLog
`after`	ValidationResult
`conversion` optional	Conversion
`text`	string	The fixed GeoJSON.

ConvertResult

Field	Type	Description
`conversion`	Conversion or null
`text`	string	GeoJSON in WGS 84 degrees.

Rule

Field	Type	Description
`id`	string
`slug`	string
`severity`	Severity
`category`	string	One of: file, structure, coordinates, geometry, properties, plausibility.
`title`	string
`whyItMatters`	string
`howToFix`	string
`fixable`	boolean
`fixAltersGeometry` optional	boolean
`sources`	string[]
`specVersion` optional	string
`lastVerified` optional	string (date)
`docsUrl` optional	string

Fix

Field	Type	Description
`id`	string
`title`	string
`description`	string
`kind`	string	One of: patch.
`bulkSafe`	boolean	Applied by default.
`altersGeometry`	boolean
`areaPromise`	string	What the fix promises about area; the guard enforces it. One of: none, unchanged, expected, review.
`ruleIds`	string[]

Dataset

Field	Type	Description
`name`	string
`version`	string
`doi`	string
`licence`	string
`citation`	string
`url`	string

ForestResult

Field Type Description

file optional string

checkedAt optional string (date-time)

dataset Dataset

lossDataset optional Dataset

indicator string

reviewShare number Forest share at or above which a plot is flagged for review.

summary

object

Field	Type	Description
`plots`	integer
`checked`	integer
`none`	integer
`low`	integer
`review`	integer
`notChecked`	integer
`forestHa`	number
`sampledHa`	number

loss optional

object

Field	Type	Description
`checked`	integer
`none` optional	integer
`low` optional	integer
`review`	integer	Plots that lost at least reviewHa of 2020 forest since 2021.
`lossHa` optional	number
`forestLossHa`	number
`byYear`	object
`notChecked` optional	integer
`tiles` optional	integer
`reviewHa`	number

plots object[]

Project

Field	Type	Description
`id`	string
`name`	string
`currentVersion`	integer
`plotCount` optional	integer or null
`errorCount` optional	integer or null
`warningCount` optional	integer or null
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Version

Field	Type	Description
`number`	integer
`filename`	string
`sha256`	string
`byteSize`	integer
`plotCount`	integer
`errorCount`	integer
`warningCount`	integer
`ruleSetVersion`	string
`note`	string
`createdAt`	string (date-time)

Statement

Field	Type	Description
`id`	string
`projectId` optional	string or null
`projectName`	string
`versionNumber`	integer
`environment`	string	One of: acceptance, production.
`uuid`	string	Assigned by the Information System.
`internalReference` optional	string or null
`referenceNumber` optional	string or null
`verificationNumber` optional	string or null
`status`	string	EudrStatusType: SUBMITTED, AVAILABLE, REJECTED, WITHDRAWN, ARCHIVED, GROUPED, OBSOLETE.
`rejectionReason` optional	string or null
`activityType` optional	string	One of: IMPORT, EXPORT, DOMESTIC.
`summary` optional	object
`submittedAt`	string (date-time)
`statusCheckedAt` optional	string (date-time) or null
`nextStatusCheckAt` optional	string (date-time) or null
`withdrawnAt` optional	string (date-time) or null

StatementRequest

Field Type Description

confirm true Confirms that you file this statement as the operator or trader, or for them, and that due diligence was exercised (Regulation (EU) 2023/1115, Art. 4(2) and 4(3)).

activityType string One of: IMPORT, EXPORT, DOMESTIC.

operatorRole optional string One of: OPERATOR, REPRESENTATIVE_OPERATOR.

representedOperator optional

object

With REPRESENTATIVE_OPERATOR: the operator you file for.

Field	Type	Description
`name`	string
`identifierType`	string
`identifierValue`	string
`eori` optional	string
`country`	string
`street` optional	string
`postalCode` optional	string
`city` optional	string
`email` optional	string
`phone` optional	string

countryOfActivity optional string EU Member State, ISO alpha-2.

borderCrossCountry optional string EU Member State of entry or exit (import and export).

internalReference optional string

comment optional string

geoLocationConfidential optional boolean

commodities object[] At most 100.

Me

Field Type Description

workspace

object

Field	Type	Description
`id`	string
`name`	string

key

object

Field	Type	Description
`id`	string
`name`	string
`prefix`	string

role string One of: owner, admin, member, viewer.

plan

object

Field	Type	Description
`id`	string
`name`	string
`readOnly`	boolean

usage

object

Field	Type	Description
`month`	string	YYYY-MM
`plots`	integer	Distinct plots metered this month.
`plotLimit`	integer or null

rateLimit

object

Field	Type	Description
`perMinute`	integer
`remaining`	integer
`resetSeconds`	integer

AlertStatus

new: not looked at. reviewing: someone is on it. dismissed: not deforestation after 2020, with the reason. confirmed: deforestation after 2020 on the plot.

string: new, reviewing, dismissed, confirmed

AlertConfidence

How sure the evidence makes us, apart from a person's review. confirmed: two or more independent sources agree, or Sentinel-2 or Sentinel-1 imagery shows the clearing. likely: one source with high confidence that has held, no clear image yet. unconfirmed: one low-confidence source, or the imagery shows no change. not_relevant: set aside (before the cut-off, not forest in 2020, minor, or along the plot's edge). Only confirmed and likely are emailed and sent to webhooks.

string: confirmed, likely, unconfirmed, not_relevant

AlertImageryCheck

Field	Type	Description
`verdict`	string	drop: the clearing shows inside while the land around is stable. no_change: it does not, or everything changed alike. unclear: no clear image yet. One of: drop, no_change, unclear.
`before`	object or null
`after`	object[]

AlertSystem

radd: RADD (WUR), Sentinel-1 radar, 10 m. glads2: GLAD-S2 (UMD), Sentinel-2, 10 m. dist: DIST-ALERT (UMD, NASA), Landsat and Sentinel-2, 30 m.

string: radd, glads2, dist

Alert

Field	Type	Description
`id`	string
`projectId`	string
`projectName`	string
`supplier`	object or null
`version`	integer	The project version the plot was last checked in.
`plot`	integer	1-based plot number in that version.
`place`	string or null
`producer`	string or null
`status`	AlertStatus
`statusNote`	string or null
`statusAt`	string (date-time) or null
`system`	AlertSystem
`systems`	AlertSystem[]	Every system that watches part of the plot, in order of preference (RADD, GLAD-S2, DIST-ALERT).
`forestAlertHa`	number	Alerts after 2020 on land the JRC mapped as forest in 2020, hectares.
`highConfidenceHa`	number	Of those, high confidence.
`alertHa`	number	All alerts after 2020 inside the plot, hectares.
`sampledHa`	number
`firstDate`	string (date)	Earliest alert on 2020 forest.
`lastDate`	string (date)	Latest alert on 2020 forest.
`center`	number[]	[longitude, latitude] of the alerts on 2020 forest.
`bbox`	number[]	[west, south, east, north] of the alerts on 2020 forest.
`reopenedAt`	string (date-time) or null
`firstSeenAt`	string (date-time)
`lastSeenAt`	string (date-time)
`confidence`	AlertConfidence
`events`	object[]	The plot's alerts grouped into events, each with its evidence. NDVI for optical, VH backscatter in dB for radar; inside the event and in a ring of land around it.
`images`	object or null

AlertEvent

Field	Type	Description
`kind`	string	detected, grew (newer alerts), reopened, status (a person's review), or confidence (the evidence changed the confidence). One of: detected, grew, reopened, status, confidence.
`status`	AlertStatus or null
`note`	string or null
`by`	string or null
`forestAlertHa`	number or null
`lastDate`	string or null
`at`	string (date-time)

Monitoring

Field	Type	Description
`on`	boolean
`enabledAt`	string (date-time) or null
`checkedVersion`	integer or null
`checkedAt`	string (date-time) or null
`pausedReason`	string or null
`pending`	boolean	A check is queued.
`openAlerts`	integer

MonitoringUsage

Field	Type	Description
`used`	integer	Plots watched across the workspace and its client workspaces.
`limit`	integer or null

Keys

Limits

Sending files

Errors

Reference

Files

POST /validate

POST /fix

POST /convert

POST /report

POST /forest

Reference

GET /rules

GET /rules/{id}

GET /fixes

Projects

GET /projects

POST /projects

GET /projects/{id}

POST /projects/{id}/versions

GET /projects/{id}/versions/{number}

Statements

GET /projects/{id}/dds

POST /projects/{id}/dds

GET /dds/{id}

POST /dds/{id}/withdraw

Monitoring

GET /projects/{id}/monitoring

PUT /projects/{id}/monitoring

GET /alerts

GET /alerts/{id}

POST /alerts/{id}/status

Account

GET /me

Schemas

Error

Severity

OffsetRange

Position

Diagnostic

Summary

Plot

Conversion

ValidationResult

ChangeLog

FixResult

ConvertResult

Rule

Fix

Dataset

ForestResult

Project

Version

Statement

StatementRequest

Me

AlertStatus

AlertConfidence

AlertImageryCheck

AlertSystem

Alert

AlertEvent

Monitoring

MonitoringUsage

Related

See also

POST `/validate`

POST `/fix`

POST `/convert`

POST `/report`

POST `/forest`

GET `/rules`

GET `/rules/{id}`

GET `/fixes`

GET `/projects`

POST `/projects`

GET `/projects/{id}`

POST `/projects/{id}/versions`

GET `/projects/{id}/versions/{number}`

GET `/projects/{id}/dds`

POST `/projects/{id}/dds`

GET `/dds/{id}`

POST `/dds/{id}/withdraw`

GET `/projects/{id}/monitoring`

PUT `/projects/{id}/monitoring`

GET `/alerts`

GET `/alerts/{id}`

POST `/alerts/{id}/status`

GET `/me`