Create and store data agreement in wallet (v2)

POST {{baseUrl}}/v1/data-agreements?draft=<boolean>&existing_schema_id=<string>

Request Params

KeyDatatypeRequiredDescription
draftstringdraft mode
existing_schema_idstringExisting 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

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: Created

{&quot;data_agreement&quot;:{&quot;@context&quot;:&quot;\u003cstring\u003e&quot;,&quot;data_controller_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;data_policy&quot;:{&quot;data_retention_period&quot;:&quot;\u003cinteger\u003e&quot;,&quot;geographic_restriction&quot;:&quot;\u003cstring\u003e&quot;,&quot;jurisdiction&quot;:&quot;\u003cstring\u003e&quot;,&quot;policy_URL&quot;:&quot;\u003cstring\u003e&quot;,&quot;storage_location&quot;:&quot;\u003cstring\u003e&quot;,&quot;industry_sector&quot;:&quot;\u003cstring\u003e&quot;},&quot;lawful_basis&quot;:&quot;vital_interest&quot;,&quot;method_of_use&quot;:&quot;data-using-service&quot;,&quot;personal_data&quot;:[{&quot;attribute_description&quot;:&quot;\u003cstring\u003e&quot;,&quot;attribute_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;attribute_category&quot;:&quot;\u003cstring\u003e&quot;,&quot;attribute_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;attribute_sensitive&quot;:&quot;\u003cboolean\u003e&quot;,&quot;restrictions&quot;:[{&quot;cred_def_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;schema_id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;cred_def_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;schema_id&quot;:&quot;\u003cstring\u003e&quot;}]}],&quot;purpose&quot;:&quot;\u003cstring\u003e&quot;,&quot;purpose_description&quot;:&quot;\u003cstring\u003e&quot;,&quot;data_controller_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;dpia&quot;:{&quot;dpia_date&quot;:&quot;\u003cstring\u003e&quot;,&quot;dpia_summary_url&quot;:&quot;\u003cstring\u003e&quot;},&quot;template_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;template_version&quot;:&quot;\u003cinteger\u003e&quot;},&quot;data_agreement_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;data_agreement_record_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;delete_flag&quot;:&quot;false&quot;,&quot;method_of_use&quot;:&quot;data-source&quot;,&quot;publish_flag&quot;:&quot;true&quot;,&quot;state&quot;:&quot;PREPARATION&quot;}