RICA

RICA Atlas

Market API

The RICA Atlas Market API allows approved software and workflow participants to connect with Atlas as the operating record for projects, evidence, and metrics.

The Market API connects approved software and workflow participants with Atlas as the operating record for projects, evidence, metrics, origination workflows, project loans, note monitoring, and portfolio outputs.

This page documents the current working surface. It is an integration guide, not a fully versioned public API contract or SDK specification. Integrators coordinate with the platform team before relying on behavior that is not explicitly documented for their environment.

API posture

Convention Current Surface
API root /api/v1
Health endpoint GET /api/v1/health
Response style JSON envelopes, typically with data.
Validation style Structured details with field paths and messages.

Authentication

External API access uses issued bearer credentials.

Atlas API access is controlled through approved environments and authenticated credentials issued for the relevant organization, role, and integration scope. 

Authorization: Bearer <token>

Authenticated routes resolve the acting user, organization, role, and permitted actions from the issued token and platform authorization policy. Integrators should not assume access to every route listed below; available surfaces depend on the approved use case, data-sharing permissions, and environment.

Integration domains

Domain Business Purpose
Identity and session bootstrap Establish user, role, organization, and desk context.
Organizations and reference data Synchronize institutional records, members, countries, districts, and currencies.
Projects, discovery, and search Find visible projects and retrieve asset-level records.
Documents and media Upload, register, retrieve, and govern evidence and investor materials.
Metrics and verification Maintain metric definitions, assignments, submissions, and review workflows.
Origination, loans, and portfolio Support project screening, loan proposals, activation, servicing, and portfolio visibility.
Notes and monitoring Expose note records, pool composition, documents, cash flows, distributions, and investor workflows.

Representative endpoints

The current surface is grouped by market workflow.

Representative Endpoints

Identity And Session Bootstrap

  • POST /api/v1/auth/bootstrap
  • POST /api/v1/auth/login
  • GET /api/v1/me
  • GET /api/v1/users/me
  • PATCH /api/v1/users/me
  • GET /api/v1/users/me/overview

Organizations And Reference Data

  • POST /api/v1/organizations
  • GET /api/v1/organizations
  • GET /api/v1/organizations/:organizationId
  • PATCH /api/v1/organizations/:organizationId
  • GET /api/v1/organizations/:organizationId/members
  • POST /api/v1/organizations/:organizationId/members
  • PATCH /api/v1/organizations/:organizationId/members/:memberId
  • GET /api/v1/reference/countries
  • GET /api/v1/reference/districts
  • GET /api/v1/reference/currencies
  • GET /api/v1/projects
  • GET /api/v1/projects/:projectId
  • GET /api/v1/discover/...
  • GET /api/v1/search/...

Documents And Media

  • GET /api/v1/projects/:projectId/documents
  • POST /api/v1/projects/:projectId/documents
  • DELETE /api/v1/projects/:projectId/documents/:documentId
  • GET /api/v1/projects/:projectId/media
  • POST /api/v1/projects/:projectId/media
  • PATCH /api/v1/projects/:projectId/media/:mediaId
  • DELETE /api/v1/projects/:projectId/media/:mediaId
  • POST /api/v1/storage/documents/presign-upload
  • PUT /api/v1/storage/documents/direct-upload/:storageKey
  • GET /api/v1/storage/documents/object/:storageKey

Metrics And Verification

  • GET /api/v1/metrics/definitions
  • GET /api/v1/metrics/framework-defaults
  • POST /api/v1/metrics/definitions
  • PATCH /api/v1/metrics/definitions/:metricId
  • GET /api/v1/projects/:projectId/metrics/assignments
  • POST /api/v1/projects/:projectId/metrics/assignments
  • PATCH /api/v1/projects/:projectId/metrics/assignments/:assignmentId
  • POST /api/v1/projects/:projectId/metrics/assignments/:assignmentId/retire
  • GET /api/v1/projects/:projectId/metrics/submissions
  • POST /api/v1/projects/:projectId/metrics/submissions
  • GET /api/v1/projects/:projectId/metrics/latest-values
  • GET /api/v1/projects/:projectId/metrics/kpis
  • GET /api/v1/projects/:projectId/metrics/dashboard
  • POST /api/v1/metrics/submissions/:submissionId/auditor-review
  • POST /api/v1/metrics/submissions/:submissionId/platform-approval

Origination, Loans, And Portfolio

  • GET /api/v1/rica-investor/opportunities
  • GET /api/v1/rica-investor/opportunities/:projectId/profile
  • GET /api/v1/rica-investor/underwriting-workbench
  • GET /api/v1/investor-pipeline
  • POST /api/v1/investor-pipeline
  • PATCH /api/v1/investor-pipeline/:pipelineId
  • GET /api/v1/projects/:projectId/loan-proposals
  • POST /api/v1/projects/:projectId/loan-proposals
  • GET /api/v1/origination/loan-proposals
  • POST /api/v1/origination/loan-proposals/:proposalId/approve
  • POST /api/v1/origination/loan-proposals/:proposalId/decline
  • POST /api/v1/origination/loan-proposals/:proposalId/activate
  • GET /api/v1/projects/:projectId/loans
  • POST /api/v1/projects/:projectId/loans
  • PATCH /api/v1/projects/:projectId/loans/:loanId
  • GET /api/v1/projects/:projectId/loans/:loanId/schedule
  • GET /api/v1/project-loans/:loanId/servicing
  • POST /api/v1/admin/project-loans/:loanId/servicing/rebuild
  • POST /api/v1/admin/project-loans/:loanId/servicing-events
  • GET /api/v1/rica-investor/loan-portfolio
  • GET /api/v1/portfolio-positions

Notes And Monitoring

  • GET /api/v1/notes
  • GET /api/v1/notes/compare
  • GET /api/v1/notes/:noteId
  • GET /api/v1/notes/:noteId/projects
  • GET /api/v1/notes/:noteId/documents
  • GET /api/v1/notes/:noteId/cashflows
  • GET /api/v1/notes/:noteId/distributions
  • GET /api/v1/notes/:noteId/loan-purchases
  • POST /api/v1/notes/:noteId/request-materials
  • POST /api/v1/notes/:noteId/questions
  • GET /api/v1/notes/:noteId/my-interest-requests

Document upload sequence

Uploads separate binary transfer from evidence registration.

  1. 01 Request upload target from /api/v1/storage/documents/presign-upload.
  2. 02 Upload the binary to the returned target.
  3. 03 Register the uploaded file with POST /api/v1/projects/:projectId/documents.
  4. 04 Allow Atlas worker flows and review policies to govern downstream access.

Representative integration patterns

Sponsor System To Atlas

Sponsor systems can synchronize organization and user identities, create or update project records, upload evidence, push metrics submissions, and respond to loan proposal or data-request states.

Workflow Tool To Atlas

Workflow tools can pull project, document, and note detail from Atlas, reference Atlas IDs as canonical records, and write back review outcomes, document metadata, or workflow events where supported.

Monitoring Stack To Atlas

Monitoring systems can fetch KPI, metrics, servicing, and portfolio endpoints, maintain downstream dashboards, and preserve Atlas as the authoritative source for operating state.

Integration discipline

Partners design for version discipline and permission-aware workflows.

Partners design for version discipline, permission checks, pagination, retries, idempotency where applicable, request tracing, and environment-specific test data.

API formalization covers route versioning, pagination and filtering conventions, rate limits, webhook events, schema examples, changelog practices, and a stable error model.