Developer documentation
Administration and operations
Manage users, institutions, applications, disputes, audit logs and reporting health.
Institution users
An authorised institution manager creates an invitation with email and one of OWNER, ADMIN, UNDERWRITER, ANALYST, DEVELOPER or VIEWER. Invitations expire after seven days. The recipient accepts the one-time token with a display name and a password of at least 12 characters.
Deliver tokens securely
The invitation endpoint returns the token. Deliver it through an approved channel and never leave it in application logs or issue trackers.
Reporting health
GET /institutions/me/reporting-health calculates a current snapshot including active accounts, stale accounts, events reported, queries, sync percentage, error count, status and last report time. Review it after imports and on an operational schedule.
Audit log
GET /audit returns institution-scoped audit records newest first. Filter by action and choose limit 1–500. Retain request ID, actor, target, IP, user agent and metadata when investigating an operation.
Platform user management
GET /admin/users provides a searchable, paginated directory containing account status, RCN administrator role and institution membership. RCN superadministrators can create either a platform administrator or a single-institution user, edit identity and assignment, activate or deactivate an account, reset its password and revoke sessions.
- POST /admin/users accepts email and display_name plus either admin_role, or institution_id and institution_role. Production queues a single-use password-setup link and never returns a credential.
- PATCH /admin/users/{user_id} changes identity, active state or assignment. Security-boundary changes invalidate issued sessions.
- POST /admin/users/{user_id}/reset-password revokes sessions and emails a hashed, expiring, single-use setup link.
- POST /admin/users/{user_id}/revoke-sessions invalidates refresh and already-issued access tokens through the session version.
- POST /auth/change-password lets an authenticated user replace their own password after confirming the current password.
Development-only temporary credentials
Development and test responses may include a one-time temporary password for local automation. Production suppresses it and uses the configured email outbox.
Platform administration
- GET /admin/applications lists institution applications; PATCH /admin/applications/{id} reviews one and creates a pending institution on approval.
- GET /admin/network-metrics returns institution, subject, active-account, outstanding-credit and open-dispute totals.
- GET /admin/institutions searches by name, legal name or slug, filters by status and paginates with limit/offset.
- PATCH /admin/institutions/{id} changes institution status; activation records joined_at when first activated.
- PATCH /admin/disputes/{id} records status and resolution.
- User listings are available to RCN administrators; user mutations require RCN_SUPERADMIN. Institution OWNER is not a platform-administrator role.
Separation of duties
Use individually assigned admin accounts, require strong authentication operationally, review admin audit events and avoid using platform credentials for routine institution work.