POST web_api/mobile_consent/{phoneNumber}/records

Record a new mobile consent record 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

The new mobile consent record to add is included in the body formatted as a GiactMobileConsent object.

GiactMobileConsent

Name	Description	Type	Additional information
PhoneNumber	The phone number that consent is being given for	string	Required Matching regular expression pattern: ^[0-9]{10}$
ClientIpAddress	The current IP address of the end user that is giving consent	string	Required Matching regular expression pattern: \b(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\b Max length: 15
ConsentDescription	The description of how the end user's consent was gathered	string	Required Max length: 125

Name

Description

Type

Additional information

PhoneNumber

The phone number that consent is being given for

string

Required

Matching regular expression pattern: ^[0-9]{10}$

ClientIpAddress

The current IP address of the end user that is giving consent

string

Required

Matching regular expression pattern: \b(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b

Max length: 15

ConsentDescription

The description of how the end user's consent was gathered

string

Required

Max length: 125

Request Formats

application/json, text/json

Sample:

{
  "PhoneNumber": "sample string 1",
  "ClientIpAddress": "sample string 2",
  "ConsentDescription": "sample string 3"
}

application/xml, text/xml

Sample:

<GiactMobileConsent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.giact.com/verificationservices/v5">
  <ClientIpAddress>sample string 2</ClientIpAddress>
  <ConsentDescription>sample string 3</ConsentDescription>
  <PhoneNumber>sample string 1</PhoneNumber>
</GiactMobileConsent>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The response body will have a GiactMobileConsentResult object with either the details of the new added record or an error message if the request was invalid.

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-28T07:02:59.4450211-05:00",
  "EndUserIpAddress": "sample string 3",
  "IsCurrentlyValid": true
}

application/xml, text/xml

Sample:

<GiactMobileConsentRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.giact.com/verificationservices/v5">
  <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:02:59.4450211-05:00</RecordedDateTime>
</GiactMobileConsentRecord>