{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-@l10n/it/products/clickwrap/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Consents","description":"Integration and usage documentation."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"consents","__idx":0},"children":["Consents"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-consent","__idx":1},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create consent"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create a consent use the following endpoint: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/Consent"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"input","__idx":2},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Input"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"//POST /api/Consent\n{\n  \"agreementGroupGuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"consentGroupGuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"userIp\": \"string\",\n  \"externalID\": \"string\",\n  \"environment\": 0,\n  \"screenshot\": \"string\",\n  \"clauses\": [\n    {\n      \"tag\": \"my_tag\",\n      \"accepted\": true\n    }\n  ],\n  \"fieldCollection\": {\n    \"name\": \"name\",\n    \"surname\": \"surname\",\n    \"email\": \"name.surname@gmail.com\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AgreementGroupGuid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Agreement group connected to the consent"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ConsentGroupGuid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This parameter is used if you want to update a previously expressed consent. If you create a new consent or you don't need to modify a previous consent, it can be set to null or to an empty guid. If the agreement feature \"Can this agreement be modified?\" isn't enabled, this value will be ignored"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UserIp"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The IP address of the user"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ExternalId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The key used in your software that represents the user"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Environment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["0: staging, 1: production"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Screenshot"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Byte array of an image corresponding to the consent. If the agreement feature \"Capture Screenshot\" isn't enabled, this value will be ignored"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Clauses"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The list of conditions set in the agreement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["FieldCollection"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A JSON where the recipient information is saved or other information you might want to save and associate with the consent"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"output","__idx":3},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"guid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"agreement\": {\n    \"version\": \"string\",\n    \"enviroment\": 0,\n    \"groupGuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"nameOfAgreement\": \"string\"\n  },\n  \"fieldCollection\": \"string\",\n  \"consentDate\": \"2023-05-03T10:35:07.421Z\",\n  \"platform\": \"string\",\n  \"userIdentifier\": \"string\",\n  \"clauses\": [\n    {\n      \"tag\": \"my_tag\",\n      \"accepted\": true\n    }\n  ],\n  \"agreementHash\": \"string\",\n  \"externalID\": \"string\",\n  \"consentGroupGuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"screenshot\": \"string\",\n  \"userIp\": \"string\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Guid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The auto generated consent guid"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Agreement"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The agreement linked to the consent"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Agreement.Version"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The version of the agreement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Agreement.Enviroment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["0 = staging, 1 = production"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Agreement.GroupGuid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier that binds all the versions of a specific agreement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Agreement.NameOfAgreement"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the agreement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["FieldCollection"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The same collection as input"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ConsentDate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creation date of the consent"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Platform"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Platform on which the consent is created (Windows, Android, Macintosh, iPhone, iPad, BlackBerry, CrOS, Linux, Symbian, Others)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UserIdentifier"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the user who has given the consent; it is automatically extracted from the field collection if there's a field named \"email\" or \"mail\" or \"e-mail\", otherwise it will be saved as an empty string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Clauses"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The same collection as input"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AgreementHash"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The hash that will be sent on the blockchain"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ExternalID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The same as input"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ConsentGroupGuid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Auto generated guid, useful to modify a consent with this API"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Screenshot"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The same as input"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UserIp"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The same as input"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-consents","__idx":4},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get consents"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To get the consents you use the following endpoint: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/Consent/List"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"input-1","__idx":5},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Input"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"//POST /api/Consent/List\n{\n  \"agreementGroupGuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"externalID\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"userIdentifier\": \"string\",\n  \"dateFrom\": \"2020-04-01T00:00:00.0000000\",\n  \"dateTo\": \"2030-04-01T00:00:00.0000000\",\n  \"platform\": \"string\",\n  \"enviroment\": 0,\n  \"version\": \"string\",\n  \"getScreenshot\": true,\n  \"page\": 1,\n  \"itemsPerPage\": 20\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AgreementGroupGuid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set, retrieves the consents related to this specific agreement group guid"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ExternalId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set, retrieves the consents related to this specific ExternalId"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UserIdentifier"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set, retrieves the consents related to this specific UserIdentifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DateFrom"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set, retrieves the consents created starting from this date"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DateTo"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set, retrieves the consents created up to this date"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Platform"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set, retrieves the consents of this specific platform"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Enviroment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set, retrieves consents of a specific environment (0: staging, 1: production)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Version"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set, retrieves consents related to a specific version of the agreement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GetScreenshot"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set, retrieves the screenshot linked to the consent"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ItemsPerPage"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Items per page"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The only required parameters are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["itemsPerPage"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"The result collection doesn't include consents related to deleted agreements.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"The output is a list of consents corresponding to the search crtiteria."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"output-1","__idx":6},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"guid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"agreement\": {\n      \"version\": \"string\",\n      \"enviroment\": 0,\n      \"groupGuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"nameOfAgreement\": \"string\"\n    },\n    \"fieldCollection\": \"string\",\n    \"consentDate\": \"2023-05-03T10:55:32.675Z\",\n    \"platform\": \"string\",\n    \"userIdentifier\": \"string\",\n    \"clauses\": [\n      {\n        \"tag\": \"my_tag\",\n        \"accepted\": true\n      }\n    ],\n    \"blockchainProcessId\": \"string\",\n    \"blockchainTxHash\": \"string\",\n    \"agreementHash\": \"string\",\n    \"blockchainStatus\": 0,\n    \"blockchainStatusDate\": \"2023-05-03T10:55:32.675Z\",\n    \"externalID\": \"string\",\n    \"blockchainUuid\": \"string\",\n    \"screenshot\": \"string\",\n    \"consentGroupGuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"userIp\": \"string\"\n  }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Guid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The auto generated consent guid"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Agreement"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The agreement linked to the consent"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Agreement.Version"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The version of the agreement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Agreement.Enviroment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["0 = staging, 1 = production"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Agreement.GroupGuid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier that binds all the versions of a specific agreement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Agreement.NameOfAgreement"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the agreement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["FieldCollection"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The JSON given as input in the integrator's APIs or compiled by the user with the required field in the website snippet"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ConsentDate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consent creation date"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Platform"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Platform on which the agreement is created (Windows, Android, Macintosh, iPhone, iPad, BlackBerry, CrOS, Linux, Symbian, Others)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UserIdentifier"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the user who has given the consent; it is automatically extracted from the field collection if there's a field named \"email\" or \"mail\" or \"e-mail\", otherwise an empty string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Clauses"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The clauses list"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Clauses.ClausesTag"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The tag you have created in the agreement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Clauses.ClausesAccepted"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If the user accepted or denied"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["BlockchainProcessId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The id of the process on the blockchain"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["BlockchainTxHash"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The final hash that represents the success on the consent save on the blockchain (the blockchain may take a bit of time and it may not be valorized immediately after the creation of a consent)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AgreementHash"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The agreement hash that will be sent on the blockchain"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["BlockchainStatus"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Save status on the blockchain (Registered = 0, Queued = 1, ProcessCreated = 2, Notarized = 3, Error = 4)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["BlockchainStatusDate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the status of the save on the blockchain changes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ExternalID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The key used in your software that represents the user"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["BlockchainUuid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UUID generated by the blockchain"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Screenshot"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The screenshot generated by creating a consent, if in the agreement the option Capture screenshot is flagged. If there's no screenshot the output is an empty byte array."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ConsentGroupGuid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Group guid of the consent"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UserIp"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The IP address of the user"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-audit-trail-pdf","__idx":7},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get audit trail PDF"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To get the audit trail PDF document you can use the following endpoint:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/Consent/GetAuditTrail/{consentGuid}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"output-2","__idx":8},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Audit Trail PDF file."]}]},"headings":[{"value":"Consents","id":"consents","depth":1},{"value":"Create consent","id":"create-consent","depth":2},{"value":"Input","id":"input","depth":3},{"value":"Output","id":"output","depth":3},{"value":"Get consents","id":"get-consents","depth":2},{"value":"Input","id":"input-1","depth":3},{"value":"Output","id":"output-1","depth":3},{"value":"Get audit trail PDF","id":"get-audit-trail-pdf","depth":2},{"value":"Output","id":"output-2","depth":3}],"frontmatter":{"seo":{"title":"Consents"}},"lastModified":"2025-06-11T14:22:17.000Z","isTranslationFallback":true,"pagePropGetterError":{"message":"","name":""}},"slug":"/it/products/clickwrap/api-integration/consents","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}