Skip to main content

Consumer Authentication

This workflow covers a consumer (renter) creating an account on your application, authenticating their identity, paying for their screening via Stripe Checkout, viewing their reports, and optionally consenting to share them with an end user. It is the longest journey in the library — the authentication head matches End User Authentication, and the consent tail is broken out separately as Consent to Share Report.

End User UXPartner Backendrelay API

Steps​

  1. Consumer creates an account on your application.
  2. Consumer agrees to your, relay, Experian, and CIC terms and conditions.
  3. Consumer authorizes identity authentication and the reports pull (credit, background, and housing court data). Persist the consent trail from steps 2–3 — date, time, and what was agreed to — in your own datastore.
  4. Consumer submits the required PII for the identity authentication and reports workflow.
  5. Your backend authenticates the consumer with POST /api/experian/renters/{renterId}.
  6. If authentication fails, relay the response to your frontend. The response may indicate a step-up challenge — see Authentication with OTP Step Up and Authentication with KBA Step Up.
  7. Show the result and prompt the consumer to review their PII; loop back to step 4 if they retry.
  8. On success, create a Stripe Checkout Session with POST /api/stripe/payment/checkout-session.
  9. Receive the hosted Stripe Checkout page URL in the response.
  10. Redirect the consumer to the hosted Stripe Checkout page.
  11. Consumer completes checkout with payment.
  12. Retrieve the consumer's reports with GET /api/experian/renters/{renterId}/report.
  13. Display the reports to the consumer.
  14. Display the consent-to-share-report choice — does the consumer want to share their report with an end user (agent or organization)?
  15. If they consent, share the report with PUT /api/experian/agents/{agentId}/renters/{renterId} or PUT /api/experian/organizations/{organizationId}/renters/{renterId}, and persist the consent (date, time, consented). This tail is documented in full as Consent to Share Report.