# The Panspectra EUDR API The API lets your own systems do what your people do in the Panspectra app: send plots to be checked for deforestation, read each result, ask your suppliers what a result asks of them, record your conclusion with the evidence it rests on, and file due diligence statements in the EU Information System (TRACES). It answers at `https://eudr-api.panspectra.com/v1/`, in JSON. Its description in OpenAPI is at [`/openapi.json`](https://eudr-api.panspectra.com/openapi.json), and this guide in Markdown, for the AI tools you may write code with, is at [`/llms.txt`](https://eudr-api.panspectra.com/llms.txt). ## A first integration, on a sandbox A sandbox organisation is one we make for you to try the API on. Its keys begin `eudr_test_`. Its plots are checked on made-up imagery in a minute or two, cost nothing, and are never counted against a plan; every page of their reports says that it is a sandbox's, and the page that checks a report's code knows none of them. Its statements are filed at once with numbers of their own (`SANDBOX-…`), never in TRACES. In the app, its questions to suppliers go to its own people alone, who answer them as a supplier would. Ask us for one at support@panspectra.com. Its admin makes its keys in the app, on the organisation's page. Every request names the key in the `Authorization` header: ``` Authorization: Bearer eudr_test_… ``` **1. Send a plot.** A plot is a GeoJSON feature: a polygon, or for a plot of 4 hectares or less a point with its area (`declared_area_ha`), its properties naming its reference (`plot_id`), its supplier, its country and its commodity. ``` POST /v1/assessments Idempotency-Key: 6c1f8f9e-first-send {"plots": {"type": "FeatureCollection", "features": [{ "type": "Feature", "geometry": {"type": "Polygon", "coordinates": [[[-54.01, -10.01], [-53.99, -10.01], [-53.99, -9.99], [-54.01, -9.99], [-54.01, -10.01]]]}, "properties": {"plot_id": "FARM-7", "supplier": "Coop Norte", "country": "BR", "commodity": "soya"}}]}} ``` The answer names an assessment of each plot sent, `in_progress`. **2. Read its result.** `GET /v1/assessments/{assessment_id}` answers the assessment, `done` once its result stands, with its result, the questions it leaves for the supplier, and links to its report as a PDF and to the page anyone may open to check it. Rather than ask again and again, make a webhook in the app (section 8): it tells you when the result is out. **3. Conclude, where the result asks for the supplier's evidence.** Send your conclusion on the risk with the evidence it rests on: `POST /v1/assessments/{assessment_id}/conclusion`. **4. File a statement.** Draft it from the goods and the plots they came from (`POST /v1/statements`), read it, and file exactly what you read (`POST /v1/statements/{statement_id}/file`). Its numbers come back when TRACES gives them. ## Keys A key is the organisation's, never a person's, and is made in the app by one of its admins, who sees it once. It outlives its maker's seat, and any admin revokes it at once. An organisation holds at most ten keys at a time, revoked ones not counted. There are two kinds: - **An editor's key** does the work: it sends plots, records conclusions, and drafts, files and withdraws statements. - **A viewer's key** reads: plots, assessments, reports and statements. A quote creates nothing, so a viewer's key may ask for one. No key is an admin's: keys, people, roles and webhooks are changed in the app alone. A key may be limited to the addresses your systems call from; a call from any other is refused. Keys work on this API alone: the app's own routes take a person's sign-in. Every act of a key is recorded under its label, in the organisation's activity, and a statement filed through the API is emailed to the organisation's people naming the key that filed it. **Keys come with a plan.** Every plan includes the API. On pay as you go an organisation makes no key, and the keys it made on a plan keep working after the plan ends. A trial organisation makes none, and none works for it (`403 forbidden`). ## Sending plots `POST /v1/assessments/quote` says what a send would use of your plan, creating nothing: each plot as our intake reads it (whether it can be checked as supplied, what is wrong with it, what was mended), the plots a send leaves out, and the plan's figures. A plot larger than 20,000 ha is never checked: its problem, `above_maximum_area`, says how to cut it into plots of its own. `POST /v1/assessments` sends them, each its own assessment, numbered on the plot: the plot's first is 1, the next 2. To check plots the library holds again, name them: `{"plot_ids": ["FARM-7"]}`. A plot the send does not take is named in the answer's `left_out` with why: `being_assessed` (it is being checked already), `assessed_today` (it was checked today as it is now: its result stands until the next day, or until you change the plot), `unknown` (your library holds no plot of that reference), `retired`, or `invalid` (one that cannot be checked as supplied: correct it first). A send that takes none of the plots named is refused, each with its reason. A plot counts once in 12 months, on every plan, however often it is sent within them, and only as its first report is issued, in the contract year it was sent: a plot whose check is not completed is never counted. A plot larger than 150 ha counts once for every 150 ha begun: an outline by its measured area, a point by the area it declares (4 ha when it declares none), so a plot of 400 ha counts as three. It stays one plot, with one assessment and one result, and the quote's and the send's figures count it so. The quote keeps the plots still being checked out of what is left (`pending_before`). Plots beyond the plan's allowance are billed at the plan's price, and a send that goes beyond it needs your consent to exactly the figures its quote gave: ``` {"plots": …, "consent": {"overage_plots": 20, "charge_cents": 2000}} ``` Without it, nothing is sent or charged, and the refusal (`409 consent_needed`) gives the fresh figures. A send takes up to 20,000 plots and 32 MiB; split a larger one. **Retries.** Every request that makes or sends something takes an `Idempotency-Key`: a send, a statement drafted, a conclusion, a filing. Sent again with the same key and the same request, it answers what the first made (`200`), as it stands now, making nothing again; another request under the same key, on any of these routes, is refused (`409 idempotency_conflict`). Use a new key for each new request. ## Results Each assessment's result is its current report's, in a short form of its own: - **`no_deforestation_found`**: no forest at the cut-off of 31 December 2020, or forest with no clearing found since. - **`supplier_evidence_needed`**: a change was found, and the supplier's evidence is needed before you conclude. - **`not_assessed`**: the plot could not be checked as supplied; its `problems` say why. A result names the period it covers, from the cut-off to the last day analysed, and each change found, in the order they happened: its area in hectares, the months it happened between, a point on it and its outline. Where forest could not be seen clearly for long, it says how much (`unseen_forest_ha`): a limitation the report states, which asks nothing of the supplier. The smallest change we report is 0.3 hectares; every figure we publish on our accuracy is for clearings of 0.5 hectares or more. How we check is on the Methodology page of the app and in each report. A result is never changed: a later look issues a later report, which replaces it, and the assessment's `result` is always its current report's. The report's PDF is at `pdf_url`, with its SHA-256, and its verification page at `verify_url`. A result is evidence for your due diligence, not a conclusion on it: the conclusion is yours. ## The questions for the supplier, and your conclusion Where a result asks for the supplier's evidence, the assessment carries the questions for the supplier, one of each kind, each naming the changes it asks about, in the supplier's language with `?lang=` (`en`, `fr`, `es`, `pt`, `id`, `vi`), the English beside it. Ask them through your own channels, or have your people send them from the app. A question already answered says `answered`: by your conclusion on the result, recorded on it or carried from an earlier report, by the supplier's answer to these questions in the app, or by its answer on an earlier report about the same change. Your conclusion is recorded with `POST /v1/assessments/{assessment_id}/conclusion`, as a form (`multipart/form-data`): the `version` of the result you concluded on (the result's own `version`), the `risk` (`negligible` or `non_negligible`), its `reason`, and the evidence it rests on, words (`text`) and `files` (JPEG, PNG or PDF, 20 MB each); any other field is refused. A result replaced since you read it, by a later look finding another change say, is refused (`409 result_changed`, with the version it gives now in `details`): read it again, and conclude on what it says now. The evidence joins the plot's own, and the conclusion rests on every piece the plot holds then. A negligible risk lets the plot be filed; a non-negligible one keeps it out of your statements. A later conclusion on the same report replaces it, both kept. A conclusion carries to the plot's next report when that report finds the same change, so a plot checked again is not asked again. ## Statements **Draft.** `POST /v1/statements` drafts a statement from your goods, a line for each commodity, each naming the plots it came from by their references: ``` {"internal_reference_number": "PO-2026-118", "lines": [{"commodity": "soya", "description": "Soya beans", "net_weight_kg": "25000", "plot_ids": ["FARM-7", "FARM-9"]}]} ``` Each plot is filed on its current report, and must be ready to be filed, as `GET /v1/plots` says in its `filing`: a plot that is not, one whose result is more than 90 days old or whose outline changed since, say, is named among the statement's errors. The answer is the statement as it will be filed: its plots, its errors, whether it can be filed now and why not, the operator it is filed for, the version of the words it is filed with, and its `digest`. **File.** `POST /v1/statements/{statement_id}/file` files it through TRACES for your operator, by Panspectra's own TRACES user, which your operator links to itself in TRACES once (the app's filing settings say how; a first link comes with a plan, and one made on a plan keeps working after it ends): ``` {"digest": "…", "attestation": "2026-10-29b", "operator_identifier": "…"} ``` What is filed is exactly what you read: a statement changed since, by a newer report of one of its plots, say, is refused (`409 digest_changed`) with its new digest, and one whose plot grew too old since it was drafted is refused (`409 not_filable`). Filing it, your organisation says: > I am authorised to file this statement for [the operator]. I approve it, as shown above, for filing in the EU Information System in [the operator]'s name by Panspectra's TRACES user, which [the operator] authorised in TRACES. By filing it, [the operator] confirms that due diligence in accordance with Regulation (EU) 2023/1115 was carried out and that no or only a negligible risk was found that the relevant products do not comply with Article 3, point (a) or (b), of that Regulation, and it remains responsible for the statement. Panspectra sends the statement as approved. `attestation` is the version of these words, `2026-10-29b`; if they change, the API says so (`409 conflict`) until you file with the new version. A statement is sent once, whatever you retry: it answers `202`, and `200` when asked again. Its status moves from `submitting` to `submitted`, then `filed` with its reference and verification numbers once TRACES gives them, or `refused`, TRACES's reasons in its `submission_detail`. Where TRACES never answered, its `submission` says `unanswered`, and nothing settles it: look for it in TRACES, as the email to your people says. An organisation's keys file at most 100 statements a day (`409 ceiling_reached`); write to us for more. While filing through TRACES is not available for your organisation, each statement says so in its `why_not` and `withdraw_why_not`, and filing a statement or a correction, or withdrawing one, is refused before anything else is checked (`409 filing_not_available`): a statement's files, on its page in the app, let you file it by hand in TRACES. **Correct and withdraw.** Within its 72 hours a filed statement is corrected by drafting another that names it (`"amends": "{statement_id}"`) and filing that, or withdrawn with `POST /v1/statements/{statement_id}/withdraw`. A correction is filed as the amendment of the statement standing in its place: the one it names, or the latest correction of it, so that the goods never stand twice in TRACES. Once that statement can no longer be amended, its 72 hours over or it withdrawn, filing the correction is refused (`409 not_filable`) unless you add `"as_new": true`, which files it as a new statement, the one it corrects standing beside it unless withdrawn. The statement says how it was filed (`filed_as`: `statement` or `amendment`) and, for an amendment, the statement it replaced (`replaces`). **Delete.** A draft nobody filed is deleted with `DELETE /v1/statements/{statement_id}`. One filed through TRACES stays in your records. ## Webhooks A webhook tells your systems when something changes, so that they need not ask. An admin makes one in the app, on the organisation's page: its address (`https`), its name and its events. Its secret is shown once. An address takes one webhook, which may take both events. Webhooks come with a plan as keys do: none is made on pay as you go, those made on a plan keep working after it ends, and a trial has none. Two events, each naming what changed and its state at the moment it happened. A delivery may come late or out of order, so read the state again from the API before acting on it: - **`assessment.updated`**, with `assessment_id`, `plot_id`, `status`, `outcome` and a `reason`: `reported`, `replaced`, `rechecking`, `restored` or `concluded`. - **`statement.updated`**, with `statement_id`, `status`, its numbers once filed and a `reason`: `approved`, `filed`, `amended`, `refused`, `withdrawn`, `unanswered` or `unsettled`. A test sends `webhook.test`. Each delivery is a `POST` of `{"type": …, "timestamp": …, "data": {…}}`, signed to the [Standard Webhooks](https://www.standardwebhooks.com) specification, whose libraries check it in most languages. The headers `webhook-id`, `webhook-timestamp` and `webhook-signature` carry the delivery's id, its time in seconds and `v1,` with the base64 HMAC-SHA256, under the secret's bytes (the base64 after `whsec_`), of the id, the time and the body joined by full stops. Check the signature, and that the time is within five minutes; the id is the same on every try, so that a delivery taken twice is seen. Answer with a `2xx` within 15 seconds, counted from our connecting to the status line and headers of your answer; its body is not read. A delivery that fails is tried again after 5 minutes, 30 minutes, 2 hours, 12 hours, a day, two days and two days again. A webhook whose every delivery failed for five days is turned off, and the organisation's admins are emailed. For a day after a new secret is made, deliveries are signed with both; a second new secret made within that day replaces the first new one, and the old one signs until its day ends. ## Catching up, pages, limits and errors **Catching up.** `GET /v1/plots?changed_since=…` and `GET /v1/statements?changed_since=…` answer what changed since a moment of our clock. Each page says when it was read, `as_of`: keep the first page's, and ask the next `changed_since` five minutes before it, so that no change is ever missed, whatever your own clock says; an item may come twice, which changes nothing. A plot moves when its result passes its 90 days, the day after its `filing.until`, as when its result or your conclusion changes. **Pages.** A list answers 100 items, up to 1,000 with `limit`, and the cursor of the next page in `next`; none on the last. The plots come in the order of their references, the statements newest first. **Limits.** An address makes up to 600 requests a minute with a key, and 60 without one. Quotes and sends, each checking up to 20,000 plots, are 5 a minute from an address. Beyond, our load balancer answers `429 Too Many Requests` without a body of ours: wait a minute, and try again. **Whether the API is up.** `GET https://eudr-api.panspectra.com/health` answers `{"status": "ok"}` while the API's service is up, with no key, for a monitor to ask at most once a minute. It looks at nothing behind the service, so a request may still be refused `unavailable` for a moment: retry it after the seconds its `Retry-After` names. **Errors.** Every refusal has the same form: ``` {"error": {"code": "invalid", "message": "…", "fields": [{"field": "lines.0.commodity", "message": "…"}], "request_id": "req_…"}} ``` Its `code` is one of a fixed list: `unauthorized` (401: no key, or a key revoked), `forbidden` (403: a viewer's key editing, or a call from an address the key is not limited to), `organisation_closing` (403: the organisation is being deleted), `not_found` (404), `method_not_allowed` (405), `invalid` (422: the request's form, field by field), `conflict` (409), `consent_needed`, `being_assessed`, `assessed_today`, `not_ready`, `not_filable`, `filing_not_available`, `digest_changed`, `result_changed`, `ceiling_reached` and `idempotency_conflict` (409), `too_large` (413), `paused` (503, with `Retry-After`, while the service is shut for maintenance), `unavailable` (503, with `Retry-After`: we cannot answer just now) and `fault` (500: ours, and we are told). What a refusal gives you to act on is in its `details`: a send's fresh quote, a statement's new digest, the version of the words a statement is filed with, the version of a result. Every answer carries its request's id in the `X-Request-Id` header: quote it when you write to us. ## Versions and changes The version is in the path, `/v1`. Within it a change only adds: a route, an optional field of a request, a field of an answer, an event, or a value of a field this guide names as open (a result's problems, a plot's reason not to be filed). Ignore what you do not know. Anything else is a new version, `/v2`, with `/v1` kept a year after it opens, its retiring routes answering with `Deprecation` and `Sunset` headers, and their users emailed. Until our first customer integrates, `/v1` itself may still change. ### Changes - 2026-11-14: A send leaves out a plot checked that day as it is now (`assessed_today`), and one that takes none of the plots it names is refused. While filing through TRACES is not available for your organisation, filing and withdrawing are refused, `filing_not_available`. - 2026-11-09: A plot larger than 20,000 ha is never checked, its problem `above_maximum_area`. Keys and webhooks come with a plan; a trial organisation's keys are refused, `403 forbidden`. A first link to TRACES comes with a plan too. The limits are counted by address, and quotes and sends have their own, 5 a minute. A plot larger than 150 ha counts once for every 150 ha begun. - 2026-11-07: A conclusion names the result's `version`, and its form refuses a field it does not take. Drafting a statement, recording a conclusion and filing take an `Idempotency-Key`. A correction whose statement can no longer be amended is filed only with `"as_new": true`, and a statement says how it was filed (`filed_as`, `replaces`) and why TRACES refused it (`submission_detail`). A plot's `filing` gives `until`, and every page `as_of`. A send names the references it does not take. The codes `method_not_allowed`, `result_changed` and `unavailable`. `GET /health`, with no key. A sandbox's reports say so on every page, and its questions to suppliers go to its own people. - 2026-11-06: The first version. # Reference Base address: https://eudr-api.panspectra.com ## POST /v1/assessments/quote: Quote a send What sending the plots would use of the plan, creating nothing: each plot as the intake reads it, the plots a send leaves out (those being checked already, and those checked today as they are now), and the plan's figures. Any key. - Body (application/json): Plots - Answers 200 (application/json), Quoted: Done. - Otherwise a refusal: Error ## POST /v1/assessments: Send plots to be checked Each plot sent becomes an assessment of its own, numbered on the plot; a plot named that the send does not take is named in left_out, with why. Plots beyond the plan's allowance need the consent to exactly the figures their quote gave. Safe to retry with an Idempotency-Key. An editor's key. - Idempotency-Key (header, string, optional): Makes a retried send safe: the same key and body answer with the assessments the first made. - Body (application/json): Send - Answers 200 (application/json), Sent: The same request again under its Idempotency-Key: what the first made, nothing sent again. - Answers 201 (application/json), Sent: The plots sent. - Otherwise a refusal: Error ## GET /v1/plots: List the plots The organisation's plots in the order of their references, a page at a time; with changed_since, those changed since a moment of our clock: a page's as_of, less a few minutes. Any key. - status (query, not_checked | in_progress | done, optional): not_checked, in_progress or done. - commodity (query, string, optional): The commodity: cattle, cocoa, coffee, oil_palm, rubber, soya or wood. - country (query, string, optional): Two letters, ISO 3166. - changed_since (query, string (date-time), optional): Only the plots whose status, result, conclusion or filing changed after this moment, by our clock (updated_at): the as_of of the last page read, less a few minutes. - limit (query, integer, optional): How many items a page holds: 100 unless asked, 1,000 at most. - cursor (query, string, optional): The page's next. - Answers 200 (application/json), PlotPage: Done. - Otherwise a refusal: Error ## GET /v1/plots/{plot_id}: Read a plot A plot: its latest assessment that stands, the organisation's conclusion, and whether a statement may file it now. Any key. - plot_id (path, string, required): The plot, by the organisation's reference. - Answers 200 (application/json), Plot: Done. - Otherwise a refusal: Error ## GET /v1/assessments/{assessment_id}: Read an assessment An assessment: its status, its current report's result, the questions it leaves for the supplier in the language asked for, and the organisation's conclusion. Any key. - assessment_id (path, string, required): The assessment. - lang (query, en | fr | es | pt | id | vi, optional): The supplier's language for the questions; English by default. - Answers 200 (application/json), Assessment: Done. - Otherwise a refusal: Error ## GET /v1/assessments/{assessment_id}/pdf: Download its report The assessment's current report, as a PDF. Any key. - assessment_id (path, string, required): The assessment. - Answers 200 (application/pdf): Done. - Otherwise a refusal: Error ## POST /v1/assessments/{assessment_id}/conclusion: Record a conclusion The organisation's conclusion on a result that asked for the supplier's evidence, with the evidence it rests on, as a form (multipart/form-data), made on the result's version it names: one replaced since is refused, result_changed. A later one on the same report replaces it, both kept. Safe to retry with an Idempotency-Key. An editor's key. - assessment_id (path, string, required): The assessment. - Idempotency-Key (header, string, optional): Makes a retried request safe: the same key and request answer what the first made (200), making nothing again; another request under the key is refused (idempotency_conflict). - Body (multipart/form-data): ConclusionForm - Answers 200 (application/json), Assessment: The same request again under its Idempotency-Key: the assessment as it stands, nothing recorded again. - Answers 201 (application/json), Assessment: The conclusion recorded: the assessment, with it. - Otherwise a refusal: Error ## POST /v1/statements: Draft a statement A statement drafted from goods and the plots they came from, each plot filed on its current report, a plot not ready to be filed named among its errors; a correction names the statement it corrects. Safe to retry with an Idempotency-Key. An editor's key. - Idempotency-Key (header, string, optional): Makes a retried request safe: the same key and request answer what the first made (200), making nothing again; another request under the key is refused (idempotency_conflict). - Body (application/json): StatementDraft - Answers 200 (application/json), Statement: The same request again under its Idempotency-Key: the statement the first drafted, as it stands. - Answers 201 (application/json), Statement: The statement drafted. - Otherwise a refusal: Error ## GET /v1/statements: List the statements The organisation's statements, the newest first, a page at a time; with changed_since, those changed since a moment of our clock: a page's as_of, less a few minutes. Any key. - changed_since (query, string (date-time), optional): Only the statements changed after this moment, by our clock (updated_at): the as_of of the last page read, less a few minutes. - limit (query, integer, optional): How many items a page holds: 100 unless asked, 1,000 at most. - cursor (query, string, optional): The page's next. - Answers 200 (application/json), StatementPage: Done. - Otherwise a refusal: Error ## GET /v1/statements/{statement_id}: Read a statement A statement as it will be or was filed: its digest, its plots, why it cannot be filed now where not, the operator and the words it is filed with, and its numbers once filed. Any key. - statement_id (path, string, required): The statement. - Answers 200 (application/json), Statement: Done. - Otherwise a refusal: Error ## DELETE /v1/statements/{statement_id}: Delete a draft A draft nobody filed. One filed through TRACES stays in the records. An editor's key. - statement_id (path, string, required): The statement. - Answers 204: Done. - Otherwise a refusal: Error ## POST /v1/statements/{statement_id}/file: File a statement Files exactly the statement read, by its digest, through TRACES for the operator it names, once whatever is retried. A correction is filed as the amendment of the statement standing in its place, or as a new statement where as_new asks, once that one can no longer be amended. Its numbers come back when TRACES gives them. An editor's key. - statement_id (path, string, required): The statement. - Idempotency-Key (header, string, optional): Makes a retried filing safe: the same key and request answer the statement again (200), whatever has become of it since, and file nothing; another request under the key is refused (idempotency_conflict). - Body (application/json): FileStatement - Answers 200 (application/json), Statement: Asked again: the statement as it stands, nothing sent again. - Answers 202 (application/json), Statement: Taken: sent to TRACES within the minute. - Otherwise a refusal: Error ## POST /v1/statements/{statement_id}/withdraw: Withdraw a statement Withdraws a filed statement from TRACES, within its 72 hours. An editor's key. - statement_id (path, string, required): The statement. - Answers 200 (application/json), Statement: Done. - Answers 202 (application/json), Statement: Taken: its withdrawal is sent to TRACES within the minute. - Otherwise a refusal: Error ## GET /health: Whether the API is up Whether the API's service is up, and nothing else. It looks at nothing behind the service, so a request may still be refused unavailable for a moment. Ask it at most once a minute. No key. - Answers 200 (application/json), Health: The API's service is up. ## Webhook events - assessment.updated: An assessment's result was reported, replaced, taken back to be checked again or restored, or the organisation's conclusion was recorded. Its delivery: AssessmentEvent - statement.updated: A statement was approved to be filed, filed, filed as a correction, refused, withdrawn, or never answered by TRACES. Its delivery: StatementEvent ## Models ### ActivityType One of IMPORT, EXPORT, DOMESTIC. ### Allowance What the plots will use of the plan's allowance this contract year: each plot counts as its first report is issued, so a plot whose check is not completed is never counted. Every figure but the plots named, those refused and those counted already is in plots as counted: a plot larger than 150 ha counts once for every 150 ha begun, an outline by its measured area, a point by the area it declares (4 ha when it declares none), and stays one plot. - plan (PlanRef) - basis (string) - contract_year (integer) - year_start (string (date)) - year_end (string (date)) - plots (integer): The plots named. - rejected (integer): Those the intake refused, never counted. - repeated (integer): Those counted already within the last 12 months. - counted (integer): What those that count count as, each as its first report is issued: a plot larger than 150 ha once for every 150 ha begun. - included (integer, optional): The year's allowance: the plan's plots and any granted. - granted (integer, optional): The plots granted for the contract year. - used_before (integer, optional): The plots counted this contract year before. - pending_before (integer, optional): The plots being checked before, which count as their reports are issued. - remaining_before (integer, optional) - within (integer, optional) - overage (integer): Those beyond the allowance, billed. - free (integer, optional): On a plan without an allowance, those the year's granted plots pay for. - used_after (integer, optional) - remaining_after (integer, optional) - currency (string, optional) - unit_price_cents (integer, optional) - charge_cents (integer, optional) - standing (string) ### Assessment A plot's assessment: one send of the plot, numbered on it. - assessment_id (string) - plot_id (string): The plot, by the organisation's reference. - number (integer): The assessment's number on the plot. - status (in_progress | done): in_progress until its result issues, and while it is checked again; done once its result stands. - sent_at (string (date-time)) - result (ReportResult, optional): The result of its current report, once issued. - questions (list of Question, optional): What the result leaves for the supplier; empty where it asks nothing. - conclusion (Conclusion, optional): The organisation's conclusion on the current report, recorded on it or carried to it. - pdf_url (string, optional): The report, as a PDF. - pdf_sha256 (string, optional): The PDF's SHA-256. - verify_url (string, optional): The verification page anyone may open to check the report. - updated_at (string (date-time)) ### AssessmentEvent A delivery of assessment.updated. - type (assessment.updated) - timestamp (string (date-time)): When it happened. - data (AssessmentUpdated) ### AssessmentUpdated What changed of an assessment, as a webhook tells it: what happened, and its state at that moment, which a later change may have moved on; a receiver reads the assessment again from the API before acting on it. - assessment_id (string) - plot_id (string): The plot, by the organisation's reference. - reason (reported | replaced | rechecking | restored | concluded): What happened: its result reported, replaced by a later report, being checked again, back as it was, or the organisation's conclusion recorded. - status (in_progress | done) - outcome (string, optional): Its result's outcome, while it is done. ### Commodity The Regulation's seven relevant commodities; a plot declares one. One of cattle, cocoa, coffee, oil_palm, rubber, soya, wood. ### Conclusion The customer's own conclusion on a report that asked for the supplier's evidence: its assessment of the risk, never a word on our result. - risk (negligible | non_negligible): The organisation's assessment of the risk. - reason (string): Its reason, in its words. - evidence (list of EvidencePiece, optional): The pieces of evidence it rests on. - recorded_at (string (date-time)) - recorded_by (string): Who recorded it: a person's address, or the API key by its label. - carried (boolean, optional): Whether it was recorded on an earlier report of the plot and carries to this one, for the same change. ### ConclusionForm A conclusion, as a form (multipart/form-data). - version (integer): The version of the result the conclusion was made on, as the assessment's result gave it (result.version): refused, result_changed, where the assessment's result is another now. - risk (negligible | non_negligible): The organisation's assessment of the risk. - reason (string): Its reason. - text (string, optional): The evidence's words: the supplier's answer, say. - files (list of string, optional): The evidence's files: JPEG, PNG or PDF, 20 MB each. ### Consent The consent to what plots beyond the plan's allowance add to the invoice, exactly as the quote said it. - overage_plots (integer): The plots beyond the allowance. - charge_cents (integer, optional): Their amount, in cents; none while unset. ### Error A refusal. - error (ErrorDetail) ### ErrorDetail - code (string): What went wrong, from a fixed list: unauthorized, forbidden, organisation_closing, not_found, method_not_allowed, invalid, conflict, consent_needed, being_assessed, assessed_today, not_ready, not_filable, filing_not_available, digest_changed, result_changed, ceiling_reached, idempotency_conflict, too_large, rate_limited, paused, unavailable, fault. - message (string): What went wrong, in words. - fields (list of Problem, optional): Each field refused, for a request not in the form it takes. - details (object, optional): What a refusal gives to act on, where it gives anything: a send's fresh quote (consent_needed), a statement's new digest (digest_changed), the version of the words a statement is filed with (conflict), the version of the result now (result_changed). - request_id (string): The request's id, also in the X-Request-Id header, to quote to us. ### EvidenceFile - name (string): The file's name as it was added. - size_bytes (integer): Its size, in bytes. - sha256 (string): Its content's SHA-256. ### EvidencePiece A piece of the plot's evidence a conclusion rests on. - text (string, optional): Its words, if any. - files (list of EvidenceFile, optional) - source (string): Where it came from: the organisation's own, or the supplier's answer. - received_at (string (date-time)): When it reached the organisation. ### FileStatement A statement filed through TRACES, exactly as it was read. - digest (string): The statement's digest as its answer gave it: what is filed is exactly what was read. - attestation (string): The version of the words the organisation files with, as the statement's answer and the guide give them. - operator_identifier (string): The operator it is filed for, as the statement's answer named it. - as_new (boolean, optional): For a correction (amends) whose statement can no longer be amended, its 72 hours over or the statement withdrawn: file it as a new statement. Without it such a correction is refused, so that the same goods never stand twice in TRACES unawares. ### Filing Whether a statement may file the plot now. - ready (boolean) - why (string, optional): Why not, where not: not_checked, being_checked, too_old, outline_changed, conclusion_needed, not_negligible or to_correct. - until (string (date), optional): The last day a statement files the plot on its latest result: 90 days after the last day the result covers. After it the plot is too_old until it is checked again. None for a plot without a result. ### Finding An outcome: no_deforestation_found, supplier_evidence_needed or not_assessed; in_progress while an assessment's result is not out. One of no_deforestation_found, supplier_evidence_needed, not_assessed, in_progress. ### GeoJSONGeometry A GeoJSON geometry in WGS-84 (longitude, latitude). - type (string): The GeoJSON geometry type; a plot is a Point, Polygon or MultiPolygon. - coordinates (any): Longitude, latitude pairs in degrees, nested as the type requires; always lists, so a record round-trips through JSON unchanged. ### Health Whether the API is up. - status (ok): The API's service is up. It looks at nothing behind the service, so a request may still be refused unavailable for a moment. ### Intake A plot as the intake read it: whether it can be assessed as supplied, why not, and what was mended. - plot_id (string) - valid (boolean) - problems (list of IntakeProblem, optional) - notices (list of string, optional) ### IntakeProblem - code (string) - message (string) ### Latest - assessment_id (string) - result (string, optional): Its outcome, once issued. - period_end (string (date), optional) ### LeftOut A plot named and not sent, and why. - plot_id (string) - why (being_assessed | assessed_today | unknown | retired | invalid | beyond_pilot): being_assessed: it is being checked already; assessed_today: it was checked today as it is now, and its result stands until the next day or until the plot changes; unknown: the library holds no plot of that reference; retired: it was retired from the library; invalid: the library holds it as one that cannot be checked as supplied, to correct first; beyond_pilot: a paid pilot's plots are used, and it does not fit in what is left of them. ### Operator - name (string) - identifier_type (EORI | VAT | GLN | TIN | OTHER, optional) - identifier_value (string, optional) - country (string, optional) - street (string, optional) - postal_code (string, optional) - city (string, optional) - email (string, optional) - phone (string, optional) ### PlanRef - id (string) - name (string) ### Plot A plot of the organisation's library. - plot_id (string): The plot, by the organisation's reference. - number (integer): The plot's number in the organisation. - supplier (string, optional): Its supplier, as the library names it. - commodity (string, optional): Its commodity: cattle, cocoa, coffee, oil_palm, rubber, soya or wood. - country (string, optional): Its country of production: two letters, ISO 3166. - status (not_checked | in_progress | done): not_checked, in_progress, or done for a plot whose latest result stands. - latest (Latest, optional): Its latest assessment that stands. - conclusion_risk (negligible | non_negligible, optional): The organisation's conclusion on its latest report, where it recorded one or one carried to it. - filing (Filing) - updated_at (string (date-time)): When its status, result, conclusion or filing last changed, which changed_since reads: a result passing its 90 days among them, from the day after filing.until. ### PlotPage A page of the organisation's plots, in the order of their references. - items (list of Plot) - next (string, optional): The cursor of the next page; none on the last. - as_of (string (date-time)): When the page was read, by our clock: ask the next changed_since a few minutes before it, since a change is stamped as it is made and may be read a moment after. ### Plots The plots of a quote or a send: GeoJSON, or the references of plots the library holds, to check them again. - plots (object, optional): A GeoJSON FeatureCollection, each feature naming its plot_id, supplier, country and commodity in its properties. - plot_ids (list of string, optional): Or the references of plots the library holds. ### Problem - field (string): The field refused, by its path in the request. - message (string): Why, in words. ### Question A question the result leaves for the supplier, as the supplier's page and paper put it. - code (string): The question's kind: clearing_date, forest_at_2020, explain_clearing or explain_disturbance, of a change found; other_changes, of the smaller changes beyond a result's ten largest, asked of together; or correct, for a plot that could not be assessed as supplied. - events (list of integer, optional): The changes it asks of, by their numbers on the plot, as the result's changes number them; none for a correction. - ask (string): The question, in the language asked for. - settles (string): What would settle it, in the language asked for. - english (object, optional): The question and what would settle it in English, beside a translation. - answered (boolean): Whether it is answered already: by the organisation's conclusion on the result, recorded on it or carried from an earlier report, or by the supplier's answer, to this result's questions or to an earlier report's about the same change. ### Quoted What sending the plots would use, creating nothing. - allowance (Allowance) - left_out (list of LeftOut) - plots (list of Intake) ### ReportChange A change the report found in the plot's forest. - number (integer): Its number on the plot, as the report numbers it. - area_ha (number): Its area, in hectares. - cleared_from (string): The months it happened between, "YYYY-MM". - cleared_to (string) - centre (list of any): A point on it, its largest part's: longitude and latitude. - outline (GeoJSONGeometry): Its outline. ### ReportResult A plot report's result, as a customer's systems read it. - schema_version (1.0, optional) - plot_id (string): The plot, by the customer's own reference. - assessment (integer): The plot's assessment, numbered on the plot, and the report's version in it: 1 the first, a later one replacing it. - version (integer) - verification_code (string): The report's verification code, which finds and checks it. - assessed_at (string (date-time)): When the assessment was finished. - period_start (string (date), optional): The period the result covers: from the cut-off to the last day analysed; None when the plot was not assessed. - period_end (string (date), optional) - result (Finding): The outcome: no_deforestation_found, supplier_evidence_needed or not_assessed. - changes (list of ReportChange, optional): Each change found, in the order they happened. - changed_area_ha (number, optional): The changes' area together, in hectares. - unseen_forest_ha (number, optional): The forest that could not be seen clearly for long stretches since the cut-off, or too seldom before it, in hectares: the limitation the report states of it, which asks nothing of the supplier; None where none went unseen. - problems (list of string, optional): Why the plot could not be assessed as supplied, by code; empty on a plot that was assessed. - trial (boolean, optional): Whether the report was made in a free trial: on real observations, to show how Panspectra works, and not for due diligence. ### Send - plots (object, optional): A GeoJSON FeatureCollection, each feature naming its plot_id, supplier, country and commodity in its properties. - plot_ids (list of string, optional): Or the references of plots the library holds. - consent (Consent, optional): Needed where the plots go beyond the plan's allowance. ### Sent The plots sent: an assessment of each, the plots left out because they are being assessed, the allowance's figures, and each plot as the intake read it. - assessments (list of SentAssessment) - left_out (list of LeftOut, optional) - allowance (Allowance, optional) - plots (list of Intake, optional) ### SentAssessment - assessment_id (string) - plot_id (string) - number (integer) - status (in_progress | done) ### Statement A statement as it will be, or was, filed. - statement_id (string) - status (string): draft, submitting, submitted, filed, refused, rejected, withdrawing, withdrawn or amended. - internal_reference_number (string, optional) - digest (string, optional): Its SHA-256, which filing it binds. - reference_number (string, optional) - verification_number (string, optional) - filed_at (string (date-time), optional) - submission (string, optional): Where its latest sending to TRACES stands, where it was approved for TRACES: queued, sending, submitted, available, refused, rejected, not_sent, withdrawn, amended, unanswered (TRACES never answered: look for it there, it is never sent again) or unsettled (TRACES took it and had not settled it a week later). - created_at (string (date-time)) - updated_at (string (date-time)) - plots (list of string, optional): Its plots, by their references. - errors (list of string, optional): Why it cannot be filed as it is. - can_file (boolean): Whether it can be filed now, by an editor's key. - why_not (string, optional): Why it cannot be filed now, where not. - operator_name (string, optional): The operator it is filed for: the one it was approved for once approved, else the organisation's connected operator. - operator_identifier (string, optional) - attestation (string, optional): The version of the words it is filed with, for FileStatement. - can_withdraw (boolean, optional) - withdraw_why_not (string, optional) - change_until (string (date-time), optional): When its 72 hours to correct or withdraw end. - amends (string, optional): The statement it corrects, by its id. - filed_as (statement | amendment, optional): How it was approved to be filed: as a statement of its own, or as the amendment of the statement it replaces in TRACES (replaces); none before. - replaces (string, optional): The statement an amendment replaces in TRACES, by its id: the one it corrects, or the latest correction of it that stands. - submission_detail (string, optional): Why its latest sending was refused or rejected, in TRACES's reasons, or why nothing was sent, in words. ### StatementDraft A statement drafted from goods and plots, as the app's form drafts one: each line's plots filed on their current reports. - lines (list of StatementLine) - production_end (string (date), optional) - operator (Operator, optional) - activity_type (ActivityType, optional) - country_of_activity (string, optional) - border_cross_country (string, optional) - internal_reference_number (string, optional) - comment (string, optional) - geolocation_confidential (boolean, optional) - again_of (string, optional) - amends (string, optional) ### StatementEvent A delivery of statement.updated. - type (statement.updated) - timestamp (string (date-time)): When it happened. - data (StatementUpdated) ### StatementLine A line of goods: its commodity and HS heading, its description and quantities, and the plots it came from, by their references. - commodity (Commodity) - hs_heading (string, optional) - description (string) - net_weight_kg (number or string, optional) - supplementary_unit (number or string, optional) - supplementary_unit_qualifier (string, optional) - percentage_estimation_or_deviation (number or string, optional) - species_scientific_name (string, optional) - species_common_name (string, optional) - plot_ids (list of string, optional) ### StatementPage A page of the organisation's statements, the newest first. - items (list of StatementSummary) - next (string, optional) - as_of (string (date-time)): When the page was read, by our clock: ask the next changed_since a few minutes before it, since a change is stamped as it is made and may be read a moment after. ### StatementSummary A statement as the list gives it. - statement_id (string) - status (string): draft, submitting, submitted, filed, refused, rejected, withdrawing, withdrawn or amended. - internal_reference_number (string, optional) - digest (string, optional): Its SHA-256, which filing it binds. - reference_number (string, optional) - verification_number (string, optional) - filed_at (string (date-time), optional) - submission (string, optional): Where its latest sending to TRACES stands, where it was approved for TRACES: queued, sending, submitted, available, refused, rejected, not_sent, withdrawn, amended, unanswered (TRACES never answered: look for it there, it is never sent again) or unsettled (TRACES took it and had not settled it a week later). - created_at (string (date-time)) - updated_at (string (date-time)) ### StatementUpdated What changed of a statement, as a webhook tells it: what happened, and its state at that moment; the statement read again from the API says where it stands now. - statement_id (string) - reason (approved | filed | amended | refused | withdrawn | unanswered | unsettled): What happened: approved to be filed, filed, filed as a correction, refused by TRACES, withdrawn, or never answered by TRACES. - status (string, optional): Its status now. - reference_number (string, optional) - verification_number (string, optional)