Skip to main content

Link Renter to Agent

PUT 
/api/experian/agents/:agentId/renters/:renterId

Creates a link between a renter and an agent, allowing the agent to view the renter's report.

The unitAddress field should include the property address the renter is applying for. This address is submitted to Experian as part of the report share and is stored for compliance purposes. It is not currently enforced server-side — a request without it succeeds and creates the share with no address on record — but omitting it is strongly discouraged and enforcement may be added in the future.

Legacy alias: PUT /api/experian/renters/{renterId}/agents/{agentId} accepts the same request body and is supported for backward compatibility.

The unitAddress wrapper accepts snake_case child keys as shown below. The wrapper key may also be sent as unit_address (legacy), and a flat camelCase form (unitStreetAddress1, unitCity, …) is also accepted. Two zip-only legacy forms, {"zipCode": "..."} and {"propertyZip": "..."}, are also accepted at the top level.

Request​

Responses​

Renter linked successfully