Get report as a renter

GET 
/api/experian/renters/:renterId/report

Retrieves the Experian credit report for the authenticated renter.

The report is only accessible after successful authentication (OTP or KBA).

Content negotiation: The response is returned as either rendered HTML (text/html) or structured JSON (application/json). The format is resolved in this priority order: format query param > contentType query param > Accept header > default. Non-relay partner clients default to HTML; relay first-party clients default to JSON.

Accessing an expired report returns 400 Bad Request (not 410).

Request

Responses

200

Report retrieved.

400

Report has expired (errorCode 138, errorOnField: tokenExpiration), or a query parameter was invalid. An invalid excludeBackground or excludeHousingCourt value returns a different, reduced body whose key is message rather than errorMessage, with no payload key.

402

The renter has not completed their per-transaction Stripe Checkout payment for this screening. payload is not null on this response — it carries reason and message alongside legacy errorCode 285. Send the renter through Create Checkout Session before retrying. See Billing.

403

Missing or invalid X-API-KEY, or the renter has not authenticated. Also returned when a partner client explicitly requests JSON — a reserved first-party format — in which case the body is the reduced {"payload": "<message>"} shape with no errors key.

404

Renter not found (errorCode 278)

406

Unsupported format. Supported values are json and html. The body is the reduced {"payload": "<message>"} shape — no errors key.

423

Temporarily blocked after repeated failed attempts (errorCode 300)