GET web_api/mobile_consent/{phoneNumber}/records
Get your API user's mobile consent record(s) for a phone number
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
phoneNumber |
The phone number that you are adding a new consent record for is part of the URL. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The response body will include a list of all mobile consent records for the phone number.
Collection of GiactMobileConsentRecordName | 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-28T07:13:09.948632-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-28T07:13:09.948632-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-28T07:13:09.948632-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-28T07:13:09.948632-05:00</RecordedDateTime> </GiactMobileConsentRecord> </ArrayOfGiactMobileConsentRecord>