Create and store data agreement in wallet (v2)
POST {{baseUrl}}/v1/data-agreements?draft=<boolean>&existing_schema_id=<string>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
draft | string | draft mode | |
existing_schema_id | string | Existing schema identifier |
Request Body
{"@context"=>"<string>", "data_controller_name"=>"<string>", "data_policy"=>{"data_retention_period"=>"<integer>", "geographic_restriction"=>"<string>", "jurisdiction"=>"<string>", "policy_URL"=>"<string>", "storage_location"=>"<string>", "industry_sector"=>"<string>"}, "lawful_basis"=>"legitimate_interest", "method_of_use"=>"data-source", "personal_data"=>[{"attribute_description"=>"<string>", "attribute_name"=>"<string>", "restrictions"=>[{"cred_def_id"=>"<string>", "schema_id"=>"<string>"}, {"cred_def_id"=>"<string>", "schema_id"=>"<string>"}]}, {"attribute_description"=>"<string>", "attribute_name"=>"<string>", "restrictions"=>[{"cred_def_id"=>"<string>", "schema_id"=>"<string>"}, {"cred_def_id"=>"<string>", "schema_id"=>"<string>"}]}], "purpose"=>"<string>", "purpose_description"=>"<string>", "data_controller_url"=>"<string>", "dpia"=>{"dpia_date"=>"<string>", "dpia_summary_url"=>"<string>"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"data_agreement":{"@context":"\u003cstring\u003e","data_controller_name":"\u003cstring\u003e","data_policy":{"data_retention_period":"\u003cinteger\u003e","geographic_restriction":"\u003cstring\u003e","jurisdiction":"\u003cstring\u003e","policy_URL":"\u003cstring\u003e","storage_location":"\u003cstring\u003e","industry_sector":"\u003cstring\u003e"},"lawful_basis":"vital_interest","method_of_use":"data-using-service","personal_data":[{"attribute_description":"\u003cstring\u003e","attribute_name":"\u003cstring\u003e","attribute_category":"\u003cstring\u003e","attribute_id":"\u003cstring\u003e","attribute_sensitive":"\u003cboolean\u003e","restrictions":[{"cred_def_id":"\u003cstring\u003e","schema_id":"\u003cstring\u003e"},{"cred_def_id":"\u003cstring\u003e","schema_id":"\u003cstring\u003e"}]}],"purpose":"\u003cstring\u003e","purpose_description":"\u003cstring\u003e","data_controller_url":"\u003cstring\u003e","dpia":{"dpia_date":"\u003cstring\u003e","dpia_summary_url":"\u003cstring\u003e"},"template_id":"\u003cstring\u003e","template_version":"\u003cinteger\u003e"},"data_agreement_id":"\u003cstring\u003e","data_agreement_record_id":"\u003cstring\u003e","delete_flag":"false","method_of_use":"data-source","publish_flag":"true","state":"PREPARATION"}