The catalog
Four products are queryable today.
They fall into two families:
- Certificates are consolidated, multi-part verification results assembled
from data furnished by network participants. A query that resolves every
part issues a certificate;
otherwise it returns
204 No Content. - Screening lists are read-only checks for listings furnished about a
consumer. They return a listing indicator plus details of the most recent
listing, never a certificate, and always
200 OK, with a clean result expressed as"is_listed": false.
The query / furnish pattern
Query
Read consolidated data for a subject, drawn from what participants have
furnished to the networks you query. Requires a
consent ID or a direct profile reference.
Furnish
Contribute verified data for a subject into a network, making it
available to future queries in that network.
POST /v1/products/{kyc,kyb}_certificate_snapshot/query/soft, the soft check: runs the certificate query as a dry run and reports whether a certificate would be issued, without returning subject data.POST /v1/products/check, the coverage check: reports, per furnishing institution, which of a product’s fields it has furnished for the subject.
How products relate to networks and policies
A product defines what data exists: its models, fields, and types. A network lists the products it offers to its members. A querying policy filters which furnished records a certificate query may use (e.g. how recent a verification must be). The same product can produce different results in two networks that apply different policies. This is why a certificate query carriesnetwork_ids and, optionally, a
policy_id: the product determines the endpoint and response schema, while the
network and policy scope determines what actually comes back.
Each product’s schema is defined as a set of models: named groups of typed
fields such as DocumentCaptureEvent or BusinessRiskComplianceEvent. These
model and field names are the shared vocabulary across the platform: policies
filter on them, the soft check and coverage check report against them, and the
per-product field reference tables document them. When a policy requires
“document captured within the last 29 days,” it is expressing a filter over a
product model’s fields.
Querying a product
A product query reads consolidated data for one subject. It needs a consent ID (or a direct profile id) identifying the subject, and a network scope, with an optional policy:200 vs 204 semantics, the X-Ref-Id audit header, and billing notes.
Furnishing a product
Furnishing contributes one or more records for a subject into a network:network_id. The network matches each
record to an existing profile on its identifying fields (or creates one) and
stores the furnished data under your organization. See
Furnishing.
Choosing a product
In practice these compose: an onboarding flow might run both screening lists,
then the free soft check, then the KYC certificate query only if the soft check
says a certificate would be issued.
In the dashboard
KYC product detail — overview
Products catalogue — By Templates
Run query — choose KYC certificate product
KYC product detail — Policies tab
Run query opened from product detail
Run query — choose KYB certificate product
Product deep dives
KYC Certificate Snapshot
Consolidated consumer identity verification: nine sub-products, full field
reference.
KYB Certificate Snapshot
Business identity, ownership & control, and risk/compliance in one
certificate.
Screening Lists
The Bank-Specific Bad Actor List and the 314(b) Cross-Bank Financial Crimes
Watch List.
Coverage Check
Non-billable, per-furnisher view of which fields are on file.