Skip to main content
POST
Validate Plot Geometry

Autorisierungen

Authorization
string
header
erforderlich

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Body

application/json

Fields read from the request body. Anything else — including server-owned fields such as id, analysisStatus, analysisResult, deforestationRiskResult, forestPercentage, isDegraded, imageWidth, imageHeight, pixelCoords, createdAt and updatedAt — is ignored.

geojson
object
erforderlich

Required. Plot geometry as GeoJSON: a Feature or a bare Geometry of type Polygon, MultiPolygon, Point or MultiPoint, in WGS84 longitude/latitude. A missing geometry is 400 with code: plot_geometry_missing; any other type (FeatureCollection, GeometryCollection, LineString, MultiLineString, …) is 400 with code: plot_geometry_type_unsupported — one request creates one plot, so send each feature of a collection as its own request. Coordinates outside longitude ±180 / latitude ±90 are rejected with 400, as is a geometry above the intake limits. A point is only accepted up to 4 ha (20,000 ha for cattle) when size is given; above that EUDR requires a polygon. Part of the duplicate check.

name
string

Plot name. Part of the duplicate check (case and surrounding/multiple whitespace are ignored).

country
string

Country of production, ISO 3166-1 alpha-2 (e.g. BR). Part of the duplicate check.

size
number

Area in hectares. Must be a finite number ≥ 0, otherwise 400.

Erforderlicher Bereich: x >= 0
commodityGroup
enum<string>

EUDR-regulated commodity groups. non_relevant = article is not covered by EUDR.

Verfügbare Optionen:
cattle,
cocoa,
coffee,
oil_palm,
rubber,
soya,
wood,
non_relevant
species
object[]

Tree species. Each entry needs both a common and a scientific name, otherwise 400. Required (at least one scientific name) when commodityGroup is wood.

Maximum array length: 500
scientificName
string

Legacy single-species shorthand, used only when species is empty. Prefer species.

producerName
string

Name of the producer.

productionDateFrom
string<date>

Start of the production period (YYYY-MM-DD).

productionDateTo
string<date>

End of the production period (YYYY-MM-DD).

supplierArticleIds
string<uuid>[]

Supplier articles to link the plot to on creation (optional; duplicates are collapsed). Every id must belong to your company, otherwise 403. Part of the duplicate check: the same plot with a different set of links is a new plot. If commodityGroup is missing or non_relevant, it is derived from the linked articles. Without links, commodityGroup is required (400, code: plot_commodity_group_required); a value outside the enum is 400 with code: plot_commodity_group_invalid.

Maximum array length: 5000

Antwort

The verdict create would give; nothing written

The verdict POST /api/v1/plots would give for the same request. Nothing is written.

valid
boolean
erforderlich

true when create would accept the plot; false when it would answer 400.

errors
object[]
erforderlich

Why create would refuse: code (the code create answers, e.g. plot_geometry_invalid, plot_geometry_self_intersection_unrepairable, plot_geometry_too_many_vertices, plot_precision_too_low) and message. [] when valid is true.

warnings
object[]
erforderlich

What the geometry quality checks changed or noted, as on create.

precision
object | null
erforderlich

digits: the fewest decimal places of any longitude/latitude, counted as written; class: ok (6 or more), borderline (5), low (4) or reject (3 or fewer). null when a check refused the request before the precision was measured.

geometry
object | null
erforderlich

The geometry create would store (rounded, cleaned and repaired). null when valid is false.

measuredAreaHa
number | null
erforderlich

Geodesic area of geometry in hectares, rounded to 2 decimals. null for a point or when valid is false.