Skip to content

Product documentation

LegalDocuments

The LegalDocuments resource.

LegalDocuments

The LegalDocuments resource.

Base URL: https://api.stg.thoryn.org

Operations

MethodPathSummaryScopes
GET/api/v1/applications/{clientId}/{docType}Legal Documents Listtenant:compliance.read
POST/api/v1/applications/{clientId}/{docType}Legal Documents Createtenant:compliance.write
GET/api/v1/applications/{clientId}/{docType}/{id}Legal Documents Gettenant:compliance.read
DELETE/api/v1/applications/{clientId}/{docType}/{id}Legal Documents Deletetenant:compliance.write
POST/api/v1/applications/{clientId}/{docType}/{id}/activateLegal Documents Activatetenant:compliance.write

Operation details

GET /api/v1/applications/{clientId}/{docType}

Legal Documents List

  • Operation ID: legalDocumentsList
  • Required scopes: tenant:compliance.read

Parameters:

NameInRequiredTypeDescription
clientIdpathyesstring
docTypepathyesstringThe legal-document type to administer.

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

POST /api/v1/applications/{clientId}/{docType}

Legal Documents Create

  • Operation ID: legalDocumentsCreate
  • Required scopes: tenant:compliance.write

Parameters:

NameInRequiredTypeDescription
clientIdpathyesstring
docTypepathyesstringThe legal-document type to administer.

Request body (required): application/jsonCreateLegalDocumentRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

GET /api/v1/applications/{clientId}/{docType}/{id}

Legal Documents Get

  • Operation ID: legalDocumentsGet
  • Required scopes: tenant:compliance.read

Parameters:

NameInRequiredTypeDescription
clientIdpathyesstring
docTypepathyesstringThe legal-document type to administer.
idpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

DELETE /api/v1/applications/{clientId}/{docType}/{id}

Legal Documents Delete

  • Operation ID: legalDocumentsDelete
  • Required scopes: tenant:compliance.write

Parameters:

NameInRequiredTypeDescription
clientIdpathyesstring
docTypepathyesstringThe legal-document type to administer.
idpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

POST /api/v1/applications/{clientId}/{docType}/{id}/activate

Legal Documents Activate

  • Operation ID: legalDocumentsActivate
  • Required scopes: tenant:compliance.write

Parameters:

NameInRequiredTypeDescription
clientIdpathyesstring
docTypepathyesstringThe legal-document type to administer.
idpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)