Skip to main content
POST
/
v1
/
evaluate
/
report
Render an evaluation as a PDF report
curl --request POST \
  --url https://api.example.com/v1/evaluate/report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "crs": "<string>",
    "geometry": {
      "coordinates": [
        [
          [
            123
          ]
        ]
      ],
      "bbox": [
        123
      ]
    },
    "scheme": {
      "type": "br:cnpj",
      "value": "12.345.678/0001-90"
    }
  },
  "ruleset_id": "<string>",
  "metadata": {
    "check_labels": {},
    "custom": {},
    "customer_name": "<string>",
    "dataset_references": [
      {
        "name": "<string>",
        "source": "<string>",
        "updated_at": "<string>"
      }
    ],
    "locale": "pt-BR",
    "logo_url": "<string>",
    "map": {
      "basemap": "satellite",
      "enabled": true,
      "zoom_hint": 13
    },
    "notes": "<string>",
    "project_ref": "<string>",
    "responsible": {
      "name": "<string>",
      "registration": "<string>",
      "role": "<string>"
    },
    "sections": [
      {
        "body": "<string>",
        "title": "<string>"
      }
    ],
    "subject_description": "<string>",
    "subtitle": "<string>",
    "title": "<string>"
  },
  "ruleset": {},
  "ruleset_as_of": "2023-11-07T05:31:56Z"
}
'
"<string>"

Documentation Index

Fetch the complete documentation index at: https://docs-attestly.code4source.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string | null

Body

application/json
​
input
EvaluationInput · object
required

Same shape as POST /v1/evaluate. At least one of input.geometry or input.scheme MUST be present.

​
ruleset_id
string | null
required
Maximum string length: 256
​
metadata
ReportMetadataRequest · object

Optional report metadata. Reserved fields render in pre-styled positions; custom renders as a key/value table after the verdict.

​
ruleset
Ruleset · object
​
ruleset_as_of
string<date-time> | null

Response

Rendered PDF report.

The response is of type file.