Consent Requests - Gigs API Docs

Properties

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"
}

GET/projects/{project}/consentRequests/{consentRequest}

Retrieves a consent request by the given id.

Path Parameters

Name
project
Type
string
required
Description
The unique identifier for the project.
Example: "gigs"
Name
consentRequest
Type
string
required
Description
The unique identifier of the consent request.
Example: "crq_0SNlurA049MEWV2jN9EvAfKMf7VU"

Responses

Returns the consent request if it exists.

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"

Request

GET

/projects/{project}/consentRequests/{consentRequest}

curl https://api.gigs.com/projects/${GIGS_PROJECT}/consentRequests/{consentRequest} \
-X GET \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${GIGS_TOKEN}" \
-H "Accept: application/json"

Response

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

POST/projects/{project}/consentRequests/{consentRequest}/approve

Grants consent for the given request. This will trigger the consent request to be processed and the request to transition to the approved status. The consent request must be in the pending status in order to be approved.

Body

Name
code
Type
string
required
Description
The OTP associated with the consent request, used to validate the given consent.
Example: "123456"

Path Parameters

Name
project
Type
string
required
Description
The unique identifier for the project.
Example: "gigs"
Name
consentRequest
Type
string
required
Description
The unique identifier of the consent request.
Example: "crq_0SNlurA049MEWV2jN9EvAfKMf7VU"

Responses

Returns the consent request.

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"

Request

POST

/projects/{project}/consentRequests/{consentRequest}/approve

curl https://api.gigs.com/projects/${GIGS_PROJECT}/consentRequests/{consentRequest}/approve \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${GIGS_TOKEN}" \
-H "Accept: application/json" \
-d '{
  "code": "123456"
}'

Response

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

{ "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" }

curl https://api.gigs.com/projects/${GIGS_PROJECT}/consentRequests/{consentRequest} \ -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${GIGS_TOKEN}" \ -H "Accept: application/json"

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

Approves the consent request

Body

Name
code
Type
string
required
Description
The OTP associated with the consent request, used to validate the given consent.
Example: "123456"

Path Parameters

Name
project
Type
string
required
Description
The unique identifier for the project.
Example: "gigs"
Name
consentRequest
Type
string
required
Description
The unique identifier of the consent request.
Example: "crq_0SNlurA049MEWV2jN9EvAfKMf7VU"

curl https://api.gigs.com/projects/${GIGS_PROJECT}/consentRequests/{consentRequest}/approve \ -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${GIGS_TOKEN}" \ -H "Accept: application/json" \ -d '{ "code": "123456" }'