Applications
An application is the core KYC/KYB record for a customer you are onboarding. Every application is one of two entity types — Business or Individual — and moves through a four-state lifecycle.
Lifecycle
Section titled “Lifecycle”| Status | Meaning | Set by |
|---|---|---|
PENDING | Created, not yet submitted for review | POST /applications (initial state) |
SUBMITTED | Submitted and awaiting a review decision | POST /applications/{id}/submit (only from PENDING) |
APPROVED | Review passed | POST /applications/{id}/approve (only from SUBMITTED) |
REJECTED | Review failed | POST /applications/{id}/reject (only from SUBMITTED) |
The transition endpoints enforce the source state: submitting a non-PENDING application, or approving/rejecting one that isn’t SUBMITTED, returns a 400.
PATCH /applications/{id} updates application data (labels, display configuration, and the individual or business details) — it does not change status. Status only moves through the submit / approve / reject endpoints.
Reading an application
Section titled “Reading an application”GET /applications returns a cursor-paginated list (see the Pagination guide). GET /applications/{id} returns the full record, including the risk object (see the Risk Scoring guide) on the populated businessApplication or individualApplication.
Approved or in-review applications can be exported via GET /applications/{id}/export/crs-xml and GET /applications/{id}/export/csv.
Example
Section titled “Example”# List applications (cursor-paginated)curl https://api.getsteward.ai/api/v1/applications \ -H "Authorization: Bearer stw_live_your_api_key_here"
# Fetch one, including its risk breakdowncurl https://api.getsteward.ai/api/v1/applications/{id} \ -H "Authorization: Bearer stw_live_your_api_key_here"
# Submit it for review (only valid from PENDING)curl -X POST https://api.getsteward.ai/api/v1/applications/{id}/submit \ -H "Authorization: Bearer stw_live_your_api_key_here"Audit trail
Section titled “Audit trail”GET /audit-logs?applicationId={id} returns an application’s change history — a cursor-paginated list of audit entries, each a timestamped event (created, submitted, approved, document uploaded, risk score updated, and so on) with the actor’s name and an optional note. Use it to reconstruct everything that has happened to an application.
Searching
Section titled “Searching”GET /platform/search?q=… runs an account-scoped global search and returns matches grouped into applications, screening, documents, and tasks sections, each with an items array and a total. Narrow it with type (applications / screening / documents / tasks) and the per-category filters. Every result carries the applicationId it belongs to, so search is the usual way to find the application you then read in full.