Workflows
Each workflow on these pages shows one end-to-end journey through your integration, color-coded by who does what: your end-user-facing UX, your backend, and the relay APIs. Every diagram is numbered, and the steps below it link to the exact endpoint reference pages you'll implement against. Hover over any diagram for an expand button with zoom controls.
Authentication
| Workflow | What it covers |
|---|---|
| End User Authentication | An agent or organization registers and authenticates through your application |
| Consumer Authentication | A renter registers, authenticates, pays via Stripe Checkout, and receives reports |
| Authentication w/ OTP Step Up | Handling a one-time-password challenge when authentication isn't immediately accepted |
| Authentication w/ KBA Step Up | Handling knowledge-based authentication questions (organizations always step up to KBA) |
| End User Re-Authentication | Re-authenticating an agent whose 365-day authentication has lapsed |
Report sharing
| Workflow | What it covers |
|---|---|
| Consent to Share Report | A consumer consents to share their report with an end user |
| Revoke Consent to Share Report | A consumer revokes a previously granted share |
| End User View Shared Report | An end user retrieves a report a consumer shared with them |
Reports
| Workflow | What it covers |
|---|---|
| Consumer View Requested Report | A consumer retrieves and views their own report |