Doctavian
ClickwrapConsents

Consent Get

This endpoint retrieves the details of a specific consent using the provided session Id. This includes information such as the session metadata (start and expiration times), consent status (accepted or not), external user identifier, and any associated data like environment or custom metadata.

GET
/consents/{sessionId}/get

Path Parameters

sessionIdunknown
Value in""

Header Parameters

Authorizationstring

JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.

Default"Bearer {{authToken}}"
Value in"Bearer {{authToken}}"
X-Subscription-Keystring

Unique API key used to identify and authorize access to a specific environment

Default"{{apiKey}}"
Value in"{{apiKey}}"

Response Body

curl -X GET "https://demo.headless.mavenmule.com/clickwrap/consents//get" \  -H "Authorization: Bearer {{authToken}}" \  -H "X-Subscription-Key: {{apiKey}}"

"{\n  \"result\": {\n    \"statusCode\": 200,\n    \"message\": \"OK\",\n    \"data\": [\n      {\n        \"consent\": {\n          \"ipAddress\": \"{{userIpAddress}}\",\n          \"termDefinitionId\": \"{{termDefinitionId}}\",\n          \"sessionId\": \"{{sessionId}}\",\n          \"sessionStartDatetime\": \"{{sessionStartDatetime}}\",\n          \"sessionExpirationDatetime\": \"{{sessionExpirationDatetime}}\",\n          \"environmentData\": \"{{environmentDescription}}\",\n          \"additionalData\": \"{{customConsentMetadata}}\",\n          \"externalUserId\": \"{{externalUserIdentifier}}\",\n          \"accepted\": true, //false\n          \"acceptedDatetime\": \"{{acceptedTimestamp}}\"\n        }\n      }\n    ]\n  },\n  \"origin\": \"{{originEnvironment}}\",\n  \"dateTime\": \"{{responseTimestamp}}\",\n  \"userId\": \"{{userId}}\"\n}"