BaseID Cloud API

BaseID Cloud is a hosted credential infrastructure platform. Issue, verify, and manage verifiable credentials via REST APIs — no infrastructure to run.

Base URL

https://api.baseid.cloud

For self-hosted deployments, replace with your instance URL.

Quick start

# 1. Register and get an API key
curl -X POST https://api.baseid.cloud/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@example.com",
    "password": "your_password",
    "display_name": "Your Name",
    "tenant_name": "Your Org",
    "tenant_slug": "your-org"
  }'
# Returns: { "token": "...", "tenant_id": "..." }

# 2. Create an API key
curl -X POST https://api.baseid.cloud/v1/admin/keys \
  -H "Authorization: Bearer <session-token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-key"}'
# Returns: { "key": "bsk_live_..." }

# 3. Create a DID
curl -X POST https://api.baseid.cloud/v1/dids \
  -H "Authorization: Bearer bsk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"method": "key", "key_type": "Ed25519"}'

# 4. Issue a credential
curl -X POST https://api.baseid.cloud/v1/credentials/issue \
  -H "Authorization: Bearer bsk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "format": "jwt_vc_json",
    "issuer_did": "did:key:z6Mk...",
    "subject_did": "did:key:z6MkHolder",
    "types": ["VerifiableCredential", "CanadianDigitalID"],
    "claims": {"givenName": "Alice", "familyName": "Martin"}
  }'

API sections

Section	Endpoints	Description
Authentication	4	Register, login, session management
Credentials	5	Issue, list, get, revoke credentials
Verification	1	Verify any credential format
DIDs	4	Create, list, resolve, deactivate
Compliance	6	Reports, consent, audit, assurance, HAIP
Trust	5	Attestations, scores, delegation
DIDComm	4	Send, receive, thread tracking
Team & RBAC	7	Members, invitations, roles, permissions
Admin	10	API keys, webhooks, usage, billing, domains, templates
SDKs	—	TypeScript, Python, Go client libraries
Errors & Limits	—	Error codes, rate limits, pricing tiers

Supported credential formats

Format	format value	Description
W3C JWT-VC	jwt_vc_json	Signed JWT Verifiable Credential
SD-JWT VC	vc+sd-jwt	Selective Disclosure JWT

Additional formats (mDL, BBS+, AnonCreds) available via the core library API.

Response format

All responses are JSON. Successful responses return 2xx status codes. Error responses include an error field:

{ "error": "description of what went wrong" }