Skip to content

Integra Guide

Endpoints

POST /v1/parse

Parses an AL3 file and converts it to the requested format.

Request: application/octet-stream (Binary AL3)

Response: Depends on Accept header.

Supported Formats

Format Accept Header Description
JSON application/json Default. Hierarchical structure with metadata and validation info.
NDJSON application/x-ndjson Newline Delimited JSON. Each line is a root Policy object.
CSV text/csv Flattened structure. Good for spreadsheets.
Parquet application/x-parquet Flattened columnar format. Best for analytics (Athena, Spark).

Example: JSON (Default)

{
  "data": {
    "policies": [ ... ],
    "metadata": { ... }
  },
  "validation": { ... }
}

Example: NDJSON

{"code":"5BIS","level":5,"data_elements":{...}}
{"code":"5BIS","level":5,"data_elements":{...}}

Example: CSV

ID,RefID,Key,Name,FormattedValue,RawValue,GroupCode,Level,NodeID,ParentID
01,INSCO,5BIS01,Insurer,ABC Insurance,ABC  ,5BIS,5,8,4
...

Note: NodeID and ParentID are included in CSV and Parquet to allow hierarchy reconstruction from flattened formats.

POST /v1/validate

Validates an AL3 file and returns a report.

Request: application/octet-stream (Binary AL3)

Response: application/json

{
  "valid": false,
  "errors": [ ... ],
  "warnings": [ ... ]
}

GET /health

Returns 200 OK if server is running. Used for Load Balancer health checks.

GET /metrics

Prometheus metrics endpoint.