trust
The contract does not describe this family.
Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.
GET /api/v1/applications/{application_id}/consents
Consentements du demandeur d'un dossier
Etat par finalite active et historique ; la lecture est journalisee (P56).
applicationsConsents
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
application_id | path | string (uuid) | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | ApplicantConsentsOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/applications/{application_id}/consents
Enregistrer un recueil ou un retrait de consentement
Evenement de consentement, avec la reference de sa piece (`consents.record`).
applicationsRecordConsent
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
application_id | path | string (uuid) | yes |
Request body
- Content type
application/json- Type
ConsentIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
201 | Successful Response | application/json | ApplicantConsentsOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/trust/compliance-report
Rapport de conformite
Cinq sections calculees sur la periode, sous `audit.read`.
trustComplianceReport
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
start | query | string (date) | yes | |
end | query | string (date) | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | ComplianceReportOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/compliance-report/export
Exporter le rapport de conformite en preuve signee
`nexclara-compliance-report@1`, signe par la cle d'instance si configuree.
trustExportComplianceReport
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
start | query | string (date) | yes | |
end | query | string (date) | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Preuve canonique, a verifier hors du service. | application/json | EvidenceBundleOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/trust/consent-purposes
Finalites de consentement
Versions de finalite, actives et retirees.
trustListPurposes
Parameters
No parameters.
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<ConsentPurposeOut> |
POST /api/v1/trust/consent-purposes
Definir une finalite (nouvelle version)
Nouvelle version ; la version active du meme code est retiree (`trust.configure`).
trustCreatePurpose
Parameters
No parameters.
Request body
- Content type
application/json- Type
ConsentPurposeIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
201 | Successful Response | application/json | ConsentPurposeOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/consent-purposes/{purpose_id}/retire
Retirer une finalite
Retire une version active ; les consentements donnes demeurent.
trustRetirePurpose
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
purpose_id | path | string (uuid) | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | ConsentPurposeOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/trust/data-rights
Demandes de droits
Demandes, recentes d'abord, filtrees par etat.
trustListRightsRequests
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
status | query | "open" | "awaiting_purge" | "completed" | "refused" | null | no |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<RightsRequestOut> |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/data-rights
Enregistrer une demande d'exercice de droits
Demande enregistree, echeance fixee ; la reference presentee n'est pas conservee.
trustRegisterRightsRequest
Parameters
No parameters.
Request body
- Content type
application/json- Type
RightsRequestIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
201 | Successful Response | application/json | RightsRequestOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/trust/data-rights/{request_id}
Une demande
Une demande et son echeance.
trustGetRightsRequest
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
request_id | path | string (uuid) | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | RightsRequestOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/data-rights/{request_id}/accept-erasure
Accepter un effacement
Effacement accepte : la prochaine purge l'execute, l'atteste et clot la demande.
trustAcceptErasure
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
request_id | path | string (uuid) | yes |
Request body
- Content type
application/json- Type
RightsTransitionIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | RightsRequestOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/data-rights/{request_id}/access-report
Emettre le releve d'acces et clore la demande
`nexclara-subject-access-report@1`, signe ; la demande est close.
trustAccessReport
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
request_id | path | string (uuid) | yes |
Request body
- Content type
application/json- Type
AccessReportIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Preuve canonique, a verifier hors du service. | application/json | EvidenceBundleOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/data-rights/{request_id}/complete-rectification
Clore une rectification faite a la source
La donnee a ete corrigee dans le systeme de l'institution ; NEXCLARA ne la reecrit pas.
trustCompleteRectification
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
request_id | path | string (uuid) | yes |
Request body
- Content type
application/json- Type
RightsTransitionIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | RightsRequestOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/data-rights/{request_id}/refuse
Refuser une demande, motif code
Refus avec un motif de la liste fermee ; aucun texte libre.
trustRefuseRightsRequest
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
request_id | path | string (uuid) | yes |
Request body
- Content type
application/json- Type
RefusalIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | RightsRequestOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/trust/purge-runs
Executions de purge
Executions recentes d'abord : comptes, empreinte de l'attestation.
trustPurgeRuns
Parameters
No parameters.
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<PurgeRunOut> |
GET /api/v1/trust/purge-runs/{run_id}/attestation
Telecharger une attestation de destruction
`nexclara-destruction-attestation@1`, octets tels qu'emis et signes.
trustPurgeAttestation
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
run_id | path | string (uuid) | yes |
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Preuve canonique, a verifier hors du service. | application/json | EvidenceBundleOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/trust/retention
Durees de conservation
Durees en vigueur (provisoires ou confirmees) et elements echus.
trustRetention
Parameters
No parameters.
Request body
No request body.
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | RetentionOut |
PUT /api/v1/trust/retention/{category}
Confirmer une duree de conservation
Confirme une duree (authentification renforcee) : la purge s'y appliquera.
trustConfirmRetention
Parameters
| Parameter | Location | Type | Required | Constraints |
|---|---|---|---|---|
category | path | RetentionCategory | yes |
Request body
- Content type
application/json- Type
RetentionIn- Required
- yes
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
200 | Successful Response | application/json | RetentionOut |
422 | Validation Error | application/json | HTTPValidationError |