Artifact Glossary
Here is the table containing the identified data fields with their descriptions, samples, types, and whether they are mandatory:
Data Element
Description
Sample
Type
Mandatory
artifact_context
URL defining the schema and specifications for the artifact
String
Yes
cp_name
Name of the consent purpose
Customer Onboarding Form
String
Yes
agreement_hash_id
Unique identifier representing the hash of the agreement content
1ca35897540ec7ae7294a8cacd11caf2c09f95f0
String
Yes
agreement_version
Version of the agreement
1.0
String
Yes
linked_agreement_hash
Hash of the linked agreement
d4828c7252da8b626a40ffdbbec74c36b74d8f80c
String
Yes
dp_df_id
Unique identifier for the data principal
d74bed43-6ee3-4cdc-a5cb-2b6b8f1732c4
String
Yes
dp_public_key
Public key of the data principal
(Not provided)
String
No
dp_residency
Residency of the data principal
india
String
Yes
dp_e
Encrypted identifier for the data principal
30ac654fe2a70f1a7a1b1b5b92b0238c2b2366ff
String
Yes
dp_verification
Indicates whether the data principal is verified
false
Boolean
Yes
dp_child
Indicates whether the data principal is a child
false
Boolean
Yes
dp_attorney_dp_df_id
Attorney's data principal ID
(Not provided)
String
No
dp_attorney_public_key
Attorney's public key
(Not provided)
String
No
dp_attorney_dp_e
Attorney's encrypted identifier
(Not provided)
String
No
df_id
Unique identifier for the data fiduciary
flipbasket
String
Yes
agreement_date
Date when the agreement was made
(Not provided)
Date
No
date_of_consent
Date when consent was given by the data principal
2024-02-23T00:00:00Z
DateTime
Yes
consent_status
Current status of the consent
active
String
Yes
revocation_date
Date when consent was revoked
2024-05-23
Date
Yes
right_to_access
Indicates if the data principal has the right to access
true
Boolean
Yes
right_to_rectify
Indicates if the data principal has the right to rectify
true
Boolean
Yes
right_to_erase
Indicates if the data principal has the right to erase
true
Boolean
Yes
right_to_restrict_processing
Indicates if the data principal has the right to restrict processing
true
Boolean
Yes
right_to_data_portability
Indicates if the data principal has the right to data portability
true
Boolean
Yes
data_element
Type of data element
home_address
String
Yes
purpose_id
Unique identifier for the purpose
bb4f25e5fd9b5b2b
String
Yes
consent_status
Status of the consent for the purpose
approved
String
Yes
shared
Indicates if the data is shared
false
Boolean
Yes
data_processors
List of data processors
123abc, 234ghi, 345jik
Array
Yes
cross_border
Indicates if the data is processed across borders
true
Boolean
Yes
consent_timestamp
Timestamp when consent was given
2024-02-23T00:00:00Z
DateTime
Yes
expiry_date
Date when the consent expires
2024-05-23T00:00:00Z
DateTime
Yes
retention_date
Date until which data is retained
2024-08-23T00:00:00Z
DateTime
Yes
This table summarizes the key data elements in the consent artifact, providing a clear understanding for developers on what each field represents and its necessity.
Last updated