Schemas: trust

Schemas whose first using operation belongs to the trust family. A shared schema is described once, here, and linked from every operation that uses it.

Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.

`AccessReportIn`

Emission du releve d'acces, qui clot la demande.

Type : object

Property	Type	Required	Description	Constraints
`row_version`	`integer`	yes		minimum: 1

Used by : trustAccessReport

`ApplicantConsentsOut`

Consentements du demandeur d'un dossier.

Type : object

Property	Type	Required
`application_id`	`string (uuid)`	yes
`history`	`array<ConsentEventOut>`	yes
`purposes`	`array<ConsentPurposeOut>`	yes
`statuses`	`array<ConsentStatusOut>`	yes

Used by : applicationsConsents, applicationsRecordConsent

`AuditIntegrityOut`

Verification complete de la chaine de l'institution.

Type : object

Property	Type	Required
`first_invalid_sequence`	`integer \| null`	yes
`head_hash`	`string`	yes
`head_sequence`	`integer`	yes
`intact`	`boolean`	yes
`reason`	`string \| null`	yes
`verified_at`	`string (date-time)`	yes
`verified_events`	`integer`	yes

Used by : trustComplianceReport

`ComplianceReportOut`

Rapport de conformite d'une periode (dates incluses, UTC).

Type : object

Property	Type	Required
`generated_at`	`string (date-time)`	yes
`period_end`	`string (date)`	yes
`period_start`	`string (date)`	yes
`sections`	`ComplianceSectionsOut`	yes

Used by : trustComplianceReport

`ComplianceSectionsOut`

Les cinq sections du rapport.

Type : object

Property	Type	Required
`audit_integrity`	`AuditIntegrityOut`	yes
`consents`	`ConsentsReportOut`	yes
`consultations`	`ConsultationsReportOut`	yes
`data_rights`	`RightsReportOut`	yes
`retention`	`RetentionReportOut`	yes

Used by : trustComplianceReport

`ConsentEventOut`

Evenement de consentement, avec son empreinte.

Type : object

Property	Type	Required
`evidence_reference`	`string \| null`	yes
`fingerprint`	`string`	yes
`id`	`string (uuid)`	yes
`kind`	`"granted" \| "withdrawn"`	yes
`purpose_id`	`string (uuid)`	yes
`recorded_at`	`string (date-time)`	yes
`recorded_by`	`string (uuid)`	yes

Used by : applicationsConsents, applicationsRecordConsent

`ConsentIn`

Recueil ou retrait pour le demandeur du dossier.

Type : object

Property	Type	Required	Description	Constraints
`evidence_reference`	`string \| null`	no	Reference de la piece dans l'archive de l'institution ; jamais un contenu.	maxLength: 80
`kind`	`"granted" \| "withdrawn"`	yes
`purpose_id`	`string (uuid)`	yes

Used by : applicationsRecordConsent

`ConsentPurposeIn`

Nouvelle version de finalite ; la version active du meme code est retiree.

Type : object

Property	Type	Required	Description	Constraints
`code`	`string`	yes		minLength: 2 ; maxLength: 48
`gates`	`"credit_evaluation" \| null`	no	Traitement conditionne : sans consentement en vigueur, il est refuse.
`label_en`	`string`	yes		minLength: 1 ; maxLength: 160
`label_fr`	`string`	yes		minLength: 1 ; maxLength: 160

Used by : trustCreatePurpose

`ConsentPurposeOut`

Version de finalite.

Type : object

Property	Type	Required
`code`	`string`	yes
`created_at`	`string (date-time)`	yes
`gates`	`"credit_evaluation" \| null`	yes
`id`	`string (uuid)`	yes
`label_en`	`string \| null`	yes
`label_fr`	`string`	yes
`retired_at`	`string (date-time) \| null`	yes
`status`	`"active" \| "retired"`	yes
`version`	`integer`	yes

Used by : applicationsConsents, applicationsRecordConsent, trustCreatePurpose, trustListPurposes, trustRetirePurpose

`ConsentStatusOut`

Etat d'une finalite active pour le demandeur.

Type : object

Property	Type	Required	Description	Constraints
`purpose`	`ConsentPurposeOut`	yes
`state`	`"granted" \| "withdrawn" \| null`	yes

Used by : applicationsConsents, applicationsRecordConsent

`ConsentsReportOut`

Consentements par finalite et refus d'evaluation.

Type : object

Property	Type	Required	Description	Constraints
`evaluations_refused`	`integer`	yes
`purposes`	`array<PurposeReportOut>`	yes

Used by : trustComplianceReport

`ConsultationsReportOut`

Consultations journalisees de la periode (P56).

Type : object

Property	Type	Required
`access_reports`	`integer`	yes
`attestation_downloads`	`integer`	yes
`by_view`	`map<string, integer>`	yes
`distinct_users`	`integer`	yes
`dossier_consultations`	`integer`	yes
`evidence_exports`	`integer`	yes
`support_consultations`	`integer`	yes
`worklist_pages`	`integer`	yes

Used by : trustComplianceReport

`PurgeRunOut`

Execution de purge (l'attestation se telecharge a part).

Type : object

Property	Type	Required
`by_category`	`map<string, integer>`	yes
`by_reason`	`map<string, integer>`	yes
`by_resource`	`map<string, integer>`	yes
`executed_by`	`string`	yes
`finished_at`	`string (date-time)`	yes
`id`	`string (uuid)`	yes
`items`	`integer`	yes
`manifest_sha256`	`string`	yes
`signed`	`boolean`	yes
`started_at`	`string (date-time)`	yes

Used by : trustPurgeRuns

`PurposeReportOut`

Une version de finalite dans le rapport.

Type : object

Property	Type	Required
`code`	`string`	yes
`gates`	`"credit_evaluation" \| null`	yes
`granted_in_period`	`integer`	yes
`granted_now`	`integer`	yes
`id`	`string (uuid)`	yes
`status`	`"active" \| "retired"`	yes
`version`	`integer`	yes
`withdrawn_in_period`	`integer`	yes
`withdrawn_now`	`integer`	yes

Used by : trustComplianceReport

`RefusalIn`

Refus motive, par un code.

Type : object

Property	Type	Required	Description	Constraints
`ground`	`"legal_retention_obligation" \| "ongoing_contract" \| "legal_claims" \| "identity_not_verified" \| "manifestly_unfounded"`	yes
`row_version`	`integer`	yes		minimum: 1

Used by : trustRefuseRightsRequest

`RetentionCategory`

Categorie de donnees purgeables. Liste fermee, donnees reelles.

Type : string

Allowed values : evaluated_application_inputs, draft_application_inputs, unlinked_import_rows

Used by : trustConfirmRetention

`RetentionIn`

Duree confirmee pour une categorie, en jours.

Type : object

Property	Type	Required	Description	Constraints
`days`	`integer`	yes		minimum: 1 ; maximum: 36500

Used by : trustConfirmRetention

`RetentionOut`

Durees de conservation de l'institution.

Type : object

Property	Type	Required	Description	Constraints
`rules`	`array<RetentionRuleOut>`	yes

Used by : trustConfirmRetention, trustRetention

`RetentionReportOut`

Durees, purges de la periode, elements echus.

Type : object

Property	Type	Required
`destroyed_by_category`	`map<string, integer>`	yes
`last_run_at`	`string (date-time) \| null`	yes
`pending_now`	`map<string, integer>`	yes
`purge_runs`	`integer`	yes
`rules`	`array<RetentionRuleReportOut>`	yes

Used by : trustComplianceReport

`RetentionRuleOut`

Duree en vigueur d'une categorie et elements echus.

Type : object

Property	Type	Required	Description
`category`	`"evaluated_application_inputs" \| "draft_application_inputs" \| "unlinked_import_rows"`	yes
`confirmed_at`	`string (date-time) \| null`	yes
`confirmed_by`	`string (uuid) \| null`	yes
`days`	`integer`	yes
`erased_fields`	`array<string>`	yes
`maximum_days`	`integer`	yes
`minimum_days`	`integer`	yes
`pending`	`integer \| null`	yes	Elements echus a purger au prochain passage ; `null` si non confirmee.
`provisional_days`	`integer`	yes
`state`	`"provisional" \| "confirmed"`	yes

Used by : trustConfirmRetention, trustRetention

`RetentionRuleReportOut`

Duree en vigueur dans le rapport.

Type : object

Property	Type	Required
`category`	`"evaluated_application_inputs" \| "draft_application_inputs" \| "unlinked_import_rows"`	yes
`confirmed_at`	`string (date-time) \| null`	yes
`days`	`integer`	yes
`state`	`"provisional" \| "confirmed"`	yes

Used by : trustComplianceReport

`RightsReportOut`

Demandes de droits de la periode et en cours.

Type : object

Property	Type	Required
`awaiting_purge_now`	`integer`	yes
`open_now`	`integer`	yes
`overdue_now`	`integer`	yes
`received`	`map<string, integer>`	yes
`received_by_status`	`map<string, integer>`	yes
`response_days`	`integer`	yes

Used by : trustComplianceReport

`RightsRequestIn`

Demande a enregistrer. La reference sert a trouver la personne ; elle n'est pas gardee.

Type : object

Property	Type	Required	Description	Constraints
`applicant_reference`	`string`	yes		minLength: 1 ; maxLength: 64
`kind`	`"access" \| "rectification" \| "erasure"`	yes
`received_at`	`string (date-time) \| null`	no	Reception anterieure (courrier) ; maintenant par defaut.
`received_via`	`"in_person" \| "postal_mail" \| "electronic"`	yes

Used by : trustRegisterRightsRequest

`RightsRequestOut`

Demande d'exercice d'un droit.

Type : object

Property	Type	Required
`completed_at`	`string (date-time) \| null`	yes
`decided_at`	`string (date-time) \| null`	yes
`due_at`	`string (date-time)`	yes
`id`	`string (uuid)`	yes
`kind`	`"access" \| "rectification" \| "erasure"`	yes
`outcome`	`"access_report_issued" \| "no_data" \| "rectified_at_source" \| "erased" \| null`	yes
`overdue`	`boolean`	yes
`purge_run_id`	`string (uuid) \| null`	yes
`received_at`	`string (date-time)`	yes
`received_via`	`"in_person" \| "postal_mail" \| "electronic"`	yes
`refusal_ground`	`"legal_retention_obligation" \| "ongoing_contract" \| "legal_claims" \| "identity_not_verified" \| "manifestly_unfounded" \| null`	yes
`report_sha256`	`string \| null`	yes
`row_version`	`integer`	yes
`status`	`"open" \| "awaiting_purge" \| "completed" \| "refused"`	yes
`subject_found`	`boolean`	yes

Used by : trustAcceptErasure, trustCompleteRectification, trustGetRightsRequest, trustListRightsRequests, trustRefuseRightsRequest, trustRegisterRightsRequest

`RightsTransitionIn`

Ecriture sans autre donnee que la version lue.

Type : object

Property	Type	Required	Description	Constraints
`row_version`	`integer`	yes		minimum: 1

Used by : trustAcceptErasure, trustCompleteRectification