Skip to main content

Revoke Consent to Share Report

A consumer who previously consented to share their report can revoke that consent at any time through UX you build. Your backend calls the unlink endpoint for the end-user type; relay deactivates the share and the same response path handles every outcome.

End User UXPartner Backendrelay API

Steps​

  1. Consumer revokes consent to share their report with an end user, via UX you create.
  2. Gather the consumer (renter) ID and the end user (agent or organization) ID and make the API call.
  3. Call the unlink endpoint for the end-user type — DELETE /api/experian/agents/{agentId}/renters/{renterId} or DELETE /api/experian/organizations/{organizationId}/renters/{renterId}.
  4. If an active shared report exists, relay revokes it and logs the sharing as inactive. If no shared report exists, or it is already inactive, the response says so — the flow continues identically.
  5. Translate the response and render UX. Recommended: persist the request and response timestamps in your own datastore.
  6. Display the response message to the consumer.
  7. Notify the end user that the report is no longer shared with them (recommended).