---
title: "Peppol ID quality summary"
method: GET
path: "/v1/id-quality"
tags: ["ID Quality"]
---

# Peppol ID quality summary

`GET /v1/id-quality`

## Request

- Base URL: `https://api.peppolstatus.com`
- URL: `https://api.peppolstatus.com/v1/id-quality`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Per-scheme (ICD) summary of the structural identifier checks: how many participants were checked, how many failed their scheme's rule, and the resulting violation rate. Ordered by violation count, busiest first.

## Response `200`

The per-scheme ID quality summary.

- IdQualitySummary: Per-scheme structural ID quality summary, busiest first.
  - `schemes` IdQualitySchemeStat[], required
    - `scheme` string, required: The 4-digit Peppol ICD (e.g. `0208`).
    - `rule` string, required: The rule id applied (e.g. `be-enterprise-mod97`).
    - `participants_checked` integer, required
    - `violations` integer, required
    - `violation_rate` number, required: violations / participants_checked, 6 decimals; 0 when none checked.
  - `totals` object, required
    - `participants_checked` integer, required
    - `violations` integer, required
  - `generated_at` string, date-time, required

---

[API](https://skmtc.dev/peppolstatus/apis/peppolstatus-api.md) · [All operations](https://skmtc.dev/peppolstatus/apis/peppolstatus-api/llms.txt) · [OpenAPI document](https://skmtc.dev/peppolstatus/apis/peppolstatus-api/revisions/7e74fb32f23c?raw)