CPIDResponse

  • The CPID endpoint returns a JSON object containing the cpid and ttlSeconds when a carrier plan identifier is successfully created.

  • The cpid is an encrypted string that uniquely identifies the user to their carrier.

  • The ttlSeconds value represents the duration, in seconds, that the CPID is valid and can be used to fetch user data plan details.

Response from the CPID endpoint when CPID creation is successful.

JSON representation 
{
  "cpid": string,
  "ttlSeconds": number
}
Fields
cpid

string

Required. Encrypted carrier plan identifier that uniquely identifies the user to the carrier.

ttlSeconds

number

Required. Duration, in seconds, for which the CPID is valid and can be used by GTAF to query the DPA for details of a user's data plan.