API reference

Legal profiles

Versions of the legal profile of your organisation.

List legal profile versions

GET/v1/legal-profiles/{profile_id}/versions

Scopes
legal:read

Versions of the legal profile of a basis profile, newest first, and a draft template with the purposes of the tenant.

Parameters

FieldTypeRequired
profile_idpathstring (uuid)yes

Responses

  • 200LegalProfileVersionList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Create a legal profile version

POST/v1/legal-profiles/{profile_id}/versions

Scopes
legal:write
Required header
Idempotency-Key

New draft version of the legal profile; an earlier draft becomes superseded. Structural violations - 422 with pointers under /content. The draft is approved by another identity of the customer (createApproval resource_type legal_profile) and then by the platform owner.

Parameters

FieldTypeRequired
profile_idpathstring (uuid)yes

Request bodyLegalProfileVersionCreate

FieldTypeRequired
contentLegalProfileContentyes

Responses

  • 201LegalProfileVersion
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Get a legal profile version

GET/v1/legal-profile-versions/{version_id}

Scopes
legal:read

Parameters

FieldTypeRequired
version_idpathstring (uuid)yes

Responses

  • 200LegalProfileVersion
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503