Management mandates (mandats de gestion) between a principal (owner/lessee) and a mandataire: create, attach a document, activate, and revoke.
List mandates
Lists the mandates visible to the authenticated user, filtered by their role.
Role filter
The role query parameter controls which mandates are returned:
mandataire(default): mandates where the user is the delegateprincipal: mandates where the user is the principal (the person who granted the mandate)
An empty or missing role is treated as mandataire. Any other value returns 400.
Multi-tenant isolation
Mandates are automatically scoped to the tenant_id extracted from the JWT.
Usage Example
Code
Response:
Code
query Parameters
roleFilter mandates by the user's role.
mandataire(default): user is the delegateprincipal: user is the principal
List mandates › Responses
List of mandates (empty array if none).
idUnique mandate identifier.
tenant_idTenant identifier (multi-tenant isolation).
mandataire_auth_user_idAuth user ID of the mandataire (extracted from the JWT).
The principal (person) on whose behalf the mandate is held.
scopeOrdered list of delegated permissions.
valid_fromStart date of validity (ISO 8601, YYYY-MM-DD).
The document backing the mandate.
statusLifecycle status of a mandate.
Valid transitions: draft → active, draft → revoked,
active → revoked, active → expired.
created_atCreation timestamp (ISO 8601).
updated_atLast update timestamp (ISO 8601).
valid_untilEnd date of validity (ISO 8601). null means no end date.
When set, must be strictly after valid_from.
revoked_atRevocation timestamp, or null if not revoked.
revoke_reasonFree-text reason for revocation (max 500 chars), or null.
Create a mandate
Creates a new mandate in draft status.
The tenant_id and mandataire_auth_user_id are derived from the JWT and
must not be supplied in the body.
Validations
principal_kindmust beownerorlesseescopemust be a non-empty array of valid scope valuesvalid_until, when present, must be strictly aftervalid_from
Usage Example
Code
Create a mandate › Request Body
principal_person_idIdentifier of the principal (owner or lessee) person.
principal_kindKind of principal (the person granting the mandate).
scopeNon-empty list of delegated permissions.
valid_fromStart date of validity (ISO 8601).
valid_untilOptional end date. Must be strictly after valid_from when provided.
Create a mandate › Responses
Mandate created (status draft).
idUnique mandate identifier.
tenant_idTenant identifier (multi-tenant isolation).
mandataire_auth_user_idAuth user ID of the mandataire (extracted from the JWT).
The principal (person) on whose behalf the mandate is held.
scopeOrdered list of delegated permissions.
valid_fromStart date of validity (ISO 8601, YYYY-MM-DD).
The document backing the mandate.
statusLifecycle status of a mandate.
Valid transitions: draft → active, draft → revoked,
active → revoked, active → expired.
created_atCreation timestamp (ISO 8601).
updated_atLast update timestamp (ISO 8601).
valid_untilEnd date of validity (ISO 8601). null means no end date.
When set, must be strictly after valid_from.
revoked_atRevocation timestamp, or null if not revoked.
revoke_reasonFree-text reason for revocation (max 500 chars), or null.
Get a mandate
Retrieves a single mandate by its identifier.
Code
path Parameters
idGet a mandate › Responses
The mandate.
idUnique mandate identifier.
tenant_idTenant identifier (multi-tenant isolation).
mandataire_auth_user_idAuth user ID of the mandataire (extracted from the JWT).
The principal (person) on whose behalf the mandate is held.
scopeOrdered list of delegated permissions.
valid_fromStart date of validity (ISO 8601, YYYY-MM-DD).
The document backing the mandate.
statusLifecycle status of a mandate.
Valid transitions: draft → active, draft → revoked,
active → revoked, active → expired.
created_atCreation timestamp (ISO 8601).
updated_atLast update timestamp (ISO 8601).
valid_untilEnd date of validity (ISO 8601). null means no end date.
When set, must be strictly after valid_from.
revoked_atRevocation timestamp, or null if not revoked.
revoke_reasonFree-text reason for revocation (max 500 chars), or null.
Attach a document to a mandate
Attaches a signed document (media) to a mandate. When the attached
document is signed and the mandate is within its validity window, the
mandate is atomically activated (status becomes active).
Code
path Parameters
idAttach a document to a mandate › Request Body
media_idIdentifier of the media (document) to attach.
Attach a document to a mandate › Responses
The updated mandate.
idUnique mandate identifier.
tenant_idTenant identifier (multi-tenant isolation).
mandataire_auth_user_idAuth user ID of the mandataire (extracted from the JWT).
The principal (person) on whose behalf the mandate is held.
scopeOrdered list of delegated permissions.
valid_fromStart date of validity (ISO 8601, YYYY-MM-DD).
The document backing the mandate.
statusLifecycle status of a mandate.
Valid transitions: draft → active, draft → revoked,
active → revoked, active → expired.
created_atCreation timestamp (ISO 8601).
updated_atLast update timestamp (ISO 8601).
valid_untilEnd date of validity (ISO 8601). null means no end date.
When set, must be strictly after valid_from.
revoked_atRevocation timestamp, or null if not revoked.
revoke_reasonFree-text reason for revocation (max 500 chars), or null.
Activate a mandate
Activates a draft mandate (status becomes active). Activation
requires a signed document to be attached and the mandate to be within
its validity window; otherwise the request is rejected.
No request body is required.
Code
path Parameters
idActivate a mandate › Responses
The activated mandate (status active).
idUnique mandate identifier.
tenant_idTenant identifier (multi-tenant isolation).
mandataire_auth_user_idAuth user ID of the mandataire (extracted from the JWT).
The principal (person) on whose behalf the mandate is held.
scopeOrdered list of delegated permissions.
valid_fromStart date of validity (ISO 8601, YYYY-MM-DD).
The document backing the mandate.
statusLifecycle status of a mandate.
Valid transitions: draft → active, draft → revoked,
active → revoked, active → expired.
created_atCreation timestamp (ISO 8601).
updated_atLast update timestamp (ISO 8601).
valid_untilEnd date of validity (ISO 8601). null means no end date.
When set, must be strictly after valid_from.
revoked_atRevocation timestamp, or null if not revoked.
revoke_reasonFree-text reason for revocation (max 500 chars), or null.
Revoke a mandate
Revokes a mandate (status becomes revoked). An optional reason
(max 500 chars) can be provided.
Code
path Parameters
idRevoke a mandate › Request Body optional
reasonOptional free-text reason for the revocation.
Revoke a mandate › Responses
The revoked mandate (status revoked).
idUnique mandate identifier.
tenant_idTenant identifier (multi-tenant isolation).
mandataire_auth_user_idAuth user ID of the mandataire (extracted from the JWT).
The principal (person) on whose behalf the mandate is held.
scopeOrdered list of delegated permissions.
valid_fromStart date of validity (ISO 8601, YYYY-MM-DD).
The document backing the mandate.
statusLifecycle status of a mandate.
Valid transitions: draft → active, draft → revoked,
active → revoked, active → expired.
created_atCreation timestamp (ISO 8601).
updated_atLast update timestamp (ISO 8601).
valid_untilEnd date of validity (ISO 8601). null means no end date.
When set, must be strictly after valid_from.
revoked_atRevocation timestamp, or null if not revoked.
revoke_reasonFree-text reason for revocation (max 500 chars), or null.