ConsentRequest

  • Name
    object
    Type
    string
    Description

    Type of object is always consentRequest.

    Allowed values: consentRequest 
  • Name
    id
    Type
    string
    Description

    Unique identifier for the consent request.

    Example: "crq_0SNlurA049MEWV2jN9EvAfKMf7VU"
  • Name
    createdAt
    Type
    string
    Description

    The timestamp at which the consent request was created.

    Example: "2024-01-09T15:00:51Z"
  • Name
    deliveryMethod
    Type
    nullable string
    Description

    The method by which the consent request is delivered to the user.

    Example: "emailLink"
    Allowed values: emailLink sms smsLink smsOTP 
  • Name
    expiredAt
    Type
    nullable string
    Description

    The timestamp at which the consent request expired.

    Example: "2024-01-09T15:00:51Z"
  • Name
    operation
    Type
    string
    Description

    The operation being requested.

    Example: "exchange.sim"
    Allowed values: change.phoneNumber change.provider exchange.sim issue.portOutCredentials portin.subscription 
  • Name
    status
    Type
    string
    Description

    The status of the consent request.

    Example: "pending"
    Allowed values: approved bypassed canceled expired pending 
  • Name
    subject
    Type
    string
    Description

    The ID of resource being affected by the operation. It can be for example a port out ID, if the operation is issue.portOutCredentials.

    Example: "pto_0SNlurA049MEWV4DWEaT4SaeDI8s"
  • Name
    subscription
    Type
    string
    Description

    Unique identifier for the subscription inferred from the resource associated with this consent request, e.g. a port-out, porting, or subscription change.

    Example: "sub_0SNlurA049MEWV2gSfSxi00xlPIi"

Example

{
  "object": "consentRequest",
  "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
  "createdAt": "2024-01-09T15:01:51.0Z",
  "deliveryMethod": "emailLink",
  "expiredAt": "2024-01-09T15:00:51Z",
  "operation": "exchange.sim",
  "status": "pending",
  "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
  "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
}