TrustLoan

Organisation API

TrustLoan is web-first for core launch. Organisations that need custom mobile apps, internal dashboards, or system integrations can use tenant-scoped API access after platform approval.

Last updated: June 20, 2026

Platform Role

TrustLoan provides technology infrastructure for savings, collections, customer records, loan workflow tracking, disclosures, and reporting. TrustLoan does not underwrite, approve, set terms for, or disburse loans. Each organisation remains responsible for its own lending authorization, product terms, customer relationship, and complaint handling.

Authentication

API credentials are issued per organisation. Raw keys are shown only once when created; TrustLoan stores only a hash, key prefix, scopes, status, and audit trail. Requests must use HTTPS and include the API key in the authorization header.

Authorization: Bearer tl_live_...

Organisation admins with API access can create a credential through the authenticated web platform endpoint below. The response includes the raw key once.

POST /api/organisation-api-credentials
{
  "name": "Custom mobile app",
  "scopes": ["customers:read", "savings:read", "collections:read"]
}

Health Check

Use the unauthenticated health endpoint to verify API availability.

GET /api/v1/health

Resource Endpoints

Resource endpoints are read-only for launch and return only records belonging to the organisation that owns the API key. Use limit to cap list responses, and use includeInactive=true only where the endpoint supports inactive records.

EndpointScopePurpose
GET /api/v1/customerscustomers:readCustomer directory records.
GET /api/v1/agentsagents:readActive collector and loan-agent records.
GET /api/v1/loan-productsloan_products:readLoan product terms and availability.
GET /api/v1/loan-applicationsloan_applications:readLoan workflow status and lender disclosure snapshots.
GET /api/v1/savings-planssavings:readSavings product metadata and active enrollment counts.
GET /api/v1/collectionscollections:readSavings contribution and cash collection records.
GET /api/v1/reports/summaryreports:readTenant dashboard summary metrics.
curl https://trustloans.n-qube.com/api/v1/customers \
  -H "Authorization: Bearer tl_live_..."

Scopes

ScopeAccess
customers:readRead customer records for the authenticated organisation.
agents:readRead agent and collector records for operational dashboards.
savings:readRead savings plans, balances, and contribution summaries.
collections:readRead field collection and cash collection records.
loan_applications:readRead loan application records and disclosure status.
loan_products:readRead active and inactive loan product metadata.
reports:readRead reporting aggregates for tenant dashboards.

Custom Apps

Tenant-branded mobile apps are custom projects. Before TrustLoan builds or submits a custom app for an organisation, that organisation must provide provider details, public support and privacy links, representative product terms, and any required regulatory or app-store evidence for the country and financial features involved.