CPIDResponse

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

  • The cpid is an encrypted identifier that uniquely identifies the user to the carrier and is required.

  • The ttlSeconds field indicates the validity duration of the CPID for GTAF to query user data plan details and is also required.

Response from the CPID endpoint when CPID creation is successful.

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

string

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

ttlSeconds

integer

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.