How the network works
Every interaction with the API is one of two operations on a product:- Furnish — contribute verified data about a consumer or business into a network. Other participants can then query it, subject to the network’s rules.
- Query — read consolidated data about an entity from the network. A query
requires a
consent_idproving the subject agreed, and returns only the fields the network’s policy exposes and you are entitled to read.
POST /v1/products/check) to see whether
the network holds enough data about a subject to make the query worthwhile.
The rules sit in the network itself: roles define what each participant can
do, policies define what each product reads and writes, and entitlement defines
what each participant sees. High-level concepts walks
through the full model.
The API itself is plain REST: JSON request and response bodies, standard HTTP
status codes, and a single versioned prefix (/v1) for every public endpoint.
Errors follow one consistent envelope — see Errors — so the
handling code you write for your first endpoint works for all of them.
Where to start
Most organizations play one or more of three roles in a network. Find yours and follow its path.Network governors
You operate a network: you decide which products it offers, what each product is allowed to read and write, and who participates. Start with Networks to understand the trust boundary you are administering, then define the rules of the road with querying and furnishing policies —POST /v1/networks/policies/querying and
POST /v1/networks/policies/furnishing create the policy shells, and the
PUT .../{policy_id}/configuration endpoints author the per-field selections.
The Join a network quickstart shows the
participant side of what you are governing.
Furnishers
You contribute data: KYC or KYB outcomes your institution has already verified. Start with the Furnishing overview to learn how contributed data is validated and stored, then run the Furnish an entity quickstart to push your first record throughPOST /v1/products/kyc_certificate/furnish. High-volume
furnishers can ingest files through POST /v1/file-upload/ingest or automated
SFTP delivery instead of per-record API calls.
Queriers
You consume data: you want a consolidated KYC certificate or a screening-list answer for an entity you are onboarding. Start with the Querying overview to see how a query resolves across network, policy, and consent, and read Consent — you must record consent and obtain aconsent_id before any query. Then run the
Query a product quickstart, which takes you
from POST /v1/consent/consumer to
POST /v1/products/kyc_certificate/query end to end.
Environments
The API is served per environment. All public endpoints sit under the/v1
prefix and require a bearer token (see
Authentication).
| Environment | Base URL | Purpose |
|---|---|---|
| Development | https://api.dev.solo.one | Early integration and experimentation |
| Sandbox | https://api.sandbox.solo.one | Pre-production testing with test data |
| Production | https://api.prod.solo.one | Live traffic |
GET /health returns {"status": "healthy"}, and GET /version reports the
supported API versions and build information.
Credentials are scoped to a single environment. A token minted for sandbox
will not authenticate against production, and vice versa.
Next steps
Quickstart
Furnish an entity, query a product, and join a network — hands-on, in
minutes.
High-level concepts
Networks, entities, consent, products, policies, and entitlement — and how
they fit together.
API Reference
Endpoint-by-endpoint request and response schemas for the full
/v1
surface.