Get Renter Report as Agent
GET/api/experian/agents/:agentId/renters/:renterId
Retrieves the Experian credit report for a linked renter.
The agent must be authenticated and have an active link to the renter. The link must have been created with a valid unit address via the Link Renter to Agent endpoint.
Content negotiation: Returned as rendered HTML (text/html) or structured
JSON (application/json). Resolution priority: 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).
Path variants: this suffix-less path is the original V1 spelling and carries
essentially all current production traffic. The service treats
GET /api/experian/agents/{agentId}/renters/{renterId}/report
(with the /report suffix) as the canonical route; it behaves identically, and
is the only form served by the SDK/Lambda surface. New integrations should
prefer the /report form.
Request
Responses
- 200
- 400
- 403
- 404
- 406
Report retrieved successfully
Report has expired or invalid request. Note — an invalid excludeBackground
or excludeHousingCourt value returns a reduced error body of the form
{"errors":[{"message": "..."}]} (no errorCode/errorOnField keys).
Invalid API key, not authenticated, or no link exists. Also returned when a
partner client explicitly requests JSON format, which is reserved for
relay first-party clients — that variant has body
{"payload": "JSON format is not available for this client"}.
Agent or renter not found
Unsupported media type (supported formats are application/json and text/html).
The body is {"payload": "<message>"} rather than the standard error envelope.