Skip to main content
POST
cURL

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new Contract resource

name
string
content
string
isInfiniteDuration
boolean | null
yearDuration
integer | null
monthDuration
integer | null
hasSignature
boolean | null
hasUpload
boolean | null
enableSignatureCancellation
boolean | null
required
boolean | null
hasAdminSignature
boolean | null
unit
string<iri-reference> | null
Example:

"/api/v1/units/1"

displayInProfile
boolean | null
defaultSignature
string<iri-reference> | null
Example:

"/api/v1/media/1"

hasDefaultSignature
boolean | null
useDefaultSignatureAsPreSigned
boolean | null

Response

Contract resource created

id
integer
read-only
name
string
content
string
isInfiniteDuration
boolean | null
yearDuration
integer | null
monthDuration
integer | null
hasSignature
boolean | null
hasUpload
boolean | null
contractHash
string
default:""
enableSignatureCancellation
boolean | null
required
boolean | null
hasAdminSignature
boolean | null
unit
object | null
displayInProfile
boolean | null
defaultSignature
object | null
hasDefaultSignature
boolean | null
useDefaultSignatureAsPreSigned
boolean | null