Recovering a third-party product entitlement

Overview

If the user has forgotten their username for the third-party service (e.g., Netflix) or registered with an incorrect email address, the operator CRM system can recover the entitlement.

The request described below returns an activation URL. The URL launches the third-party service’s portal with a short-lived token that allows the user to set up their account there. It is up to the CRM system as to how this is displayed or communicated to the user.

Request

To recover a third-party product entitlement, the CRM system should send a POST request to:

BASH

https://<host>:<port>/tpes/v1/operator/entitlements/{entitlementId}/actions/recover

Headers

x-correlation-id – identifier for logging, to correlate messages across a call flow
Authorization – Keycloak access token (see Accessing operator APIs using Keycloak)
nv-tenant-id – the tenant ID

Mandatory arguments

entitlementId (in URL) – the ID of the entitlement to recover

Optional arguments

None

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

If the specified entitlement does not exist, the request returns an HTTP 404 status.

See the Third Party Entitlement Service (TPES) API documentation for the specific error codes and their meanings.

Example

A successful request returns the following response body:

CODE

{
  "recoveryUrl": "https://example.activation.url.bango.com"
}