Skip to main content

End User Authentication

This workflow covers an end user — an independent rental owner (agent) or a property management organization — creating an account on your application and completing identity authentication through the relay APIs. Your backend persists the consent trail, calls the endpoint matching the end user's type, and relays the result to your frontend.

End User UXPartner Backendrelay API

Steps​

  1. End user creates an account on your application (your UX).
  2. End user accepts the relay Terms of Use Agreement in your UX.
  3. End user authorizes identity authentication. Persist the consent trail from steps 2–3 — date, time, and what was agreed to — in your own datastore.
  4. End user submits the required PII for identity authentication.
  5. Your backend sends the PII to relay, choosing the endpoint by end-user type.
  6. Call the matching endpoint — POST /api/experian/agents/{agentId} for an individual agent, or POST /api/experian/organizations/{organizationId} for an organization.
  7. If authentication fails, your backend relays 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.
  8. Show the result and prompt the end user to review their PII.
  9. On success (or when the user declines to retry), continue into your app — e.g., your dashboard.