Retrieve product activation URL

The Request Activation Info API lets you retrieve activation details for entitlements in a PENDING state. You can use it to get a new activation URL when a previous one has expired, while keeping the same entitlement. The endpoint to request activation info is:

POST  /v1/entitlement/activationInfo/{entitlementId}

It is expected that the Entitlement ID is provided as part of the path parameter. (See our API documentation for full details) The Response will look like:

{
"entitlementId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f",
"responseCode": "CLIENT_ACTION_REQUIRED",
"responseMessage": "An action is required to be performed by the client.",
"parameters": {
"action": "NAVIGATE_TO_URL",
"url": "https://example.com/?entitlementId=a25100b8-4e0c-4e37-b921-cac9cb1e930f",
"urlExpiry": "0001-01-01T00:00:000Z"
}
}

When Should you use this service?

Use this endpoint when a consumer needs to complete their service sign-up or activation flow. The API supports:

Initial activation requests
Refreshing expired activation information

When activation information is refreshed, the entitlementId stays the same and the API returns a new valid activation URL. The response includes a urlExpiry value, which shows how long the activation URL remains valid. Every API call returns a currently valid activation URL for the entitlement.

Canceling entitlements

Welcome

Getting started

Partner management

Migrating to DVM

Offer management

Entitlement management

Billing & Charging

Notifications

Correlation and reconciliation

Dashboard and reporting

Partner care

When Should you use this service?

​When Should you use this service?

When Should you use this service?