Skip to main content
POST
Sign a document

Authorizations

Authorization
string
header
required

Bearer access token (JWT) issued by Keycloak or the sandbox token endpoint.

Path Parameters

id
string<uuid>
required

Document id

Body

application/json

Request to record a signature on a document, gated by a one-time code.

challengeId
string
required

Signing challenge id from the sign/otp step

Minimum string length: 1
code
string
required

One-time code the signer received

Minimum string length: 1
Pattern: \d{4,8}
role
enum<string>
required

Capacity in which the party signs

Available options:
LANDLORD,
MANAGER,
TENANT

Response

The document, now signed

certificateRef
string
certifiedOn
string<date>
certifyingAuthority
enum<string>
Available options:
POLICE,
MAIRIE,
NOTARY,
NONE
documentType
enum<string>
Available options:
NATIONAL_ID,
PASSPORT,
RESIDENCE_PERMIT,
DRIVER_LICENSE
expiresOn
string<date>
id
string<uuid>
mediaObjectId
string<uuid>
role
enum<string>
Available options:
SELF_ID,
PROOF_OF_OWNERSHIP,
ATTESTATION,
OWNER_MANDATE,
OWNER_ID,
OTHER