Getting access
There is no self-serve signup over the API. Your organization gets a SOLO dashboard account and is added to networks there; everything else follows from that.1
Get a sandbox dashboard account
Ask your SOLO contact for a sandbox account. SOLO sets up your organization
in the sandbox dashboard at
app.sandbox.solo.one and adds it to one or
more sandbox networks with the roles you need — furnisher to contribute
data, querier to read it.
2
Create an API key
In the sandbox dashboard, open Settings → API keys and create a key for
your integration. Export it so every example in these guides works as-is:See Authentication for how keys work and how to
rotate them.
3
Find your network ID and product IDs
network_id— in the dashboard, open Networks and select your network. Its ID is the last segment of the page URL (/networks/<network_id>). The Members tab shows your organization’s permissions in that network.product_id— needed only for the coverage check (POST /v1/products/check). Open Products in the dashboard and select a product; its Product ID is shown at the top of the page.policy_id— optional. Each querying policy’s Policy ID is shown on its page under Policies. If you leave it out of a query, the querying policy assigned to the first network you query applies.
4
Make your first call
Search for consumers in your network. A A
200 — even with an empty []
body — confirms your key, your organization’s account, and your
network_id all work:401 means the key isn’t being accepted — see the
troubleshooting table.Every example in these docs uses the sandbox API,
https://api.sandbox.solo.one. When you go live, create production keys in
the production dashboard (https://app.solo.one) and switch the base URL to
https://api.solo.one.The sequence
Work through the guides in order the first time:- Join a network — how membership and roles work, and how to confirm your access with read-only calls.
- Furnish an entity — record consent, then contribute KYC verification data about a consumer.
- Query a product — check whether a
certificate can be issued, then read a consolidated KYC certificate back,
including how to interpret a
200versus a204.
/v1/consent/consumer_identity, /v1/entities/consumer_identity/search, and
the KYC certificate’s query, query/soft, and furnish). The business-side
equivalents — POST /v1/consent/business_identity,
GET /v1/entities/business_identity/search, and the KYB certificate’s
POST /v1/products/kyb_certificate_snapshot/query, query/soft, and furnish
— follow the same patterns; the
fintech golden path
lists them.
Domain errors share one envelope: a human-readable
detail plus a
machine-readable error_code (for example PERMISSION_DENIED or
RESOURCE_NOT_FOUND). Authentication failures and malformed requests use a
shorter {"detail": ...} body. See Errors.Choose your path
Join a network
Understand membership and roles, and confirm your access.
Furnish your first entity
Record consent, then contribute KYC data about a consumer.
Query your first product
Read a consolidated KYC certificate back from the network.