API v1 reference
Every endpoint, in one place.
Use this catalogue to find implemented methods and access requirements. The integration guides explain request models, lifecycle behavior and production controls.
Authentication
User sessions and invitations.
/auth/loginExchange email/password for rotating token pair
/auth/refreshRotate a valid refresh token
/auth/meReturn the authenticated user
/auth/change-passwordChange the current user's password and revoke refresh sessions
/auth/accept-invitationCreate a user from a valid invitation
Subjects and credit
Identity resolution, inquiries and explainable profiles.
/subjectsCreate an individual or organisation
/subjects/minecraft/{minecraft_uuid}Resolve an individual by Minecraft UUID
/subjectsSearch subjects with q and limit parameters
/inquiriesRecord an explicit inquiry
/credit/{subject_id}Query profile and record inquiry
/credit/{subject_id}/historyList score snapshots
Accounts and events
Institution reporting surfaces.
/accountsCreate an account idempotently
/accountsList institution accounts
/accounts/bulkCreate up to 100 accounts
/accounts/{account_id}/eventsAppend one event idempotently
/events/bulkAppend up to 500 events
Reports, disputes and audit
Durable assessments and governance workflows.
/reportsCreate a detailed report
/reports/{report_id}Retrieve an accessible report
/disputesList applicable disputes
/auditList institution audit events
/institutions/me/reporting-healthCalculate reporting health
API keys and users
Institution access administration.
/api-keysIssue a scoped key
/api-keysList key metadata
/api-keys/{key_id}Revoke a key
/api-keys/{key_id}/rotateRevoke and replace a key
/institutions/users/invitationsInvite an institution user
Webhooks
Signed delivery management.
/webhooksCreate a subscription
/webhooksList subscriptions
/webhooks/{webhook_id}/rotate-secretRotate signing secret
/webhooks/{webhook_id}Disable subscription
/webhooks/{webhook_id}/deliveriesList recent deliveries
/webhooks/deliveries/{delivery_id}/retryRequeue an eligible delivery
/webhooks/{webhook_id}/testGenerate a signed test payload
Public
Aggregate reads and controlled intake only; no public credit data.
/public/network-statsAggregate network totals
/public/member-institutionsPublicly listed active institutions
/public/statusService status
/public/contactSubmit contact request
/public/institution-applicationsApply for membership
/public/disputesOpen a dispute
RCN administration
Cross-network operations; platform administrator only.
/admin/applicationsList institution applications
/admin/applications/{application_id}Review an application
/admin/network-metricsNetwork operating metrics
/admin/institutionsSearch and paginate institutions
/admin/institutions/{institution_id}Change institution status
/admin/disputes/{dispute_id}Resolve a dispute
/admin/usersSearch and paginate user accounts
/admin/usersCreate a platform or institution login
/admin/users/{user_id}Update status, identity or access assignment
/admin/users/{user_id}/reset-passwordIssue a one-time temporary password
/admin/users/{user_id}/revoke-sessionsRevoke the user's refresh sessions
Need the request model?
The live OpenAPI explorer reflects the running backend schema. Use it alongside these operational guides, and pin your integration to the /api/v1 base path.
Open live schema