Skip to main content
The coverage check is a non-billable, read-only utility. Given a product, a subject, and a set of networks, it reports per furnishing institution which of the product’s fields that institution has furnished for the subject, and whether the subject’s consent covers them. It does not issue a certificate, return subject data values, or create a billable query event. One endpoint serves every product: pass the product_id of the product you want to check.
The response names the furnishing institutions in the queried networks and shows which of them hold data on the subject (hit). Treat it with the same care as any other information about the subject.

​
Coverage check vs soft check

The coverage check answers “who has furnished which fields?”. It counts any furnished value and does not apply the querying policy’s filters (such as freshness windows), so a complete coverage row does not mean a certificate query will succeed. To ask “would this certificate query issue a certificate right now?”, use the certificate soft check instead: POST /v1/products/{kyc,kyb}_certificate_snapshot/query/soft. It runs the real query logic as a non-billable dry run. See Soft check before you query.

​
At a glance

A 200 OK returns one entry per member institution of the queried networks. Each entry has a hit flag (does this institution hold any data for the subject?), a complete flag (has it furnished every field?), and a per-model, per-field breakdown of which fields are met and consented. The field_name values match each product’s field reference.

Full request & response schema

The complete coverage check deep dive: request fields, the response shape, and when to use it.

Products

The full product catalog.

Querying

The billable product queries.