{"openapi":"3.1.0","info":{"title":"Consent & Preferences - Consent Receipts","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my-onetrust-com.ccsf.idm.oclc.org/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"description":"The Consent Receipts APIs are used to integrate external systems and streamline the flow of consent receipt data with the OneTrust Platform."},"servers":[{"url":"https://{hostname}/request/v1","variables":{"hostname":{"default":"privacyportal.onetrust.com","description":"The OneTrust privacy portal hostname that stores data subject consent transactions.","enum":["privacyportal.onetrust.com","privacyportal-eu.onetrust.com","privacyportaluat.onetrust.com","privacyportaluateu.onetrust.com","privacyportaltrial.onetrust.com"]}}}],"tags":[{"name":"Consent Receipts","description":"The Consent Receipts APIs are used to create consent receipts from a collection point to store data subject consent.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.ccsf.idm.oclc.org/onetrust/openapi/consent-preferences-consent-receipts.json"}}],"x-onetrust":{"spec-label":"OpenAPI 3.1.0"},"x-readme":{"explorer-enabled":false,"proxy-enabled":false,"metrics-enabled":false},"paths":{"/consentreceipts":{"post":{"operationId":"createConsentReceiptUsingPOST","summary":"Create Consent Receipts","description":"Use this API to create consent receipts from a collection point. This API is used by all collection points and allows external applications to submit requests to store data subject consent transactions.\n\n> 🗒 Things to Know\n> \n> - Each collection point must first be set up in the OneTrust Platform to generate a valid JWT, which must be present in the request payload. The JWT can be found on the **Integrations** tab of the **Collection point details** screen within the platform or can be retrieved by calling the [Get Collection Point Token API](https://developer-onetrust-com.ccsf.idm.oclc.org/onetrust/reference/gettokenusingget). \n> \n> - Once the `test` parameter is set to `true`, reverting it to `false` is not possible. However, transitioning from `test=false` to `test=true` is supported. For more information on how to remove the test flag in the OneTrust Platform, see [Managing Data Subject Records](https://my-onetrust-com.ccsf.idm.oclc.org/s/article/UUID-68370031-bf8a-953e-39a0-5027f766d04f).\n> \n> - In most cases, further authorization is not required. However, additional information for setting up authenticated consent can be found [here](https://my-onetrust-com.ccsf.idm.oclc.org/s/article/UUID-b359a104-1900-9ac9-7765-ee08c8047f1d) when needed.\n> \n> - Please avoid passing privacy notices for regular Custom API collection points. OneTrust strongly recommends using `privacyNotices` only for those enabled with dynamic configuration, as they allow you to gather information about all purposes.\n> \n> - When passing the `purposes` parameter, the version for `PrivacyNotices` will be used based on the consent date.\n> \n> - OneTrust recommends including no more than 10 purposes per consent receipt, with an absolute maximum of 20 purposes.\n>\n> - Please validate all inputs before sending data to a Custom API collection point. This API does not perform data type validation to ensure high performance and fast response times. However, invalid data will not be passed to the data subject.","tags":["Consent Receipts"],"x-onetrust":{"highly-available":true,"spec-label":"https://developer-onetrust-com.ccsf.idm.oclc.org/onetrust/openapi/consent-preferences-consent-receipts.json"},"parameters":[{"name":"authorization","in":"header","description":"The signed JWT that can be verified with the Public Key created in the OneTrust application. The value must include the type \"Bearer\" and should also include a \"sub\" claim that matches the identifier parameter value.","required":false,"schema":{"description":"The signed JWT that can be verified with the Public Key created in the OneTrust application. The value must include the type \"Bearer\" and should also include a \"sub\" claim that matches the identifier parameter value.","type":"string","example":"Bearer eyJhbGciOiJSUxl1NiIsInT7xCI6IkpXVCIsImtpZCI6ImtleTIxMDQyABCyIn0.eyJwY3MiOiJiMzI2OWE3YmEzMTJjZjljM2YwODZmOTQ4Mjc5Zjc5MmY5NTc4ZjE4NWZkNzAzn2MwMzE5OTllZDMyZDU0MDFhIiwidmlydHVhbFJvbGUiOmZhbHNlLCJyb2xlIjoiU2l0ZSBBZG1pbiIsInVzZXJfbmFtZSI6Im90YXV0b3RlbmFudDAxQGdtYWlsLmNvbSIsImxhbmd1YWdlSWQABCsImZncHQiOiIkMmEkMTAkZzJIRHAuLy5ILkYuS3BGMlpZLkF2T0s0dHM1OUNvcWJZYnpmQzg3dEUyYzZ6anJuMVloblciLCJzZXNzaW9uSWQiOiI5ZmY5NTYzNi0yNTc2LTRmNGMtOWM1ZC0zODdjODYwZjhmMjgiLCJ0ZW5hbnRHdWlkIjoiZDQ0NGY0MGEtYmJiZS00NmMyLTgwODUtNmFkNjJkNThlMDJlIiwiYXV0aG9yaXRpZXMiOlsiU2l0ZSBBZG1pbiJdLCJjbGllbnRfaWQiOiJvbmV0cnVzdCIsInJ0ZWQiOjcsIm9yZ0dyb3VwqweiOiIxIiwib3JnR3JvdXBHdWlkIjoiMzBiODBmODEtMzlmYy00MzkxLTg4YWEtOWJjMjIxNDM5ZTcyIiwicGVybWlzc2lvbnMiOiJINHNJQUFBQUFBQUEveVdPTVVnRFFSQkY1eUtDWUJFRXhjSVVRbnBiYlNSTkxBVEJTa0d3MGtJUVJHME1KQ1FiaTlRcFVvaWdTU2tvZ3FBUUE4YlZTcXl1VVFRbG5oWWlJcmtMRWUrV2JIYS9lM0ZnEFGNdy8vM1puUmxJQWxBZm5sRkl0Zm1LbDNmVmNUajJMU0tLUGdyVzNFQ3NZOFBuSjA5MTMxVUl1cGxqcUt2Q1drWk1INmIyaGg3U1kyM3JWak1uSkZSREYxR29MWWJSWWw3YXpsS1ZjOEQ5cnZpNEF3SnpKZXlqUm5FZFlGbGRtNnBzRFZ1WDVUTlBNcFVOTktSdi9zQi8vYXg2bjcxQkd4L3pBeTRRN3dROFN2UUdiQitrYy9XVTAxVFF3Yms5MjRWSzVFenNUVTNISVYzSUABCh6NU5SYWlvQjFtTWt1b04wMFo0Z3lvdVNBQndHSHNMbkkzR1g2OU9LeStkR0ZqMG85aC9PazEvRjBzcENXWU5KZUwzbHIrbGw5Rm1SR05GNHZ3bkxVd0s0aGxkdDdTQlgrQVA4cWg4U1RRRUFBQT09LiIsInNjb3BlIjpbInJlAbciXSwicm9vdCI6IjMwYjgwZjgxLTM5ZmMtNDM5MS04OGFhLTliYzIyMTQzOWU3MiIsInRlbmFudElkIjo5MTExLCJndWlkIjoiNDRhYWY4OGEtNWU1NC00MzcxLWEzZGYtN2RhN2QABCVhMTAwIiwiZG9Ob3REZWxldGUiOmZhbHNlLCJleHAiOjE2ODU1MjM0OTAsImlhdCI6MTY4NTQzNzA5MCwianRpIjoid2FpMVRYRGtlMnU3LTZlRi16ZVgyV3hWTHU0IiwiZW1haWwiOiJvdGF1dG90ZW5hbnQwMUBnbWFpbC5jb20ifQ.HW2Q40LtN0HUHk2V1OOghG_rzGxPkua9ORT-P6vCtvpKT2vRss5vCfI5-2FaeDI7Wq4PoJXVaixcPC48EPqMWwSXavIR2-OMYJrDBYPxt8ABCAAOYC3nG5GFhv1Mhlk_1lFtf0mybkZLKv4mt0LduPqm4tNfpgOtzdumoUSr-5fLJ8mXJoKS961MkFIJSg0XP8rNQYcR7dzqViUpWLPHPkRRxyTSmXfRyfR7daSBnMx2WpoTIN00PIE8gDwMnCjDx83d2edENCg_STGJJQ6l36Ft1Wz3JOpUGU-lC6939XFO4CR7S4DPOVIl7WxHyXg7w1uj2R2opUr6j0RoZ0_IwA"},"example":"Bearer eyJhbGciOiJSUxl1NiIsInT7xCI6IkpXVCIsImtpZCI6ImtleTIxMDQyABCyIn0.eyJwY3MiOiJiMzI2OWE3YmEzMTJjZjljM2YwODZmOTQ4Mjc5Zjc5MmY5NTc4ZjE4NWZkNzAzn2MwMzE5OTllZDMyZDU0MDFhIiwidmlydHVhbFJvbGUiOmZhbHNlLCJyb2xlIjoiU2l0ZSBBZG1pbiIsInVzZXJfbmFtZSI6Im90YXV0b3RlbmFudDAxQGdtYWlsLmNvbSIsImxhbmd1YWdlSWQABCsImZncHQiOiIkMmEkMTAkZzJIRHAuLy5ILkYuS3BGMlpZLkF2T0s0dHM1OUNvcWJZYnpmQzg3dEUyYzZ6anJuMVloblciLCJzZXNzaW9uSWQiOiI5ZmY5NTYzNi0yNTc2LTRmNGMtOWM1ZC0zODdjODYwZjhmMjgiLCJ0ZW5hbnRHdWlkIjoiZDQ0NGY0MGEtYmJiZS00NmMyLTgwODUtNmFkNjJkNThlMDJlIiwiYXV0aG9yaXRpZXMiOlsiU2l0ZSBBZG1pbiJdLCJjbGllbnRfaWQiOiJvbmV0cnVzdCIsInJ0ZWQiOjcsIm9yZ0dyb3VwqweiOiIxIiwib3JnR3JvdXBHdWlkIjoiMzBiODBmODEtMzlmYy00MzkxLTg4YWEtOWJjMjIxNDM5ZTcyIiwicGVybWlzc2lvbnMiOiJINHNJQUFBQUFBQUEveVdPTVVnRFFSQkY1eUtDWUJFRXhjSVVRbnBiYlNSTkxBVEJTa0d3MGtJUVJHME1KQ1FiaTlRcFVvaWdTU2tvZ3FBUUE4YlZTcXl1VVFRbG5oWWlJcmtMRWUrV2JIYS9lM0ZnEFGNdy8vM1puUmxJQWxBZm5sRkl0Zm1LbDNmVmNUajJMU0tLUGdyVzNFQ3NZOFBuSjA5MTMxVUl1cGxqcUt2Q1drWk1INmIyaGg3U1kyM3JWak1uSkZSREYxR29MWWJSWWw3YXpsS1ZjOEQ5cnZpNEF3SnpKZXlqUm5FZFlGbGRtNnBzRFZ1WDVUTlBNcFVOTktSdi9zQi8vYXg2bjcxQkd4L3pBeTRRN3dROFN2UUdiQitrYy9XVTAxVFF3Yms5MjRWSzVFenNUVTNISVYzSUABCh6NU5SYWlvQjFtTWt1b04wMFo0Z3lvdVNBQndHSHNMbkkzR1g2OU9LeStkR0ZqMG85aC9PazEvRjBzcENXWU5KZUwzbHIrbGw5Rm1SR05GNHZ3bkxVd0s0aGxkdDdTQlgrQVA4cWg4U1RRRUFBQT09LiIsInNjb3BlIjpbInJlAbciXSwicm9vdCI6IjMwYjgwZjgxLTM5ZmMtNDM5MS04OGFhLTliYzIyMTQzOWU3MiIsInRlbmFudElkIjo5MTExLCJndWlkIjoiNDRhYWY4OGEtNWU1NC00MzcxLWEzZGYtN2RhN2QABCVhMTAwIiwiZG9Ob3REZWxldGUiOmZhbHNlLCJleHAiOjE2ODU1MjM0OTAsImlhdCI6MTY4NTQzNzA5MCwianRpIjoid2FpMVRYRGtlMnU3LTZlRi16ZVgyV3hWTHU0IiwiZW1haWwiOiJvdGF1dG90ZW5hbnQwMUBnbWFpbC5jb20ifQ.HW2Q40LtN0HUHk2V1OOghG_rzGxPkua9ORT-P6vCtvpKT2vRss5vCfI5-2FaeDI7Wq4PoJXVaixcPC48EPqMWwSXavIR2-OMYJrDBYPxt8ABCAAOYC3nG5GFhv1Mhlk_1lFtf0mybkZLKv4mt0LduPqm4tNfpgOtzdumoUSr-5fLJ8mXJoKS961MkFIJSg0XP8rNQYcR7dzqViUpWLPHPkRRxyTSmXfRyfR7daSBnMx2WpoTIN00PIE8gDwMnCjDx83d2edENCg_STGJJQ6l36Ft1Wz3JOpUGU-lC6939XFO4CR7S4DPOVIl7WxHyXg7w1uj2R2opUr6j0RoZ0_IwA"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestInformation"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"instantLinkToken":{"description":"Instant link tokens operate independently from the magic link creation functionality under Global Settings and will expire after 12 months.","type":"string","example":"{JWT TOKEN}"},"linkToken":{"description":"The magic link token can be appended to the Preference Center login URL for a data subject login.","type":"string","example":"p4S2%2FKWgxNmOkf7Rz0%2FCxVrQR3o9HhvTgN2jgSU9pMk%3D"},"receipt":{"description":"A JSON web token (JWT) which contains the record of the transaction.","type":"string","example":"{JWT TOKEN}"}}}},"Receipt Only - application/json":{"example":{"receipt":"{JWT TOKEN}"}},"Receipt with Instant Link Token - application/json":{"example":{"instantLinkToken":"{JWT TOKEN}","receipt":"{JWT TOKEN}"}},"Receipt with Short Link Token - application/json":{"example":{"linkToken":"p4S2%2FKWgxNmOkf7Rz0%2FCxVrQR3o9HhvTgN2jgSU9pMk%3D","receipt":"{JWT TOKEN}"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.ccsf.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}}}},"/consentreceipts/bulk":{"post":{"operationId":"createBulkConsentReceiptUsingPOST","summary":"Create Consent Receipts in Bulk","description":"Use this API when bulk importing consent receipts. This bulk endpoint optimizes performance when processing a large number of consent transactions simultaneously.\n\n> 🗒 Things to Know\n> \n> - Each collection point must first be set up in the OneTrust Platform to generate a valid JWT, which must be present in the request payload. The JWT can be found on the **Integrations** tab of the **Collection point details** screen or via the [Get Collection Point Token API](https://developer-onetrust-com.ccsf.idm.oclc.org/onetrust/reference/gettokenusingget).\n> \n> - Response times may vary depending on the number of receipts being processed. Consider implementing appropriate timeout handling in your integration.\n> \n> - In most cases, further authorization is not required. However, additional information for setting up authenticated consent can be found [here](https://my-onetrust-com.ccsf.idm.oclc.org/s/article/UUID-b359a104-1900-9ac9-7765-ee08c8047f1d) when needed.\n> \n> - OneTrust recommends including no more than 10 purposes per consent receipt, with an absolute maximum of 20 purposes.\n> \n> - The default rate limit for imports is 3k Calls/Minute and 3M Receipts/Day.\n>\n> - Please validate all inputs before sending data to a Custom API collection point. This API does not perform data type validation to ensure high performance and fast response times. However, invalid data will not be passed to the data subject.","tags":["Consent Receipts"],"x-onetrust":{"highly-available":true,"spec-label":"https://developer-onetrust-com.ccsf.idm.oclc.org/onetrust/openapi/consent-preferences-consent-receipts.json"},"parameters":[{"name":"authorization","in":"header","description":"The signed JWT that can be verified with the Public Key created in the OneTrust application. The value must include the type \"Bearer\" and should also include a \"sub\" claim that matches the identifier parameter value.","required":false,"schema":{"description":"The signed JWT that can be verified with the Public Key created in the OneTrust application. The value must include the type \"Bearer\" and should also include a \"sub\" claim that matches the identifier parameter value.","type":"string","example":"Bearer eyJhbGciOiJSUxl1NiIsInT7xCI6IkpXVCIsImtpZCI6ImtleTIxMDQyABCyIn0.eyJwY3MiOiJiMzI2OWE3YmEzMTJjZjljM2YwODZmOTQ4Mjc5Zjc5MmY5NTc4ZjE4NWZkNzAzn2MwMzE5OTllZDMyZDU0MDFhIiwidmlydHVhbFJvbGUiOmZhbHNlLCJyb2xlIjoiU2l0ZSBBZG1pbiIsInVzZXJfbmFtZSI6Im90YXV0b3RlbmFudDAxQGdtYWlsLmNvbSIsImxhbmd1YWdlSWQABCsImZncHQiOiIkMmEkMTAkZzJIRHAuLy5ILkYuS3BGMlpZLkF2T0s0dHM1OUNvcWJZYnpmQzg3dEUyYzZ6anJuMVloblciLCJzZXNzaW9uSWQiOiI5ZmY5NTYzNi0yNTc2LTRmNGMtOWM1ZC0zODdjODYwZjhmMjgiLCJ0ZW5hbnRHdWlkIjoiZDQ0NGY0MGEtYmJiZS00NmMyLTgwODUtNmFkNjJkNThlMDJlIiwiYXV0aG9yaXRpZXMiOlsiU2l0ZSBBZG1pbiJdLCJjbGllbnRfaWQiOiJvbmV0cnVzdCIsInJ0ZWQiOjcsIm9yZ0dyb3VwqweiOiIxIiwib3JnR3JvdXBHdWlkIjoiMzBiODBmODEtMzlmYy00MzkxLTg4YWEtOWJjMjIxNDM5ZTcyIiwicGVybWlzc2lvbnMiOiJINHNJQUFBQUFBQUEveVdPTVVnRFFSQkY1eUtDWUJFRXhjSVVRbnBiYlNSTkxBVEJTa0d3MGtJUVJHME1KQ1FiaTlRcFVvaWdTU2tvZ3FBUUE4YlZTcXl1VVFRbG5oWWlJcmtMRWUrV2JIYS9lM0ZnEFGNdy8vM1puUmxJQWxBZm5sRkl0Zm1LbDNmVmNUajJMU0tLUGdyVzNFQ3NZOFBuSjA5MTMxVUl1cGxqcUt2Q1drWk1INmIyaGg3U1kyM3JWak1uSkZSREYxR29MWWJSWWw3YXpsS1ZjOEQ5cnZpNEF3SnpKZXlqUm5FZFlGbGRtNnBzRFZ1WDVUTlBNcFVOTktSdi9zQi8vYXg2bjcxQkd4L3pBeTRRN3dROFN2UUdiQitrYy9XVTAxVFF3Yms5MjRWSzVFenNUVTNISVYzSUABCh6NU5SYWlvQjFtTWt1b04wMFo0Z3lvdVNBQndHSHNMbkkzR1g2OU9LeStkR0ZqMG85aC9PazEvRjBzcENXWU5KZUwzbHIrbGw5Rm1SR05GNHZ3bkxVd0s0aGxkdDdTQlgrQVA4cWg4U1RRRUFBQT09LiIsInNjb3BlIjpbInJlAbciXSwicm9vdCI6IjMwYjgwZjgxLTM5ZmMtNDM5MS04OGFhLTliYzIyMTQzOWU3MiIsInRlbmFudElkIjo5MTExLCJndWlkIjoiNDRhYWY4OGEtNWU1NC00MzcxLWEzZGYtN2RhN2QABCVhMTAwIiwiZG9Ob3REZWxldGUiOmZhbHNlLCJleHAiOjE2ODU1MjM0OTAsImlhdCI6MTY4NTQzNzA5MCwianRpIjoid2FpMVRYRGtlMnU3LTZlRi16ZVgyV3hWTHU0IiwiZW1haWwiOiJvdGF1dG90ZW5hbnQwMUBnbWFpbC5jb20ifQ.HW2Q40LtN0HUHk2V1OOghG_rzGxPkua9ORT-P6vCtvpKT2vRss5vCfI5-2FaeDI7Wq4PoJXVaixcPC48EPqMWwSXavIR2-OMYJrDBYPxt8ABCAAOYC3nG5GFhv1Mhlk_1lFtf0mybkZLKv4mt0LduPqm4tNfpgOtzdumoUSr-5fLJ8mXJoKS961MkFIJSg0XP8rNQYcR7dzqViUpWLPHPkRRxyTSmXfRyfR7daSBnMx2WpoTIN00PIE8gDwMnCjDx83d2edENCg_STGJJQ6l36Ft1Wz3JOpUGU-lC6939XFO4CR7S4DPOVIl7WxHyXg7w1uj2R2opUr6j0RoZ0_IwA"},"example":"Bearer eyJhbGciOiJSUxl1NiIsInT7xCI6IkpXVCIsImtpZCI6ImtleTIxMDQyABCyIn0.eyJwY3MiOiJiMzI2OWE3YmEzMTJjZjljM2YwODZmOTQ4Mjc5Zjc5MmY5NTc4ZjE4NWZkNzAzn2MwMzE5OTllZDMyZDU0MDFhIiwidmlydHVhbFJvbGUiOmZhbHNlLCJyb2xlIjoiU2l0ZSBBZG1pbiIsInVzZXJfbmFtZSI6Im90YXV0b3RlbmFudDAxQGdtYWlsLmNvbSIsImxhbmd1YWdlSWQABCsImZncHQiOiIkMmEkMTAkZzJIRHAuLy5ILkYuS3BGMlpZLkF2T0s0dHM1OUNvcWJZYnpmQzg3dEUyYzZ6anJuMVloblciLCJzZXNzaW9uSWQiOiI5ZmY5NTYzNi0yNTc2LTRmNGMtOWM1ZC0zODdjODYwZjhmMjgiLCJ0ZW5hbnRHdWlkIjoiZDQ0NGY0MGEtYmJiZS00NmMyLTgwODUtNmFkNjJkNThlMDJlIiwiYXV0aG9yaXRpZXMiOlsiU2l0ZSBBZG1pbiJdLCJjbGllbnRfaWQiOiJvbmV0cnVzdCIsInJ0ZWQiOjcsIm9yZ0dyb3VwqweiOiIxIiwib3JnR3JvdXBHdWlkIjoiMzBiODBmODEtMzlmYy00MzkxLTg4YWEtOWJjMjIxNDM5ZTcyIiwicGVybWlzc2lvbnMiOiJINHNJQUFBQUFBQUEveVdPTVVnRFFSQkY1eUtDWUJFRXhjSVVRbnBiYlNSTkxBVEJTa0d3MGtJUVJHME1KQ1FiaTlRcFVvaWdTU2tvZ3FBUUE4YlZTcXl1VVFRbG5oWWlJcmtMRWUrV2JIYS9lM0ZnEFGNdy8vM1puUmxJQWxBZm5sRkl0Zm1LbDNmVmNUajJMU0tLUGdyVzNFQ3NZOFBuSjA5MTMxVUl1cGxqcUt2Q1drWk1INmIyaGg3U1kyM3JWak1uSkZSREYxR29MWWJSWWw3YXpsS1ZjOEQ5cnZpNEF3SnpKZXlqUm5FZFlGbGRtNnBzRFZ1WDVUTlBNcFVOTktSdi9zQi8vYXg2bjcxQkd4L3pBeTRRN3dROFN2UUdiQitrYy9XVTAxVFF3Yms5MjRWSzVFenNUVTNISVYzSUABCh6NU5SYWlvQjFtTWt1b04wMFo0Z3lvdVNBQndHSHNMbkkzR1g2OU9LeStkR0ZqMG85aC9PazEvRjBzcENXWU5KZUwzbHIrbGw5Rm1SR05GNHZ3bkxVd0s0aGxkdDdTQlgrQVA4cWg4U1RRRUFBQT09LiIsInNjb3BlIjpbInJlAbciXSwicm9vdCI6IjMwYjgwZjgxLTM5ZmMtNDM5MS04OGFhLTliYzIyMTQzOWU3MiIsInRlbmFudElkIjo5MTExLCJndWlkIjoiNDRhYWY4OGEtNWU1NC00MzcxLWEzZGYtN2RhN2QABCVhMTAwIiwiZG9Ob3REZWxldGUiOmZhbHNlLCJleHAiOjE2ODU1MjM0OTAsImlhdCI6MTY4NTQzNzA5MCwianRpIjoid2FpMVRYRGtlMnU3LTZlRi16ZVgyV3hWTHU0IiwiZW1haWwiOiJvdGF1dG90ZW5hbnQwMUBnbWFpbC5jb20ifQ.HW2Q40LtN0HUHk2V1OOghG_rzGxPkua9ORT-P6vCtvpKT2vRss5vCfI5-2FaeDI7Wq4PoJXVaixcPC48EPqMWwSXavIR2-OMYJrDBYPxt8ABCAAOYC3nG5GFhv1Mhlk_1lFtf0mybkZLKv4mt0LduPqm4tNfpgOtzdumoUSr-5fLJ8mXJoKS961MkFIJSg0XP8rNQYcR7dzqViUpWLPHPkRRxyTSmXfRyfR7daSBnMx2WpoTIN00PIE8gDwMnCjDx83d2edENCg_STGJJQ6l36Ft1Wz3JOpUGU-lC6939XFO4CR7S4DPOVIl7WxHyXg7w1uj2R2opUr6j0RoZ0_IwA"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestInformation"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConsentReceiptResponse"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.ccsf.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}}}},"/consentreceipts/identified":{"post":{"operationId":"createIdentifiedConsentReceiptUsingPOST","summary":"Create Identified Consent Receipts","description":"Use this API to create consent receipts for identified data subjects using non-cookie collection points. This endpoint is designed specifically for scenarios where data subjects are identified through explicit identifiers rather than cookies.\n\n> 🗒 Things to Know\n> \n> - Each collection point must first be set up in the OneTrust Platform to generate a valid JWT, which must be present in the request payload. The JWT can be found on the **Integrations** tab of the **Collection point details** screen or via the [Get Collection Point Token API](https://developer-onetrust-com.ccsf.idm.oclc.org/onetrust/reference/gettokenusingget).\n> \n> - When using this endpoint, you must include an identifier for the data subject, such as an email address or other unique identifier, in the request payload.\n> \n> - The identified endpoint creates a persistent record of consent for the data subject that can be managed and updated over time through the OneTrust preference center.\n> \n> - If you need to link multiple identifiers to the same data subject, use the `additionalIdentifiers` parameter in your request payload.\n> \n> - In most cases, further authorization is not required. However, additional information for setting up authenticated consent can be found [here](https://my-onetrust-com.ccsf.idm.oclc.org/s/article/UUID-b359a104-1900-9ac9-7765-ee08c8047f1d) when needed.\n> \n> - OneTrust recommends including no more than 10 purposes per consent receipt, with an absolute maximum of 20 purposes.\n>\n> - Please validate all inputs before sending data to a Custom API collection point. This API does not perform data type validation to ensure high performance and fast response times. However, invalid data will not be passed to the data subject.","tags":["Consent Receipts"],"x-onetrust":{"highly-available":true,"spec-label":"https://developer-onetrust-com.ccsf.idm.oclc.org/onetrust/openapi/consent-preferences-consent-receipts.json"},"parameters":[{"name":"authorization","in":"header","description":"The signed JWT that can be verified with the Public Key created in the OneTrust application. The value must include the type \"Bearer\" and should also include a \"sub\" claim that matches the identifier parameter value.","required":false,"schema":{"description":"The signed JWT that can be verified with the Public Key created in the OneTrust application. The value must include the type \"Bearer\" and should also include a \"sub\" claim that matches the identifier parameter value.","type":"string","example":"Bearer eyJhbGciOiJSUxl1NiIsInT7xCI6IkpXVCIsImtpZCI6ImtleTIxMDQyABCyIn0.eyJwY3MiOiJiMzI2OWE3YmEzMTJjZjljM2YwODZmOTQ4Mjc5Zjc5MmY5NTc4ZjE4NWZkNzAzn2MwMzE5OTllZDMyZDU0MDFhIiwidmlydHVhbFJvbGUiOmZhbHNlLCJyb2xlIjoiU2l0ZSBBZG1pbiIsInVzZXJfbmFtZSI6Im90YXV0b3RlbmFudDAxQGdtYWlsLmNvbSIsImxhbmd1YWdlSWQABCsImZncHQiOiIkMmEkMTAkZzJIRHAuLy5ILkYuS3BGMlpZLkF2T0s0dHM1OUNvcWJZYnpmQzg3dEUyYzZ6anJuMVloblciLCJzZXNzaW9uSWQiOiI5ZmY5NTYzNi0yNTc2LTRmNGMtOWM1ZC0zODdjODYwZjhmMjgiLCJ0ZW5hbnRHdWlkIjoiZDQ0NGY0MGEtYmJiZS00NmMyLTgwODUtNmFkNjJkNThlMDJlIiwiYXV0aG9yaXRpZXMiOlsiU2l0ZSBBZG1pbiJdLCJjbGllbnRfaWQiOiJvbmV0cnVzdCIsInJ0ZWQiOjcsIm9yZ0dyb3VwqweiOiIxIiwib3JnR3JvdXBHdWlkIjoiMzBiODBmODEtMzlmYy00MzkxLTg4YWEtOWJjMjIxNDM5ZTcyIiwicGVybWlzc2lvbnMiOiJINHNJQUFBQUFBQUEveVdPTVVnRFFSQkY1eUtDWUJFRXhjSVVRbnBiYlNSTkxBVEJTa0d3MGtJUVJHME1KQ1FiaTlRcFVvaWdTU2tvZ3FBUUE4YlZTcXl1VVFRbG5oWWlJcmtMRWUrV2JIYS9lM0ZnEFGNdy8vM1puUmxJQWxBZm5sRkl0Zm1LbDNmVmNUajJMU0tLUGdyVzNFQ3NZOFBuSjA5MTMxVUl1cGxqcUt2Q1drWk1INmIyaGg3U1kyM3JWak1uSkZSREYxR29MWWJSWWw3YXpsS1ZjOEQ5cnZpNEF3SnpKZXlqUm5FZFlGbGRtNnBzRFZ1WDVUTlBNcFVOTktSdi9zQi8vYXg2bjcxQkd4L3pBeTRRN3dROFN2UUdiQitrYy9XVTAxVFF3Yms5MjRWSzVFenNUVTNISVYzSUABCh6NU5SYWlvQjFtTWt1b04wMFo0Z3lvdVNBQndHSHNMbkkzR1g2OU9LeStkR0ZqMG85aC9PazEvRjBzcENXWU5KZUwzbHIrbGw5Rm1SR05GNHZ3bkxVd0s0aGxkdDdTQlgrQVA4cWg4U1RRRUFBQT09LiIsInNjb3BlIjpbInJlAbciXSwicm9vdCI6IjMwYjgwZjgxLTM5ZmMtNDM5MS04OGFhLTliYzIyMTQzOWU3MiIsInRlbmFudElkIjo5MTExLCJndWlkIjoiNDRhYWY4OGEtNWU1NC00MzcxLWEzZGYtN2RhN2QABCVhMTAwIiwiZG9Ob3REZWxldGUiOmZhbHNlLCJleHAiOjE2ODU1MjM0OTAsImlhdCI6MTY4NTQzNzA5MCwianRpIjoid2FpMVRYRGtlMnU3LTZlRi16ZVgyV3hWTHU0IiwiZW1haWwiOiJvdGF1dG90ZW5hbnQwMUBnbWFpbC5jb20ifQ.HW2Q40LtN0HUHk2V1OOghG_rzGxPkua9ORT-P6vCtvpKT2vRss5vCfI5-2FaeDI7Wq4PoJXVaixcPC48EPqMWwSXavIR2-OMYJrDBYPxt8ABCAAOYC3nG5GFhv1Mhlk_1lFtf0mybkZLKv4mt0LduPqm4tNfpgOtzdumoUSr-5fLJ8mXJoKS961MkFIJSg0XP8rNQYcR7dzqViUpWLPHPkRRxyTSmXfRyfR7daSBnMx2WpoTIN00PIE8gDwMnCjDx83d2edENCg_STGJJQ6l36Ft1Wz3JOpUGU-lC6939XFO4CR7S4DPOVIl7WxHyXg7w1uj2R2opUr6j0RoZ0_IwA"},"example":"Bearer eyJhbGciOiJSUxl1NiIsInT7xCI6IkpXVCIsImtpZCI6ImtleTIxMDQyABCyIn0.eyJwY3MiOiJiMzI2OWE3YmEzMTJjZjljM2YwODZmOTQ4Mjc5Zjc5MmY5NTc4ZjE4NWZkNzAzn2MwMzE5OTllZDMyZDU0MDFhIiwidmlydHVhbFJvbGUiOmZhbHNlLCJyb2xlIjoiU2l0ZSBBZG1pbiIsInVzZXJfbmFtZSI6Im90YXV0b3RlbmFudDAxQGdtYWlsLmNvbSIsImxhbmd1YWdlSWQABCsImZncHQiOiIkMmEkMTAkZzJIRHAuLy5ILkYuS3BGMlpZLkF2T0s0dHM1OUNvcWJZYnpmQzg3dEUyYzZ6anJuMVloblciLCJzZXNzaW9uSWQiOiI5ZmY5NTYzNi0yNTc2LTRmNGMtOWM1ZC0zODdjODYwZjhmMjgiLCJ0ZW5hbnRHdWlkIjoiZDQ0NGY0MGEtYmJiZS00NmMyLTgwODUtNmFkNjJkNThlMDJlIiwiYXV0aG9yaXRpZXMiOlsiU2l0ZSBBZG1pbiJdLCJjbGllbnRfaWQiOiJvbmV0cnVzdCIsInJ0ZWQiOjcsIm9yZ0dyb3VwqweiOiIxIiwib3JnR3JvdXBHdWlkIjoiMzBiODBmODEtMzlmYy00MzkxLTg4YWEtOWJjMjIxNDM5ZTcyIiwicGVybWlzc2lvbnMiOiJINHNJQUFBQUFBQUEveVdPTVVnRFFSQkY1eUtDWUJFRXhjSVVRbnBiYlNSTkxBVEJTa0d3MGtJUVJHME1KQ1FiaTlRcFVvaWdTU2tvZ3FBUUE4YlZTcXl1VVFRbG5oWWlJcmtMRWUrV2JIYS9lM0ZnEFGNdy8vM1puUmxJQWxBZm5sRkl0Zm1LbDNmVmNUajJMU0tLUGdyVzNFQ3NZOFBuSjA5MTMxVUl1cGxqcUt2Q1drWk1INmIyaGg3U1kyM3JWak1uSkZSREYxR29MWWJSWWw3YXpsS1ZjOEQ5cnZpNEF3SnpKZXlqUm5FZFlGbGRtNnBzRFZ1WDVUTlBNcFVOTktSdi9zQi8vYXg2bjcxQkd4L3pBeTRRN3dROFN2UUdiQitrYy9XVTAxVFF3Yms5MjRWSzVFenNUVTNISVYzSUABCh6NU5SYWlvQjFtTWt1b04wMFo0Z3lvdVNBQndHSHNMbkkzR1g2OU9LeStkR0ZqMG85aC9PazEvRjBzcENXWU5KZUwzbHIrbGw5Rm1SR05GNHZ3bkxVd0s0aGxkdDdTQlgrQVA4cWg4U1RRRUFBQT09LiIsInNjb3BlIjpbInJlAbciXSwicm9vdCI6IjMwYjgwZjgxLTM5ZmMtNDM5MS04OGFhLTliYzIyMTQzOWU3MiIsInRlbmFudElkIjo5MTExLCJndWlkIjoiNDRhYWY4OGEtNWU1NC00MzcxLWEzZGYtN2RhN2QABCVhMTAwIiwiZG9Ob3REZWxldGUiOmZhbHNlLCJleHAiOjE2ODU1MjM0OTAsImlhdCI6MTY4NTQzNzA5MCwianRpIjoid2FpMVRYRGtlMnU3LTZlRi16ZVgyV3hWTHU0IiwiZW1haWwiOiJvdGF1dG90ZW5hbnQwMUBnbWFpbC5jb20ifQ.HW2Q40LtN0HUHk2V1OOghG_rzGxPkua9ORT-P6vCtvpKT2vRss5vCfI5-2FaeDI7Wq4PoJXVaixcPC48EPqMWwSXavIR2-OMYJrDBYPxt8ABCAAOYC3nG5GFhv1Mhlk_1lFtf0mybkZLKv4mt0LduPqm4tNfpgOtzdumoUSr-5fLJ8mXJoKS961MkFIJSg0XP8rNQYcR7dzqViUpWLPHPkRRxyTSmXfRyfR7daSBnMx2WpoTIN00PIE8gDwMnCjDx83d2edENCg_STGJJQ6l36Ft1Wz3JOpUGU-lC6939XFO4CR7S4DPOVIl7WxHyXg7w1uj2R2opUr6j0RoZ0_IwA"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestInformation"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConsentReceiptResponse"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.ccsf.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"ConsentString":{"type":"object","properties":{"type":{"description":"The encoded consent string that represents the data subject's consent choices","type":"string","example":"GPP","enum":["GPP","TCF_EU","TCF_CANADA"]},"content":{"description":"The actual consent string content","example":"DBACMYA~CQPftcAQPftcAPoABABGBkEAAAAAAAAAAAAAAAAAAAAA.QAAA.IAAA~BQPftcAQPftcAPoABABGB-CAAAAAAAAAAAAAAAAAAA.YAAAAAAAAAA","type":"string"}}},"DsAttachments":{"type":"object","properties":{"id":{"description":"The unique identifier of the file uploaded for the data subject.","type":"string","format":"uuid","example":"aa978afe-bbe9-4419-8fa9-f3691f1046c3"}},"title":"DsAttachments"},"DsCustomPreference":{"type":"object","properties":{"Id":{"description":"The unique identifier of a Purpose Preference related to the purpose.","type":"string","format":"uuid","example":"aa978afe-bbe9-4419-8fa9-f3691f1046c3"},"Options":{"description":"The list of unique identifers for only the Purpose Preference options into which the data subject should be opted in.","type":"array","items":{"type":"string","format":"uuid"},"example":["aa978afe-bbe9-4419-8fa9-f3691f1046c3"]},"Choices":{"description":"The unique identifier(s) of Purpose Preferences that should be modified using the CHANGE_PREFERENCES transactionType.","type":"array","items":{"$ref":"#/components/schemas/DsCustomPreferenceChoices"}}},"title":"DsCustomPreference"},"DsCustomPreferenceChoices":{"type":"object","properties":{"OptionId":{"description":"The unique identifier of an individual option within a Purpose Preference related to the purpose.","type":"string","format":"uuid","example":"aa978afe-bbe9-4419-8fa9-f3691f1046c3"},"TransactionType":{"type":"string","example":"OPT_OUT","enum":["OPT_IN","OPT_OUT"]}},"title":"DsCustomPreferenceChoices"},"DsGeolocation":{"type":"object","properties":{"country":{"description":"The country where consent was provided.","type":"string","example":"US"},"state":{"description":"The state code where consent was provided.","type":"string","example":"GA"},"stateName":{"description":"The name of the state where consent was provided.","type":"string","example":"Georgia"},"purposeIds":{"description":"The list of unique identifiers of the purposes for which consent was provided.","type":"array","items":{"type":"string","format":"uuid"},"minProperties":1,"uniqueItems":true}},"title":"DsGeolocation"},"DsPreference":{"type":"object","properties":{"TopicId":{"description":"The unique identifier of a topic related to the purpose.","type":"string","format":"uuid","example":"aa978afe-bbe9-4419-8fa9-f3691f1046c3"},"TransactionType":{"description":"The type of consent transaction for a single topic ID that specifies the data subject's action. This parameter is not supported on Web Form Collection Points. ","type":"string","example":"OPT_IN","enum":["OPT_IN","OPT_OUT"]}},"title":"DsPreference"},"DsPrivacyNotice":{"type":"object","properties":{"Id":{"description":"The unique identifier of the linked privacy notice.","type":"string","format":"uuid","example":"18c07e52-689c-447c-b640-546385a3efcf"},"Version":{"description":"The version of the linked privacy notice.","type":"integer","format":"int64","example":1},"MinorVersion":{"description":"The minor version of the linked privacy notice.","type":"integer","format":"int64","example":1}}},"DsPurpose":{"type":"object","properties":{"Id":{"description":"The unique identifier of the purpose. ","type":"string","format":"uuid","example":"aa978afe-bbe9-4419-8fa9-f3691f1046c3"},"Version":{"description":"The version of the purpose.","type":"integer","format":"int64","example":1},"Preferences":{"description":"The details of the topics involved in the consent interaction.","type":"array","items":{"$ref":"#/components/schemas/DsPreference"}},"CustomPreferences":{"description":"The details of the purpose preferences involved in the consent interaction.","type":"array","items":{"$ref":"#/components/schemas/DsCustomPreference"}},"PrivacyNotices":{"description":"The details of linked privacy notices.","type":"array","items":{"$ref":"#/components/schemas/DsPrivacyNotice"}},"TransactionType":{"description":"The type of consent transaction. This parameter is only supported for API-type collection points.","type":"string","example":"CONFIRMED","enum":["PENDING","CONFIRMED","WITHDRAWN","EXPIRED","NOTGIVEN","EXTEND","OPT_OUT","HARD_OPT_OUT","NO_CHOICE","CHANGE_PREFERENCES","CANCEL","IMPLICIT"]},"ExpiryDate":{"description":"The explicit expiration date after which the purpose is no longer valid and no further consent is collected against it.","type":"string","format":"date-time","example":"2020-01-01T12:00-05:00"},"PurposeAttachments":{"description":"The details of the uploaded files that contain written consent records for a specific purpose.","type":"array","items":{"$ref":"#/components/schemas/DsAttachments"},"uniqueItems":true},"PurposeNote":{"description":"The details of the reason template used to explain changes to the data subject's preferences.","$ref":"#/components/schemas/DsPurposeNote"},"attributes":{"description":"The custom collection point attributes configured within Attribute Manager. Custom collection point attributes are written to the receipt only if the Add to Receipts check box is selected for the attribute.","type":"object","example":"{\"key\": [\"value\", \"value2]\"}","additionalProperties":{"type":"array","items":{"type":"string"}},"readOnly":true}},"title":"DsPurpose"},"DsPurposeNote":{"type":"object","properties":{"noteId":{"description":"The unique identifier for a reason template.","type":"string","format":"uuid","example":"aa978afe-bbe9-4419-8fa9-f3691f1046c3"},"noteType":{"description":"The type of reason template.","type":"string","example":"UNSUBSCRIBE_REASON","enum":["UNSUBSCRIBE_REASON"]},"noteLanguage":{"description":"The ISO code for the language of the note text.","type":"string","example":"en-us"},"noteText":{"description":"The text of the note to be stored.","type":"string","example":"Reason 1"}},"title":"DsPurposeNote"},"ParentPrimaryIdentifiers":{"type":"object","properties":{"ParentIdentifier":{"description":"The data subject identifier of the parent data subject.","type":"string","example":"+1(999)999-9999"},"AdditionalParentIdentifierTypes":{"description":"The types of data subject identifiers allowed for parent data subjects.","type":"object","example":{"Mobile":"+1(999)999-9999"},"additionalProperties":{"type":"string"}},"ConsentGivenBy":{"description":"This flag indicates whether consent was given by the parent data subject.","type":"boolean","example":false},"ParentTestDataSubject":{"description":"Boolean flag to indicate if the parent needs to be marked as test","type":"boolean","example":true}},"title":"ParentPrimaryIdentifiers"},"ReceiptOption":{"type":"object","properties":{"option":{"description":"The type of receipt option that applies additional changes to the receipt.","type":"string","example":"ClearExpiration","enum":["ClearExpiration"]},"purposes":{"description":"The list of purposes to which the option applies.","type":"array","items":{"type":"string","format":"uuid"},"example":["3fa85f64-5717-4562-b3fc-2c963f66afa6"],"uniqueItems":true}},"title":"ReceiptOption"},"RequestInformation":{"type":"object","properties":{"requestInformation":{"description":"The JSON web token (JWT) for a collection point.","type":"string","example":"eyJhbGciOiJSUzVyMiJ9.eyJvdEp4gFZlcnNpb24iOjEsInByb2Nlc3NJZCI6Ijc2NTdkM2E5LTcwYWEtNGZjNy04MzE5LTgwYmU2OTkzNWQ0NiIsInByb2Nlc3NWZXJzaW9uIjo5LCJpYXQiOiIyMDIzLTAyLTAxVDA4OjIzOjUwLjg4MyIsIm1vYyI6IkhPU1RFRF9XRUJfRk9STSIsInBvbGljeV91cmkiOm51bGwsInN1YiI6IkVtYWlsIiwiaXNzIjpudWxsLCJ0ZW5hbnRJZCI6Ijk1MjE5ODkyLWVjZDEtNGI4Mi05MzQ0LWYyMjczMmY2YmJmOSIsImRlc2NyaXB0aW9uIjoiZGVzYyIsImNvbnNlbnRUeXBlIjoiT1BUSU5DSEVDS0JPWCIsImFsbG93Tm90R2l2ZW5Db25zZW50cyI6ZmFsc2UsImRvdWJsZU9wdEluIjpmYWxzZSwicHVycG9zZXMiOlt7ImlkIjoiNTEyNDI4YjctOTBkYS00YmQyLWE5MDEtNzM4NWUxMzM1ZWVlIiwidmVyc2lvbiI6MiwicGFyZW50SWQiOm51bGwsInRvcGljcyI6W10sImN1c3RvbVByZXSlcmVuY2VzIjpbeyJpZCI6ImViNTA1MGYzLWRmY2MtNDFmNi1iNzdiLTY1ODliYWRiNWUzZiIsImlzUmVxdWlyZWQiOmZhbHNlLCJvcHRpb25zIjpbIjg5NDJmMTMwLTc1YzUtNGE5Yi04YWJkLTdjZGEwMDZiZjMwMSIsIjJkOTkyZjJiLWYxNTUtNDdiOC04MzU3LTMxZTQxMmMyOGRjYSIsImQ2YzNmNDk3LTRkNzUtNDFkZi1iNzdhLTRiMTlmOTVhMGU2NiJdfV0sImVuYWJsZUdlb2xvY2F0aW9uIjpmYWxzZX0seyJpZCI6IjRkYWVkOTk0LTQxYzAtNDc2MS1hY2YwLTEzMzI5ZmM5YjVmOCIsInZlcnNpb24iOjMsInBhcmVudElkIjpudWxsLCJ0b3BpY3MiOltdLCJjdXN0b21QcmVmZXJlbmNlcyI6W10sImVuYWJsZUdlb2xvY2F0aW9uIjpmYWxzZX1dLCJub3RpY2VzIjpbXSwiZHNEYXRhRWxlbWVudHMiOlsiQWRkcmVzcyJdLCJhdXRoZW50aWNhdGlvblJlcXVpcmVkIjpmYWxzZSwicmVjb25maXJtQWN0aXZlUHVycG9zZSI6ZmFsc2UsIm92ZXJyaWRlQWN0aXZlUHVycG9zZSI6dHJ1ZSwiZHluYW1pY0NvbGxlY3Rpb25Qb2ludCI6ZmFsc2UsImFkZGl0aW9uYWxJZGVudGlmaWVycyI6W10sIm11bHRpcAblSWRlbnRpZmllclR5cGVzIjpmYWxzZSwiZW5hYmxlUGFyZW50UHJpbWFyeUlkZW50aWZpZXJzIjpmYWxzZSwicGFyZW50UHJpbWFyeUlkZW50aWZpZXJzVHlwZSI6bnVsbCwiYWRkaXRpb25hbFBhcmVudElkZW50aWZpZXJUeXBlcyI6W10sImVuYWJsZUdlb3fxY2F0aW9uIjpmYWxzZX0.tQvB9kNcmhKs05qFbXJdeBBSGFjvL2TyQVjuwaIaCs-Rr4r-sZsFzDeb9d0VPzSOLH15VPwgbCRgFfFO4WWHHnOExUiSFAgeo2PH4uNcCnocUQqHFxTD7CS7jKVgITgs0cf89_3cYBaevSUQz4NzG7QZLu8CAckTRyZfd15eN3D_9PzlvcJclj6Wu1zmcmMqXEXeyyCw9CCLp4Ss78eSptjd7aKOHmEtaXnXYym1qFvzvxn8vpEJS0fQ1OctSll0E0bt7N8AWSDDosBZU4f9YqZjpD_xc_1yoYbfxQFUbsc4zD_IEAN7ghwfpV4msUcCGXaNYnOOqrBtmhSaODAGrQ","minLength":1},"test":{"description":"This flag indicates whether the receipt is for testing purposes.","type":"boolean","example":true,"default":"false"},"generateInstantLinkToken":{"description":"This flag indicates whether to generate a data subject link token (JWT) that expires after 12 months. This operates independently from the Magic Link settings configured within Global Settings. This parameter is only supported for API-type collection points and cannot be used in conjunction with the `shortLinkToken` parameter.","type":"boolean","example":false,"default":"false"},"shortLinkToken":{"description":"This flag indicates whether to generate a data subject link token with a reduced character length. This parameter cannot be used in conjunction with the `generateInstantLinkToken` parameter.","type":"boolean","example":true,"default":"false"},"consentString":{"description":"The details of the consent string that carries and encodes the data subject's consent choices.","example":true,"$ref":"#/components/schemas/ConsentString"},"receiptOptions":{"description":"The details of the receipt option.","type":"array","items":{"$ref":"#/components/schemas/ReceiptOption"}},"source":{"description":"The source details of the consent interaction.","$ref":"#/components/schemas/Source"},"language":{"description":"The language set for the data subject.","type":"string","example":"en-GB"},"identifier":{"description":"The data subject identifier of the data subject.","type":"string","example":"mail@mail.com"},"parentPrimaryIdentifiers":{"description":"The parent identifiers to link to a child data subject. This is used when the Enable Parent-child relationship on this collection point setting is enabled for a collection point.","type":"array","items":{"$ref":"#/components/schemas/ParentPrimaryIdentifiers"}},"dsDataElements":{"description":"The additional information about the data subject provided during their consent interaction.","type":"object","example":{"DataElement1Name":"Value"},"additionalProperties":{"type":"string"}},"customPayload":{"description":"This parameter can be used to store custom data in key value pairs against the receipt. The total size of the `customPayload` data should not exceed 4000 characters.","type":"object","example":{"key1":"value1"},"additionalProperties":{"type":"string"}},"additionalIdentifiers":{"description":"Additional identifiers for the request, such as secondary email addresses","type":"object","example":{"Email":"test_secondary_identifier@test.com"},"additionalProperties":{"type":"string"}},"attachments":{"description":"The details of the uploaded files that contain written consent records. A maximum of 20 attachments can be referenced.","type":"array","items":{"$ref":"#/components/schemas/DsAttachments"}},"purposes":{"description":"The details of the purposes involved in the consent interaction.","type":"array","items":{"$ref":"#/components/schemas/DsPurpose"}},"interactionDate":{"description":"The date and time that the data subject interacted with the collection point.","type":"string","example":"2019-05-14T01:34:33.000Z"},"privacyNotices":{"description":"The details of the privacy notice linked to the collection point. ","type":"array","items":{"$ref":"#/components/schemas/DsPrivacyNotice"}},"geoLocation":{"description":"The data subject's location where consent was provided.","$ref":"#/components/schemas/DsGeolocation"},"enableDataElementDateValidation":{"description":"This flag indicates whether interaction date validation is enabled when updating data element values. If set to `true`, data element values will be overwritten only if the interaction date of the receipt is later than the last updated date of the data subject.","type":"boolean","example":true,"default":"false"},"identifierType":{"description":"The type of data subject identifier used for the data subject's primary identifier.","type":"string","example":"Email"}},"required":["identifier","requestInformation"],"title":"RequestInformation"},"Source":{"type":"object","properties":{"type":{"description":"The type of source that captured the consent interaction.","type":"string","example":"WEB","enum":["WEB","MOBILE","CUSTOM","CTV"]},"content":{"description":"The URL or identifier of the source where the consent interaction took place.","example":"www.onetrust.com","type":"string"},"purposeIds":{"description":"The unique identifiers of the purposes that the data subject must consent to in order for the source to be captured, such as the purpose ID for Advanced analytics or similar.","type":"array","items":{"type":"string","format":"uuid"},"example":"313ef5eb-aaa5-4c7f-bc1f-0b8883bca1af"}}},"ConsentReceiptResponse":{"type":"object","properties":{"receipt":{"description":"A JSON web token (JWT) which contains the record of the transaction.","type":"string","example":"625ba071-61b0-485f-81a0-a2245777b430"},"instantLinkToken":{"description":"Instant link tokens operate independently from the magic link creation functionality under Global Settings and will expire after 12 months.","type":"string","example":"{JWT TOKEN}"},"linkToken":{"description":"The magic link token can be appended to the Preference Center login URL for a data subject login.","type":"string","example":"p4S2%2FKWgxNmOkf7Rz0%2FCxVrQR3o9HhvTgN2jgSU9pMk%3D"}}}},"securitySchemes":{"OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"CONSENT":"Consent Scope gives the user access to read/write operations","CONSENT_READ":"Consent Read Scope gives the user read-only access"}}}}}}}