ID Quality

List malformed participant identifiers

The individual identifiers that failed their scheme's structural rule, keyset-paginated on (scheme, value). The first page's meta.facets gives scheme and reason counts over the filtered set.

get/v1/id-quality/malformed

Request

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

Query parameters

schemestring

Filter to one Peppol ICD scheme (e.g. 0208).

reason'length' | 'charset' | 'check-digit'

Filter by the kind of structural failure.

qstring

Case-insensitive substring match on the identifier value.

smpstring

Filter to malformed ids homed on one SMP hostname (from meta.facets.smp).

limitinteger

Page size, clamped to [1, 200]. Defaults to 50.

cursorstring

Opaque pagination cursor returned as next_cursor by the previous page.

Response

A page of malformed identifiers with scheme/reason facets.

next_cursorstring nullable required

Opaque cursor for the next page, or null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.