Docs / API and agents
Customer (applicant) read API
Read endpoints behind the customer workspace: dashboard, application detail, messages, references and settings.
All routes need a session and answer private, no-store. Every read is scoped to applications the caller created (createdById equals the session user); an application id, code or email text never grants access on its own. A foreign or unknown id is a 404.
| Method and path | What |
|---|---|
GET /applicant/dashboard?status=&page= | counts by status, accounts (approved count, summed limits, payment terms in days in use), needsYou[] (supplier message awaiting reply on an open application, references that did not respond or declined, drafts untouched for 7 days; reference items need references.view, canAct is references.remind), one page of rows with paymentTermsDays |
GET /applicant/applications/by-code/:code | resolve a confirmation code to the caller's application id (404 if it is not theirs) |
GET /applicant/applications/:id | one application with references, documents and decision status |
GET /applicant/messages | the messaging inbox; accepts only thread, page, messagePage, q (anything else is 400 "Invalid inbox selector.") |
GET /applicant/references | references across the caller's applications |
GET /applicant/settings | account and business settings view |