PATCH web_api/mobile_consent/{phoneNumber}

You must allow your customer to revoke gMoblie consent for their phone number. Once a consent record has been set to not valid, your API user cannot make gMobile enabled inquiries on the phone number until a new valid consent is recorded for the phone number.

Request Information

URI Parameters

Name	Description	Type	Additional information
phoneNumber	The phone number to revoke mobile consent for should be included in the request body as a numeric value with no punctuation nor spaces.	integer	Required

Body Parameters

If the value of the body is "false", then all valid consent records for the phone number will be set as no longer valid. If the value is "true" then no action will be taken. Consent records for a phone number that have been set invalid cannot be set back to valid. A new consent must be recorded to regain permission for the phone number.

boolean

Request Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of GiactMobileConsentRecord

Name	Description	Type	Additional information
MobileConsentId	The unique identifier for the mobile consent record	integer	None.
RecordedConsent	The recorded mobile consent details	GiactMobileConsent	None.
RecordedDateTime	The DateTime for when the consent was recorded	date	None.
EndUserIpAddress	IP address of the end user that gave consent.	string	None.
IsCurrentlyValid	If the consent is currently valid. Recorded consent can be revoked at any time by the request of the phone number owner.	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "MobileConsentId": 1,
    "RecordedConsent": {
      "PhoneNumber": "sample string 1",
      "ClientIpAddress": "sample string 2",
      "ConsentDescription": "sample string 3"
    },
    "RecordedDateTime": "2025-04-28T06:26:17.5888643-05:00",
    "EndUserIpAddress": "sample string 3",
    "IsCurrentlyValid": true
  },
  {
    "MobileConsentId": 1,
    "RecordedConsent": {
      "PhoneNumber": "sample string 1",
      "ClientIpAddress": "sample string 2",
      "ConsentDescription": "sample string 3"
    },
    "RecordedDateTime": "2025-04-28T06:26:17.5888643-05:00",
    "EndUserIpAddress": "sample string 3",
    "IsCurrentlyValid": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfGiactMobileConsentRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.giact.com/verificationservices/v5">
  <GiactMobileConsentRecord>
    <EndUserIpAddress>sample string 3</EndUserIpAddress>
    <IsCurrentlyValid>true</IsCurrentlyValid>
    <MobileConsentId>1</MobileConsentId>
    <RecordedConsent>
      <ClientIpAddress>sample string 2</ClientIpAddress>
      <ConsentDescription>sample string 3</ConsentDescription>
      <PhoneNumber>sample string 1</PhoneNumber>
    </RecordedConsent>
    <RecordedDateTime>2025-04-28T06:26:17.5888643-05:00</RecordedDateTime>
  </GiactMobileConsentRecord>
  <GiactMobileConsentRecord>
    <EndUserIpAddress>sample string 3</EndUserIpAddress>
    <IsCurrentlyValid>true</IsCurrentlyValid>
    <MobileConsentId>1</MobileConsentId>
    <RecordedConsent>
      <ClientIpAddress>sample string 2</ClientIpAddress>
      <ConsentDescription>sample string 3</ConsentDescription>
      <PhoneNumber>sample string 1</PhoneNumber>
    </RecordedConsent>
    <RecordedDateTime>2025-04-28T06:26:17.5888643-05:00</RecordedDateTime>
  </GiactMobileConsentRecord>
</ArrayOfGiactMobileConsentRecord>