Search

External Consent Controller

findAll

Method GET
Prod URL https://cpm.trustarc.com/server/api/v1/external/consents
EU URL https://cpm.trustarc.eu/server/api/v1/external/consents
Headers Authorization: Bearer <access_token from 'Token Access' section>
URL Parameters Required Query Parameters
Name Value Description
brandId string($uuid) Brand ID filter
consentFormId string($uuid) Consent Form ID filter
dataSubjectId string($uuid) Data Subject ID filter
dataSubjectTypeId string($uuid) Data Subject Type ID filter
fromCreatedDate string($epoch seconds) Created Date start filter
fromModifiedDate string Modified Date start filter
fromValidityEndDate string($epoch seconds) Validity End Date start filter
identifierMap [object] This is used to filter consents by Identifier ID and value, like email identifier ID = sample@email.com
NOTE: This parameter will not work using swagger. Can only be used using curl or postman. To pass an identifier as a parameter, you will have to add it as identifierId=identifierValue.
Sample: https://cpm.trustarc.com/server/api/v1/external/consents?0000000-0000-0000-0000-000000000031=identifierValue
isByBrandPreference boolean This is used in conjunction with isFetchLatest=true. This filters the latest consents for a specific form and specific brand ID provided.
isFetchLatest boolean This only retrieves the latest preference or latest submitted consent only so there are no duplicate consents per DS and consent form.
page integer($int32) Results page you want to retrieve (0…N).
programId string($uuid)  
size integer($int32) Number of records per page.
sort array[string] Sorting criteria in the format: property(,asc|desc)Example: createdDate,asc
status string Available values : ACTIVE, EXPIRED, PENDING
toCreatedDate string($epoch seconds) Created Date end filter
toModifiedDate string Modified Date end filter
toValidityEndDate string($epoch seconds) Validity End Date end filter
Sample Request N/A
Sample Success Response 
{
  "content": [
    {
      "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brandId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "channel": "API",
      "consentFormId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdDate": "string",
      "dataSubjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dataSubjectTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "formFieldValues": [
        {
          "field": {
            "display": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          },
          "formValues": [
            {
              "display": "string",
              "value": "string"
            }
          ]
        }
      ],
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "locale": "string",
      "modifiedDate": "string",
      "programId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "validityEndDate": "string",
      "websiteSource": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  }
}

 

Where:

  • content – list of consent objects
  • first –
  • last –
  • numberOfElements – number of elements in content
  • number – page number
  • size – size from url parameter
  • sort – sorting criteria 
Success Response Code: 200 OK
Error Response

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

findById

Method GET
Prod URL https://cpm.trustarc.com/server/api/v1/external/consents/{id}
EU URL https://cpm.trustarc.eu/server/api/v1/external/consents/{id}
Headers Authorization: Bearer <access_token from 'Token Access' section>
URL Parameters Required Query Parameters
Name Value Description
id string($uuid) The id (UUID) is the ID of the consent
Sample Request N/A
Sample Success Response 
{
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "brandId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "channel": "API",
  "consentFormId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdDate": "string",
  "dataSubjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "dataSubjectTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "formFieldValues": [
    {
      "field": {
        "display": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "formValues": [
        {
          "display": "string",
          "value": "string"
        }
      ]
    }
  ],
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "locale": "string",
  "modifiedDate": "string",
  "programId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "validityEndDate": "string",
  "websiteSource": "string"
}

 

Where:

  • response – the consent object
Success Response Code: 200 OK
Error Response

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

expireConsentByIds

Method POST
Prod URL https://cpm.trustarc.com/server/api/v1/external/consents/expire
EU URL https://cpm.trustarc.eu/server/api/v1/external/consents/expire
Headers Authorization: Bearer <access_token from 'Token Access' section>
URL Parameters Required Query Parameters
Name Value Description
consentIds*required array[string] IDs of consents to be set as expired status
Sample Request N/A
Sample Success Response N/A
Success Response

Code: 200 OK

Code: 201 Created
Error Response

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

preCheckCsvData

Method POST
Prod URL https://cpm.trustarc.com/server/api/v1/external/consents/precheck-csv
EU URL https://cpm.trustarc.eu/server/api/v1/external/consents/precheck-csv
Headers Authorization: Bearer <access_token from 'Token Access' section>
URL Parameters Required Query Parameters
Name Value Description
file (formData)  
Sample Request N/A
Sample Success Response N/A
Success Response

Code: 200 OK

Code: 201 Created
Error Response

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

partitionAndSaveCsv

Method POST
Prod URL https://cpm.trustarc.com/server/api/v1/external/consents/import
EU URL https://cpm.trustarc.eu/server/api/v1/external/consents/import
Headers Authorization: Bearer <access_token from 'Token Access' section>
URL Parameters Required Query Parameters
Name Value Description
file (formData)  
Sample Request N/A
Sample Success Response N/A
Success Response

Code: 200 OK

Code: 201 Created
Error Response

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found