Essence Consent Management API

All OpenAPI documents

Version v1 · OpenAPI 3.0.1 · 636 operations · Download the JSON document

Zero-knowledge consent management for secure document sharing

Generated from the Consent service's code at build time (api-specs/generated/Consent/Essence.Consent.Core.Api.json) and drift-checked in CI. It describes what the code registers, which is not the same as what any one deployment has routed.

AccountCapture

POST/api/v1/account/capture-requests

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.IssueAccountCaptureRequestDto as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.Commands.AccountCapture.AccountCaptureRequestResult

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/account/capture-requests/by-token/{token}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
token	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Commands.AccountCapture.AccountCaptureContextResult

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

410Client Error — Essence.Consent.Core.Application.Commands.AccountCapture.AccountCaptureContextResult

GET/api/v1/account/capture-requests/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Commands.AccountCapture.AccountCaptureRequestResult

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/account/capture-requests/{id}/decision

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.AccountCaptureDecisionDto as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.Commands.AccountCapture.AccountCaptureDecisionResult

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/account/capture-requests/{id}/receipt

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Commands.AccountCapture.CaptureConsentReceiptDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

AgentDelegation

GET/api/v1/consent/agent-delegations

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
agentReference	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.AgentDelegationDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/agent-delegations

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.CreateAgentDelegationRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.AgentDelegationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/agent-delegations/agents/{agentReference}/activity

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
agentReference	path	string	yes	—
from	query	string (date-time)	no	—
to	query	string (date-time)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.AgentActivityEntryDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/agent-delegations/agents/{agentReference}/report

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
agentReference	path	string	yes	—
from	query	string (date-time)	no	—
to	query	string (date-time)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.AgentActivityReportDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/agent-delegations/agents/{agentReference}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
agentReference	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeAgentAuthorityRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RevokeAgentAuthorityResultDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/agent-delegations/authorizedeprecated

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

410Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/agent-delegations/force-revoke-for-agent

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ForceRevokeAgentDelegationsRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.AgentDelegationForceRevocationResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

429Too Many Requests — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/agent-delegations/templates

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.AgentScopeTemplateDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

AppOwnership

GET/api/v1/consent/app-ownership-changes

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
outstandingOnly	query	boolean	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.AppOwnership.AppOwnerChangeSummaryView[]

GET/api/v1/consent/app-ownership-changes/rescope-validation

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
appId	query	string	no	—
toOrgId	query	string (uuid)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Api.Controllers.AppRescopeValidationResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/app-ownership-changes/{transferId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
transferId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.AppOwnership.AppOwnerChangeDetailView

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/app-ownership-changes/{transferId}/acknowledge

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
transferId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Api.Controllers.AppOwnershipActionResponse

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/app-ownership-changes/{transferId}/confirm-billing

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
transferId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Api.Controllers.AppOwnershipActionResponse

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/app-ownership-changes/{transferId}/reconsent

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
transferId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Api.Controllers.AppOwnershipActionResponse

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/app-ownership-changes/{transferId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
transferId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Api.Controllers.AppOwnershipActionResponse

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

AppSunset

GET/api/v1/consent/app-sunset

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.AppSunset.AppSunsetSummaryView[]

GET/api/v1/consent/app-sunset/{deprecationId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
deprecationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.AppSunset.AppSunsetDetailView

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/app-sunset/{deprecationId}/cohort

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
deprecationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.AppSunset.AppSunsetCohortView

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/app-sunset/{deprecationId}/migrate-now

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
deprecationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Api.Controllers.AppSunsetMigrateNowResponse

POST/api/v1/consent/app-sunset/{deprecationId}/remind-me

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
deprecationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.AppSunsetReminderRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Api.Controllers.AppSunsetReminderResponse

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/app-sunset/{deprecationId}/request-extension

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
deprecationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.AppSunsetExtensionRequest as application/*+json, application/json, text/json

Responses

202Accepted

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

AssuranceEstablishmentConsent

POST/api/v1/consents/assurance-establishment

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordAssuranceEstablishmentConsentRequestDto as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.AssuranceEstablishmentConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

BiometricProcessingConsent

POST/api/v1/consents/biometric-processing

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordBiometricProcessingConsentRequestDto as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.BiometricProcessingConsentDto

201Created — Essence.Consent.Core.Contracts.DTOs.BiometricProcessingConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consents/biometric-processing/{consentId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.BiometricProcessingConsentDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consents/biometric-processing/{consentId}/withdraw

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.BiometricProcessingConsentDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

CaptureEscrow

POST/api/v1/captures

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.IssueCaptureRequestDto as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.IssueCaptureResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/captures/consent-requests/bulk

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.BulkCaptureConsentRequestDto as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.BulkCaptureConsentResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/captures/holdings

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.CaptureHoldingsDto

GET/api/v1/captures/notices/{token}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
token	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.CaptureNoticeDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/captures/{captureId}/decision

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
captureId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.CaptureDecisionRequestDto as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.CaptureDecisionResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/captures/{captureId}/erase

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
captureId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.CaptureEraseRequestDto as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/captures/{captureId}/notices/deliver

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
captureId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.DeliverCaptureNoticeResultDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

ChildhoodConsent

GET/api/v1/consent/childhood/{childId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
childId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ChildhoodConsentDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/childhood/{childId}/{consentId}/withdraw

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
childId	path	string (uuid)	yes	—
consentId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeGuardianConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ChildhoodConsentWithdrawResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/guardian-granted/{childId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
childId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.GuardianGrantedConsentDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/guardian-granted/{childId}/{consentId}/decision

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
childId	path	string (uuid)	yes	—
consentId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.DecideGuardianGrantedConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.GuardianGrantedConsentDecisionResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ChildRecordConsent

GET/api/v1/consent/child-records/approvals/{approvalId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
approvalId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CoParentApprovalDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/child-records/approvals/{approvalId}/decision

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
approvalId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.DecideCoParentApprovalRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CoParentApprovalDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/child-records/approvals/{approvalId}/undo

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
approvalId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CoParentApprovalDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/child-records/releases

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RequestChildRecordReleaseRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.ChildRecordReleaseDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

402Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/children/{childId}/consent-register

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
childId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ChildConsentRegisterDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/children/{childId}/consent-register/pdf

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
childId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

ClosureConsent

GET/api/v1/account/closure/{closureId}/report

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
closureId	path	string (uuid)	yes	—
X-Api-Version	header	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Handover.ClosureHandoverReportDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/closure/{closureId}/link-states

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
closureId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Handover.ClosureLinkStateDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/closure/{closureId}/report

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
closureId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Handover.ClosureHandoverReportDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ClosureTransferConsent

GET/api/v1/account/closure/{closureId}/handover-contacts/{linkId}/transfer-consent

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
closureId	path	string (uuid)	yes	—
linkId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ClosureTransferConsentDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/account/closure/{closureId}/handover-contacts/{linkId}/transfer-consent

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
closureId	path	string (uuid)	yes	—
linkId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordClosureTransferConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ClosureTransferConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/account/closure/{closureId}/transfer-consents

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
closureId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ClosureTransferConsentListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/closure-transfer-asks

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ClosureTransferAskListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/closure-transfer-asks/{id}/answer

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.AnswerClosureTransferAskRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ClosureTransferAskDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

CollectiveDecisions

POST/api/v1/consent/collective-decisions

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.OpenCollectiveDecisionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CollectiveDecisionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/collective-decisions/capabilities

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CollectiveDecisionCapabilitiesDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/collective-decisions/{decisionId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
decisionId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CollectiveDecisionDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/collective-decisions/{decisionId}/grants

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
decisionId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CollectiveAcceptanceListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/collective-decisions/{decisionId}/grants

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
decisionId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.GrantCollectiveAcceptanceRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.CollectiveAcceptanceDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/collective-decisions/{decisionId}/grants/{grantId}/withdraw

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
decisionId	path	string (uuid)	yes	—
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.WithdrawCollectiveAcceptanceRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CollectiveAcceptanceDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

CommunicationsConsent

GET/api/v1/consent/communications

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.CommunicationsConsentStateDto

PUT/api/v1/consent/communications

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.UpdateCommunicationsConsentRequestDto as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.CommunicationsConsentStateDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

Compliance

GET/api/v1/Compliance/snapshots/consent/{consentId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ComplianceSnapshotDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/Compliance/snapshots/my

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ComplianceSnapshotDto[]

GET/api/v1/Compliance/snapshots/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ComplianceSnapshotDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/Compliance/snapshots/{id}/retention

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — unspecified

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ComplianceReporting

GET/api/v1/compliance/reporting/audit-trail

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
startDate	query	string (date-time)	no	—
endDate	query	string (date-time)	no	—
grantorId	query	string (uuid)	no	—
granteeId	query	string (uuid)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ComplianceReportDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/compliance/reporting/gdpr/validate/{grantorId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantorId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — unspecified

POST/api/v1/compliance/reporting/generate

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Queries.ConsentHistory.GenerateComplianceReportQuery as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ComplianceReportDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/compliance/reporting/grantor/{grantorId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantorId	path	string (uuid)	yes	—
startDate	query	string (date-time)	no	—
endDate	query	string (date-time)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ComplianceReportDto

GET/api/v1/compliance/reporting/my-summary

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
startDate	query	string (date-time)	no	—
endDate	query	string (date-time)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ComplianceReportDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/compliance/reporting/statistics

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantorId	query	string (uuid)	no	—
days	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ComplianceStatisticsDto

GET/api/v1/compliance/reporting/violations

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
startDate	query	string (date-time)	no	—
endDate	query	string (date-time)	no	—
severity	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ComplianceViolationDto[]

GET/api/v1/compliance/reporting/{reportId}/export

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
reportId	path	string (uuid)	yes	—
grantorId	query	string (uuid)	no	—
startDate	query	string (date-time)	no	—
endDate	query	string (date-time)	no	—
granteeId	query	string (uuid)	no	—
format	query	string	no	—

Request body

No request body.

Responses

200Success

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

ConnectionConsent

GET/api/v1/consent/connection-consents

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Connection.ConnectionConsentAcceptanceDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/connection-consents/accept

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.Connection.AcceptConnectionConsentCommand as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.Connection.ConnectionConsentAcceptanceDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/connection-consents/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Connection.ConnectionConsentAcceptanceDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/connection-consents/{id}/receipt

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Connection.ConsentReceiptDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/connection-consents/{id}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RevokeConnectionConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Connection.ConnectionConsentAcceptanceDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

Connections

GET/api/v1/connections/{id}/sync-transparency

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Connection.ConnectionSyncTransparencyDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

Consent

GET/api/v1/Consent

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
documentId	query	string (uuid)	no	—
cursor	query	string	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Contracts.DTOs.ConsentGrantDto

POST/api/v1/Consent

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.GrantConsentRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.GrantConsentResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

423Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/Consent/check/{documentId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
documentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — boolean

POST/api/v1/Consent/credential-impact

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.CredentialConsentImpactRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CredentialConsentImpactDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/Consent/document/{documentId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
documentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentGrantDto[]

POST/api/v1/Consent/grant

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.GrantConsentRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.GrantConsentResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

423Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/Consent/granted

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
documentId	query	string (uuid)	no	—
cursor	query	string	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Contracts.DTOs.ConsentGrantDto

GET/api/v1/Consent/granted-to-me

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
documentId	query	string (uuid)	no	—
cursor	query	string	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Contracts.DTOs.ConsentGrantDto

GET/api/v1/Consent/granted-to-my-org

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
documentId	query	string (uuid)	no	—
cursor	query	string	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Contracts.DTOs.ConsentGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Consent/{consentId}/legal-hold/{holdId}/request-release

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—
holdId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RequestLegalHoldReleaseRequest as application/*+json, application/json, text/json

Responses

202Accepted

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/Consent/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentGrantDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/Consent/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.UpdateConsentRequest as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

DELETE/api/v1/Consent/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeConsentRequest as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

423Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

PATCH/api/v1/Consent/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
Idempotency-Key	header	string	no	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.UpdateConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentModifiedResponse

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Consent/{id}/access

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Consent/{id}/approval-challenge

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ApprovalChallengeResponse

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Consent/{id}/approve

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ApproveConsentRequest as application/*+json, application/json, text/json

Responses

204No Content

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/Consent/{id}/credential-descriptor

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.PublishCredentialDescriptorRequest as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Consent/{id}/deny

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.DenyConsentRequest as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Consent/{id}/reactivate

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ReactivateConsentRequest as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/Consent/{id}/receipt

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentReceiptDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/Consent/{id}/shared-credential

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.DeclareSharedCredentialRequest as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/Consent/{id}/sharing-key

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentSharingKeyDto

402Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/Consent/{id}/sharing-key

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RewrapSharingKeyRequest as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Consent/{id}/suspend

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.SuspendConsentRequest as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentAccessRequests

GET/api/v1/consent/access-requests/pending

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentAccessRequestDto[]

GET/api/v1/consent/{id}/access-requests

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentAccessRequestDto[]

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/{id}/access-requests/{requestId}/approve

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
requestId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentAccessRequestDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/{id}/access-requests/{requestId}/deny

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
requestId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.DenyConsentAccessRequestRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentAccessRequestDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentBundle

GET/api/v1/consent-bundles

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
purpose	query	Essence.Consent.Core.Domain.Enums.ConsentPurpose	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleDto[]

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

POST/api/v1/consent-bundles

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.Bundle.CreateConsentBundleCommand as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent-bundles/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent-bundles/{id}/accept

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent-bundles/{id}/items/{documentId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
documentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent-bundles/{id}/reject

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RejectConsentBundleRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent-bundles/{id}/revoke-all

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RevokeConsentBundleRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent-bundles/{id}/submit

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent-bundles/{id}/subscription

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Bundle.BundleSubscriptionStatusDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent-bundles/{id}/subscription

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.Bundle.AttachBundleSubscriptionCommand as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent-bundles/{id}/subscription/sync

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
Idempotency-Key	header	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Bundle.BundleSubscriptionStatusDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent-bundles/{id}/terminate-on-event

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.TerminateConsentBundleOnEventRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentChangeRequest

POST/api/v1/consent/change-requests

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RequestConsentChangeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ChangeRequest.ConsentChangeRequestDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/change-requests/for-grant/{consentGrantId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentGrantId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ChangeRequest.ConsentChangeRequestDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/change-requests/pending

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ChangeRequest.ConsentChangeRequestDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/change-requests/{id}/apply

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.ResolveConsentChangeRequestRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ChangeRequest.ConsentChangeRequestDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/change-requests/{id}/dismiss

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.ResolveConsentChangeRequestRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ChangeRequest.ConsentChangeRequestDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentCompliance

GET/api/v1/consent/{id}/compliance-snapshot

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ComplianceSnapshotDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/{id}/compliance-snapshot

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

201Created — unspecified

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentDelegation

GET/api/v1/consent/delegations

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
asDelegate	query	boolean	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/delegations

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.CreateDelegationRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.DelegationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/delegations/bulk

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.BulkCreateDelegationsRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.DelegationDto[]

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/delegations/candidates

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationCandidateDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/delegations/collections

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationCollectionDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/delegations/templates

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationTemplateDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/delegations/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/delegations/{id}/actions

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationActionDto[]

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/delegations/{id}/actions

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordDelegationActionRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.DelegationActionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/delegations/{id}/reconfirm

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ReconfirmDelegationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/delegations/{id}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeDelegationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationClosureRecordDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PATCH/api/v1/consent/delegations/{id}/scope

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.UpdateDelegationScopeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentDelegationValidation

POST/api/v1/consents/validate-delegation

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ValidateDelegationGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationValidationResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentHistory

POST/api/v1/consent-history/bulk-revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.ConsentHistory.BulkRevokeConsentsCommand as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.Commands.ConsentHistory.BulkRevocationResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent-history/grantor/{grantorId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantorId	path	string (uuid)	yes	—
startDate	query	string (date-time)	no	—
endDate	query	string (date-time)	no	—
cursor	query	string	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Application.DTOs.ConsentHistoryDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent-history/my-consents

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
startDate	query	string (date-time)	no	—
endDate	query	string (date-time)	no	—
cursor	query	string	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Application.DTOs.ConsentHistoryDto

GET/api/v1/consent-history/statistics

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ConsentHistoryStatisticsDto

GET/api/v1/consent-history/{consentId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ConsentHistoryDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent-history/{consentId}/as-at

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—
asAtUtc	query	string (date-time)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ConsentStateAsAtDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent-history/{consentId}/export

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—
format	query	string	no	—

Request body

No request body.

Responses

200Success

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentInjectionValidation

POST/api/v1/consents/validate-care-link

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ValidateCareLinkRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CareLinkValidationResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consents/validate-injection

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ValidateInjectionConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.InjectionConsentValidationResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentMerge

GET/api/v1/consent-remaps

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
limit	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Merge.ConsentMergePlan[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent-remaps/{mergeSessionId}/summary

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
mergeSessionId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Merge.ConsentMergePlan

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/merge/{mergeSessionId}/plan

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
mergeSessionId	path	string (uuid)	yes	—
retiredAccountId	query	string (uuid)	no	—
survivingAccountId	query	string (uuid)	no	—
mode	query	Essence.Consent.Core.Domain.Merge.MergeRepointMode	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Merge.ConsentMergePlan

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentNotice

GET/api/v1/consent/notices/locale-assessment

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
reserveAuditRef	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.MyLocaleAssessmentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/notices/locale-posture

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ReServePostureDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/notices/outstanding-reaffirmations

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentNoticeReServeDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/notices/{id}/reaffirm

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentNoticeReServeDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentOrgAdmin

GET/api/v1/consent/org/bulk-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
documentId	query	string (uuid)	no	—
cursor	query	string	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Contracts.DTOs.ConsentGrantDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/org/escrow-queue

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
cursor	query	string	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/org/invitation-ttl

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.OrgAdmin.OrgInvitationTtlDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/consent/org/invitation-ttl

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.UpdateOrgInvitationTtlRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.OrgAdmin.OrgInvitationTtlDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/org/oversight

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.OrgAdmin.OrgOversightSummaryDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentPermissions

GET/api/v1/consent/{id}/permissions

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Queries.Permissions.ConsentPermissionDto[]

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/{id}/permissions

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.AddPermissionRequest as application/*+json, application/json, text/json

Responses

201Created — unspecified

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

DELETE/api/v1/consent/{id}/permissions/{permId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
permId	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentPolicyTemplate

GET/api/v1/consent/policy-templates

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.PolicyTemplate.ConsentPolicyTemplateDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/policy-templates

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.PublishConsentPolicyTemplateRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.PolicyTemplate.ConsentPolicyTemplateDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/policy-templates/org

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.PolicyTemplate.ConsentPolicyTemplateDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentRenewal

POST/api/v1/consent/renewal

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RepointConsentsForRenewalRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.Commands.Renewal.RenewalRepointResult

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/renewal/preview

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
previousDocumentId	query	string (uuid)	no	—
replacementDocumentId	query	string (uuid)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Commands.Renewal.RenewalRepointResult

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentSharedContent

PUT/api/v1/consent/{id}/shared-content

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ResealSharedContentRequest as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

ConsentValidation

POST/api/v1/consent/validate

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ValidateConsentGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentGrantValidationResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consents/validate

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ValidateConsentGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentGrantValidationResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

ContactCardBoundarySnapshot

GET/api/v1/contact-cards/{cardId}/boundary-snapshot

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
cardId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.BoundarySnapshotDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/contact-cards/{cardId}/majority-transfer/boundary-snapshot

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
cardId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.BoundarySnapshotDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ContactChangeImpact

GET/api/v1/consent/affected-by-contact-change/{changeId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
changeId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ContactChangeImpactDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

CounterpartyChanges

GET/api/v1/consents/counterparty-changes

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Queries.CounterpartyChanges.CounterpartyChangeDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

503Server Error — Microsoft.AspNetCore.Mvc.ProblemDetails

CourtConferredAuthority

GET/api/v1/consent/court-conferred-authorities

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
includeEnded	query	boolean	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtConferredAuthorityDto[]

POST/api/v1/consent/court-conferred-authorities

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.IngestCourtOrderRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtConferredAuthorityDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/court-conferred-authorities/access-decisions

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.CourtAuthorityAccessDecisionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtAuthorityAccessDecisionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/court-conferred-authorities/wards/{wardId}/capacity-determinations

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
wardId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordCapacityDeterminationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.CourtAuthority.DeputyshipTerminationOutcomeDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/court-conferred-authorities/wards/{wardId}/termination-notice

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
wardId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.CourtAuthority.DeputyshipTerminationNoticeDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/court-conferred-authorities/{authorityId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
authorityId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtConferredAuthorityDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/court-conferred-authorities/{authorityId}/activate

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
authorityId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtConferredAuthorityDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/court-conferred-authorities/{authorityId}/end

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
authorityId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.EndCourtAuthorityRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtConferredAuthorityDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/court-conferred-authorities/{authorityId}/suspend

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
authorityId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtConferredAuthorityDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/court-conferred-authorities/{authorityId}/variations

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
authorityId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordCourtAuthorityVariationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtConferredAuthorityDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

CrossBorderConsentGrant

GET/api/v1/consent/cross-border/grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.CrossBorder.CrossBorderConsentGrantDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/cross-border/grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordCrossBorderConsentGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.CrossBorder.CrossBorderConsentGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/cross-border/grants/adequacy

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantorRegion	query	Essence.Consent.Core.Domain.Enums.DataResidencyRegion	no	—
recipientRegion	query	Essence.Consent.Core.Domain.Enums.DataResidencyRegion	no	—
mechanism	query	Essence.Consent.Core.Domain.Enums.TransferMechanism	no	—
complianceFramework	query	Essence.Consent.Core.Domain.Enums.ComplianceFramework	no	—
justification	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.CrossBorder.JurisdictionTransferDecisionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/cross-border/grants/legal-basis

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
recipientClass	query	string	no	—
subjectStanding	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.CrossBorder.RecipientLegalBasisDto[]

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

CrossInstanceConsent

POST/api/v1/cross-instance-consent/request

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.CrossInstance.RequestConsentMirrorCommand as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.CrossInstance.CrossInstanceConsentMirrorDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/cross-instance-consent/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.CrossInstance.CrossInstanceConsentMirrorDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/cross-instance-consent/{id}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RequestCrossInstanceRevocationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.CrossInstance.CrossInstanceConsentMirrorDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

CustodianGrants

GET/api/v1/consent/custodian-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
subjectRef	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CustodianGrantListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/custodian-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ProvisionCustodianGrantRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.CustodianGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/custodian-grants/{grantId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CustodianGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/custodian-grants/{grantId}/extend

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ExtendCustodianGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CustodianGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/custodian-grants/{grantId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeCustodianGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CustodianGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

DeceasedConsentTeardown

POST/api/v1/consent/deceased-teardown

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.DeceasedConsentTeardownRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Api.Controllers.DeceasedConsentTeardownResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

DelegatedCapabilities

GET/api/v1/consent/capabilities

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
delegateRef	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegatedCapabilityDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/capabilities

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.IssueDelegatedCapabilityRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.DelegatedCapabilityDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

503Server Error

GET/api/v1/consent/capabilities/issued-to-me

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.AgentCapabilityReferenceDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/capabilities/jwks

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success

POST/api/v1/consent/capabilities/revoke-for-agent

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeCapabilitiesForAgentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.AgentCapabilityRevocationResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

429Too Many Requests — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/capabilities/status-list

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CapabilityStatusListDto

503Server Error

GET/api/v1/consent/capabilities/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegatedCapabilityDetailDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/capabilities/{id}/children

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
Capability-Proof	header	string	no	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.IssueChildCapabilityRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.DelegatedCapabilityDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/capabilities/{id}/presentation

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
Capability-Proof	header	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CapabilityPresentationDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/capabilities/{id}/redemptions

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
Idempotency-Key	header	string	no	—
Capability-Proof	header	string	no	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RedeemCapabilityRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CapabilityRedemptionDto

201Created — Essence.Consent.Core.Contracts.DTOs.CapabilityRedemptionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/capabilities/{id}/redemptions/{redemptionId}/exercise

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
redemptionId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ExerciseCapabilityRedemptionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CapabilityRedemptionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/capabilities/{id}/redemptions/{redemptionId}/release

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
redemptionId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ReleaseCapabilityRedemptionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.CapabilityRedemptionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/capabilities/{id}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeDelegatedCapabilityRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RevokeDelegatedCapabilityResultDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

DelegationBulkRevocations

GET/api/v1/consent/delegations/bulk-revocations

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationBulkRevocationDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/delegations/bulk-revocations/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationBulkRevocationDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/delegations/bulk-revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.BulkRevokeDelegationsRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DelegationBulkRevocationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

DevicePrincipal

GET/api/v1/consent/principals/{principalId}/grant-count

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
principalId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.PrincipalGrantCountDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

DisclosureRecipients

GET/api/v1/consent/disclosure-recipients

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
subjectId	query	string (uuid)	no	—
recordId	query	string	no	—
fieldKey	query	string	no	—
scopes	query	string[]	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Queries.DisclosureRecipients.DisclosureRecipientsResult

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

DocumentRequest

POST/api/v1/consent/document-requests

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.CreateDocumentRequestRequestDto as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.CreateDocumentRequestResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/document-requests/inbound

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.DocumentRequestInboundDto[]

GET/api/v1/consent/document-requests/inbound/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.DocumentRequestInboundDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/document-requests/inbound/{id}/approve

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.ApproveDocumentRequestRequestDto as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ApproveDocumentRequestResultDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/document-requests/inbound/{id}/decline

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.DocumentRequestContactDecisionResultDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/document-requests/outbound

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.DocumentRequestOutboundDto[]

GET/api/v1/consent/document-requests/{id}/audit

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.DocumentRequestAuditRecordDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

DonorDisclosurePreferences

POST/api/v1/orgs/{organizationId}/donor-disclosure-preferences

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordDonorDisclosurePreferenceRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.DonorDisclosurePreferenceDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/orgs/{organizationId}/donor-disclosure-preferences/{donorRef}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
donorRef	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DonorDisclosurePreferenceDto[]

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

DonorRegisterCases

GET/api/v1/orgs/{organizationId}/donor-register/cases

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DonorCaseSummaryDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/orgs/{organizationId}/donor-register/cases

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.LodgeDonorRegisterCaseRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.DonorCaseSummaryDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/orgs/{organizationId}/donor-register/cases/{caseId}/assignment

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
caseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.AssignDonorRegisterCaseRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DonorCaseSummaryDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/orgs/{organizationId}/donor-register/cases/{caseId}/determination

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
caseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordDonorDeterminationRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.SignedDonorDeterminationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

DriverCredentialStatusShares

GET/api/v1/consent/driver-credential-status/shares

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	query	string (uuid)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DriverCredentialStatusShareDto[]

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/driver-credential-status/shares

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.CreateDriverCredentialStatusShareRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.DriverCredentialStatusShareDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

DELETE/api/v1/consent/driver-credential-status/shares/{shareId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
shareId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DriverCredentialStatusShareDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

EmergencyAccess

GET/api/v1/consent/emergency-access

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
activeOnly	query	boolean	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Commands.EmergencyAccess.EmergencyAccessAuthorizationDto[]

POST/api/v1/consent/emergency-access

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.AuthorizeEmergencyAccessRequestDto as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.Commands.EmergencyAccess.EmergencyAccessAuthorizationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/emergency-access/{id}/proof-of-life

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Commands.EmergencyAccess.EmergencyAccessAuthorizationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/emergency-access/{id}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Commands.EmergencyAccess.EmergencyAccessAuthorizationDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

Erasure

GET/api/v1/erasure-probe/{subjectId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
subjectId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success

EstateDisclosure

GET/api/v1/estate-disclosures

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
claimRef	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.EstateDisclosure.EstateDisclosureBasisDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/estate-disclosures/basis

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordEstateDisclosureBasisRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.EstateDisclosure.EstateDisclosureBasisDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/estate-disclosures/{demandRef}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
demandRef	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.EstateDisclosure.EstateDisclosureBasisDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/estate-disclosures/{demandRef}/scope-audit

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
demandRef	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordEstateDisclosureScopeAuditRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.EstateDisclosure.EstateDisclosureScopeAuditDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

EstateRelease

GET/api/v1/estate/release/bequest

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ExecutorBequestDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/estate/release/consent

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.PreAuthoriseReleaseOnDeathConsentRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.ReleaseOnDeathConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/estate/release/consent/mine

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.DeferredGrantRegisterDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/estate/release/consent/{consentId}/items/{itemId}/reveal

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—
itemId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ReleaseOnDeathConsentDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/estate/release/consent/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ReleaseOnDeathConsentDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/estate/release/consent/{id}/activation-snapshot

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ActivationComplianceSnapshotDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/estate/release/consent/{id}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeReleaseOnDeathConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ReleaseOnDeathConsentDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/estate/release/org-executor/appointments

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ExecutorAppointmentCaseloadDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/estate/release/org-executor/caseload

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrgExecutorCaseloadDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/estate/release/org-executor/cases/{consentId}/officer

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.AssignExecutorOfficerRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ReleaseOnDeathConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/estate/release/org-executor/cases/{consentId}/officer-attribution

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OfficerAttributionExportDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/estate/release/org-executor/cases/{consentId}/officer/handover

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.HandoverExecutorOfficerRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ReleaseOnDeathConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/estate/release/org-executor/cases/{consentId}/officer/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeExecutorOfficerRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ReleaseOnDeathConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ExternalDisclosure

GET/api/v1/consent/external-disclosures

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ExternalDisclosure.ExternalDisclosureDto[]

POST/api/v1/consent/external-disclosures

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordExternalDisclosureRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.ExternalDisclosure.ExternalDisclosureDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

GET/api/v1/consent/external-disclosures/{disclosureId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
disclosureId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ExternalDisclosure.ExternalDisclosureDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/external-disclosures/{disclosureId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
disclosureId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RevokeExternalDisclosureRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ExternalDisclosure.ExternalDisclosureDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ExternalDisclosureShares

GET/api/v1/consent/external-disclosures/shared/{shareRef}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
shareRef	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ExternalDisclosure.SharedExternalDisclosureDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

FieldVisibility

POST/api/v1/consent/field-visibility/blast-radius

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.BulkVisibilityChangeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Propagation.BlastRadiusPreviewDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/field-visibility/bulk

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.BulkVisibilityChangeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Propagation.BlastRadiusPreviewDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

FitToFlyClearance

GET/api/v1/consent/fit-to-fly/desk/overview

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyDeskQueueItemDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/fit-to-fly/desk/queue

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
carrier	query	string	no	—
flightNumber	query	string	no	—
departureDate	query	string (date)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyDeskQueueItemDto[]

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/fit-to-fly/desk/shares/{shareId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
shareId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyDeskQueueItemDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/fit-to-fly/desk/shares/{shareId}/decision

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
shareId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordFitToFlyDecisionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyDeskQueueItemDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/fit-to-fly/desk/shares/{shareId}/non-retention

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
shareId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.DeskActorRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyDeskQueueItemDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/fit-to-fly/desk/shares/{shareId}/open

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
shareId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.DeskActorRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyDisclosureDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/fit-to-fly/shares

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyShareDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/fit-to-fly/shares

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.ShareFitToFlyClearanceRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyShareDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/fit-to-fly/shares/{shareId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
shareId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyShareDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/fit-to-fly/shares/{shareId}/withdraw

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
shareId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.WithdrawFitToFlyShareRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyShareDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GranteeRosters

GET/api/v1/consent/grantee-rosters

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.GranteeRosterListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/grantee-rosters

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.OpenGranteeRosterRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.GranteeRosterDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/grantee-rosters/{rosterId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
rosterId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.GranteeRosterDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/grantee-rosters/{rosterId}/close

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
rosterId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.GranteeRosterDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/grantee-rosters/{rosterId}/members

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
rosterId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.AddGranteeRosterMemberRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.GranteeRosterDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

DELETE/api/v1/consent/grantee-rosters/{rosterId}/members/{userId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
rosterId	path	string (uuid)	yes	—
userId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.GranteeRosterDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/{consentId}/accesses

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentAccessReportDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/consent/{consentId}/grantee-roster

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RouteConsentToGranteeRosterRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ConsentRosterRoutingDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GuardianConsent

POST/api/v1/consent/guardian-grant

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.GrantGuardianConsentRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.GuardianConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/guardian-grant/{childId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
childId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.GuardianConsentDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/guardian-grant/{id}/majority-reconsent

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.MajorityReconsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.GuardianConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/guardian-grant/{id}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeGuardianConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.GuardianConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

HolderUnderstanding

GET/api/v1/consent/holder-understanding

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.HolderUnderstandingStatusDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/holder-understanding/answers

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordHolderAnswerRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.HolderUnderstandingStatusDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/holder-understanding/withdraw

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.WithdrawHolderUnderstandingRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.HolderUnderstandingStatusDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

HouseholdAddressBook

GET/api/v1/household/address-book/{householdId}/consent-log

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
householdId	path	string	yes	—
offset	query	integer (int32)	no	—
limit	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.HouseholdConsentLogDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/household/address-book/{householdId}/consent-log/export

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
householdId	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.IntraHouseholdConsentRecordDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/household/address-book/{householdId}/members/{memberRef}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
householdId	path	string	yes	—
memberRef	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeHouseholdMemberRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.HouseholdMemberRevocationResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/household/address-book/{householdId}/members/{memberRef}/visibility

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
householdId	path	string	yes	—
memberRef	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.SetFieldVisibilityRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.FieldVisibilityGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/household/address-book/{householdId}/visibility

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
householdId	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.FieldVisibilityGrantDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

HouseholdDepartureRevocations

POST/api/v1/household/address-book/{householdId}/members/{memberRef}/departure-revocations

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
householdId	path	string	yes	—
memberRef	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeDepartingHouseholdMemberRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.HouseholdMemberRevocationResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

HouseholdShare

POST/api/v1/family/households/{householdId}/shares

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
householdId	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.CompleteHouseholdShareRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.HouseholdShare.HouseholdShareResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/family/households/{householdId}/shares/preview

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
householdId	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.PreviewHouseholdShareRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.HouseholdShare.HouseholdSharePreviewDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/family/households/{householdId}/shares/{documentId}/subject-consent

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
householdId	path	string	yes	—
documentId	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.SubjectConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.HouseholdShare.HouseholdSharePreviewDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ImportClassification

GET/api/v1/consent/imports/{importId}/classification

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
importId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ImportClassificationLedgerDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/imports/{importId}/classification

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
importId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ClassifyImportContactRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.ImportContactClassificationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/imports/{importId}/classification/{contactId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
importId	path	string (uuid)	yes	—
contactId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeImportContactClassificationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ImportContactClassificationDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

InFlightAction

POST/api/v1/consent/in-flight-actions

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.InFlightActions.PersistInFlightActionCommand as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.InFlightActions.PersistInFlightActionResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/in-flight-actions/{resumeToken}/resume

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
resumeToken	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.ResumeInFlightActionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.InFlightActions.ResumeInFlightActionResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

LawfulCompulsion

GET/api/v1/lawful-compulsion/bases

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
subjectRef	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.LawfulCompulsion.LawfulCompulsionBasisDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/lawful-compulsion/bases

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordLawfulCompulsionBasisRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.LawfulCompulsion.LawfulCompulsionBasisDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/lawful-compulsion/bases/{instrumentReference}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
instrumentReference	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.LawfulCompulsion.LawfulCompulsionBasisDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/lawful-compulsion/bases/{instrumentReference}/access-decisions

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
instrumentReference	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.DecideLawfulCompulsionAccessRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.LawfulCompulsion.LawfulCompulsionAccessDecisionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/lawful-compulsion/bases/{instrumentReference}/withdrawal

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
instrumentReference	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.WithdrawLawfulCompulsionBasisRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.LawfulCompulsion.LawfulCompulsionBasisDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

LegalHoldReleaseRequests

GET/api/v1/legal-hold-release-requests

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
holdId	query	string (uuid)	no	—
owner	query	string	no	—
maxResults	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.LegalHold.LegalHoldReleaseRequestDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

LegalNameChangeDisclosure

POST/api/v1/consent/name-change/{changeId}/disclose

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
changeId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.DiscloseNameChangeRequestDto as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.Commands.LegalNameChange.DisclosureResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/name-change/{changeId}/disclosure-targets

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
changeId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Queries.LegalNameChange.DisclosureTargetDto[]

GET/api/v1/consent/name-change/{changeId}/summary

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
changeId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Queries.LegalNameChange.CloseoutSummaryDto

LegalNameChangeIntake

GET/api/v1/consent/org/{orgId}/name-change/policy

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Commands.LegalNameChange.NameChangeIntakePolicyDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/consent/org/{orgId}/name-change/policy

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.NameChangeIntakePolicyRequestDto as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.Commands.LegalNameChange.NameChangeIntakePolicyDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/org/{orgId}/name-change/queue

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—
all	query	boolean	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Queries.LegalNameChange.IntakeQueueMemberDto[]

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/org/{orgId}/name-change/queue/bulk

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—
itemId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.BulkProcessIntakeRequestDto as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.Queries.LegalNameChange.DeedPollEvidenceAccessDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/org/{orgId}/name-change/queue/{itemId}/evidence

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—
itemId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.BulkProcessIntakeRequestDto as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.Queries.LegalNameChange.DeedPollEvidenceAccessDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

MinorConfidentialConsent

POST/api/v1/consent/minor-confidential

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordMinorConfidentialConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.MinorConfidentialConsentConfirmationDto

201Created — Essence.Consent.Core.Contracts.DTOs.MinorConfidentialConsentConfirmationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

503Server Error — Microsoft.AspNetCore.Mvc.ProblemDetails

ModuleSwitchConsentRescope

GET/api/v1/orgs/{organizationId}/module-switches/{switchId}/consent-rescope

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
switchId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ModuleSwitchEnvelopeOfEssence.Consent.Core.Contracts.DTOs.ModuleSwitchConsentRescopeDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/orgs/{organizationId}/module-switches/{switchId}/consent-rescope

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
switchId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.FrameModuleSwitchConsentRescopeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ModuleSwitchEnvelopeOfEssence.Consent.Core.Contracts.DTOs.ModuleSwitchConsentRescopeDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/orgs/{organizationId}/module-switches/{switchId}/consent-rescope

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
switchId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ApplyModuleSwitchConsentRescopeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ModuleSwitchEnvelopeOfEssence.Consent.Core.Contracts.DTOs.ModuleSwitchConsentRescopeDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

MultiGranteeConsent

GET/api/v1/consents/grants/multi-grantee

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.MultiGrantee.MultiGranteeGrantDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consents/grants/multi-grantee

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.MultiGrantee.CreateMultiGranteeGrantRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.MultiGrantee.MultiGranteeGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consents/grants/multi-grantee/{grantId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.MultiGrantee.MultiGranteeGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

DELETE/api/v1/consents/grants/multi-grantee/{grantId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.MultiGrantee.RevokeMultiGranteeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.MultiGrantee.MultiGranteeGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consents/grants/multi-grantee/{grantId}/authorize-field

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.MultiGrantee.AuthorizeGranteeFieldRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.MultiGrantee.GranteeAccessDecisionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

DELETE/api/v1/consents/grants/multi-grantee/{grantId}/grantees/{granteeId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—
granteeId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.MultiGrantee.RevokeMultiGranteeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.MultiGrantee.MultiGranteeGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consents/grants/{grantId}/disclosure-report

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Domain.Entities.MultiGrantee.MultiGranteeDisclosureReport

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

MutualDisclosureExchange

POST/api/v1/consent/mutual-disclosures

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.MutualDisclosure.OpenMutualDisclosureExchangeCommand as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.MutualDisclosure.MutualDisclosureExchangeDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/mutual-disclosures/by-matter/{matterId}/reciprocity-status

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
matterId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.MutualDisclosure.ReciprocityStatusDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/mutual-disclosures/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.MutualDisclosure.MutualDisclosureExchangeDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/mutual-disclosures/{id}/disclose

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.DisclosePartnerScheduleRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.MutualDisclosure.MutualDisclosureExchangeDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/mutual-disclosures/{id}/reciprocity-status

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.MutualDisclosure.ReciprocityStatusDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/mutual-disclosures/{id}/record-execution

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.MutualDisclosure.MutualDisclosureExchangeDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/mutual-disclosures/{id}/revoke-visibility

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RevokeDisclosureVisibilityRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.MutualDisclosure.MutualDisclosureExchangeDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

NameChangeDecisionExports

GET/api/v1/consent/org/{orgId}/name-change/decisions/exports

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Queries.LegalNameChange.NameChangeDecisionExportSummaryDto[]

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/org/{orgId}/name-change/decisions/exports

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—

Request body

No request body.

Responses

201Created — Essence.Consent.Core.Application.Queries.LegalNameChange.NameChangeDecisionExportDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/org/{orgId}/name-change/decisions/exports/{exportId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—
exportId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Queries.LegalNameChange.NameChangeDecisionExportDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/org/{orgId}/name-change/decisions/exports/{exportId}/csv

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—
exportId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — string

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

OrgActOnBehalfGrants

GET/api/v1/consent/org-act-on-behalf-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
side	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfGrantListDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/org-act-on-behalf-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.CreateOrgActOnBehalfGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfGrantResultDto

201Created — Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfGrantResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/org-act-on-behalf-grants/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/org-act-on-behalf-grants/{id}/accept

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfGrantResultDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/org-act-on-behalf-grants/{id}/authorization

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
purpose	query	string	no	—
capability	query	string	no	—
at	query	string (date-time)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfAuthorizationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/org-act-on-behalf-grants/{id}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeOrgActOnBehalfGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfGrantResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

OrganisationDisclosureGrants

GET/api/v1/consent/organisation-disclosure-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureGrantListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/organisation-disclosure-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.IssueOrganisationDisclosureGrantRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/organisation-disclosure-grants/capabilities

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureGrantCapabilitiesDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/organisation-disclosure-grants/{grantId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/organisation-disclosure-grants/{grantId}/access-events

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—
since	query	string (date-time)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureAccessEventListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/organisation-disclosure-grants/{grantId}/access-events

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordOrganisationDisclosureAccessRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureAccessEventDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/organisation-disclosure-grants/{grantId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeOrganisationDisclosureGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

OrganisationPrincipalGrants

GET/api/v1/consent/organisation-principal-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
cursor	query	string	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Contracts.DTOs.OrganisationGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/organisation-principal-grants/{id}/steward

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ReassignOrganisationGrantStewardRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrganisationGrantStewardReassignedDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

OrgNoticeLocalePolicy

GET/api/v1/orgs/{orgId}/locale-policy

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrgNoticeLocalePolicyDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/orgs/{orgId}/locale-policy

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.UpsertOrgNoticeLocalePolicyRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrgNoticeLocalePolicyDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/orgs/{orgId}/notice-cohorts

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.NoticeCohortsDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/orgs/{orgId}/notice-cohorts/{locale}/re-serve

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—
locale	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.BulkReServeResultDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/orgs/{orgId}/notice-locale-policy

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrgNoticeLocalePolicyDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/orgs/{orgId}/notice-locale-policy

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
orgId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.UpsertOrgNoticeLocalePolicyRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OrgNoticeLocalePolicyDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

OriginRecordsCases

GET/api/v1/orgs/{organizationId}/origin-records/capabilities

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OriginRecordsCapabilitiesDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/orgs/{organizationId}/origin-records/cases

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.LodgeOriginRecordsCaseRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.OriginRecordsCaseDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/orgs/{organizationId}/origin-records/cases/{caseId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
caseId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OriginRecordsCaseDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/orgs/{organizationId}/origin-records/cases/{caseId}/determination

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
caseId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SignedOriginRecordsDeterminationDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/orgs/{organizationId}/origin-records/cases/{caseId}/determination

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
caseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordOriginRecordsDeterminationRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.SignedOriginRecordsDeterminationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

OriginRecordsQueue

GET/api/v1/orgs/{organizationId}/origin-records/cases

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OriginRecordsCaseSummaryDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/orgs/{organizationId}/origin-records/cases/{caseId}/assignment

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
caseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.AssignOriginRecordsCaseRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OriginRecordsCaseSummaryDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

OriginRecordsRequests

GET/api/v1/origin-records/requests

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OriginRecordsApplicationViewDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/origin-records/requests

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.LodgeOriginRecordsApplicationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OriginRecordsApplicationViewDto

201Created — Essence.Consent.Core.Contracts.DTOs.OriginRecordsApplicationViewDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/origin-records/requests/{caseId}/decision-notification

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
caseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.SetOriginRecordsDecisionNotificationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OriginRecordsApplicationViewDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/origin-records/requests/{caseId}/withdrawal

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
caseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.WithdrawOriginRecordsApplicationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.OriginRecordsApplicationViewDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

ParentAccessConsentScope

POST/api/v{version}/consent/parent-access-scope

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
version	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ParentAccessConsentScopeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ParentAccessConsentScopeResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized

403Forbidden

PredicateAttestation

GET/api/v1/consent/predicate-attestations

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
relyingPartyRef	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.PredicateAttestations.PredicateAttestationDto[]

POST/api/v1/consent/predicate-attestations

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordPredicateAttestationRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.PredicateAttestations.PredicateAttestationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/predicate-attestations/{attestationId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
attestationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.PredicateAttestations.PredicateAttestationDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/predicate-attestations/{attestationId}/compliance-attestation

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
attestationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.PredicateAttestations.PredicateComplianceAttestationDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PresentationDisclosure

GET/api/v1/consent/presentation-disclosures

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
relyingPartyRef	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Presentation.PresentationDisclosureDto[]

POST/api/v1/consent/presentation-disclosures

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordPresentationDisclosureRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.Presentation.PresentationDisclosureDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/presentation-disclosures/{disclosureId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
disclosureId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Presentation.PresentationDisclosureDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/presentation-disclosures/{disclosureId}/acknowledge-revocation

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
disclosureId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.AcknowledgePresentationRevocationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Presentation.PresentationDisclosureDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/presentation-disclosures/{disclosureId}/opened

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
disclosureId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordPresentationDisclosureOpenedRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Presentation.PresentationDisclosureDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/presentation-disclosures/{disclosureId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
disclosureId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Presentation.PresentationDisclosureDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PresentationReceiptKeys

GET/api/v1/consent/presentation-receipts/jwks

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success

PreviousNameDisposition

GET/api/v1/identity/name-change/{changeId}/previous-name-disposition

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
changeId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Commands.VerifiedChange.PreviousNameDispositionResult

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/identity/name-change/{changeId}/previous-name-disposition

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
changeId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.SetPreviousNameDispositionRequestDto as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.Commands.VerifiedChange.PreviousNameDispositionResult

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

ProcessingConsent

GET/api/v1/consent/processing

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
activeOnly	query	boolean	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ProcessingConsentDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/processing

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordProcessingConsentRequestDto as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ProcessingConsentDto

201Created — Essence.Consent.Core.Contracts.DTOs.ProcessingConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/processing/{consentId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ProcessingConsentDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/processing/{consentId}/withdraw

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ProcessingConsentDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ProgrammeGrants

GET/api/v1/consent/programme-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ProgrammeGrantListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/programme-grants/held

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
programmeId	query	string (uuid)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ProgrammeGrantListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/programme-grants/{grantId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ProgrammeGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PropagationAudit

POST/api/v1/consent/propagation-audit

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordPropagationPushRequestDto as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Api.Controllers.RecordPropagationPushResponseDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/propagation-audit/{pushId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
pushId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.PropagationAuditDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/propagation-audit/{pushId}/export

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
pushId	path	string (uuid)	yes	—
format	query	string	no	—

Request body

No request body.

Responses

200Success

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PropagationPolicy

GET/api/v1/consent/propagation-policy

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Propagation.PropagationPolicyDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/consent/propagation-policy

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.SetPropagationPolicyRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Propagation.PropagationPolicyDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

ProtectionCaseProvenance

GET/api/v1/consent/protection-cases/{caseId}/provenance

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
caseId	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ProtectionCaseProvenanceEntryDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/protection-cases/{caseId}/provenance

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
caseId	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.AppendProtectionCaseProvenanceEntryRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.ProtectionCaseProvenanceEntryDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

PseudonymousConsentGrants

GET/api/v1/orgs/{organizationId}/pseudonymous-consent-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
subjectPseudonym	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.PseudonymousConsentGrantDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/orgs/{organizationId}/pseudonymous-consent-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ProvisionPseudonymousConsentGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.PseudonymousConsentGrantDto

201Created — Essence.Consent.Core.Contracts.DTOs.PseudonymousConsentGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/orgs/{organizationId}/pseudonymous-consent-grants/mine

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.PseudonymousConsentGrantDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/orgs/{organizationId}/pseudonymous-consent-grants/revocations

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.BulkRevokePseudonymousConsentGrantsRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.BulkRevokePseudonymousConsentGrantsResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/orgs/{organizationId}/pseudonymous-consent-grants/{grantId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
grantId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.PseudonymousConsentGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/orgs/{organizationId}/pseudonymous-consent-grants/{grantId}/revocation

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokePseudonymousConsentGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.PseudonymousConsentGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

PurposeConsentChecks

POST/api/v1/consent/purpose-checks

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.PurposeConsentCheckRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.PurposeConsentCheckResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

PurposeScopedGrants

GET/api/v1/consent/purpose-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.PurposeScopedGrantListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/purpose-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.GivePurposeScopedGrantRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.PurposeScopedGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/purpose-grants/capabilities

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.PurposeScopedGrantCapabilitiesDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/purpose-grants/{grantId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.PurposeScopedGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/purpose-grants/{grantId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokePurposeScopedGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.PurposeScopedGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

QRCode

POST/api/v1/consents/qr

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.QRCode.GenerateQRCodeCommand as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.Commands.QRCode.GenerateQRCodeResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

503Server Error

GET/api/v1/consents/qr/my

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.QRCodeShareDto[]

POST/api/v1/consents/qr/scan

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.QRCode.ScanQRCodeCommand as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.Commands.QRCode.ScanQRCodeResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consents/qr/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.QRCodeShareDto

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

DELETE/api/v1/consents/qr/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RevokeQRCodeRequest as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consents/qr/{id}/sessions

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.QRCode.StartQRCodeSessionCommand as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.Commands.QRCode.StartQRCodeSessionResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consents/qr/{id}/verify

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.VerifyQRCodeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.Queries.QRCode.QRCodeVerificationResult

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consents/qr/{qrCodeId}/sessions/{sessionId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
qrCodeId	path	string (uuid)	yes	—
sessionId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.QRCodeSessionDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consents/qr/{qrCodeId}/sessions/{sessionId}/complete

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
qrCodeId	path	string (uuid)	yes	—
sessionId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.QRCode.CompleteQRCodeSessionCommand as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

RecipientRedactionPreview

GET/api/v1/consent/recipients/{id}/redaction-preview

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
field	query	string	no	—
documentId	query	string (uuid)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RecipientRedactionPreviewDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

ReciprocalExchange

GET/api/v1/consent/reciprocal-exchanges

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalExchangeViewDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/reciprocal-exchanges

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.Reciprocal.InitiateReciprocalExchangeCommand as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalExchangeViewDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/reciprocal-exchanges/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalExchangeViewDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/reciprocal-exchanges/{id}/commit

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalExchangeViewDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/reciprocal-exchanges/{id}/rescind

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RescindReciprocalExchangeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalExchangeViewDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/reciprocal-exchanges/{id}/respond

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RespondReciprocalExchangeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalExchangeViewDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

RecordsHandover

GET/api/v1/records-handovers

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RecordsHandoverDto[]

POST/api/v1/records-handovers

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.InitiateRecordsHandoverRequestDto as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.InitiateRecordsHandoverResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/records-handovers/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RecordsHandoverDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/records-handovers/{id}/accept

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RecordsHandoverDecisionResultDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/records-handovers/{id}/decline

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RecordsHandoverDecisionResultDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/records-handovers/{id}/withdraw

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RecordsHandoverDecisionResultDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

Reliances

POST/api/v1/consent/{consentId}/reliance

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.EstablishRelianceRequest as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/{consentId}/reliance/verification-revoked

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordRelianceRevokedRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RelianceRevocationResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/user/reliances

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RelianceViewDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

RenunciationTeardown

GET/api/v1/consent/renunciation/cases/{caseId}/notices

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
caseId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Renunciation.StopRelyingAuditDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/renunciation/cases/{caseId}/notices/{noticeId}/acknowledge

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
caseId	path	string (uuid)	yes	—
noticeId	path	string (uuid)	yes	—
relyingPartyRef	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Renunciation.StopRelyingAuditDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/renunciation/cases/{caseId}/notices/{noticeId}/delivery

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
caseId	path	string (uuid)	yes	—
noticeId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordStopRelyingDeliveryRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Renunciation.StopRelyingAuditDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/renunciation/scope

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
jurisdiction	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Renunciation.RenunciationScopePreviewDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

RepairAccess

GET/api/v1/consent/repair-access/grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessGrantDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/repair-access/grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.RepairAccess.CreateRepairAccessGrantRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/repair-access/grants/{grantId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/repair-access/grants/{grantId}/device-propagation

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.RepairAccess.ReportDeviceRevocationPropagationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/repair-access/grants/{grantId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.RepairAccess.RevokeRepairAccessRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/repair-access/grants/{grantId}/share-code

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.RepairAccess.IssueRepairShareCodeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/repair-access/inbox

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
openOnly	query	boolean	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessGrantDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/repair-access/inbox/{grantId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/repair-access/inbox/{grantId}/accesses

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.RepairAccess.RecordRepairAccessRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessEventDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/repair-access/inbox/{grantId}/assign

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.RepairAccess.AssignRepairTechnicianRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/repair-access/inbox/{grantId}/repair-log

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.RepairAccess.LogRepairRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/repair-access/staff-access

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Queries.RepairAccess.RepairStaffAccessRowDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

RepresentativeAuthorization

GET/api/v1/consent/representative-authorizations

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
subjectRef	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepresentativeAuthority.RepresentativeAuthorizationDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/representative-authorizations

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RegisterRepresentativeAuthorizationRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.RepresentativeAuthority.RepresentativeAuthorizationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/representative-authorizations/access-decision

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
subjectRef	query	string	no	—
representativeRef	query	string	no	—
recordType	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepresentativeAuthority.RepresentativeAuthorizationAccessDecisionDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/representative-authorizations/{authorizationId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
authorizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepresentativeAuthority.RepresentativeAuthorizationDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/representative-authorizations/{authorizationId}/end

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
authorizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.EndRepresentativeAuthorizationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.RepresentativeAuthority.RepresentativeAuthorizationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

RetainedAttestations

GET/api/v1/consent/attestations

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
attestationType	query	string	no	—
status	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RetainedAttestationListDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/attestations

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.MakeRetainedAttestationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RetainedAttestationResultDto

201Created — Essence.Consent.Core.Contracts.DTOs.RetainedAttestationResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/attestations/received

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
attestationType	query	string	no	—
status	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RetainedAttestationListDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/attestations/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RetainedAttestationDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/attestations/{id}/in-force

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
at	query	string (date-time)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RetainedAttestationInForceDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/attestations/{id}/withdraw

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.WithdrawRetainedAttestationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RetainedAttestationResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

Reveal

POST/api/v1/consent/reveal

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordDisclosureRevealRequestDto as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.DisclosureRevealResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/reveal-proof/{revealId}/status

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
revealId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RevealProofStatusDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/reveals

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
workEntityId	query	string (uuid)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.DisclosureRevealAuditEntryDto[]

POST/api/v1/consent/reveals/{revealId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
revealId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.DisclosureRevealRevokeResultDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

RevocationExposure

GET/api/v1/consent/revocation-exposure/board

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.RevocationExposure.RevocationExposureBoardDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/revocation-exposure/export

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — string

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

RevocationReviewDecisions

GET/api/v1/consent/revocation-reviews

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
revocationRef	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RevocationReviewDecisionListDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/revocation-reviews/decisions

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordRevocationReviewDecisionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RevocationReviewDecisionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/revocation-reviews/snoozed

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RevocationReviewDecisionListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

RotationConsentReconciliation

GET/api/v1/consent/rotation-reconciliations

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RotationConsentReconciliationDto[]

GET/api/v1/consent/rotation-reconciliations/by-rotation/{rotationSessionId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
rotationSessionId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RotationConsentReconciliationDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/rotation-reconciliations/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RotationConsentReconciliationDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ScamEvidenceDisclosureGrants

GET/api/v1/consent/scam-evidence-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureGrantListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/scam-evidence-grants

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.GiveScamEvidenceDisclosureGrantRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/scam-evidence-grants/capabilities

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureGrantCapabilitiesDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/scam-evidence-grants/claims/{claimReference}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
claimReference	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScamClaimConsentStateDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/scam-evidence-grants/claims/{claimReference}/evidence/{evidenceItemId}/access

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
claimReference	path	string	yes	—
evidenceItemId	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScamEvidenceAccessDecisionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/scam-evidence-grants/received

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureGrantListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/scam-evidence-grants/{grantId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/scam-evidence-grants/{grantId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeScamEvidenceDisclosureGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ScopeOfAuthority

GET/api/v1/consent/scope-of-authority

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
asAttorney	query	boolean	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScopeOfAuthorityRecordDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/scope-of-authority

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.CreateScopeOfAuthorityRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.ScopeOfAuthorityRecordDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/scope-of-authority/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScopeOfAuthorityRecordDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/scope-of-authority/{id}/activate

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ActivateScopeOfAuthorityRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScopeOfAuthorityRecordDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

402Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/scope-of-authority/{id}/attorney-visibility-preview

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.AttorneyVisibilityPreviewDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PATCH/api/v1/consent/scope-of-authority/{id}/categories

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.SetScopeCategoryRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScopeOfAuthorityRecordDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PATCH/api/v1/consent/scope-of-authority/{id}/fields

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.SetScopeFieldVisibilityRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScopeOfAuthorityRecordDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/scope-of-authority/{id}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RevokeScopeOfAuthorityRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScopeOfAuthorityRecordDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PATCH/api/v1/consent/scope-of-authority/{id}/scope

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.UpdateScopeOfAuthorityRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScopeOfAuthorityRecordDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/scope-of-authority/{id}/standby

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.PlaceScopeOfAuthorityOnStandbyRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.ScopeOfAuthorityRecordDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

SecretDelegation

GET/api/v1/secret-delegations

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
secretId	query	string (uuid)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SecretDelegationHolderTableDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/secret-delegations

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.GrantSecretDelegationRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.SecretDelegationGrantDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/secret-delegations/rotate

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RotateDelegatedSecretRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RotateDelegatedSecretResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/secret-delegations/{grantId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
grantId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RevokeSecretDelegationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SecretDelegationGrantDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

SelfExclusion

GET/api/v1/self-exclusion/audit

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionAuditTrailDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/self-exclusion/credential

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.IssueSelfExclusionCredentialRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.SelfExclusionCredentialDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/self-exclusion/credential/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionCredentialDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/self-exclusion/credentials

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionCredentialDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/self-exclusion/oversight

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionOversightDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/self-exclusion/policy

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
jurisdiction	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionPolicyDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/self-exclusion/policy/effective

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
jurisdiction	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionPolicyDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/self-exclusion/policy/{jurisdiction}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
jurisdiction	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.UpsertSelfExclusionPolicyRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionPolicyDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/self-exclusion/presentations

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.OpenSelfExclusionPresentationRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.SelfExclusionPresentationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/self-exclusion/reinstatement

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.StartSelfExclusionReinstatementRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionReinstatementDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/self-exclusion/reinstatement/current

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionReinstatementDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/self-exclusion/reinstatement/{id}/complete

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionReinstatementDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/self-exclusion/verify

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.VerifySelfExclusionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionVerificationResult

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

SelfExclusionBroadcast

POST/api/v1/self-exclusion/broadcast

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RegisterSelfExclusionBroadcastRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/self-exclusion/broadcast/assurance

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastAssuranceDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/self-exclusion/broadcast/current

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/self-exclusion/broadcast/operators

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastOperatorsDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/self-exclusion/broadcast/{id}/operators/{operatorId}/proof

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
operatorId	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionOperatorProofDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/self-exclusion/broadcast/{id}/rebroadcast

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RebroadcastSelfExclusionBroadcastRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/self-exclusion/broadcast/{id}/register-export

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionRegisterExportDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/self-exclusion/broadcast/{id}/renew

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RenewSelfExclusionBroadcastRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/self-exclusion/broadcast/{id}/withdrawal

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

DELETE/api/v1/self-exclusion/broadcast/{id}/withdrawal

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/self-exclusion/broadcast/{id}/withdrawal/complete

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

SelfSyncPolicy

GET/api/v1/consent/self-sync-policies

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SelfSync.SelfSyncPolicyDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/consent/self-sync-policies/{deviceClass}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
deviceClass	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.SetSelfSyncPolicyRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.SelfSync.SelfSyncPolicyDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

SessionAccessConsent

GET/api/v1/consent/session-access

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SessionAccessConsentListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/session-access/{consentId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SessionAccessConsentDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/session-access/{consentId}/receipt

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SessionAccessConsentReceiptDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

SharedCredentialRole

GET/api/v1/consent/shared-credentials/{credentialId}/roles

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
credentialId	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SharedCredentialRoleMatrixDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/shared-credentials/{credentialId}/roles

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
credentialId	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.SetSharedCredentialRoleRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SharedCredentialRoleResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/shared-credentials/{credentialId}/roles/history

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
credentialId	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SharedCredentialRoleHistoryDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

SpecialAssistance

GET/api/v1/consent/special-assistance/carriers/{carrierIataCode}/catalogue

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
carrierIataCode	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.CarrierAssistanceCatalogueDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/special-assistance/desk/awaiting-deletion

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceRosterItemDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/special-assistance/desk/catalogue

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.CarrierAssistanceCatalogueDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/consent/special-assistance/desk/catalogue/categories/{category}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
category	path	Essence.Consent.Core.Domain.Enums.PrmAssistanceCategory	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.ConfigureAssistanceCategoryRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.CarrierAssistanceCatalogueDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/consent/special-assistance/desk/catalogue/retention

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.ConfigureAssistanceRetentionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.CarrierAssistanceCatalogueDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/special-assistance/desk/notifications/outcome-batch

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordAssistanceOutcomeBatchRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.Commands.SpecialAssistance.AssistanceOutcomeBatchResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/special-assistance/desk/notifications/{notificationId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
notificationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceRosterItemDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/special-assistance/desk/notifications/{notificationId}/arrival

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
notificationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.ReportTripArrivalRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceRosterItemDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/special-assistance/desk/notifications/{notificationId}/deletion-attestation

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
notificationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.AttestAssistanceDeletionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceRosterItemDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/special-assistance/desk/notifications/{notificationId}/open

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
notificationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.AssistanceDeskActorRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceNeedDisclosureDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/special-assistance/desk/notifications/{notificationId}/outcome

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
notificationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RecordAssistanceOutcomeRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceRosterItemDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/special-assistance/desk/overview

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceRosterItemDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/special-assistance/desk/roster

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
carrier	query	string	no	—
flightNumber	query	string	no	—
departureDate	query	string (date)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceRosterItemDto[]

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/special-assistance/notifications

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.SpecialAssistanceNotificationDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/special-assistance/notifications

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.NotifyAssistanceNeedRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.SpecialAssistance.SpecialAssistanceNotificationDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/special-assistance/notifications/{notificationId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
notificationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.SpecialAssistanceNotificationDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/special-assistance/notifications/{notificationId}/receipt

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
notificationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceDeletionReceiptDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/special-assistance/notifications/{notificationId}/withdraw

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
notificationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SpecialAssistance.SpecialAssistanceNotificationDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

StatusProjectionConsent

POST/api/v1/consent/status-projections

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.GrantStatusProjectionConsentRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.StatusProjection.StatusProjectionConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/status-projections/check

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
holderId	query	string (uuid)	no	—
requesterId	query	string (uuid)	no	—
purpose	query	string	no	—
credentialId	query	string (uuid)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.StatusProjection.StatusProjectionConsentDecisionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/status-projections/{consentId}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
consentId	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

StatutoryDisclosureRequests

GET/api/v1/consent/statutory-disclosure-requests

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
matterId	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.StatutoryDisclosureRequestListDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/statutory-disclosure-requests/transitions

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordStatutoryDisclosureTransitionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.StatutoryDisclosureTransitionResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/statutory-disclosure-requests/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.StatutoryDisclosureRequestDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

SubjectExport

GET/api/v1/subject-export/scope

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SubjectExportScopeDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/subject-export/{category}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
category	path	string	yes	—
skip	query	integer (int32)	no	—
take	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.SubjectExportPageDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

Subscription

POST/api/v1/Subscription

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.Subscription.RequestSubscriptionRequestDto as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.Subscription.SyncSubscriptionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/Subscription/granted

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.Subscription.SyncSubscriptionDto[]

GET/api/v1/Subscription/my-subscriptions

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.Subscription.SyncSubscriptionDto[]

GET/api/v1/Subscription/pending-approvals

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.Subscription.SyncSubscriptionDto[]

GET/api/v1/Subscription/per-sync-consents/pending

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.Subscription.PerSyncConsentRequestDto[]

POST/api/v1/Subscription/per-sync-consents/{requestId}/approve

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
requestId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.Subscription.ApprovePerSyncConsentRequestDto as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Subscription/per-sync-consents/{requestId}/decline

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
requestId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.Subscription.DeclinePerSyncConsentRequestDto as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/Subscription/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.Subscription.SyncSubscriptionDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

DELETE/api/v1/Subscription/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.Subscription.CancelSubscriptionRequestDto as application/*+json, application/json, text/json

Responses

204No Content

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Subscription/{id}/approve

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.Subscription.ApproveSubscriptionRequestDto as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Subscription/{id}/per-sync-approval/{requestId}/approve

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
requestId	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Subscription/{id}/per-sync-approval/{requestId}/decline

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
requestId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.Subscription.DeclinePerSyncConsentRequestDto as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Subscription/{id}/reject

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.Subscription.RejectSubscriptionRequestDto as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Subscription/{id}/request-more

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.Subscription.RequestMoreSyncsRequestDto as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.Subscription.RequestMoreSyncsResponseDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Subscription/{id}/request-more/{requestId}/approve

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
requestId	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/Subscription/{id}/request-more/{requestId}/decline

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
requestId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.Subscription.DeclineMoreSyncsRequestDto as application/*+json, application/json, text/json

Responses

204No Content

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/Subscription/{id}/sync-jobs

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.Subscription.SyncJobDto[]

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

SubscriptionPerSyncStrikes

POST/api/v1/subscription/{id}/per-sync-strikes/reaffirm

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

SuccessionApprovals

POST/api/v1/consent/succession-approvals

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.OpenSuccessionApprovalRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.SuccessionApprovalDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/succession-approvals/{caseId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
caseId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SuccessionApprovalDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/succession-approvals/{caseId}/sign-offs

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
caseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.SignOffSuccessionApprovalRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SuccessionApprovalDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

PUT/api/v1/consent/succession-approvals/{caseId}/terms

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
caseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.AmendSuccessionTermsRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SuccessionApprovalDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

SupervisionControlTemplates

GET/api/v1/consent/supervision-control-templates

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
includeArchived	query	boolean	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SupervisionControlTemplateSummaryDto[]

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/supervision-control-templates

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.CreateSupervisionControlTemplateRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.SupervisionControlTemplateDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/supervision-control-templates/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SupervisionControlTemplateDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/supervision-control-templates/{id}/archive

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SupervisionControlTemplateDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

PATCH/api/v1/consent/supervision-control-templates/{id}/name

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RenameSupervisionControlTemplateRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SupervisionControlTemplateDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/supervision-control-templates/{id}/reactivate

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SupervisionControlTemplateDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/supervision-control-templates/{id}/versions

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ReviseSupervisionControlTemplateRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SupervisionControlTemplateDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/supervision-control-templates/{id}/versions/{versionNumber}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
versionNumber	path	integer (int32)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SupervisionControlTemplateVersionDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

SupplierConsentCoverage

POST/api/v1/consents/supplier-coverage

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.SupplierConsentCoverageRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.SupplierConsentBasisDto[]

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

ThirdPartyConsent

GET/api/v1/third-party-consents

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
role	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto[]

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/third-party-consents/invite

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.Commands.ThirdParty.InviteThirdPartyConsentCommand as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.ThirdParty.InviteThirdPartyConsentResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

429Too Many Requests — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/third-party-consents/subject-shares

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
token	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.SubjectSharesDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/third-party-consents/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/third-party-consents/{id}/accept

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.AcceptThirdPartyConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/third-party-consents/{id}/auto-update

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Application.DTOs.ThirdParty.RecordAutoUpdateDisclosureRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.ThirdParty.AutoUpdateEventDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/third-party-consents/{id}/auto-update-events

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.AutoUpdateEventListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/third-party-consents/{id}/decline

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.DeclineThirdPartyConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/third-party-consents/{id}/link-grant

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.LinkThirdPartyConsentGrantRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/third-party-consents/{id}/purge-receipt

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.PurgeReceiptDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/third-party-consents/{id}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RevokeThirdPartyConsentRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/third-party-consents/{id}/subject-approve

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.SubjectEscrowDecisionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/third-party-consents/{id}/subject-deny

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.DenyThirdPartyConsentBySubjectRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ThirdPartyConsentDeceasedSubject

POST/api/v1/third-party-consents/{id}/data-subject-deceased

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

ThirdPartyInvitation

GET/api/v1/third-party-consents/invitations/{token}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
token	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyInvitationView

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/third-party-consents/invitations/{token}/identity-binding

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
token	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RequestInvitationOtpRequest as application/*+json, application/json, text/json

Responses

202Accepted

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

POST/api/v1/third-party-consents/invitations/{token}/identity-binding/confirm

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
token	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.ConfirmInvitationOtpRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.ConfirmInvitationOtpResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/third-party-consents/invitations/{token}/respond

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
token	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RespondToInvitationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.RespondToInvitationResponse

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/third-party-consents/invitations/{token}/withdraw

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
token	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.WithdrawInvitationRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.ThirdParty.AccountlessWithdrawalReceiptDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

TranslationCommission

GET/api/v1/consent/translation-commissions

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
originalDocumentRef	query	string	no	—
role	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Translation.TranslationCommissionDto[]

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

POST/api/v1/consent/translation-commissions

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RequestTranslationCommissionRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.DTOs.Translation.TranslationCommissionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

GET/api/v1/consent/translation-commissions/{commissionId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
commissionId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Translation.TranslationCommissionDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/translation-commissions/{commissionId}/accept

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
commissionId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.AcceptTranslationCommissionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Translation.TranslationCommissionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/translation-commissions/{commissionId}/attest

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
commissionId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.AttestTranslationCommissionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Translation.TranslationCommissionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/translation-commissions/{commissionId}/bind

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
commissionId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.BindTranslationCommissionRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Translation.TranslationCommissionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/translation-commissions/{commissionId}/failure

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
commissionId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.RaiseTranslationCommissionFailureRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.Translation.TranslationCommissionDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/translation-commissions/{commissionId}/start

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
commissionId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.Translation.TranslationCommissionDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

TrustSafetyRingEnforcements

GET/api/v1/consent/trust-safety/ring-enforcements

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
ringId	query	string (uuid)	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RingEnforcementDto[]

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/trust-safety/ring-enforcements

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ExecuteRingEnforcementRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RingEnforcementDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/trust-safety/ring-enforcements/{enforcementId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
enforcementId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RingEnforcementDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/trust-safety/ring-enforcements/{enforcementId}/subjects/{subjectUserId}/reverse

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
enforcementId	path	string (uuid)	yes	—
subjectUserId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ReverseRingEnforcementSubjectRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.RingEnforcementDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

VaultSplitConsentCascades

GET/api/v1/consent/vault-splits/{splitId}/cascades

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
splitId	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.VaultSplitDocumentCascadeDto[]

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/vault-splits/{splitId}/cascades

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
splitId	path	string	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.CascadeVaultSplitConsentsRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.VaultSplitConsentCascadeResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

VehicleLeasePurgeAttestation

POST/api/v1/consent/vehicle-leases/{leaseId}/purge-attestation

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
leaseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecordVehiclePurgeReportRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.LeasePurgeReportDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

403Forbidden — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

VehicleLeases

GET/api/v1/consent/vehicle-leases

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.VehicleProfileLeaseListDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/vehicle-leases

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.GrantVehicleLeaseRequest as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Contracts.DTOs.VehicleProfileLeaseDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

422Client Error — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/vehicle-leases/{leaseId}/end

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
leaseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.EndVehicleLeaseRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.LeasePurgeReportDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/vehicle-leases/{leaseId}/extend

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
leaseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.ExtendVehicleLeaseRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.VehicleProfileLeaseDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/vehicle-leases/{leaseId}/purge-report

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
leaseId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.LeasePurgeReportDto

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/vehicle-leases/{leaseId}/purge-report/recheck

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
leaseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.RecheckPurgeCategoryRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.LeasePurgeReportDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

401Unauthorized — Microsoft.AspNetCore.Mvc.ProblemDetails

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

VerifiedChangeReconciliation

POST/api/v1/consent/verified-change/{changeId}/reconcile

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
changeId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.ReconcileVerifiedChangeRequestDto as application/*+json, application/json, text/json

Responses

201Created — Essence.Consent.Core.Application.Commands.VerifiedChange.VerifiedChangeReconciliationResult

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/verified-change/{changeId}/reconciliations

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
changeId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Commands.VerifiedChange.VerifiedChangeReconciliationResult[]

GET/api/v1/consent/verified-change/{changeId}/reconciliations/{reconciliationId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
changeId	path	string (uuid)	yes	—
reconciliationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.Commands.VerifiedChange.VerifiedChangeReconciliationResult

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

VisitorConsentRecords

POST/api/v1/consent/visitor-records

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Contracts.DTOs.FileVisitorConsentRecordRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.VisitorConsentRecordDto

201Created — Essence.Consent.Core.Contracts.DTOs.VisitorConsentRecordDto

400Bad Request — Microsoft.AspNetCore.Mvc.ProblemDetails

409Conflict — Microsoft.AspNetCore.Mvc.ProblemDetails

GET/api/v1/consent/visitor-records/{recordId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
recordId	path	string	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Contracts.DTOs.VisitorConsentRecordDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

WalletClaimConsent

GET/api/v1/consent/wallet-claim-consents

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
disclosureRef	query	string	no	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.WalletClaimConsent.WalletClaimConsentDto[]

GET/api/v1/consent/wallet-claim-consents/granularity

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.WalletClaimConsent.WalletClaimConsentGranularityDto[]

POST/api/v1/consent/wallet-claim-consents/sync

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• Essence.Consent.Core.Api.Controllers.SyncWalletClaimConsentsRequest as application/*+json, application/json, text/json

Responses

200Success — Essence.Consent.Core.Application.DTOs.WalletClaimConsent.WalletClaimConsentSyncResultDto

400Bad Request — Microsoft.AspNetCore.Mvc.ValidationProblemDetails

GET/api/v1/consent/wallet-claim-consents/{recordId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
recordId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.WalletClaimConsent.WalletClaimConsentDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

POST/api/v1/consent/wallet-claim-consents/{recordId}/withdraw

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
recordId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — Essence.Consent.Core.Application.DTOs.WalletClaimConsent.WalletClaimConsentDto

404Not Found — Microsoft.AspNetCore.Mvc.ProblemDetails

Schemas

Essence.Consent.Core.Api.Controllers.AcceptThirdPartyConsentRequest

Property	Type	Required	Description
invitationToken	string | null	no	—

Essence.Consent.Core.Api.Controllers.AcceptTranslationCommissionRequest

Property	Type	Required	Description
currency	string | null	no	—
estimatedTurnaroundHours	integer (int32)	no	—
indicativePriceMinor	integer (int64)	no	—
invitationToken	string | null	no	—
translatorRef	string | null	no	—

Essence.Consent.Core.Api.Controllers.AccountCaptureDecisionDto

Property	Type	Required	Description
accept	boolean	no	—

Essence.Consent.Core.Api.Controllers.AcknowledgePresentationRevocationRequest

Property	Type	Required	Description
ackReference	string | null	no	—

Essence.Consent.Core.Api.Controllers.AppOwnershipActionResponse

Property	Type	Required	Description
affected	integer (int32)	no	—

Essence.Consent.Core.Api.Controllers.AppRescopeValidationResponse

Property	Type	Required	Description
activeGrants	integer (int32)	no	—
authorisedForNewOwner	integer (int32)	no	—
blocked	integer (int32)	no	—
requiresReconsent	integer (int32)	no	—
truncated	boolean	no	—

Essence.Consent.Core.Api.Controllers.ApproveDocumentRequestRequestDto

Property	Type	Required	Description
deliveryModel	Essence.Consent.Core.Domain.Enums.DocumentDeliveryModel	no	—
fulfillingDocumentId	string (uuid)	no	—

Essence.Consent.Core.Api.Controllers.AppSunsetExtensionRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.AppSunsetMigrateNowResponse

Property	Type	Required	Description
grantsEnded	integer (int32)	no	—

Essence.Consent.Core.Api.Controllers.AppSunsetReminderRequest

Property	Type	Required	Description
remindAt	string (date-time) | null	no	—

Essence.Consent.Core.Api.Controllers.AppSunsetReminderResponse

Property	Type	Required	Description
remindAt	string (date-time)	no	—

Essence.Consent.Core.Api.Controllers.AssistanceDeskActorRequest

Property	Type	Required	Description
actorRef	string | null	no	—

Essence.Consent.Core.Api.Controllers.AttestAssistanceDeletionRequest

Property	Type	Required	Description
actorRef	string | null	no	—
attestationReference	string | null	no	—

Essence.Consent.Core.Api.Controllers.AttestTranslationCommissionRequest

Property	Type	Required	Description
attestationRef	string | null	no	—

Essence.Consent.Core.Api.Controllers.AuthorizeEmergencyAccessRequestDto

Property	Type	Required	Description
inactivityWaitDays	integer (int32)	no	—
legalBasis	Essence.Consent.Core.Domain.Entities.EmergencyAccess.EmergencyAccessLegalBasis	no	—
proofOfLifeCadenceDays	integer (int32)	no	—
releasableCategories	string[] | null	no	—
trustedContactId	string (uuid)	no	—

Essence.Consent.Core.Api.Controllers.BindTranslationCommissionRequest

Property	Type	Required	Description
translatedDocumentRef	string | null	no	—

Essence.Consent.Core.Api.Controllers.BulkCaptureConsentRequestDto

Property	Type	Required	Description
captureIds	(string (uuid))[] | null	no	—

Essence.Consent.Core.Api.Controllers.BulkProcessIntakeRequestDto

Property	Type	Required	Description
accept	(string (uuid))[] | null	no	—
reject	(string (uuid))[] | null	no	—

Essence.Consent.Core.Api.Controllers.BulkVisibilityChangeRequest

Property	Type	Required	Description
circles	Essence.Consent.Core.Api.Controllers.BulkVisibilityCircleDto[] | null	no	—
fieldKey	string | null	no	—
fieldLabel	string | null	no	—
hideFromCircleIds	string[] | null	no	—

Essence.Consent.Core.Api.Controllers.BulkVisibilityCircleDto

Property	Type	Required	Description
circleId	string | null	no	—
circleName	string | null	no	—
connectionCount	integer (int32) | null	no	—

Essence.Consent.Core.Api.Controllers.CaptureDecisionRequestDto

Property	Type	Required	Description
allow	boolean	no	—
noticeToken	string | null	no	—

Essence.Consent.Core.Api.Controllers.CaptureEraseRequestDto

Property	Type	Required	Description
noticeToken	string | null	no	—

Essence.Consent.Core.Api.Controllers.CompleteHouseholdShareRequest

Property	Type	Required	Description
category	string | null	no	—
documentId	string | null	no	—

Essence.Consent.Core.Api.Controllers.ConfigureAssistanceCategoryRequest

Property	Type	Required	Description
advanceNoticeHours	integer (int32)	no	—
carrierDisplayName	string | null	no	—
carrierIataCode	string | null	no	—
isOffered	boolean	no	—
requiresNote	boolean	no	—

Essence.Consent.Core.Api.Controllers.ConfigureAssistanceRetentionRequest

Property	Type	Required	Description
carrierDisplayName	string | null	no	—
carrierIataCode	string | null	no	—
postTripAccessGraceHours	integer (int32)	no	—

Essence.Consent.Core.Api.Controllers.ConfirmInvitationOtpRequest

Property	Type	Required	Description
email	string | null	no	—
otp	string | null	no	—

Essence.Consent.Core.Api.Controllers.CourtAuthorityAccessDecisionRequest

Property	Type	Required	Description
deputyId	string (uuid)	no	—
scopeCategory	string | null	no	—
wardId	string (uuid)	no	—

Essence.Consent.Core.Api.Controllers.CreateDocumentRequestRequestDto

Property	Type	Required	Description
contactId	string (uuid)	no	—
documentName	string | null	no	—
expiresAt	string (date-time) | null	no	—
purpose	string | null	no	—

Essence.Consent.Core.Api.Controllers.DeceasedConsentTeardownRequest

Property	Type	Required	Description
actingExecutorUserId	string (uuid)	no	—
basis	string | null	no	—
deceasedUserId	string (uuid)	no	—
estateId	string | null	no	—

Essence.Consent.Core.Api.Controllers.DeceasedConsentTeardownResponse

Property	Type	Required	Description
basis	string | null	no	—
basisRecorded	boolean	no	—
completedAt	string (date-time) | null	no	—
deceasedUserId	string (uuid)	no	—
estateId	string | null	no	—
failedConsentIds	(string (uuid))[] | null	no	—
failedCount	integer (int32)	no	—
nominationId	string (uuid) | null	no	—
pendingConsentIds	(string (uuid))[] | null	no	—
pendingCount	integer (int32)	no	—
revokedConsentIds	(string (uuid))[] | null	no	—
revokedCount	integer (int32)	no	—
skipped	Essence.Consent.Core.Application.Commands.DeceasedTeardown.DeceasedConsentTeardownSkip[] | null	no	—
skippedCount	integer (int32)	no	—
teardownId	string (uuid)	no	—
totalGrants	integer (int32)	no	—

Essence.Consent.Core.Api.Controllers.DecideLawfulCompulsionAccessRequest

Property	Type	Required	Description
purpose	string | null	no	—
recordTypes	string[] | null	no	—
subjectRef	string | null	no	—

Essence.Consent.Core.Api.Controllers.DeclineThirdPartyConsentRequest

Property	Type	Required	Description
invitationToken	string | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.DenyThirdPartyConsentBySubjectRequest

Property	Type	Required	Description
acceptedFieldKeys	string[] | null	no	—
invitationToken	string | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.DeskActorRequest

Property	Type	Required	Description
actorRef	string | null	no	—

Essence.Consent.Core.Api.Controllers.DiscloseNameChangeRequestDto

Property	Type	Required	Description
deedPollDocumentId	string (uuid) | null	no	—
relyingPartyIds	(string (uuid))[] | null	no	—

Essence.Consent.Core.Api.Controllers.DisclosePartnerScheduleRequest

Property	Type	Required	Description
disclosedCategories	string[] | null	no	—
scheduleDocumentId	string (uuid)	no	—

Essence.Consent.Core.Api.Controllers.EndCourtAuthorityRequest

Property	Type	Required	Description
endReason	string | null	no	—
note	string | null	no	—

Essence.Consent.Core.Api.Controllers.EndRepresentativeAuthorizationRequest

Property	Type	Required	Description
note	string | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.GrantStatusProjectionConsentRequest

Property	Type	Required	Description
credentialIds	(string (uuid))[] | null	no	—
expiresAt	string (date-time)	no	—
purpose	string | null	no	—
requesterOrganizationId	string (uuid)	no	—

Essence.Consent.Core.Api.Controllers.HouseholdShareSubjectRequest

Property	Type	Required	Description
relationshipLabel	string | null	no	—
subjectRef	string | null	no	—

Essence.Consent.Core.Api.Controllers.IngestCourtOrderRequest

Property	Type	Required	Description
effectiveFrom	string (date-time) | null	no	—
effectiveUntil	string (date-time) | null	no	—
issuingCourt	string | null	no	—
jurisdiction	string | null	no	—
orderMadeOn	string (date-time)	no	—
orderReference	string | null	no	—
orderType	string | null	no	—
reportingCadence	string | null	no	—
scope	Essence.Consent.Core.Application.Commands.CourtAuthority.CourtAuthorityScopeInput[] | null	no	—
supervisionLevel	string | null	no	—
wardId	string (uuid)	no	—

Essence.Consent.Core.Api.Controllers.InitiateRecordsHandoverRequestDto

Property	Type	Required	Description
acceptanceWindowDays	integer (int32) | null	no	—
contextCiphertext	string | null	no	—
incomingKeeperId	string (uuid)	no	—
lawfulBasis	Essence.Consent.Core.Domain.Enums.RecordsHandoverLawfulBasis	no	—
recordDocumentId	string (uuid) | null	no	—
recordFieldKeys	string[] | null	no	—
retentionDays	integer (int32) | null	no	—
subjectRef	string (uuid)	no	—

Essence.Consent.Core.Api.Controllers.IssueAccountCaptureRequestDto

Property	Type	Required	Description
accountId	string (uuid)	no	—
dataClassesRetained	string[] | null	no	—
dataClassesShared	string[] | null	no	—
domain	string | null	no	—
domainVerificationRef	string | null	no	—
lawfulBasis	string | null	no	—
organizationName	string | null	no	—
purpose	Essence.Consent.Core.Domain.Enums.ConsentPurpose	no	—
subjectEmailMasked	string | null	no	—
subjectId	string (uuid)	no	—

Essence.Consent.Core.Api.Controllers.IssueCaptureRequestDto

Property	Type	Required	Description
capturedFieldKeys	string[] | null	no	—
contextCiphertext	string | null	no	—
escrowDocumentId	string (uuid) | null	no	—
escrowLifetimeDays	integer (int32) | null	no	—
privateNoteCiphertext	string | null	no	—
subjectUserId	string (uuid) | null	no	—

Essence.Consent.Core.Api.Controllers.LinkThirdPartyConsentGrantRequest

Property	Type	Required	Description
consentGrantId	string (uuid)	no	—

Essence.Consent.Core.Api.Controllers.NameChangeIntakePolicyRequestDto

Property	Type	Required	Description
acceptance	Essence.Consent.Core.Domain.Entities.LegalNameChange.IntakeAcceptanceMode	no	—
graceWindowDays	integer (int32)	no	—
requireDeedPollEvidence	boolean	no	—
routingTeam	string | null	no	—

Essence.Consent.Core.Api.Controllers.NotifyAssistanceNeedRequest

Property	Type	Required	Description
arrivalAirportIata	string | null	no	—
article49TransferBasis	Essence.Consent.Core.Domain.Enums.ConsentArticle49TransferBasis	no	—
carrierIataCode	string | null	no	—
flightNumber	string | null	no	—
includesTravellerNote	boolean	no	—
isCrossBorder	boolean	no	—
needEnvelopeRef	string | null	no	—
needWrappedKeyForDesk	string | null	no	—
needWrappedKeyForTraveller	string | null	no	—
recipientJurisdiction	string | null	no	—
scheduledArrivalUtc	string (date-time)	no	—
scheduledDepartureUtc	string (date-time)	no	—
tripReference	string | null	no	—

Essence.Consent.Core.Api.Controllers.PredicateProofInput

Property	Type	Required	Description
attributeCommitment	string | null	no	—
attributePath	string | null	no	—
disclosedAttributes	string[] | null	no	—
issuerDID	string | null	no	—
issuerName	string | null	no	—
operator	string | null	no	—
predicateHolds	boolean	no	—
salt	string | null	no	—
signature	string | null	no	—
thresholdValue	string | null	no	—
verificationMethodId	string | null	no	—

Essence.Consent.Core.Api.Controllers.PreviewHouseholdShareRequest

Property	Type	Required	Description
additionalSubjects	Essence.Consent.Core.Api.Controllers.HouseholdShareSubjectRequest[] | null	no	—
category	string | null	no	—
documentId	string | null	no	—

Essence.Consent.Core.Api.Controllers.PublishConsentPolicyTemplateRequest

Property	Type	Required	Description
description	string | null	no	—
lawfulBasis	Essence.Consent.Core.Contracts.DTOs.ConsentLawfulBasisDto	no	—
maxDurationDays	integer (int32) | null	no	—
name	string | null	no	—
onwardSharingAllowed	boolean	no	—
recommendedCanDelete	boolean	no	—
recommendedCanRead	boolean	no	—
recommendedCanShare	boolean	no	—
recommendedCanWrite	boolean	no	—
recommendedDurationDays	integer (int32) | null	no	—
recommendedOnwardSharing	boolean	no	—
recommendedRevocationPolicy	string | null	no	—

Essence.Consent.Core.Api.Controllers.RaiseTranslationCommissionFailureRequest

Property	Type	Required	Description
detail	string | null	no	—
failure	string | null	no	—

Essence.Consent.Core.Api.Controllers.ReconcileVerifiedChangeRequestDto

Property	Type	Required	Description
memberIds	(string (uuid))[] | null	no	—

Essence.Consent.Core.Api.Controllers.RecordAssistanceOutcomeBatchRequest

Property	Type	Required	Description
actorRef	string | null	no	—
notificationIds	(string (uuid))[] | null	no	—
outcome	Essence.Consent.Core.Domain.Enums.SpecialAssistanceStatus	no	—
unavailableReason	Essence.Consent.Core.Domain.Enums.AssistanceUnavailableReason	no	—

Essence.Consent.Core.Api.Controllers.RecordAssistanceOutcomeRequest

Property	Type	Required	Description
actorRef	string | null	no	—
outcome	Essence.Consent.Core.Domain.Enums.SpecialAssistanceStatus	no	—
unavailableReason	Essence.Consent.Core.Domain.Enums.AssistanceUnavailableReason	no	—

Essence.Consent.Core.Api.Controllers.RecordCapacityDeterminationRequest

Property	Type	Required	Description
closurePolicy	string | null	no	—
determinationReference	string | null	no	—
determinedOn	string (date-time)	no	—
determiningBody	string | null	no	—
note	string | null	no	—
outcome	string | null	no	—

Essence.Consent.Core.Api.Controllers.RecordCourtAuthorityVariationRequest

Property	Type	Required	Description
effectiveUntil	string (date-time) | null	no	—
note	string | null	no	—
reportingCadence	string | null	no	—
scope	Essence.Consent.Core.Application.Commands.CourtAuthority.CourtAuthorityScopeInput[] | null	no	—
supervisionLevel	string | null	no	—

Essence.Consent.Core.Api.Controllers.RecordCrossBorderConsentGrantRequest

Property	Type	Required	Description
assuranceLevelReliedUpon	string | null	no	—
jurisdiction	string | null	no	—
legalBasis	string | null	no	—
minimumRequiredLoa	string | null	no	—
relyingPartyRef	string | null	no	—
subjectRef	string | null	no	—
subjectStandingCode	string | null	no	—

Essence.Consent.Core.Api.Controllers.RecordDisclosureRevealRequestDto

Property	Type	Required	Description
accessExpiry	Essence.Consent.Core.Domain.Enums.RevealAccessExpiry	no	—
contentHash	string | null	no	—
purpose	string | null	no	—
recipientLabel	string | null	no	—
stage	Essence.Consent.Core.Domain.Enums.RevealStage	no	—
workEntityId	string (uuid)	no	—
workEntryId	string (uuid)	no	—

Essence.Consent.Core.Api.Controllers.RecordEstateDisclosureBasisRequest

Property	Type	Required	Description
claimRef	string | null	no	—
courtOrderRef	string | null	no	—
deceasedRef	string | null	no	—
demandRef	string | null	no	—
executorUserId	string | null	no	—
legalBasis	string | null	no	—
organizationId	string | null	no	—
scopeFieldKeys	string[] | null	no	—

Essence.Consent.Core.Api.Controllers.RecordEstateDisclosureScopeAuditRequest

Property	Type	Required	Description
claimRef	string | null	no	—
disclosedFieldKeys	string[] | null	no	—
organizationId	string | null	no	—
scopeFieldKeys	string[] | null	no	—
withheldGroupKeys	string[] | null	no	—
withinScope	boolean	no	—

Essence.Consent.Core.Api.Controllers.RecordExternalDisclosureRequest

Property	Type	Required	Description
claimRef	string | null	no	—
evidenceRefs	string[] | null	no	—
externalRecipientRef	string | null	no	—
purpose	string | null	no	—
sealedPayload	string | null	no	—
shareExpiresAt	string (date-time) | null	no	—

Essence.Consent.Core.Api.Controllers.RecordFitToFlyDecisionRequest

Property	Type	Required	Description
actorRef	string | null	no	—
infoRequest	Essence.Consent.Core.Domain.Enums.FitToFlyInfoRequest	no	—
outcome	Essence.Consent.Core.Domain.Enums.FitToFlyClearanceStatus	no	—

Essence.Consent.Core.Api.Controllers.RecordLawfulCompulsionBasisRequest

Property	Type	Required	Description
authorityId	string | null	no	—
authorityName	string | null	no	—
fromDate	string (date-time) | null	no	—
instrumentReference	string | null	no	—
instrumentType	string | null	no	—
jurisdiction	string | null	no	—
recordTypes	string[] | null	no	—
statedPurpose	string | null	no	—
statuteRef	string | null	no	—
subjectRef	string | null	no	—
toDate	string (date-time) | null	no	—

Essence.Consent.Core.Api.Controllers.RecordPredicateAttestationRequest

Property	Type	Required	Description
assuranceLevel	string | null	no	—
predicate	string | null	no	—
proof	Essence.Consent.Core.Api.Controllers.PredicateProofInput	no	—
relyingPartyName	string | null	no	—
relyingPartyRef	string | null	no	—
thresholdYears	integer (int32)	no	—
trustFramework	string | null	no	—

Essence.Consent.Core.Api.Controllers.RecordPresentationDisclosureOpenedRequest

Property	Type	Required	Description
fieldKeys	string[] | null	no	—

Essence.Consent.Core.Api.Controllers.RecordPresentationDisclosureRequest

Property	Type	Required	Description
ackMethod	string | null	no	—
disclosedFields	Essence.Consent.Core.Application.Commands.Presentation.DisclosedFieldInput[] | null	no	—
disclosureKind	string | null	no	—
presentationGrantId	string (uuid) | null	no	—
relyingPartyRef	string | null	no	—

Essence.Consent.Core.Api.Controllers.RecordPropagationPushRequestDto

Property	Type	Required	Description
recipients	Essence.Consent.Core.Api.Controllers.RecordPropagationRecipientDto[] | null	no	—

Essence.Consent.Core.Api.Controllers.RecordPropagationPushResponseDto

Property	Type	Required	Description
pushId	string (uuid)	no	—
pushedAt	string (date-time)	no	—
recipientCount	integer (int32)	no	—

Essence.Consent.Core.Api.Controllers.RecordPropagationRecipientDto

Property	Type	Required	Description
fieldsRedacted	string[] | null	no	—
fieldsShared	string[] | null	no	—
governingGrantId	string (uuid)	no	—
grantVersion	integer (int32)	no	—
recipientId	string (uuid)	no	—

Essence.Consent.Core.Api.Controllers.RecordStopRelyingDeliveryRequest

Property	Type	Required	Description
failed	boolean	no	—
failureReason	string | null	no	—

Essence.Consent.Core.Api.Controllers.RegisterRepresentativeAuthorizationRequest

Property	Type	Required	Description
authorityKind	string | null	no	—
authorityName	string | null	no	—
authorizationReference	string | null	no	—
basisKind	string | null	no	—
effectiveFrom	string (date-time)	no	—
expiresAt	string (date-time)	no	—
jurisdiction	string | null	no	—
organisationId	string (uuid) | null	no	—
representativeRef	string | null	no	—
restrictions	string[] | null	no	—
route	string | null	no	—
scopeRecordTypes	string[] | null	no	—
sourceAuthorizationId	string | null	no	—
statedPurpose	string | null	no	—
statuteRef	string | null	no	—
subjectRef	string | null	no	—

Essence.Consent.Core.Api.Controllers.RejectConsentBundleRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.RepointConsentsForRenewalRequest

Property	Type	Required	Description
previousDocumentId	string (uuid)	no	—
replacementDocumentId	string (uuid)	no	—

Essence.Consent.Core.Api.Controllers.ReportTripArrivalRequest

Property	Type	Required	Description
actualArrivalUtc	string (date-time)	no	—

Essence.Consent.Core.Api.Controllers.RequestConsentChangeRequest

Property	Type	Required	Description
consentGrantId	string (uuid)	no	—
message	string | null	no	—
requestedChange	string | null	no	—
requestedExpiresAt	string (date-time) | null	no	—

Essence.Consent.Core.Api.Controllers.RequestCrossInstanceRevocationRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.RequestInvitationOtpRequest

Property	Type	Required	Description
email	string | null	no	—

Essence.Consent.Core.Api.Controllers.RequestTranslationCommissionRequest

Property	Type	Required	Description
grantExpiresAt	string (date-time) | null	no	—
originalDocumentRef	string | null	no	—
sourceLanguage	string | null	no	—
targetLanguage	string | null	no	—

Essence.Consent.Core.Api.Controllers.RescindReciprocalExchangeRequest

Property	Type	Required	Description
cause	string | null	no	—

Essence.Consent.Core.Api.Controllers.ResolveConsentChangeRequestRequest

Property	Type	Required	Description
resolutionNote	string | null	no	—

Essence.Consent.Core.Api.Controllers.RespondReciprocalExchangeRequest

Property	Type	Required	Description
counterpartyFields	string[] | null	no	—
decline	boolean	no	—
declineReason	string | null	no	—

Essence.Consent.Core.Api.Controllers.RespondToInvitationRequest

Property	Type	Required	Description
accept	boolean	no	—
acceptedFieldKeys	string[] | null	no	—
identityBindingToken	string | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.ResumeInFlightActionRequest

Property	Type	Required	Description
achievedAssuranceLevel	string | null	no	—
achievedAt	string (date-time) | null	no	—
achievedVerificationId	string | null	no	—
validUntil	string (date-time) | null	no	—

Essence.Consent.Core.Api.Controllers.RevokeConnectionConsentRequest

Property	Type	Required	Description
cause	string | null	no	—

Essence.Consent.Core.Api.Controllers.RevokeConsentBundleRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.RevokeDisclosureVisibilityRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.RevokeExternalDisclosureRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.RevokeQRCodeRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.RevokeSecretDelegationRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.RevokeThirdPartyConsentRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.SetPreviousNameDispositionRequestDto

Property	Type	Required	Description
choice	Essence.Consent.Core.Domain.Entities.VerifiedChange.PreviousNameDispositionChoice	no	—
disposition	string | null	no	—

Essence.Consent.Core.Api.Controllers.SetPropagationPolicyRequest

Property	Type	Required	Description
defaultSyncType	string | null	no	—
inheritable	boolean	no	—
propagationModel	string | null	no	—
scope	string | null	no	—
scopeRef	string | null	no	—

Essence.Consent.Core.Api.Controllers.SetSelfSyncPolicyRequest

Property	Type	Required	Description
approvalRequired	boolean	no	—
defaultCircles	string[] | null	no	—
syncType	string | null	no	—

Essence.Consent.Core.Api.Controllers.ShareFitToFlyClearanceRequest

Property	Type	Required	Description
airlineDisplayName	string | null	no	—
airlineOrganizationId	string (uuid)	no	—
article49TransferBasis	Essence.Consent.Core.Domain.Enums.ConsentArticle49TransferBasis	no	—
article9Condition	Essence.Consent.Core.Domain.Enums.ConsentArticle9Condition	no	—
attestationCertificateId	string | null	no	—
carrierIataCode	string | null	no	—
clearanceEnvelopeRef	string | null	no	—
clearanceWrappedKey	string | null	no	—
clinicalEnvelopeRef	string | null	no	—
clinicalWrappedKey	string | null	no	—
disclosureLevel	Essence.Consent.Core.Domain.Enums.FitToFlyDisclosureLevel	no	—
flightNumber	string | null	no	—
isCrossBorder	boolean	no	—
recipientJurisdiction	string | null	no	—
scheduledDepartureUtc	string (date-time)	no	—
sourceCertificateId	string | null	no	—
tripReference	string | null	no	—

Essence.Consent.Core.Api.Controllers.SubjectConsentRequest

Property	Type	Required	Description
attestationRef	string | null	no	—
granted	boolean | null	no	—
subjectRef	string | null	no	—

Essence.Consent.Core.Api.Controllers.SubjectEscrowDecisionRequest

Property	Type	Required	Description
acceptedFieldKeys	string[] | null	no	—
invitationToken	string | null	no	—

Essence.Consent.Core.Api.Controllers.SyncWalletClaimConsentsRequest

Property	Type	Required	Description
records	Essence.Consent.Core.Application.Commands.WalletClaimConsent.WalletClaimConsentInput[] | null	no	—

Essence.Consent.Core.Api.Controllers.TerminateConsentBundleOnEventRequest

Property	Type	Required	Description
eventReference	string | null	no	—
eventType	string | null	no	—

Essence.Consent.Core.Api.Controllers.UpdateOrgInvitationTtlRequest

Property	Type	Required	Description
invitationTtlDays	integer (int32)	no	—

Essence.Consent.Core.Api.Controllers.VerifyQRCodeRequest

Property	Type	Required	Description
verificationToken	string | null	no	—

Essence.Consent.Core.Api.Controllers.WithdrawFitToFlyShareRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.WithdrawInvitationRequest

Property	Type	Required	Description
consentId	string (uuid)	no	—
email	string | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Api.Controllers.WithdrawLawfulCompulsionBasisRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Application.AppOwnership.AppOwnerChangeDetailView

Property	Type	Required	Description
appId	string | null	no	—
appName	string | null	no	—
billingConfirmationOutstanding	boolean	no	—
billingRelationshipChanged	boolean	no	—
effectiveAt	string (date-time)	no	—
grants	Essence.Consent.Core.Application.AppOwnership.AppOwnerChangeGrantView[] | null	no	—
newOrgId	string (uuid)	no	—
newOrgName	string | null	no	—
posture	string | null	no	—
previousOrgId	string (uuid)	no	—
transferId	string (uuid)	no	—

Essence.Consent.Core.Application.AppOwnership.AppOwnerChangeGrantView

Property	Type	Required	Description
acknowledgedAt	string (date-time) | null	no	—
changeId	string (uuid)	no	—
documentId	string (uuid) | null	no	—
grantId	string (uuid)	no	—
grantStatus	string | null	no	—
purpose	string | null	no	—
resolvedAt	string (date-time) | null	no	—
state	string | null	no	—

Essence.Consent.Core.Application.AppOwnership.AppOwnerChangeSummaryView

Property	Type	Required	Description
appId	string | null	no	—
appName	string | null	no	—
billingConfirmationOutstanding	boolean	no	—
billingRelationshipChanged	boolean	no	—
effectiveAt	string (date-time)	no	—
grantCount	integer (int32)	no	—
heldGrantCount	integer (int32)	no	—
newOrgId	string (uuid)	no	—
newOrgName	string | null	no	—
outstanding	boolean	no	—
posture	string | null	no	—
revokedGrantCount	integer (int32)	no	—
scopes	string[] | null	no	—
transferId	string (uuid)	no	—

Essence.Consent.Core.Application.AppSunset.AppSunsetCohortRowView

Property	Type	Required	Description
endedAt	string (date-time) | null	no	—
extensionRequested	boolean	no	—
grantCount	integer (int32)	no	—
notifiedAt	string (date-time)	no	—
state	string | null	no	—
subjectId	string (uuid)	no	—

Essence.Consent.Core.Application.AppSunset.AppSunsetCohortView

Property	Type	Required	Description
appId	string | null	no	—
appName	string | null	no	—
daysRemaining	integer (int32)	no	—
deadlineAt	string (date-time)	no	—
deprecationId	string (uuid)	no	—
rows	Essence.Consent.Core.Application.AppSunset.AppSunsetCohortRowView[] | null	no	—
truncated	boolean	no	—
unattributedCount	integer (int32)	no	—

Essence.Consent.Core.Application.AppSunset.AppSunsetDetailView

Property	Type	Required	Description
activeGrantCount	integer (int32)	no	—
appId	string | null	no	—
appName	string | null	no	—
daysRemaining	integer (int32)	no	—
deadlineAt	string (date-time)	no	—
deprecationId	string (uuid)	no	—
exportAvailable	boolean	no	—
extensionRequested	boolean	no	—
remindAt	string (date-time) | null	no	—
sharedItems	Essence.Consent.Core.Application.AppSunset.AppSunsetSharedItemView[] | null	no	—

Essence.Consent.Core.Application.AppSunset.AppSunsetSharedItemView

Property	Type	Required	Description
allowDownload	boolean	no	—
available	boolean	no	—
documentId	string (uuid) | null	no	—
grantActive	boolean	no	—
grantId	string (uuid)	no	—
noticeState	string | null	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—

Essence.Consent.Core.Application.AppSunset.AppSunsetSummaryView

Property	Type	Required	Description
appId	string | null	no	—
appName	string | null	no	—
daysRemaining	integer (int32)	no	—
deadlineAt	string (date-time)	no	—
deprecationId	string (uuid)	no	—
extensionRequested	boolean	no	—
grantCount	integer (int32)	no	—
remindAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.Commands.AccountCapture.AccountCaptureContextResult

Property	Type	Required	Description
becomesOrgManaged	Essence.Consent.Core.Application.Commands.AccountCapture.OwnershipDataClassRow[] | null	no	—
capabilities	Essence.Consent.Core.Application.Commands.AccountCapture.CaptureCapabilityStatement[] | null	no	—
domain	string | null	no	—
domainVerifiedAt	string (date-time)	no	—
expiresAt	string (date-time)	no	—
organizationName	string | null	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
requestId	string (uuid)	no	—
scopedRoleName	string | null	no	—
status	string | null	no	—
staysYours	Essence.Consent.Core.Application.Commands.AccountCapture.OwnershipDataClassRow[] | null	no	—
subjectEmailMasked	string | null	no	—
verifiedByName	string | null	no	—

Essence.Consent.Core.Application.Commands.AccountCapture.AccountCaptureDecisionResult

Property	Type	Required	Description
captureRequestId	string (uuid)	no	—
decidedAt	string (date-time)	no	—
receipt	Essence.Consent.Core.Application.Commands.AccountCapture.CaptureConsentReceiptDto	no	—
status	Essence.Consent.Core.Domain.Enums.AccountCaptureStatus	no	—
statusName	string | null	no	—

Essence.Consent.Core.Application.Commands.AccountCapture.AccountCaptureRequestResult

Property	Type	Required	Description
accountId	string (uuid)	no	—
captureRequestId	string (uuid)	no	—
dataClassesRetained	string[] | null	no	—
dataClassesShared	string[] | null	no	—
decidedAt	string (date-time) | null	no	—
domain	string | null	no	—
expiresAt	string (date-time)	no	—
lawfulBasis	string | null	no	—
noticeAccessToken	string | null	no	—
organizationId	string (uuid)	no	—
organizationName	string | null	no	—
purpose	Essence.Consent.Core.Domain.Enums.ConsentPurpose	no	—
purposeName	string | null	no	—
receiptId	string | null	no	—
scopedRoleTemplate	string | null	no	—
status	Essence.Consent.Core.Domain.Enums.AccountCaptureStatus	no	—
statusName	string | null	no	—
subjectEmailMasked	string | null	no	—
subjectId	string (uuid)	no	—

Essence.Consent.Core.Application.Commands.AccountCapture.CaptureCapabilityStatement

Property	Type	Required	Description
allowed	boolean	no	—
statement	string | null	no	—

Essence.Consent.Core.Application.Commands.AccountCapture.CaptureConsentReceiptDto

Property	Type	Required	Description
contentHash	string | null	no	—
dataClassesRetained	string[] | null	no	—
dataClassesShared	string[] | null	no	—
decidedAt	string (date-time)	no	—
decision	Essence.Consent.Core.Domain.Enums.AccountCaptureStatus	no	—
decisionName	string | null	no	—
domain	string | null	no	—
lawfulBasis	string | null	no	—
organizationName	string | null	no	—
presentationAttestation	string | null	no	—
purpose	Essence.Consent.Core.Domain.Enums.ConsentPurpose	no	—
purposeName	string | null	no	—
receiptId	string | null	no	—
requestId	string (uuid)	no	—
subjectEmailMasked	string | null	no	—

Essence.Consent.Core.Application.Commands.AccountCapture.OwnershipDataClassRow

Property	Type	Required	Description
dataClass	string | null	no	—
detail	string | null	no	—
key	string | null	no	—
label	string | null	no	—
side	string | null	no	—

Essence.Consent.Core.Application.Commands.Bundle.AttachBundleSubscriptionCommand

Property	Type	Required	Description
attachedBy	string (uuid)	no	—
attachedByOrganizationId	string (uuid) | null	no	—
bundleId	string (uuid)	no	—
maxSyncs	integer (int32) | null	no	—
subscriptionId	string (uuid)	no	—
syncType	string | null	no	—
validFrom	string (date-time) | null	no	—
validTo	string (date-time) | null	no	—

Essence.Consent.Core.Application.Commands.Bundle.CreateConsentBundleCommand

Property	Type	Required	Description
complianceFramework	string | null	no	—
description	string | null	no	—
granteeId	string (uuid)	no	—
granteeType	string | null	no	—
isRegulatedData	boolean	no	—
items	Essence.Consent.Core.Application.Commands.Bundle.CreateConsentBundleItemInput[] | null	no	—
name	string | null	no	—
policyAllowDownload	boolean	no	—
policyAllowForward	boolean	no	—
policyAllowPrint	boolean	no	—
policyExpiresAt	string (date-time) | null	no	—
policyMaxAccessCount	integer (int32) | null	no	—
purpose	string | null	no	—
terminatesOnEventReference	string | null	no	—
terminatesOnEventType	string | null	no	—

Essence.Consent.Core.Application.Commands.Bundle.CreateConsentBundleItemInput

Property	Type	Required	Description
authTagBase64	string | null	no	—
documentDescription	string | null	no	—
documentId	string (uuid)	no	—
isRequired	boolean	no	—
nonceBase64	string | null	no	—
sharedBlobReference	string | null	no	—
wrappedSharingKey	string | null	no	—

Essence.Consent.Core.Application.Commands.Connection.AcceptConnectionConsentCommand

Property	Type	Required	Description
accepterDisclosesFields	string[] | null	no	—
accepterId	string (uuid)	no	—
accountVerified	boolean	no	—
connectionRequestId	string (uuid)	no	—
credentialState	string | null	no	—
expiresAt	string (date-time) | null	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
requesterDisclosesFields	string[] | null	no	—
requesterId	string (uuid)	no	—
trustResolution	string | null	no	—
verificationStubId	string | null	no	—

Essence.Consent.Core.Application.Commands.ConsentHistory.BulkRevocationEvidence

Property	Type	Required	Description
coRecipientIdentifiersIncluded	boolean	no	—
consentId	string (uuid)	no	—
noticeDispatched	boolean	no	—
noticeRecipientCount	integer (int32)	no	—
outcome	string | null	no	—
recordedInConsentHistory	boolean	no	—
skipReason	string | null	no	—

Essence.Consent.Core.Application.Commands.ConsentHistory.BulkRevocationResponse

Property	Type	Required	Description
errors	string[] | null	no	—
evidence	Essence.Consent.Core.Application.Commands.ConsentHistory.BulkRevocationEvidence[] | null	no	—
failedConsentIds	(string (uuid))[] | null	no	—
failedRevocations	integer (int32)	no	—
pendingConsentIds	(string (uuid))[] | null	no	—
pendingRevocations	integer (int32)	no	—
revocationBatchId	string (uuid)	no	—
revokedConsentIds	(string (uuid))[] | null	no	—
skippedConsents	Essence.Consent.Core.Application.Commands.ConsentHistory.BulkRevocationSkip[] | null	no	—
skippedRevocations	integer (int32)	no	—
successfulRevocations	integer (int32)	no	—
totalRequested	integer (int32)	no	—

Essence.Consent.Core.Application.Commands.ConsentHistory.BulkRevocationSkip

Property	Type	Required	Description
consentId	string (uuid)	no	—
legalHoldId	string (uuid) | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Application.Commands.ConsentHistory.BulkRevokeConsentsCommand

Property	Type	Required	Description
cascadeRevocation	boolean	no	—
consentIds	(string (uuid))[] | null	no	—
reason	string | null	no	—
revokedBy	string (uuid)	no	—
sendNotifications	boolean	no	—

Essence.Consent.Core.Application.Commands.CourtAuthority.CourtAuthorityScopeInput

Property	Type	Required	Description
categoryKey	string | null	no	—
displayLabel	string | null	no	—
orderClause	string | null	no	—

Essence.Consent.Core.Application.Commands.CrossInstance.RequestConsentMirrorCommand

Property	Type	Required	Description
complianceFramework	string | null	no	—
correlationId	string | null	no	—
documentId	string (uuid)	no	—
granteeId	string (uuid)	no	—
grantorId	string (uuid)	no	—
grantorRegion	string | null	no	—
originGrantId	string (uuid)	no	—
recipientRegion	string | null	no	—
targetInstanceId	string | null	no	—
transferJustification	string | null	no	—
transferMechanism	string | null	no	—
wrappedFileKey	Essence.Consent.Core.Contracts.DTOs.WrappedFileKeyEnvelopeDto	no	—

Essence.Consent.Core.Application.Commands.DeceasedTeardown.DeceasedConsentTeardownSkip

Property	Type	Required	Description
consentId	string (uuid)	no	—
legalHoldId	string (uuid) | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Application.Commands.EmergencyAccess.EmergencyAccessAuthorizationDto

Property	Type	Required	Description
authorizedAt	string (date-time)	no	—
id	string (uuid)	no	—
inactivityWaitDays	integer (int32)	no	—
lastProofOfLifeAt	string (date-time) | null	no	—
legalBasis	Essence.Consent.Core.Domain.Entities.EmergencyAccess.EmergencyAccessLegalBasis	no	—
legalBasisLabel	string | null	no	—
proofOfLifeCadenceDays	integer (int32)	no	—
proofOfLifeCount	integer (int32)	no	—
releasableCategories	string[] | null	no	—
revokedAt	string (date-time) | null	no	—
status	Essence.Consent.Core.Domain.Entities.EmergencyAccess.EmergencyAccessStatus	no	—
trustedContactId	string (uuid)	no	—

Essence.Consent.Core.Application.Commands.InFlightActions.PersistInFlightActionCommand

Property	Type	Required	Description
encryptedInputPayload	string | null	no	—
journeyKey	string | null	no	—
ownerId	string (uuid)	no	—
requiredAssuranceLevel	string | null	no	—
stepKey	string | null	no	—
ttlMinutes	integer (int32)	no	—

Essence.Consent.Core.Application.Commands.LegalNameChange.DisclosureResultDto

Property	Type	Required	Description
auditEventId	string (uuid)	no	—
disclosedAt	string (date-time)	no	—
notifiedCount	integer (int32)	no	—

Essence.Consent.Core.Application.Commands.LegalNameChange.NameChangeIntakePolicyDto

Property	Type	Required	Description
acceptance	Essence.Consent.Core.Domain.Entities.LegalNameChange.IntakeAcceptanceMode	no	—
authoredBy	string (uuid) | null	no	—
configuredAt	string (date-time)	no	—
effectiveFrom	string (date-time) | null	no	—
graceWindowDays	integer (int32)	no	—
requireDeedPollEvidence	boolean	no	—
routingTeam	string | null	no	—
version	integer (int32) | null	no	—

Essence.Consent.Core.Application.Commands.MutualDisclosure.OpenMutualDisclosureExchangeCommand

Property	Type	Required	Description
matterId	string (uuid)	no	—
partnerAId	string (uuid)	no	—
partnerBId	string (uuid)	no	—
purposeDescription	string | null	no	—
requiredCategories	string[] | null	no	—

Essence.Consent.Core.Application.Commands.Presentation.DisclosedFieldInput

Property	Type	Required	Description
assuranceLevel	string | null	no	—
disclosureDigest	string | null	no	—
fieldKey	string | null	no	—
signingKeyRef	string | null	no	—

Essence.Consent.Core.Application.Commands.QRCode.CompleteQRCodeSessionCommand

Property	Type	Required	Description
nonce	string | null	no	—
qrCodeShareId	string (uuid)	no	—
sessionId	string (uuid)	no	—

Essence.Consent.Core.Application.Commands.QRCode.GenerateQRCodeCommand

Property	Type	Required	Description
allowedScanners	(string (uuid))[] | null	no	—
brandingColor	string | null	no	—
consentGrantId	string (uuid) | null	no	—
customMessage	string | null	no	—
documentId	string (uuid)	no	—
expiryMinutes	integer (int32)	no	—
grantorId	string (uuid)	no	—
grantorPublicKey	string | null	no	—
isOneTimeUse	boolean	no	—
logoUrl	string | null	no	—
maxScans	integer (int32) | null	no	—
notifyOnScan	boolean	no	—
purpose	string | null	no	—
requireAuthentication	boolean	no	—

Essence.Consent.Core.Application.Commands.QRCode.GenerateQRCodeResponse

Property	Type	Required	Description
createdAt	string (date-time)	no	—
expiresAt	string (date-time)	no	—
isOneTimeUse	boolean	no	—
maxScans	integer (int32) | null	no	—
qrCodeImageData	string | null	no	—
qrCodeShareId	string (uuid)	no	—
verificationToken	string | null	no	—

Essence.Consent.Core.Application.Commands.QRCode.ScanQRCodeCommand

Property	Type	Required	Description
qrCodeShareId	string (uuid)	no	—
scannerId	string (uuid)	no	—
scannerPublicKey	string | null	no	—
startE2ESession	boolean	no	—
verificationToken	string | null	no	—

Essence.Consent.Core.Application.Commands.QRCode.ScanQRCodeResponse

Property	Type	Required	Description
documentId	string (uuid)	no	—
encryptedDataToken	string | null	no	—
grantorPublicKey	string | null	no	—
qrCodeShareId	string (uuid)	no	—
scanCount	integer (int32)	no	—
scannedAt	string (date-time)	no	—
sessionId	string (uuid) | null	no	—

Essence.Consent.Core.Application.Commands.QRCode.StartQRCodeSessionCommand

Property	Type	Required	Description
qrCodeShareId	string (uuid)	no	—
scannerPublicKey	string | null	no	—
scannerUserId	string (uuid)	no	—
sessionDurationMinutes	integer (int32)	no	—
verificationToken	string | null	no	—

Essence.Consent.Core.Application.Commands.QRCode.StartQRCodeSessionResponse

Property	Type	Required	Description
expiresAt	string (date-time)	no	—
grantorPublicKey	string | null	no	—
nonce	string | null	no	—
sessionId	string (uuid)	no	—

Essence.Consent.Core.Application.Commands.Reciprocal.InitiateReciprocalExchangeCommand

Property	Type	Required	Description
counterpartyId	string (uuid)	no	—
initiatorFields	string[] | null	no	—
initiatorId	string (uuid)	no	—
offerLifetimeDays	integer (int32)	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
requestedFields	string[] | null	no	—

Essence.Consent.Core.Application.Commands.Renewal.RenewalGrantOutcome

Property	Type	Required	Description
consentId	string (uuid)	no	—
disposition	string | null	no	—
granteeId	string (uuid)	no	—
reason	string | null	no	—

Essence.Consent.Core.Application.Commands.Renewal.RenewalRepointResult

Property	Type	Required	Description
awaitingReconfirmation	integer (int32)	no	—
carriedForward	integer (int32)	no	—
grants	Essence.Consent.Core.Application.Commands.Renewal.RenewalGrantOutcome[] | null	no	—
leftAlone	integer (int32)	no	—
previewOnly	boolean	no	—

Essence.Consent.Core.Application.Commands.SpecialAssistance.AssistanceOutcomeBatchFailureDto

Property	Type	Required	Description
notificationId	string (uuid)	no	—
reason	string | null	no	—

Essence.Consent.Core.Application.Commands.SpecialAssistance.AssistanceOutcomeBatchResultDto

Property	Type	Required	Description
skipped	Essence.Consent.Core.Application.Commands.SpecialAssistance.AssistanceOutcomeBatchFailureDto[] | null	no	—
updated	Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceRosterItemDto[] | null	no	—

Essence.Consent.Core.Application.Commands.ThirdParty.InviteThirdPartyConsentCommand

Property	Type	Required	Description
authorityReference	string | null	no	—
complianceFramework	string | null	no	—
dataSubjectId	string (uuid) | null	no	—
delegationExpiresAt	string (date-time) | null	no	—
delegationIssuedAt	string (date-time)	no	—
delegationType	string | null	no	—
documentId	string (uuid) | null	no	—
expiresAt	string (date-time) | null	no	—
granteeEmail	string | null	no	—
granteeId	string (uuid)	no	—
granteeType	string | null	no	—
invitationLifetimeDays	integer (int32) | null	no	—
issuingAuthority	string | null	no	—
jurisdiction	string | null	no	—
organizationId	string (uuid) | null	no	—
organizationName	string | null	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
requestedFields	Essence.Consent.Core.Application.Commands.ThirdParty.RequestedFieldInput[] | null	no	—
subjectContact	string | null	no	—
subjectDisplayName	string | null	no	—

Essence.Consent.Core.Application.Commands.ThirdParty.RequestedFieldInput

Property	Type	Required	Description
justification	string | null	no	—
key	string | null	no	—
required	boolean	no	—

Essence.Consent.Core.Application.Commands.VerifiedChange.ContactPreviousNameVisibilityDto

Property	Type	Required	Description
contactId	string (uuid)	no	—
governingGrantId	string (uuid) | null	no	—
state	Essence.Consent.Core.Domain.Entities.VerifiedChange.PreviousNameVisibilityState	no	—
stateDescription	string | null	no	—

Essence.Consent.Core.Application.Commands.VerifiedChange.PreviousNameDispositionResult

Property	Type	Required	Description
changeId	string (uuid)	no	—
choice	Essence.Consent.Core.Domain.Entities.VerifiedChange.PreviousNameDispositionChoice	no	—
decidedAt	string (date-time)	no	—
dispositionId	string (uuid)	no	—
recomputations	Essence.Consent.Core.Application.Commands.VerifiedChange.ContactPreviousNameVisibilityDto[] | null	no	—
redactedCount	integer (int32)	no	—
visibleCount	integer (int32)	no	—

Essence.Consent.Core.Application.Commands.VerifiedChange.VerifiedChangeMemberOutcomeDto

Property	Type	Required	Description
governingGrantId	string (uuid) | null	no	—
memberId	string (uuid)	no	—
outcome	Essence.Consent.Core.Domain.Entities.VerifiedChange.VerifiedChangeRecipientOutcome	no	—
reason	Essence.Consent.Core.Domain.Entities.VerifiedChange.VerifiedChangeExclusionReason	no	—
reasonDescription	string | null	no	—

Essence.Consent.Core.Application.Commands.VerifiedChange.VerifiedChangeReconciliationResult

Property	Type	Required	Description
changeId	string (uuid)	no	—
excluded	Essence.Consent.Core.Application.Commands.VerifiedChange.VerifiedChangeMemberOutcomeDto[] | null	no	—
excludedCount	integer (int32)	no	—
reconciledAt	string (date-time)	no	—
reconciliationId	string (uuid)	no	—
willReceive	Essence.Consent.Core.Application.Commands.VerifiedChange.VerifiedChangeMemberOutcomeDto[] | null	no	—
willReceiveCount	integer (int32)	no	—

Essence.Consent.Core.Application.Commands.WalletClaimConsent.WalletClaimConsentInput

Property	Type	Required	Description
dedupeToken	string | null	no	—
disclosureRef	string | null	no	—
sealAlgorithm	string | null	no	—
sealedConsent	string | null	no	—

Essence.Consent.Core.Application.DTOs.ApproveDocumentRequestResultDto

Property	Type	Required	Description
auditAnchorHash	string | null	no	—
decidedAt	string (date-time)	no	—
deliveryModel	Essence.Consent.Core.Domain.Enums.DocumentDeliveryModel	no	—
documentRequestId	string (uuid)	no	—
fulfillingConsentGrantId	string (uuid)	no	—
fulfillingGrantVersion	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.BulkCaptureConsentResultDto

Property	Type	Required	Description
notices	Essence.Consent.Core.Application.DTOs.CaptureNoticeIssueDto[] | null	no	—
reachedNoOne	boolean	no	—
requested	integer (int32)	no	—
skipped	Essence.Consent.Core.Application.DTOs.BulkCaptureConsentSkipDto[] | null	no	—

Essence.Consent.Core.Application.DTOs.BulkCaptureConsentSkipDto

Property	Type	Required	Description
captureId	string (uuid)	no	—
reason	string | null	no	—

Essence.Consent.Core.Application.DTOs.Bundle.BundleSubscriptionPolicyDto

Property	Type	Required	Description
maxSyncs	integer (int32) | null	no	—
syncType	string | null	no	—
syncsUsed	integer (int32)	no	—
validFrom	string (date-time) | null	no	—
validTo	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.Bundle.BundleSubscriptionStatusDto

Property	Type	Required	Description
bundleId	string (uuid)	no	—
eligible	boolean	no	—
maxSyncs	integer (int32) | null	no	—
routing	string | null	no	—
subscriptionId	string (uuid)	no	—
syncType	string | null	no	—
syncsRemaining	integer (int32) | null	no	—
syncsUsed	integer (int32)	no	—
validFrom	string (date-time) | null	no	—
validTo	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleDto

Property	Type	Required	Description
acceptedAt	string (date-time) | null	no	—
activeItemCount	integer (int32)	no	—
complianceFramework	string | null	no	—
createdAt	string (date-time)	no	—
description	string | null	no	—
expiredAt	string (date-time) | null	no	—
granteeId	string (uuid)	no	—
granteeType	string | null	no	—
grantorId	string (uuid)	no	—
id	string (uuid)	no	—
isRegulatedData	boolean	no	—
items	Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleItemDto[] | null	no	—
name	string | null	no	—
purpose	string | null	no	—
rejectedAt	string (date-time) | null	no	—
rejectionReason	string | null	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
revokedBy	string (uuid) | null	no	—
status	string | null	no	—
submittedAt	string (date-time) | null	no	—
subscriptionId	string (uuid) | null	no	—
subscriptionPolicy	Essence.Consent.Core.Application.DTOs.Bundle.BundleSubscriptionPolicyDto	no	—
terminatedOnEventAt	string (date-time) | null	no	—
terminatesOnEventReference	string | null	no	—
terminatesOnEventType	string | null	no	—
totalItemCount	integer (int32)	no	—
updatedAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.Bundle.ConsentBundleItemDto

Property	Type	Required	Description
consentGrantId	string (uuid) | null	no	—
documentDescription	string | null	no	—
documentId	string (uuid)	no	—
id	string (uuid)	no	—
isRequired	boolean	no	—
isRevoked	boolean	no	—
revokedAt	string (date-time) | null	no	—
sortOrder	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.CaptureDecisionResultDto

Property	Type	Required	Description
captureId	string (uuid)	no	—
decidedAt	string (date-time)	no	—
receipt	Essence.Consent.Core.Application.DTOs.CaptureReceiptDto	no	—
releasedContactId	string (uuid) | null	no	—
status	Essence.Consent.Core.Domain.Enums.CaptureEscrowStatus	no	—

Essence.Consent.Core.Application.DTOs.CaptureHoldingEntryDto

Property	Type	Required	Description
captureId	string (uuid)	no	—
capturedAt	string (date-time)	no	—
consentRequestCount	integer (int32)	no	—
counterparty	string | null	no	—
counterpartyRole	string | null	no	—
counterpartyUserId	string (uuid) | null	no	—
decidedAt	string (date-time) | null	no	—
escrowExpiresAt	string (date-time)	no	—
eventContext	string | null	no	—
eventContextCiphertext	string | null	no	—
fields	string[] | null	no	—
payloadPurged	boolean	no	—
status	string | null	no	—

Essence.Consent.Core.Application.DTOs.CaptureHoldingsCoverageDto

Property	Type	Required	Description
capturesIHoldWithNoLinkedSubject	integer (int32)	no	—
generatedAt	string (date-time)	no	—
recordTypes	string[] | null	no	—
subjectLinkage	string | null	no	—

Essence.Consent.Core.Application.DTOs.CaptureHoldingsDto

Property	Type	Required	Description
coverage	Essence.Consent.Core.Application.DTOs.CaptureHoldingsCoverageDto	no	—
heldAboutMe	Essence.Consent.Core.Application.DTOs.CaptureHoldingEntryDto[] | null	no	—
iHold	Essence.Consent.Core.Application.DTOs.CaptureHoldingEntryDto[] | null	no	—

Essence.Consent.Core.Application.DTOs.CaptureNoticeDto

Property	Type	Required	Description
captureId	string (uuid)	no	—
capturedAt	string (date-time)	no	—
capturedFieldKeys	string[] | null	no	—
capturerId	string (uuid)	no	—
contextCiphertext	string | null	no	—
escrowExpiresAt	string (date-time)	no	—
privateNoteCiphertext	string | null	no	—
status	Essence.Consent.Core.Domain.Enums.CaptureEscrowStatus	no	—

Essence.Consent.Core.Application.DTOs.CaptureNoticeIssueDto

Property	Type	Required	Description
captureId	string (uuid)	no	—
escrowExpiresAt	string (date-time)	no	—
noticeToken	string | null	no	—

Essence.Consent.Core.Application.DTOs.CaptureReceiptDto

Property	Type	Required	Description
captureId	string (uuid)	no	—
capturedFieldKeys	string[] | null	no	—
capturerId	string (uuid)	no	—
issuedAt	string (date-time)	no	—
receiptHash	string | null	no	—

Essence.Consent.Core.Application.DTOs.ChangeRequest.ConsentChangeRequestDto

Property	Type	Required	Description
consentGrantId	string (uuid)	no	—
createdAt	string (date-time)	no	—
granteeId	string (uuid)	no	—
grantorId	string (uuid)	no	—
id	string (uuid)	no	—
message	string | null	no	—
requestedChange	string | null	no	—
requestedExpiresAt	string (date-time) | null	no	—
resolutionNote	string | null	no	—
resolvedAt	string (date-time) | null	no	—
status	string | null	no	—

Essence.Consent.Core.Application.DTOs.ChannelPreferenceDto

Property	Type	Required	Description
channel	string | null	no	—
optIn	boolean	no	—

Essence.Consent.Core.Application.DTOs.CommunicationChannelStateDto

Property	Type	Required	Description
channel	string | null	no	—
grantedAt	string (date-time) | null	no	—
optedIn	boolean	no	—
withdrawnAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.CommunicationsConsentStateDto

Property	Type	Required	Description
channels	Essence.Consent.Core.Application.DTOs.CommunicationChannelStateDto[] | null	no	—
lastAnchorTransactionId	string | null	no	—
lastWithdrawalSource	string | null	no	—
lawfulBasis	string | null	no	—
updatedAt	string (date-time)	no	—
userId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.ComplianceReportDto

Property	Type	Required	Description
consents	Essence.Consent.Core.Application.DTOs.ConsentSummaryDto[] | null	no	—
endDate	string (date-time) | null	no	—
generatedAt	string (date-time)	no	—
reportId	string (uuid)	no	—
reportType	string | null	no	—
startDate	string (date-time) | null	no	—
statistics	Essence.Consent.Core.Application.DTOs.ComplianceStatisticsDto	no	—
summary	string | null	no	—
violations	Essence.Consent.Core.Application.DTOs.ComplianceViolationDto[] | null	no	—

Essence.Consent.Core.Application.DTOs.ComplianceStatisticsDto

Property	Type	Required	Description
activeConsents	integer (int32)	no	—
averageAccessesPerConsent	number (double)	no	—
averageConsentLifespanDays	number (double)	no	—
earliestConsentDate	string (date-time) | null	no	—
expiredConsents	integer (int32)	no	—
latestConsentDate	string (date-time) | null	no	—
revocationRate	number (double)	no	—
revokedConsents	integer (int32)	no	—
totalAccesses	integer (int32)	no	—
totalConsents	integer (int32)	no	—
totalRevocations	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.ComplianceViolationDto

Property	Type	Required	Description
consentId	string (uuid)	no	—
description	string | null	no	—
detectedAt	string (date-time)	no	—
recommendedAction	string | null	no	—
severity	string | null	no	—
violationType	string | null	no	—

Essence.Consent.Core.Application.DTOs.Connection.ConnectionConsentAcceptanceDto

Property	Type	Required	Description
acceptedAt	string (date-time)	no	—
accepterDisclosesFields	string[] | null	no	—
accepterId	string (uuid)	no	—
accountVerified	boolean	no	—
connectionRequestId	string (uuid)	no	—
createdAt	string (date-time)	no	—
credentialState	string | null	no	—
expiresAt	string (date-time) | null	no	—
id	string (uuid)	no	—
pairedGrantId	string (uuid)	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
receipt	Essence.Consent.Core.Application.DTOs.Connection.ConsentReceiptDto	no	—
requesterDisclosesFields	string[] | null	no	—
requesterId	string (uuid)	no	—
revokeCause	string | null	no	—
revokedAt	string (date-time) | null	no	—
revokedBy	string (uuid) | null	no	—
status	string | null	no	—
trustResolution	string | null	no	—
updatedAt	string (date-time) | null	no	—
verificationStubId	string | null	no	—

Essence.Consent.Core.Application.DTOs.Connection.ConnectionSyncTransparencyDto

Property	Type	Required	Description
connectionConsentId	string (uuid)	no	—
counterpartyId	string (uuid)	no	—
evaluatedAt	string (date-time)	no	—
expiresAt	string (date-time) | null	no	—
fieldsCounterpartySees	Essence.Consent.Core.Application.DTOs.Connection.SyncFieldVisibilityDto[] | null	no	—
fieldsCounterpartyShares	Essence.Consent.Core.Application.DTOs.Connection.SyncFieldVisibilityDto[] | null	no	—
isLive	boolean	no	—
pairedGrantId	string (uuid)	no	—
propagationNote	string | null	no	—
status	string | null	no	—

Essence.Consent.Core.Application.DTOs.Connection.ConsentReceiptDto

Property	Type	Required	Description
accepterDisclosesScope	string[] | null	no	—
accountVerified	boolean	no	—
credentialState	string | null	no	—
expiresAt	string (date-time) | null	no	—
issuedAt	string (date-time)	no	—
legalBasis	string | null	no	—
purpose	string | null	no	—
receiptNumber	string | null	no	—
requesterDisclosesScope	string[] | null	no	—
trustResolution	string | null	no	—
verificationStubId	string | null	no	—

Essence.Consent.Core.Application.DTOs.Connection.SyncFieldVisibilityDto

Property	Type	Required	Description
fieldGroup	string | null	no	—
propagatesOnEdit	boolean	no	—
visibleNow	boolean	no	—

Essence.Consent.Core.Application.DTOs.ConsentChangeRecordDto

Property	Type	Required	Description
changeType	string | null	no	—
description	string | null	no	—
ipAddress	string | null	no	—
newStatus	string | null	no	—
performedBy	string (uuid) | null	no	—
previousStatus	string | null	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
reason	string | null	no	—
relatedEntityId	string | null	no	—
timestamp	string (date-time)	no	—
userAgent	string | null	no	—
version	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.ConsentHistoryDto

Property	Type	Required	Description
accessFrequency	number (double)	no	—
changes	Essence.Consent.Core.Application.DTOs.ConsentChangeRecordDto[] | null	no	—
consentId	string (uuid)	no	—
consentLifespan	System.TimeSpan	no	—
currentVersion	integer (int32)	no	—
documentId	string (uuid)	no	—
granteeId	string (uuid)	no	—
grantorId	string (uuid)	no	—
historyHash	string | null	no	—
id	string (uuid)	no	—
initialCreationDate	string (date-time)	no	—
isExpired	boolean	no	—
isRevoked	boolean	no	—
lastModifiedDate	string (date-time)	no	—
stateTransitionCount	integer (int32)	no	—
totalAccessCount	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.ConsentHistoryStatisticsDto

Property	Type	Required	Description
activeConsents	integer (int32)	no	—
averageAccessesPerConsent	number (double)	no	—
averageLifespanDays	number (double)	no	—
expiredConsents	integer (int32)	no	—
highFrequencyConsents	integer (int32)	no	—
revokedConsents	integer (int32)	no	—
totalAccesses	integer (int32)	no	—
totalConsents	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.ConsentStateAsAtDto

Property	Type	Required	Description
asAtUtc	string (date-time)	no	—
consentId	string (uuid)	no	—
effectiveStatus	string | null	no	—
effectiveVersion	integer (int32)	no	—
existed	boolean	no	—
lastChangeAtUtc	string (date-time) | null	no	—
lastChangeType	string | null	no	—
lastChangedBy	string (uuid) | null	no	—

Essence.Consent.Core.Application.DTOs.ConsentSummaryDto

Property	Type	Required	Description
accessCount	integer (int32)	no	—
complianceFramework	string | null	no	—
consentId	string (uuid)	no	—
documentId	string (uuid)	no	—
expiresAt	string (date-time) | null	no	—
grantedAt	string (date-time)	no	—
granteeId	string (uuid)	no	—
granteeType	string | null	no	—
grantorId	string (uuid)	no	—
isRegulatedData	boolean	no	—
purpose	string | null	no	—
revokedAt	string (date-time) | null	no	—
status	string | null	no	—

Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtAuthorityAccessDecisionDto

Property	Type	Required	Description
authorityId	string (uuid) | null	no	—
granted	boolean	no	—
orderReference	string | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtAuthorityScopeDto

Property	Type	Required	Description
categoryKey	string | null	no	—
displayLabel	string | null	no	—
orderClause	string | null	no	—

Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtConferredAuthorityDto

Property	Type	Required	Description
activatedAt	string (date-time) | null	no	—
deputyId	string (uuid)	no	—
effectiveFrom	string (date-time)	no	—
effectiveUntil	string (date-time) | null	no	—
endNote	string | null	no	—
endReason	string | null	no	—
endedAt	string (date-time) | null	no	—
id	string (uuid)	no	—
inForce	boolean	no	—
issuingCourt	string | null	no	—
jurisdiction	string | null	no	—
lastVariationNote	string | null	no	—
lastVariedAt	string (date-time) | null	no	—
nextReportDueOn	string (date-time) | null	no	—
orderMadeOn	string (date-time)	no	—
orderReference	string | null	no	—
orderType	string | null	no	—
reportingCadence	string | null	no	—
reportingPeriodEnd	string (date-time) | null	no	—
reportingPeriodStart	string (date-time) | null	no	—
scope	Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtAuthorityScopeDto[] | null	no	—
status	string | null	no	—
supervisionLevel	string | null	no	—
variationCount	integer (int32)	no	—
wardId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.CourtAuthority.DeputyshipAuthorityTerminationDto

Property	Type	Required	Description
accessCeasedAt	string (date-time)	no	—
action	string | null	no	—
authorityId	string (uuid)	no	—
deputyId	string (uuid)	no	—
orderReference	string | null	no	—
wasActivated	boolean	no	—

Essence.Consent.Core.Application.DTOs.CourtAuthority.DeputyshipTerminationNoticeDto

Property	Type	Required	Description
anyStillInForce	boolean	no	—
authorities	Essence.Consent.Core.Application.DTOs.CourtAuthority.CourtConferredAuthorityDto[] | null	no	—
endReason	string | null	no	—
endedAt	string (date-time) | null	no	—
handoverTo	string | null	no	—
notifyParties	string[] | null	no	—
preservationBasis	string | null	no	—
recordsPreserved	boolean	no	—
wardId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.CourtAuthority.DeputyshipTerminationOutcomeDto

Property	Type	Required	Description
authorities	Essence.Consent.Core.Application.DTOs.CourtAuthority.DeputyshipAuthorityTerminationDto[] | null	no	—
determinationOutcome	string | null	no	—
determinationReference	string | null	no	—
determinedOn	string (date-time)	no	—
determiningBody	string | null	no	—
handoverTo	string | null	no	—
notifyParties	string[] | null	no	—
preservationBasis	string | null	no	—
recordedAt	string (date-time)	no	—
recordsPreserved	boolean	no	—
wardId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.CreateDocumentRequestResultDto

Property	Type	Required	Description
documentRequestId	string (uuid)	no	—
expiresAt	string (date-time) | null	no	—
requestedAt	string (date-time)	no	—
requesterVisibleStatus	Essence.Consent.Core.Domain.Enums.DocumentRequestRequesterVisibleStatus	no	—

Essence.Consent.Core.Application.DTOs.CrossBorder.CrossBorderConsentGrantDto

Property	Type	Required	Description
assuranceLevelReliedUpon	string | null	no	—
id	string (uuid)	no	—
jurisdiction	string | null	no	—
legalBasis	string | null	no	—
minimumMet	boolean	no	—
minimumRequiredLoa	string | null	no	—
relyingPartyRef	string | null	no	—
status	string | null	no	—
subjectRef	string | null	no	—
subjectStandingCode	string | null	no	—
userId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.CrossBorder.JurisdictionTransferDecisionDto

Property	Type	Required	Description
complianceFramework	string | null	no	—
grantorRegion	string | null	no	—
isAllowed	boolean	no	—
isCrossBorder	boolean	no	—
isIntraRegion	boolean	no	—
mechanism	string | null	no	—
message	string | null	no	—
reasonCode	string | null	no	—
recipientRegion	string | null	no	—

Essence.Consent.Core.Application.DTOs.CrossBorder.RecipientLegalBasisDto

Property	Type	Required	Description
heading	string | null	no	—
legalBasisCode	string | null	no	—
plainLanguage	string | null	no	—
recipientClass	string | null	no	—
revocable	boolean	no	—
subjectStanding	string | null	no	—
withdrawalMeaning	string | null	no	—

Essence.Consent.Core.Application.DTOs.CrossInstance.CrossInstanceConsentMirrorDto

Property	Type	Required	Description
acknowledgedAt	string (date-time) | null	no	—
complianceFramework	string | null	no	—
correlationId	string | null	no	—
documentId	string (uuid)	no	—
failureMessage	string | null	no	—
failureReasonCode	string | null	no	—
granteeId	string (uuid)	no	—
grantorId	string (uuid)	no	—
grantorRegion	string | null	no	—
id	string (uuid)	no	—
jurisdictionReasonCode	string | null	no	—
originGrantId	string (uuid)	no	—
originInstanceId	string | null	no	—
recipientRegion	string | null	no	—
requestedAt	string (date-time)	no	—
revocationReason	string | null	no	—
revocationRequestedAt	string (date-time) | null	no	—
revocationRequestedBy	string (uuid) | null	no	—
revokedAt	string (date-time) | null	no	—
role	string | null	no	—
status	string | null	no	—
targetInstanceId	string | null	no	—
transferJustification	string | null	no	—
transferMechanism	string | null	no	—

Essence.Consent.Core.Application.DTOs.DeliverCaptureNoticeResultDto

Property	Type	Required	Description
captureId	string (uuid)	no	—
consentRequestCount	integer (int32)	no	—
escrowExpiresAt	string (date-time)	no	—
inAppDelivery	string | null	no	—
noticeUrl	string | null	no	—

Essence.Consent.Core.Application.DTOs.DisclosureRevealAuditEntryDto

Property	Type	Required	Description
accessExpiry	Essence.Consent.Core.Domain.Enums.RevealAccessExpiry	no	—
auditAnchorHash	string | null	no	—
changeType	Essence.Consent.Core.Domain.Enums.ConsentChangeType	no	—
contentHash	string | null	no	—
expiresAt	string (date-time) | null	no	—
purpose	string | null	no	—
recipientLabel	string | null	no	—
revealId	string (uuid)	no	—
revealedAt	string (date-time)	no	—
revokedAt	string (date-time) | null	no	—
stage	Essence.Consent.Core.Domain.Enums.RevealStage	no	—
status	Essence.Consent.Core.Domain.Enums.RevealGrantStatus	no	—
verifierLink	string | null	no	—
workEntityId	string (uuid)	no	—
workEntryId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.DisclosureRevealResultDto

Property	Type	Required	Description
accessExpiry	Essence.Consent.Core.Domain.Enums.RevealAccessExpiry	no	—
auditAnchorHash	string | null	no	—
contentHash	string | null	no	—
expiresAt	string (date-time) | null	no	—
purpose	string | null	no	—
recipientLabel	string | null	no	—
revealId	string (uuid)	no	—
revealedAt	string (date-time)	no	—
stage	Essence.Consent.Core.Domain.Enums.RevealStage	no	—
status	Essence.Consent.Core.Domain.Enums.RevealGrantStatus	no	—
verifierLink	string | null	no	—
workEntityId	string (uuid)	no	—
workEntryId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.DisclosureRevealRevokeResultDto

Property	Type	Required	Description
revealId	string (uuid)	no	—
revokedAt	string (date-time)	no	—
status	Essence.Consent.Core.Domain.Enums.RevealGrantStatus	no	—

Essence.Consent.Core.Application.DTOs.DocumentRequestAuditRecordDto

Property	Type	Required	Description
auditAnchorHash	string | null	no	—
contactId	string (uuid)	no	—
decidedAt	string (date-time) | null	no	—
documentName	string | null	no	—
documentRequestId	string (uuid)	no	—
outcome	Essence.Consent.Core.Domain.Enums.DocumentRequestRequesterVisibleStatus	no	—
purpose	string | null	no	—
requestedAt	string (date-time)	no	—
requesterId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.DocumentRequestContactDecisionResultDto

Property	Type	Required	Description
decidedAt	string (date-time)	no	—
documentRequestId	string (uuid)	no	—
status	Essence.Consent.Core.Domain.Enums.DocumentRequestStatus	no	—

Essence.Consent.Core.Application.DTOs.DocumentRequestInboundDto

Property	Type	Required	Description
contactId	string (uuid)	no	—
decidedAt	string (date-time) | null	no	—
deliveryModel	Essence.Consent.Core.Domain.Enums.DocumentDeliveryModel	no	—
documentName	string | null	no	—
documentRequestId	string (uuid)	no	—
expiresAt	string (date-time) | null	no	—
fulfillingDocumentId	string (uuid) | null	no	—
purpose	string | null	no	—
requestedAt	string (date-time)	no	—
requesterId	string (uuid)	no	—
status	Essence.Consent.Core.Domain.Enums.DocumentRequestStatus	no	—

Essence.Consent.Core.Application.DTOs.DocumentRequestOutboundDto

Property	Type	Required	Description
contactId	string (uuid)	no	—
decidedAt	string (date-time) | null	no	—
deliveryModel	Essence.Consent.Core.Domain.Enums.DocumentDeliveryModel	no	—
documentName	string | null	no	—
documentRequestId	string (uuid)	no	—
expiresAt	string (date-time) | null	no	—
fulfillingConsentGrantId	string (uuid) | null	no	—
purpose	string | null	no	—
requestedAt	string (date-time)	no	—
status	Essence.Consent.Core.Domain.Enums.DocumentRequestRequesterVisibleStatus	no	—

Essence.Consent.Core.Application.DTOs.EstateDisclosure.EstateDisclosureBasisDto

Property	Type	Required	Description
basisKind	string | null	no	—
claimRef	string | null	no	—
courtOrderRef	string | null	no	—
deceasedRef	string | null	no	—
demandRef	string | null	no	—
executorUserRef	string | null	no	—
id	string (uuid)	no	—
legalBasis	string | null	no	—
recordId	string | null	no	—
recordedAt	string (date-time)	no	—
scopeAudits	Essence.Consent.Core.Application.DTOs.EstateDisclosure.EstateDisclosureScopeAuditDto[] | null	no	—
scopeFieldKeys	string[] | null	no	—
status	string | null	no	—

Essence.Consent.Core.Application.DTOs.EstateDisclosure.EstateDisclosureScopeAuditDto

Property	Type	Required	Description
basisId	string (uuid)	no	—
claimRef	string | null	no	—
disclosedFieldKeys	string[] | null	no	—
id	string (uuid)	no	—
outOfScopeFieldKeys	string[] | null	no	—
recordId	string | null	no	—
recordedAt	string (date-time)	no	—
reportMatchesRecord	boolean	no	—
reportedWithinScope	boolean	no	—
scopeFieldKeys	string[] | null	no	—
status	string | null	no	—
withheldGroupKeys	string[] | null	no	—
withinScope	boolean	no	—

Essence.Consent.Core.Application.DTOs.ExternalDisclosure.ExternalDisclosureDto

Property	Type	Required	Description
claimRef	string | null	no	—
createdAt	string (date-time)	no	—
evidenceRefs	string[] | null	no	—
externalRecipientRef	string | null	no	—
id	string (uuid)	no	—
purpose	string | null	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
shareExpiresAt	string (date-time) | null	no	—
sharePublished	boolean	no	—
shareRef	string | null	no	—
status	string | null	no	—
subjectId	string (uuid)	no	—
updatedAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.ExternalDisclosure.SharedExternalDisclosureDto

Property	Type	Required	Description
expiresAt	string (date-time) | null	no	—
purpose	string | null	no	—
sealedPayload	string | null	no	—

Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyConsumptionDto

Property	Type	Required	Description
accessedAt	string (date-time)	no	—
actorRef	string | null	no	—
role	string | null	no	—
scopeUnwrapped	string | null	no	—

Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyDeskQueueItemDto

Property	Type	Required	Description
accessEndsAt	string (date-time)	no	—
consumptions	Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyConsumptionDto[] | null	no	—
decisionRecordedAt	string (date-time) | null	no	—
disclosureLevel	string | null	no	—
flightDesignator	string | null	no	—
hasClinicalRecord	boolean	no	—
infoRequest	string | null	no	—
nonRetentionAttested	boolean	no	—
remainingAccesses	integer (int32)	no	—
scheduledDepartureUtc	string (date-time)	no	—
shareId	string (uuid)	no	—
sharedAt	string (date-time)	no	—
status	string | null	no	—
tripReference	string | null	no	—

Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyDisclosureDto

Property	Type	Required	Description
accessEndsAt	string (date-time)	no	—
allowDownload	boolean	no	—
allowForward	boolean	no	—
allowPrint	boolean	no	—
clearanceEnvelopeRef	string | null	no	—
clearanceWrappedKey	string | null	no	—
clinicalEnvelopeRef	string | null	no	—
clinicalWrappedKey	string | null	no	—
nonRetentionAttested	boolean	no	—
remainingAccesses	integer (int32)	no	—
scopeUnwrapped	string | null	no	—

Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyShareDto

Property	Type	Required	Description
accessCount	integer (int32)	no	—
accessEndsAt	string (date-time)	no	—
airlineDisplayName	string | null	no	—
airlineOrganizationId	string (uuid)	no	—
allowDownload	boolean	no	—
allowForward	boolean	no	—
allowPrint	boolean	no	—
article49TransferBasis	string | null	no	—
article9Condition	string | null	no	—
consumptions	Essence.Consent.Core.Application.DTOs.FitToFly.FitToFlyConsumptionDto[] | null	no	—
decisionRecordedAt	string (date-time) | null	no	—
disclosureLevel	string | null	no	—
flightDesignator	string | null	no	—
infoRequest	string | null	no	—
isCrossBorder	boolean	no	—
nonRetentionAttested	boolean	no	—
nonRetentionAttestedAt	string (date-time) | null	no	—
recipientJurisdiction	string | null	no	—
remainingAccesses	integer (int32)	no	—
scheduledDepartureUtc	string (date-time)	no	—
shareId	string (uuid)	no	—
sharedAt	string (date-time)	no	—
status	string | null	no	—
tripReference	string | null	no	—

Essence.Consent.Core.Application.DTOs.Handover.ClosureHandoverReportDto

Property	Type	Required	Description
closureId	string (uuid)	no	—
entries	Essence.Consent.Core.Application.DTOs.Handover.ClosureHandoverReportEntryDto[] | null	no	—
generatedAt	string (date-time)	no	—
legalHoldCount	integer (int32)	no	—
reportId	string (uuid)	no	—
subjectDisplayName	string | null	no	—

Essence.Consent.Core.Application.DTOs.Handover.ClosureHandoverReportEntryDto

Property	Type	Required	Description
grantId	string (uuid)	no	—
granteeRef	string (uuid)	no	—
legalHold	boolean	no	—
revocationOutcome	string | null	no	—
shareStateAtClosure	string | null	no	—

Essence.Consent.Core.Application.DTOs.Handover.ClosureLinkStateDto

Property	Type	Required	Description
consentState	string | null	no	—
grantId	string (uuid)	no	—
granteeRef	string (uuid)	no	—
legalHold	boolean	no	—

Essence.Consent.Core.Application.DTOs.HouseholdShare.AdditionalDataSubjectDto

Property	Type	Required	Description
consentStatus	string | null	no	—
relationshipLabel	string | null	no	—
subjectRef	string | null	no	—

Essence.Consent.Core.Application.DTOs.HouseholdShare.HouseholdSharePreviewDto

Property	Type	Required	Description
additionalSubjects	Essence.Consent.Core.Application.DTOs.HouseholdShare.AdditionalDataSubjectDto[] | null	no	—
blocked	boolean	no	—
category	string | null	no	—
detectionPending	boolean	no	—
documentId	string | null	no	—
householdId	string | null	no	—

Essence.Consent.Core.Application.DTOs.HouseholdShare.HouseholdShareResultDto

Property	Type	Required	Description
documentId	string | null	no	—
gateDecisionAuditId	string (uuid)	no	—
grantId	string (uuid)	no	—
householdId	string | null	no	—
sharedAt	string (date-time)	no	—

Essence.Consent.Core.Application.DTOs.InFlightActions.PersistInFlightActionResponse

Property	Type	Required	Description
expiresAt	string (date-time)	no	—
inFlightActionId	string (uuid)	no	—
resumeToken	string | null	no	—

Essence.Consent.Core.Application.DTOs.InFlightActions.ResumeInFlightActionResponse

Property	Type	Required	Description
encryptedInputPayload	string | null	no	—
inFlightActionId	string (uuid)	no	—
journeyKey	string | null	no	—
resumedAt	string (date-time) | null	no	—
status	string | null	no	—
stepKey	string | null	no	—

Essence.Consent.Core.Application.DTOs.InitiateRecordsHandoverResultDto

Property	Type	Required	Description
acceptanceExpiresAt	string (date-time)	no	—
handoverId	string (uuid)	no	—
status	Essence.Consent.Core.Domain.Enums.RecordsHandoverStatus	no	—

Essence.Consent.Core.Application.DTOs.IssueCaptureResultDto

Property	Type	Required	Description
captureId	string (uuid)	no	—
escrowExpiresAt	string (date-time)	no	—
noticeToken	string | null	no	—

Essence.Consent.Core.Application.DTOs.LawfulCompulsion.LawfulCompulsionAccessDecisionDto

Property	Type	Required	Description
authorised	boolean	no	—
basisId	string (uuid)	no	—
decidedAt	string (date-time)	no	—
id	string (uuid)	no	—
outOfScopeRecordTypes	string[] | null	no	—
outcome	string | null	no	—
purpose	string | null	no	—
recordId	string | null	no	—
refusalGround	string | null	no	—
requestedRecordTypes	string[] | null	no	—
subjectRef	string | null	no	—

Essence.Consent.Core.Application.DTOs.LawfulCompulsion.LawfulCompulsionBasisDto

Property	Type	Required	Description
accessDecisions	Essence.Consent.Core.Application.DTOs.LawfulCompulsion.LawfulCompulsionAccessDecisionDto[] | null	no	—
authorityId	string | null	no	—
authorityName	string | null	no	—
basisKind	string | null	no	—
fromDate	string (date-time) | null	no	—
id	string (uuid)	no	—
instrumentReference	string | null	no	—
instrumentType	string | null	no	—
isUnbounded	boolean	no	—
jurisdiction	string | null	no	—
recordId	string | null	no	—
recordTypes	string[] | null	no	—
recordedAt	string (date-time)	no	—
statedPurpose	string | null	no	—
status	string | null	no	—
statuteRef	string | null	no	—
subjectRef	string | null	no	—
toDate	string (date-time) | null	no	—
withdrawalReason	string | null	no	—
withdrawnAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.LegalHold.LegalHoldReleaseRequestDto

Property	Type	Required	Description
consentId	string (uuid)	no	—
daysAwaitingAdjudication	integer (int32)	no	—
documentId	string (uuid)	no	—
granteeId	string (uuid)	no	—
grantorId	string (uuid)	no	—
legalHoldAppliedAt	string (date-time) | null	no	—
legalHoldExpiresAt	string (date-time) | null	no	—
legalHoldId	string (uuid)	no	—
legalHoldOwner	string | null	no	—
legalHoldReason	string | null	no	—
requestReason	string | null	no	—
requestedAt	string (date-time)	no	—
requestedBy	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.MultiGrantee.AuthorizeGranteeFieldRequest

Property	Type	Required	Description
actorRef	string | null	no	—
documentId	string (uuid) | null	no	—
fieldKey	string | null	no	—

Essence.Consent.Core.Application.DTOs.MultiGrantee.CreateMultiGranteeGrantRequest

Property	Type	Required	Description
affirmationStatement	string | null	no	—
article9Condition	Essence.Consent.Core.Domain.Enums.ConsentArticle9Condition	no	—
description	string | null	no	—
expiresAt	string (date-time)	no	—
explicitlySpecialCategoryFields	string[] | null	no	—
grantees	Essence.Consent.Core.Application.DTOs.MultiGrantee.GranteeScopeRequest[] | null	no	—
purpose	Essence.Consent.Core.Domain.Enums.ConsentPurpose	no	—
purposeLimitation	string | null	no	—

Essence.Consent.Core.Application.DTOs.MultiGrantee.GranteeAccessDecisionDto

Property	Type	Required	Description
consentId	string (uuid) | null	no	—
enforcementPoint	string | null	no	—
outcome	Essence.Consent.Core.Domain.Enums.GranteeAccessOutcome	no	—
permitted	boolean	no	—
reason	string | null	no	—

Essence.Consent.Core.Application.DTOs.MultiGrantee.GranteeScopeDto

Property	Type	Required	Description
consentId	string (uuid)	no	—
documentIds	(string (uuid))[] | null	no	—
effectiveFieldScope	string[] | null	no	—
excludedFieldScope	string[] | null	no	—
fieldScope	string[] | null	no	—
granteeId	string (uuid)	no	—
granteeType	Essence.Consent.Core.Domain.Enums.PartyType	no	—
label	string | null	no	—
revokedAt	string (date-time) | null	no	—
role	string | null	no	—
status	Essence.Consent.Core.Domain.Enums.GranteeScopeStatus	no	—

Essence.Consent.Core.Application.DTOs.MultiGrantee.GranteeScopeRequest

Property	Type	Required	Description
documentIds	(string (uuid))[] | null	no	—
excludedFieldScope	string[] | null	no	—
fieldScope	string[] | null	no	—
granteeId	string (uuid)	no	—
granteeType	Essence.Consent.Core.Domain.Enums.PartyType	no	—
label	string | null	no	—
role	string | null	no	—

Essence.Consent.Core.Application.DTOs.MultiGrantee.MultiGranteeGrantDto

Property	Type	Required	Description
affirmationStatement	string | null	no	—
article9Condition	Essence.Consent.Core.Domain.Enums.ConsentArticle9Condition	no	—
consentIds	(string (uuid))[] | null	no	—
description	string | null	no	—
enforcementPoint	string | null	no	—
expiresAt	string (date-time)	no	—
grantId	string (uuid)	no	—
grantedAt	string (date-time)	no	—
grantees	Essence.Consent.Core.Application.DTOs.MultiGrantee.GranteeScopeDto[] | null	no	—
grantorId	string (uuid)	no	—
purpose	Essence.Consent.Core.Domain.Enums.ConsentPurpose	no	—
purposeLimitation	string | null	no	—
revokedAt	string (date-time) | null	no	—
specialCategoryFields	string[] | null	no	—
status	Essence.Consent.Core.Domain.Enums.MultiGranteeGrantStatus	no	—

Essence.Consent.Core.Application.DTOs.MultiGrantee.RevokeMultiGranteeRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Application.DTOs.MutualDisclosure.MutualDisclosureExchangeDto

Property	Type	Required	Description
becameReciprocalAt	string (date-time) | null	no	—
bothDisclosed	boolean	no	—
canProceedToExecution	boolean	no	—
cancelReason	string | null	no	—
cancelledAt	string (date-time) | null	no	—
createdAt	string (date-time)	no	—
equivalent	boolean	no	—
executedAt	string (date-time) | null	no	—
executedBy	string (uuid) | null	no	—
id	string (uuid)	no	—
matterId	string (uuid)	no	—
partnerA	Essence.Consent.Core.Application.DTOs.MutualDisclosure.PartnerDisclosureStatusDto	no	—
partnerAId	string (uuid)	no	—
partnerB	Essence.Consent.Core.Application.DTOs.MutualDisclosure.PartnerDisclosureStatusDto	no	—
partnerBId	string (uuid)	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
requiredCategories	string[] | null	no	—
status	string | null	no	—
updatedAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.MutualDisclosure.PartnerDisclosureStatusDto

Property	Type	Required	Description
coversAllRequired	boolean	no	—
disclosed	boolean	no	—
disclosedAt	string (date-time) | null	no	—
disclosedCategories	string[] | null	no	—
partnerId	string (uuid)	no	—
scheduleDocumentId	string (uuid) | null	no	—
visibilityActive	boolean	no	—
visibilityRevokeReason	string | null	no	—
visibilityRevokedAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.MutualDisclosure.ReciprocityStatusDto

Property	Type	Required	Description
bothDisclosed	boolean	no	—
canProceedToExecution	boolean	no	—
equivalent	boolean	no	—
exchangeId	string (uuid)	no	—
matterId	string (uuid)	no	—
partnerA	Essence.Consent.Core.Application.DTOs.MutualDisclosure.PartnerDisclosureStatusDto	no	—
partnerB	Essence.Consent.Core.Application.DTOs.MutualDisclosure.PartnerDisclosureStatusDto	no	—
requiredCategories	string[] | null	no	—
status	string | null	no	—

Essence.Consent.Core.Application.DTOs.OrgAdmin.OrgGrantorSummaryDto

Property	Type	Required	Description
activeGrantCount	integer (int32)	no	—
grantorId	string (uuid)	no	—
totalGrantCount	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.OrgAdmin.OrgInvitationTtlDto

Property	Type	Required	Description
invitationTtlDays	integer (int32)	no	—
maxInvitationTtlDays	integer (int32)	no	—
minInvitationTtlDays	integer (int32)	no	—
organizationId	string (uuid)	no	—
pendingEscrowCount	integer (int32)	no	—
updatedAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.OrgAdmin.OrgOversightSummaryDto

Property	Type	Required	Description
generatedAt	string (date-time)	no	—
grantsByStatus	map<string, integer (int32)> | null	no	—
organizationId	string (uuid)	no	—
thirdPartyInvitationsByStatus	map<string, integer (int32)> | null	no	—
topGrantors	Essence.Consent.Core.Application.DTOs.OrgAdmin.OrgGrantorSummaryDto[] | null	no	—

Essence.Consent.Core.Application.DTOs.PolicyTemplate.ConsentPolicyTemplateDto

Property	Type	Required	Description
createdAt	string (date-time)	no	—
description	string | null	no	—
id	string (uuid)	no	—
lawfulBasis	Essence.Consent.Core.Application.DTOs.PolicyTemplate.ConsentPolicyTemplateLawfulBasisDto	no	—
maxDurationDays	integer (int32) | null	no	—
name	string | null	no	—
onwardSharingAllowed	boolean	no	—
organizationId	string (uuid)	no	—
recommendedCanDelete	boolean	no	—
recommendedCanRead	boolean	no	—
recommendedCanShare	boolean	no	—
recommendedCanWrite	boolean	no	—
recommendedDurationDays	integer (int32) | null	no	—
recommendedOnwardSharing	boolean	no	—
recommendedRevocationPolicy	string | null	no	—
status	string | null	no	—

Essence.Consent.Core.Application.DTOs.PolicyTemplate.ConsentPolicyTemplateLawfulBasisDto

Property	Type	Required	Description
article6Basis	string | null	no	—
articleReference	string | null	no	—
justification	string | null	no	—
retentionDaysAfterEnd	integer (int32) | null	no	—
withdrawalStopsProcessing	boolean	no	—

Essence.Consent.Core.Application.DTOs.PredicateAttestations.PredicateAttestationDto

Property	Type	Required	Description
assuranceLevel	string | null	no	—
attributesRevealed	map<string, boolean> | null	no	—
fieldsDisclosed	string[] | null	no	—
id	string (uuid)	no	—
issuerDid	string | null	no	—
issuerName	string | null	no	—
occurredAt	string (date-time)	no	—
predicate	string | null	no	—
proofVerification	string | null	no	—
relyingPartyName	string | null	no	—
relyingPartyRef	string | null	no	—
result	boolean	no	—
thresholdYears	integer (int32)	no	—
trustFramework	string | null	no	—
verifiedAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.PredicateAttestations.PredicateComplianceAttestationDto

Property	Type	Required	Description
assuranceLevel	string | null	no	—
attestationId	string (uuid)	no	—
attributesRevealed	map<string, boolean> | null	no	—
fieldsDisclosed	string[] | null	no	—
generatedAt	string (date-time)	no	—
howToVerify	Essence.Consent.Core.Application.DTOs.PredicateAttestations.PredicateProofVerificationInstructionsDto	no	—
issuerDid	string | null	no	—
issuerName	string | null	no	—
legalBasis	string[] | null	no	—
occurredAt	string (date-time)	no	—
predicate	string | null	no	—
proof	Essence.Consent.Core.Application.DTOs.PredicateAttestations.PredicateProofEnvelopeDto	no	—
proofVerification	string | null	no	—
relyingPartyName	string | null	no	—
relyingPartyRef	string | null	no	—
result	boolean	no	—
statement	string | null	no	—
thresholdYears	integer (int32)	no	—
trustFramework	string | null	no	—
verifiedAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.PredicateAttestations.PredicateProofEnvelopeDto

Property	Type	Required	Description
attributeCommitment	string | null	no	—
attributePath	string | null	no	—
issuerDID	string | null	no	—
operator	string | null	no	—
salt	string | null	no	—
signature	string | null	no	—
thresholdValue	string | null	no	—
verificationMethodId	string | null	no	—

Essence.Consent.Core.Application.DTOs.PredicateAttestations.PredicateProofVerificationInstructionsDto

Property	Type	Required	Description
body	string | null	no	—
expect	string | null	no	—
method	string | null	no	—
path	string | null	no	—

Essence.Consent.Core.Application.DTOs.Presentation.DisclosedFieldProvenanceDto

Property	Type	Required	Description
assuranceLevel	string | null	no	—
disclosureDigest	string | null	no	—
fieldKey	string | null	no	—
firstOpenedAt	string (date-time) | null	no	—
signingKeyRef	string | null	no	—

Essence.Consent.Core.Application.DTOs.Presentation.PresentationDisclosureDto

Property	Type	Required	Description
ackMethod	string | null	no	—
ackReference	string | null	no	—
ackState	string | null	no	—
acknowledgedAt	string (date-time) | null	no	—
cannotGuaranteePurge	boolean	no	—
commitmentAlgorithm	string | null	no	—
createdAt	string (date-time)	no	—
disclosedFields	Essence.Consent.Core.Application.DTOs.Presentation.DisclosedFieldProvenanceDto[] | null	no	—
id	string (uuid)	no	—
presentationGrantId	string (uuid) | null	no	—
receipt	string | null	no	—
receiptAlgorithm	string | null	no	—
receiptKeyId	string | null	no	—
relyingPartyRef	string | null	no	—
revokedAt	string (date-time) | null	no	—
status	string | null	no	—
subjectId	string (uuid)	no	—
updatedAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.Propagation.BlastRadiusCircleDto

Property	Type	Required	Description
circleId	string | null	no	—
circleName	string | null	no	—
connectionCount	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.Propagation.BlastRadiusPreviewDto

Property	Type	Required	Description
affectedCircleCount	integer (int32)	no	—
affectedConnectionCount	integer (int32)	no	—
fieldLabel	string | null	no	—
perCircle	Essence.Consent.Core.Application.DTOs.Propagation.BlastRadiusCircleDto[] | null	no	—
remainingCount	integer (int32) | null	no	—
topUpRequired	boolean	no	—

Essence.Consent.Core.Application.DTOs.Propagation.PropagationPolicyDto

Property	Type	Required	Description
createdAt	string (date-time)	no	—
defaultSyncType	string | null	no	—
id	string (uuid)	no	—
inheritable	boolean	no	—
propagationModel	string | null	no	—
scope	string | null	no	—
scopeRef	string | null	no	—
updatedAt	string (date-time) | null	no	—
userId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.PropagationAuditDto

Property	Type	Required	Description
pushId	string (uuid)	no	—
pushedAt	string (date-time)	no	—
recipients	Essence.Consent.Core.Application.DTOs.PropagationRecipientOutcomeDto[] | null	no	—
subjectId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.PropagationRecipientOutcomeDto

Property	Type	Required	Description
fieldsRedacted	string[] | null	no	—
fieldsShared	string[] | null	no	—
governingGrantId	string (uuid) | null	no	—
grantVersion	integer (int32) | null	no	—
pushedAt	string (date-time)	no	—
recipientId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalExchangeHalfDto

Property	Type	Required	Description
committed	boolean	no	—
fields	string[] | null	no	—
isViewer	boolean	no	—
role	string | null	no	—
userId	string (uuid)	no	—
verificationLevel	string | null	no	—
verificationSource	string | null	no	—
verified	boolean	no	—
verifiedAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalExchangeViewDto

Property	Type	Required	Description
blockedOnRole	string | null	no	—
committedAt	string (date-time) | null	no	—
counterOfferedAt	string (date-time) | null	no	—
declineReason	string | null	no	—
declinedAt	string (date-time) | null	no	—
exchangeId	string (uuid)	no	—
initiatorHalf	Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalExchangeHalfDto	no	—
lifecycle	Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalLifecycleEntryDto[] | null	no	—
offerExpiresAt	string (date-time)	no	—
offeredAt	string (date-time)	no	—
ownerService	string | null	no	—
pairedTransactionId	string (uuid) | null	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
rescind	Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalRescindDto	no	—
responderHalf	Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalExchangeHalfDto	no	—
status	string | null	no	—
viewerRole	string | null	no	—

Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalLifecycleEntryDto

Property	Type	Required	Description
actorRole	string | null	no	—
at	string (date-time) | null	no	—
audited	boolean	no	—
event	string | null	no	—
inProgress	boolean	no	—
notified	boolean	no	—

Essence.Consent.Core.Application.DTOs.Reciprocal.ReciprocalRescindDto

Property	Type	Required	Description
at	string (date-time)	no	—
byRole	string | null	no	—
byUserId	string (uuid)	no	—
cause	string | null	no	—

Essence.Consent.Core.Application.DTOs.RecordsHandoverDecisionResultDto

Property	Type	Required	Description
decidedAt	string (date-time)	no	—
disclosureRecordHash	string | null	no	—
handoverId	string (uuid)	no	—
status	Essence.Consent.Core.Domain.Enums.RecordsHandoverStatus	no	—

Essence.Consent.Core.Application.DTOs.RecordsHandoverDto

Property	Type	Required	Description
acceptanceExpiresAt	string (date-time)	no	—
decidedAt	string (date-time) | null	no	—
disclosedAt	string (date-time) | null	no	—
disclosureRecordHash	string | null	no	—
handoverId	string (uuid)	no	—
incomingKeeperId	string (uuid)	no	—
initiatedAt	string (date-time)	no	—
lawfulBasis	Essence.Consent.Core.Domain.Enums.RecordsHandoverLawfulBasis	no	—
outgoingKeeperId	string (uuid)	no	—
purpose	Essence.Consent.Core.Domain.Enums.ConsentPurpose	no	—
recordDocumentId	string (uuid) | null	no	—
recordFieldKeys	string[] | null	no	—
retentionDays	integer (int32)	no	—
status	Essence.Consent.Core.Domain.Enums.RecordsHandoverStatus	no	—
subjectRef	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.Renunciation.RenunciationScopedGrantDto

Property	Type	Required	Description
alreadyWithdrawn	boolean	no	—
grantId	string (uuid)	no	—
jurisdiction	string | null	no	—
legalBasis	string | null	no	—
relyingPartyRef	string | null	no	—
status	string | null	no	—

Essence.Consent.Core.Application.DTOs.Renunciation.RenunciationScopePreviewDto

Property	Type	Required	Description
grants	Essence.Consent.Core.Application.DTOs.Renunciation.RenunciationScopedGrantDto[] | null	no	—
jurisdiction	string | null	no	—
legalHoldReason	string | null	no	—
liveGrantCount	integer (int32)	no	—
teardownCaseId	string (uuid) | null	no	—
validityCeilingDays	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.Renunciation.StopRelyingAuditDto

Property	Type	Required	Description
cascadedAt	string (date-time) | null	no	—
evidencedCount	integer (int32)	no	—
jurisdiction	string | null	no	—
legalHoldBlockedCount	integer (int32)	no	—
notices	Essence.Consent.Core.Application.DTOs.Renunciation.StopRelyingNoticeDto[] | null	no	—
pendingCount	integer (int32)	no	—
registeredAt	string (date-time)	no	—
status	string | null	no	—
teardownCaseId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.Renunciation.StopRelyingNoticeDto

Property	Type	Required	Description
acknowledgedAt	string (date-time) | null	no	—
channel	string | null	no	—
deliveredAt	string (date-time) | null	no	—
failureReason	string | null	no	—
grantId	string (uuid)	no	—
isEvidenced	boolean	no	—
noticeId	string (uuid)	no	—
notifiedAt	string (date-time)	no	—
relyingPartyRef	string | null	no	—
status	string | null	no	—
validityCeilingAt	string (date-time)	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.AssignRepairTechnicianRequest

Property	Type	Required	Description
technicianLabel	string | null	no	—
technicianRef	string | null	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.CreateRepairAccessGrantRequest

Property	Type	Required	Description
bundle	Essence.Consent.Core.Application.DTOs.RepairAccess.RepairBundleItemRequest[] | null	no	—
deviceLabel	string | null	no	—
deviceRef	string | null	no	—
durationModel	string | null	no	—
expiresAt	string (date-time) | null	no	—
repairerDisplayName	string | null	no	—
repairerOrganizationId	string (uuid)	no	—
warrantyAtGrant	Essence.Consent.Core.Application.DTOs.RepairAccess.WarrantyStateSnapshotRequest	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.DeviceRevocationPropagationDto

Property	Type	Required	Description
crlPublishedAt	string (date-time) | null	no	—
ocspConfirmedAt	string (date-time) | null	no	—
requestedAt	string (date-time) | null	no	—
state	string | null	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.IssueRepairShareCodeRequest

Property	Type	Required	Description
rotationSeconds	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.LogRepairRequest

Property	Type	Required	Description
outcome	string | null	no	—
repairSummaryRef	string | null	no	—
warrantyAtCompletion	Essence.Consent.Core.Application.DTOs.RepairAccess.WarrantyStateSnapshotRequest	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.RecordRepairAccessRequest

Property	Type	Required	Description
deviceRef	string | null	no	—
scope	string | null	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessEventDto

Property	Type	Required	Description
accessId	string (uuid)	no	—
actorLabel	string | null	no	—
actorRef	string | null	no	—
authorityExpiresAt	string (date-time) | null	no	—
deviceRef	string | null	no	—
occurredAt	string (date-time)	no	—
scope	string | null	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessGrantDto

Property	Type	Required	Description
accessEvents	Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessEventDto[] | null	no	—
assignedTechnicianLabel	string | null	no	—
assignedTechnicianRef	string | null	no	—
bundle	Essence.Consent.Core.Application.DTOs.RepairAccess.RepairBundleItemDto[] | null	no	—
deviceLabel	string | null	no	—
deviceRef	string | null	no	—
durationModel	string | null	no	—
expiresAt	string (date-time) | null	no	—
grantId	string (uuid)	no	—
grantedAt	string (date-time)	no	—
onwardSharingPermitted	boolean	no	—
ownerId	string (uuid)	no	—
propagation	Essence.Consent.Core.Application.DTOs.RepairAccess.DeviceRevocationPropagationDto	no	—
purpose	string | null	no	—
repairLoggedAt	string (date-time) | null	no	—
repairOutcome	string | null	no	—
repairSummaryRef	string | null	no	—
repairerDisplayName	string | null	no	—
repairerOrganizationId	string (uuid)	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
shareCode	string | null	no	—
shareCodeExpiresAt	string (date-time) | null	no	—
shareCodeRotationSeconds	integer (int32) | null	no	—
status	string | null	no	—
technicianAssignedAt	string (date-time) | null	no	—
warrantyAtCompletion	Essence.Consent.Core.Application.DTOs.RepairAccess.WarrantyStateSnapshotDto	no	—
warrantyAtGrant	Essence.Consent.Core.Application.DTOs.RepairAccess.WarrantyStateSnapshotDto	no	—
warrantyPreserved	boolean | null	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.RepairBundleItemDto

Property	Type	Required	Description
itemRef	string | null	no	—
label	string | null	no	—
scope	string | null	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.RepairBundleItemRequest

Property	Type	Required	Description
itemRef	string | null	no	—
label	string | null	no	—
scope	string | null	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.ReportDeviceRevocationPropagationRequest

Property	Type	Required	Description
crlPublishedAt	string (date-time) | null	no	—
ocspConfirmedAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.RevokeRepairAccessRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.WarrantyStateSnapshotDto

Property	Type	Required	Description
capturedAt	string (date-time)	no	—
policySource	string | null	no	—
stance	string | null	no	—
stateDigest	string | null	no	—
warrantyEndsOn	string (date-time) | null	no	—
warrantyRef	string | null	no	—

Essence.Consent.Core.Application.DTOs.RepairAccess.WarrantyStateSnapshotRequest

Property	Type	Required	Description
policySource	string | null	no	—
stance	string | null	no	—
stateDigest	string | null	no	—
warrantyEndsOn	string (date-time) | null	no	—
warrantyRef	string | null	no	—

Essence.Consent.Core.Application.DTOs.RepresentativeAuthority.RepresentativeAuthorizationAccessDecisionDto

Property	Type	Required	Description
authorizationId	string (uuid) | null	no	—
authorizationReference	string | null	no	—
granted	boolean	no	—
reason	string | null	no	—

Essence.Consent.Core.Application.DTOs.RepresentativeAuthority.RepresentativeAuthorizationDto

Property	Type	Required	Description
authorityKind	string | null	no	—
authorityName	string | null	no	—
authorizationReference	string | null	no	—
basisKind	string | null	no	—
basisRegistrationRef	string | null	no	—
effectiveFrom	string (date-time)	no	—
endReason	string | null	no	—
endedAt	string (date-time) | null	no	—
expiresAt	string (date-time)	no	—
id	string (uuid)	no	—
inForce	boolean	no	—
jurisdiction	string | null	no	—
organizationId	string (uuid)	no	—
representativeRef	string | null	no	—
restrictions	string[] | null	no	—
route	string | null	no	—
scopeRecordTypes	string[] | null	no	—
sourceAuthorizationId	string | null	no	—
statedPurpose	string | null	no	—
status	string | null	no	—
statuteRef	string | null	no	—
subjectRef	string | null	no	—

Essence.Consent.Core.Application.DTOs.RevealProofStatusDto

Property	Type	Required	Description
auditAnchorHash	string | null	no	—
expiresAt	string (date-time) | null	no	—
revealId	string (uuid)	no	—
revealedAt	string (date-time)	no	—
stage	Essence.Consent.Core.Domain.Enums.RevealStage	no	—
status	Essence.Consent.Core.Domain.Enums.RevealGrantStatus	no	—

Essence.Consent.Core.Application.DTOs.RevocationExposure.RevocationExposureBoardDto

Property	Type	Required	Description
affectedVerifications	integer (int32)	no	—
generatedAt	string (date-time)	no	—
maxDwellHours	integer (int32)	no	—
rows	Essence.Consent.Core.Application.DTOs.RevocationExposure.RevocationExposureRowDto[] | null	no	—
totalLiveShares	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.RevocationExposure.RevocationExposureRowDto

Property	Type	Required	Description
dwellBand	string | null	no	—
dwellHours	integer (int32)	no	—
liveShareCount	integer (int32)	no	—
verificationRef	string | null	no	—

Essence.Consent.Core.Application.DTOs.SelfSync.SelfSyncPolicyDto

Property	Type	Required	Description
approvalRequired	boolean	no	—
createdAt	string (date-time)	no	—
defaultCircles	string[] | null	no	—
deviceClass	string | null	no	—
id	string (uuid)	no	—
syncType	string | null	no	—
updatedAt	string (date-time) | null	no	—
userId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceCategoryOptionDto

Property	Type	Required	Description
advanceNoticeHours	integer (int32)	no	—
category	string | null	no	—
iataCode	string | null	no	—
isOffered	boolean	no	—
requiresNote	boolean	no	—

Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceDeletionReceiptDto

Property	Type	Required	Description
accessEnded	boolean	no	—
accessEndsAt	string (date-time)	no	—
carrierDisplayName	string | null	no	—
deletionAttestationRef	string | null	no	—
deletionAttested	boolean	no	—
deletionAttestedAt	string (date-time) | null	no	—
flightDesignator	string | null	no	—
notificationId	string (uuid)	no	—
outcomeRecordedAt	string (date-time) | null	no	—
status	string | null	no	—
timesRead	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceDeskAccessDto

Property	Type	Required	Description
accessedAt	string (date-time)	no	—
actorRef	string | null	no	—
role	string | null	no	—

Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceNeedDisclosureDto

Property	Type	Required	Description
accessEndsAt	string (date-time)	no	—
allowDownload	boolean	no	—
allowForward	boolean	no	—
includesTravellerNote	boolean	no	—
needEnvelopeRef	string | null	no	—
needWrappedKeyForDesk	string | null	no	—
notificationId	string (uuid)	no	—
remainingAccesses	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceRosterItemDto

Property	Type	Required	Description
accessEndsAt	string (date-time)	no	—
accesses	Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceDeskAccessDto[] | null	no	—
arrivalAirportIata	string | null	no	—
awaitingDeletionAttestation	boolean	no	—
deletionAttested	boolean	no	—
deletionAttestedAt	string (date-time) | null	no	—
flightDesignator	string | null	no	—
includesTravellerNote	boolean	no	—
isCrossBorder	boolean	no	—
notificationId	string (uuid)	no	—
notifiedAt	string (date-time)	no	—
outcomeRecordedAt	string (date-time) | null	no	—
recipientJurisdiction	string | null	no	—
remainingAccesses	integer (int32)	no	—
scheduledArrivalUtc	string (date-time)	no	—
scheduledDepartureUtc	string (date-time)	no	—
status	string | null	no	—
tripReference	string | null	no	—
unavailableReason	string | null	no	—

Essence.Consent.Core.Application.DTOs.SpecialAssistance.CarrierAssistanceCatalogueDto

Property	Type	Required	Description
carrierDisplayName	string | null	no	—
carrierIataCode	string | null	no	—
carrierOrganizationId	string (uuid)	no	—
lastConfiguredAt	string (date-time) | null	no	—
maxPostTripAccessGraceHours	integer (int32)	no	—
options	Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceCategoryOptionDto[] | null	no	—
postTripAccessGraceHours	integer (int32)	no	—
publishedAt	string (date-time)	no	—

Essence.Consent.Core.Application.DTOs.SpecialAssistance.SpecialAssistanceNotificationDto

Property	Type	Required	Description
accessCount	integer (int32)	no	—
accessEndsAt	string (date-time)	no	—
accesses	Essence.Consent.Core.Application.DTOs.SpecialAssistance.AssistanceDeskAccessDto[] | null	no	—
actualArrivalUtc	string (date-time) | null	no	—
allowDownload	boolean	no	—
allowForward	boolean	no	—
arrivalAirportIata	string | null	no	—
article49TransferBasis	string | null	no	—
article9Condition	string | null	no	—
carrierDisplayName	string | null	no	—
carrierOrganizationId	string (uuid)	no	—
deletionAttestationRef	string | null	no	—
deletionAttested	boolean	no	—
deletionAttestedAt	string (date-time) | null	no	—
flightDesignator	string | null	no	—
includesTravellerNote	boolean	no	—
isCrossBorder	boolean	no	—
needEnvelopeRef	string | null	no	—
needWrappedKeyForTraveller	string | null	no	—
notificationId	string (uuid)	no	—
notifiedAt	string (date-time)	no	—
outcomeRecordedAt	string (date-time) | null	no	—
postTripAccessGraceHours	integer (int32)	no	—
purpose	string | null	no	—
recipientJurisdiction	string | null	no	—
remainingAccesses	integer (int32)	no	—
scheduledArrivalUtc	string (date-time)	no	—
scheduledDepartureUtc	string (date-time)	no	—
status	string | null	no	—
tripReference	string | null	no	—
unavailableReason	string | null	no	—
withdrawnAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.SubjectExportCategoryScopeDto

Property	Type	Required	Description
category	string | null	no	—
estimatedBytes	integer (int64)	no	—
recordCount	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.SubjectExportEntryDto

Property	Type	Required	Description
category	string | null	no	—
data	map<string, unspecified> | null	no	—
reference	string | null	no	—

Essence.Consent.Core.Application.DTOs.SubjectExportPageDto

Property	Type	Required	Description
capturedAt	string (date-time)	no	—
category	string | null	no	—
entries	Essence.Consent.Core.Application.DTOs.SubjectExportEntryDto[] | null	no	—
hasMore	boolean	no	—
scopeNotice	string | null	no	—
skip	integer (int32)	no	—
subjectId	string (uuid)	no	—
take	integer (int32)	no	—
totalCount	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.SubjectExportScopeDto

Property	Type	Required	Description
activeGrantCount	integer (int32)	no	—
categories	Essence.Consent.Core.Application.DTOs.SubjectExportCategoryScopeDto[] | null	no	—
measuredAt	string (date-time)	no	—
subjectId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.AccountlessWithdrawalReceiptDto

Property	Type	Required	Description
auditAnchor	string | null	no	—
autoUpdateHalted	boolean	no	—
consentId	string (uuid)	no	—
purgedFieldKeys	string[] | null	no	—
status	string | null	no	—
withdrawnAt	string (date-time)	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.AutoUpdateEventDto

Property	Type	Required	Description
auditAnchor	string | null	no	—
consentValidatedAt	string (date-time)	no	—
disclosedAt	string (date-time)	no	—
fieldKeys	string[] | null	no	—
id	string (uuid)	no	—
purpose	string | null	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.AutoUpdateEventListDto

Property	Type	Required	Description
autoUpdateHalted	boolean	no	—
consentId	string (uuid)	no	—
events	Essence.Consent.Core.Application.DTOs.ThirdParty.AutoUpdateEventDto[] | null	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.ConfirmInvitationOtpResponse

Property	Type	Required	Description
bound	boolean	no	—
identityBindingToken	string | null	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.InvitationRequestedFieldView

Property	Type	Required	Description
justification	string | null	no	—
key	string | null	no	—
label	string | null	no	—
required	boolean	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.InviteThirdPartyConsentResponse

Property	Type	Required	Description
consent	Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto	no	—
invitationToken	string | null	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.PurgeReceiptDto

Property	Type	Required	Description
auditAnchor	string | null	no	—
autoUpdateHalted	boolean	no	—
consentId	string (uuid)	no	—
purgedAt	string (date-time) | null	no	—
purgedFieldKeys	string[] | null	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.RecordAutoUpdateDisclosureRequest

Property	Type	Required	Description
fieldKeys	string[] | null	no	—
purpose	string | null	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.RequestedFieldDto

Property	Type	Required	Description
consented	boolean | null	no	—
justification	string | null	no	—
key	string | null	no	—
required	boolean	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.RespondToInvitationResponse

Property	Type	Required	Description
accepted	boolean	no	—
consentedFieldKeys	string[] | null	no	—
respondedAt	string (date-time)	no	—
status	string | null	no	—
thirdPartyConsentId	string (uuid)	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.SubjectShareDto

Property	Type	Required	Description
autoUpdateEvents	Essence.Consent.Core.Application.DTOs.ThirdParty.AutoUpdateEventDto[] | null	no	—
autoUpdateHalted	boolean	no	—
consentId	string (uuid)	no	—
grantedAt	string (date-time) | null	no	—
granteeId	string (uuid)	no	—
granteeType	string | null	no	—
invitationExpiresAt	string (date-time)	no	—
invitedAt	string (date-time)	no	—
isContactAddressed	boolean	no	—
purpose	string | null	no	—
requestedFieldKeys	string[] | null	no	—
revokedAt	string (date-time) | null	no	—
status	string | null	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.SubjectSharesDto

Property	Type	Required	Description
shares	Essence.Consent.Core.Application.DTOs.ThirdParty.SubjectShareDto[] | null	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto

Property	Type	Required	Description
acceptedAt	string (date-time) | null	no	—
authorityReference	string | null	no	—
complianceFramework	string | null	no	—
consentGrantId	string (uuid) | null	no	—
consentedFieldKeys	string[] | null	no	—
createdAt	string (date-time)	no	—
dataSubjectDeceasedAt	string (date-time) | null	no	—
dataSubjectId	string (uuid) | null	no	—
dataSubjectNotified	boolean	no	—
dataSubjectNotifiedAt	string (date-time) | null	no	—
dataSubjectObjected	boolean	no	—
delegationType	string | null	no	—
delegationVerified	boolean | null	no	—
documentId	string (uuid) | null	no	—
grantedAt	string (date-time)	no	—
granteeId	string (uuid)	no	—
granteeType	string | null	no	—
grantorId	string (uuid)	no	—
id	string (uuid)	no	—
invitationExpiresAt	string (date-time)	no	—
invitedAt	string (date-time)	no	—
issuingAuthority	string | null	no	—
jurisdiction	string | null	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
requestedFields	Essence.Consent.Core.Application.DTOs.ThirdParty.RequestedFieldDto[] | null	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
revokedBy	string (uuid) | null	no	—
status	string | null	no	—
updatedAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyInvitationView

Property	Type	Required	Description
accountlessResponseEnabled	boolean	no	—
complianceFramework	string | null	no	—
delegationType	string | null	no	—
expiresAt	string (date-time)	no	—
granteeType	string | null	no	—
invitedAt	string (date-time)	no	—
invitedEmailMasked	string | null	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
requestedFields	Essence.Consent.Core.Application.DTOs.ThirdParty.InvitationRequestedFieldView[] | null	no	—
respondentRole	string | null	no	—
tokenReference	string | null	no	—

Essence.Consent.Core.Application.DTOs.Translation.TranslationCommissionDto

Property	Type	Required	Description
attestationRef	string | null	no	—
createdAt	string (date-time)	no	—
currency	string | null	no	—
estimatedTurnaroundHours	integer (int32) | null	no	—
failure	string | null	no	—
failureDetail	string | null	no	—
grantExpiresAt	string (date-time) | null	no	—
id	string (uuid)	no	—
indicativePriceMinor	integer (int64) | null	no	—
originalDocumentRef	string | null	no	—
requesterId	string (uuid) | null	no	—
sourceLanguage	string | null	no	—
stage	string | null	no	—
targetLanguage	string | null	no	—
translatedDocumentRef	string | null	no	—
translatorInvitationExpiresAt	string (date-time) | null	no	—
translatorInvitationToken	string | null	no	—
translatorJoinedAt	string (date-time) | null	no	—
translatorRef	string | null	no	—
updatedAt	string (date-time) | null	no	—
viewerRole	string | null	no	—

Essence.Consent.Core.Application.DTOs.UpdateCommunicationsConsentRequestDto

Property	Type	Required	Description
channels	Essence.Consent.Core.Application.DTOs.ChannelPreferenceDto[] | null	no	—
lawfulBasis	string | null	no	—

Essence.Consent.Core.Application.DTOs.WalletClaimConsent.WalletClaimConsentDto

Property	Type	Required	Description
createdAt	string (date-time)	no	—
dedupeToken	string | null	no	—
disclosureRef	string | null	no	—
id	string (uuid)	no	—
recordedAt	string (date-time)	no	—
sealAlgorithm	string | null	no	—
sealedConsent	string | null	no	—
status	string | null	no	—
subjectId	string (uuid)	no	—
updatedAt	string (date-time) | null	no	—
withdrawnAt	string (date-time) | null	no	—

Essence.Consent.Core.Application.DTOs.WalletClaimConsent.WalletClaimConsentGranularityDto

Property	Type	Required	Description
claimCount	integer (int32)	no	—
disclosureRef	string | null	no	—
recordedAt	string (date-time)	no	—
withdrawnCount	integer (int32)	no	—

Essence.Consent.Core.Application.DTOs.WalletClaimConsent.WalletClaimConsentSyncResultDto

Property	Type	Required	Description
alreadyRecorded	integer (int32)	no	—
received	integer (int32)	no	—
recorded	integer (int32)	no	—
records	Essence.Consent.Core.Application.DTOs.WalletClaimConsent.WalletClaimConsentDto[] | null	no	—

Essence.Consent.Core.Application.Merge.ConsentMergePlan

Property	Type	Required	Description
allDispositionsTerminal	boolean	no	—
carriedCount	integer (int32)	no	—
droppedCount	integer (int32)	no	—
entries	Essence.Consent.Core.Application.Merge.ConsentMergePlanEntry[] | null	no	—
executed	boolean	no	—
lapsedCount	integer (int32)	no	—
mergeSessionId	string (uuid)	no	—
mergedAt	string (date-time) | null	no	—
mode	Essence.Consent.Core.Domain.Merge.MergeRepointMode	no	—
reconfirmCount	integer (int32)	no	—
reconfirmRequiredCount	integer (int32)	no	—
repointedCount	integer (int32)	no	—
retiredAccountId	string (uuid)	no	—
survivingAccountId	string (uuid)	no	—
suspendedCount	integer (int32)	no	—
totalCount	integer (int32)	no	—

Essence.Consent.Core.Application.Merge.ConsentMergePlanEntry

Property	Type	Required	Description
disposition	Essence.Consent.Core.Domain.Merge.MergeGrantDisposition	no	—
grantId	string (uuid)	no	—
lapsedAt	string (date-time) | null	no	—
outcome	Essence.Consent.Core.Domain.Merge.MergeGrantOutcome	no	—
reason	string | null	no	—
reconfirmationDueAt	string (date-time) | null	no	—
regulated	boolean	no	—
role	Essence.Consent.Core.Domain.Merge.MergeGrantRole	no	—
sharedDataLabel	Essence.Consent.Core.Domain.Enums.ConsentPurpose	no	—
suspendedAt	string (date-time) | null	no	—
thirdParty	string (uuid)	no	—
thirdPartyType	Essence.Consent.Core.Domain.Enums.PartyType	no	—
timeInStateSeconds	number (double) | null	no	—

Essence.Consent.Core.Application.Queries.ConsentHistory.GenerateComplianceReportQuery

Property	Type	Required	Description
endDate	string (date-time) | null	no	—
format	string | null	no	—
granteeId	string (uuid) | null	no	—
grantorId	string (uuid) | null	no	—
includeAccessHistory	boolean	no	—
includeExpiredConsents	boolean	no	—
includeRevokedConsents	boolean	no	—
startDate	string (date-time) | null	no	—

Essence.Consent.Core.Application.Queries.CounterpartyChanges.CounterpartyChangeDto

Property	Type	Required	Description
authorisingEventTitle	string | null	no	—
consentId	string (uuid)	no	—
corporateEventId	string (uuid)	no	—
grantLabel	string | null	no	—
newControllerName	string | null	no	—
newLawfulBasis	string | null	no	—
previousControllerName	string | null	no	—
schemeReference	string | null	no	—
transitionedAt	string (date-time)	no	—

Essence.Consent.Core.Application.Queries.DisclosureRecipients.DisclosureRecipientDto

Property	Type	Required	Description
channel	string | null	no	—
currentlyActive	boolean	no	—
name	string | null	no	—
organizationId	string (uuid) | null	no	—
partyId	string (uuid) | null	no	—
partyType	string | null	no	—
purpose	string | null	no	—
sourceIds	(string (uuid))[] | null	no	—

Essence.Consent.Core.Application.Queries.DisclosureRecipients.DisclosureRecipientsResult

Property	Type	Required	Description
completeness	string | null	no	—
coveredScopes	string[] | null	no	—
fieldKey	string | null	no	—
recipients	Essence.Consent.Core.Application.Queries.DisclosureRecipients.DisclosureRecipientDto[] | null	no	—
recordId	string | null	no	—
subjectId	string (uuid)	no	—
unreconciledChannels	string[] | null	no	—
unreconciledReasons	Essence.Consent.Core.Application.Queries.DisclosureRecipients.UnreconciledChannelDto[] | null	no	—

Essence.Consent.Core.Application.Queries.DisclosureRecipients.UnreconciledChannelDto

Property	Type	Required	Description
reason	string | null	no	—
scope	string | null	no	—

Essence.Consent.Core.Application.Queries.LegalNameChange.CloseoutSummaryDto

Property	Type	Required	Description
changeId	string (uuid)	no	—
completedAt	string (date-time) | null	no	—
pending	string[] | null	no	—
relyingPartiesNotified	integer (int32)	no	—
relyingPartiesTotal	integer (int32)	no	—

Essence.Consent.Core.Application.Queries.LegalNameChange.DeedPollEvidenceAccessDto

Property	Type	Required	Description
consentGrantRef	string (uuid)	no	—
deedPollDocumentId	string (uuid)	no	—
expiresAt	string (date-time) | null	no	—
itemId	string (uuid)	no	—
openUrl	string | null	no	—

Essence.Consent.Core.Application.Queries.LegalNameChange.DisclosureTargetDto

Property	Type	Required	Description
alreadyDisclosed	boolean	no	—
onOldName	boolean	no	—
relyingPartyId	string (uuid)	no	—

Essence.Consent.Core.Application.Queries.LegalNameChange.IntakeQueueMemberDto

Property	Type	Required	Description
cascadeState	Essence.Consent.Core.Domain.Entities.LegalNameChange.IntakeCascadeState	no	—
changeId	string (uuid)	no	—
decidedAt	string (date-time) | null	no	—
decidedBy	string (uuid) | null	no	—
decision	Essence.Consent.Core.Domain.Entities.LegalNameChange.IntakeDecision	no	—
deedPollDocumentId	string (uuid) | null	no	—
disclosedAt	string (date-time)	no	—
evidenceVisible	boolean	no	—
itemId	string (uuid)	no	—
memberId	string (uuid)	no	—
policyVersionInForce	integer (int32) | null	no	—

Essence.Consent.Core.Application.Queries.LegalNameChange.NameChangeDecisionExportDto

Property	Type	Required	Description
auditAnchorId	string | null	no	—
auditAnchored	boolean	no	—
canonicalPayload	string | null	no	—
decisionCount	integer (int32)	no	—
exportId	string (uuid)	no	—
exportedAt	string (date-time)	no	—
exportedBy	string (uuid)	no	—
orgId	string (uuid)	no	—
payloadDigest	string | null	no	—
signature	string | null	no	—
signatureAlgorithm	string | null	no	—
signingKeyId	string | null	no	—
verification	Essence.Consent.Core.Application.Queries.LegalNameChange.NameChangeDecisionExportVerificationDto	no	—

Essence.Consent.Core.Application.Queries.LegalNameChange.NameChangeDecisionExportSummaryDto

Property	Type	Required	Description
auditAnchored	boolean	no	—
decisionCount	integer (int32)	no	—
exportId	string (uuid)	no	—
exportedAt	string (date-time)	no	—
exportedBy	string (uuid)	no	—
orgId	string (uuid)	no	—
payloadDigest	string | null	no	—

Essence.Consent.Core.Application.Queries.LegalNameChange.NameChangeDecisionExportVerificationDto

Property	Type	Required	Description
digestMatches	boolean	no	—
signatureValid	boolean	no	—
verified	boolean	no	—

Essence.Consent.Core.Application.Queries.Permissions.ConsentPermissionDto

Property	Type	Required	Description
consentGrantId	string (uuid)	no	—
documentId	string (uuid)	no	—
expiresAt	string (date-time) | null	no	—
fieldNames	string[] | null	no	—
grantedAt	string (date-time)	no	—
granteeId	string (uuid)	no	—
grantorId	string (uuid)	no	—
isActive	boolean	no	—
level	string | null	no	—
permissionId	string (uuid)	no	—
revokedAt	string (date-time) | null	no	—
schemaId	string | null	no	—

Essence.Consent.Core.Application.Queries.QRCode.QRCodeVerificationResult

Property	Type	Required	Description
canScan	boolean	no	—
errorMessage	string | null	no	—
expiresAt	string (date-time) | null	no	—
isValid	boolean	no	—
remainingScans	integer (int32) | null	no	—

Essence.Consent.Core.Application.Queries.RepairAccess.RepairStaffAccessRowDto

Property	Type	Required	Description
access	Essence.Consent.Core.Application.DTOs.RepairAccess.RepairAccessEventDto	no	—
deviceLabel	string | null	no	—
grantId	string (uuid)	no	—
withinAuthority	boolean	no	—

Essence.Consent.Core.Application.StatusProjection.StatusProjectionConsentDecisionDto

Property	Type	Required	Description
consentId	string (uuid) | null	no	—
hasActiveConsent	boolean	no	—
projection	string | null	no	—

Essence.Consent.Core.Application.StatusProjection.StatusProjectionConsentDto

Property	Type	Required	Description
consentId	string (uuid)	no	—
credentialIds	(string (uuid))[] | null	no	—
expiresAt	string (date-time)	no	—
holderId	string (uuid)	no	—
projection	string | null	no	—
purpose	string | null	no	—
requesterOrganizationId	string (uuid)	no	—
revokedAt	string (date-time) | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ActivateScopeOfAuthorityRequest

Property	Type	Required	Description
evidenceRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ActivationComplianceSnapshotDto

Property	Type	Required	Description
activatedAt	string (date-time) | null	no	—
attestedAt	string (date-time) | null	no	—
auditAnchorReference	string | null	no	—
auditAnchored	boolean	no	—
authorityBasis	string | null	no	—
authorityReference	string | null	no	—
consentId	string (uuid)	no	—
grantorId	string (uuid)	no	—
lifecycleEventOccurredAt	string (date-time) | null	no	—
lifecycleEvidenceReference	string | null	no	—
recipientId	string (uuid)	no	—
recipientKind	string | null	no	—
releaseTier	string | null	no	—
releasedScope	Essence.Consent.Core.Contracts.DTOs.ReleaseScopeItemDto[] | null	no	—
scopeAttestationVerified	boolean	no	—
scopeDigest	string | null	no	—
scopeDigestAlgorithm	string | null	no	—
scopeItemCount	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.ActivationConditionDto

Property	Type	Required	Description
evidenceRef	string | null	no	—
kind	string | null	no	—
requiresEvidence	boolean	no	—
satisfiedAt	string (date-time) | null	no	—
satisfiedBy	string (uuid) | null	no	—

Essence.Consent.Core.Contracts.DTOs.AddGranteeRosterMemberRequest

Property	Type	Required	Description
userId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.AddPermissionRequest

Property	Type	Required	Description
expiresAt	string (date-time) | null	no	—
fieldNames	string[] | null	no	—
level	string | null	no	—
schemaId	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.AgeAssuranceDto

Property	Type	Required	Description
evidenceReference	string | null	no	—
level	string | null	no	—
method	string | null	no	—
resultState	string | null	no	—
verifiedAt	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.AgentActivityEntryDto

Property	Type	Required	Description
action	string | null	no	—
actorKind	string | null	no	—
agentLabel	string | null	no	—
agentReference	string | null	no	—
delegationId	string (uuid)	no	—
description	string | null	no	—
documentType	string | null	no	—
id	string (uuid)	no	—
outcome	string | null	no	—
performedAt	string (date-time)	no	—
principalId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.AgentActivityReportDto

Property	Type	Required	Description
agentLabel	string | null	no	—
agentReference	string | null	no	—
allowedCount	integer (int32)	no	—
deniedCount	integer (int32)	no	—
entries	Essence.Consent.Core.Contracts.DTOs.AgentActivityEntryDto[] | null	no	—
from	string (date-time)	no	—
generatedAt	string (date-time)	no	—
grants	Essence.Consent.Core.Contracts.DTOs.AgentDelegationDto[] | null	no	—
principalId	string (uuid)	no	—
to	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.AgentCapabilityReferenceDto

Property	Type	Required	Description
capabilityId	string (uuid)	no	—
delegationDepth	integer (int32)	no	—
holderKeyThumbprint	string | null	no	—
issuedAt	string (date-time)	no	—
validUntil	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.AgentCapabilityRevocationResultDto

Property	Type	Required	Description
agentReference	string | null	no	—
allPrincipals	boolean	no	—
capabilitiesRevoked	integer (int32)	no	—
revocationReference	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.AgentDelegationDto

Property	Type	Required	Description
actions	string[] | null	no	—
agentDelegateId	string (uuid)	no	—
agentReference	string | null	no	—
automatedDecisionMaking	boolean	no	—
automatedDecisionNote	string | null	no	—
documentTypes	string[] | null	no	—
expiresAt	string (date-time)	no	—
forceRevokedForIncidentId	string (uuid) | null	no	—
grantedAt	string (date-time)	no	—
id	string (uuid)	no	—
isActionable	boolean	no	—
issuedCapability	Essence.Consent.Core.Contracts.DTOs.DelegatedCapabilityDto	no	—
label	string | null	no	—
liveCapabilityCount	integer (int32)	no	—
operatorRole	string | null	no	—
principalId	string (uuid)	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.AgentDelegationForceRevocationResultDto

Property	Type	Required	Description
agentReference	string | null	no	—
allPrincipals	boolean	no	—
alreadyEnded	integer (int32)	no	—
complianceSnapshotIds	(string (uuid))[] | null	no	—
delegationsRevoked	integer (int32)	no	—
revocationReference	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.AgentScopeTemplateDto

Property	Type	Required	Description
actions	string[] | null	no	—
defaultDurationDays	integer (int32)	no	—
description	string | null	no	—
documentTypes	string[] | null	no	—
key	string | null	no	—
name	string | null	no	—
source	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.AmendSuccessionTermsRequest

Property	Type	Required	Description
currency	string | null	no	—
pricePerShareMinor	integer (int64)	no	—
shareClass	string | null	no	—
shareCount	integer (int64)	no	—

Essence.Consent.Core.Contracts.DTOs.AnswerClosureTransferAskRequest

Property	Type	Required	Description
answer	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.AppendProtectionCaseProvenanceEntryRequest

Property	Type	Required	Description
basisDocumentId	string (uuid) | null	no	—
confidence	string | null	no	—
event	string | null	no	—
evidencePath	string | null	no	—
lawfulBasis	string | null	no	—
recipientOrganizationId	string (uuid) | null	no	—
recordCompleteness	string | null	no	—
reviewOutcome	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ApplyModuleSwitchConsentRescopeRequest

Property	Type	Required	Description
decisions	Essence.Consent.Core.Contracts.DTOs.RescopeDecisionDto[] | null	no	—
legalAttestation	Essence.Consent.Core.Contracts.DTOs.RescopeLegalAttestationDto	no	—
policy	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ApprovalChallengeResponse

Property	Type	Required	Description
challenge	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ApproveConsentRequest

Property	Type	Required	Description
challenge	string | null	no	—
credentialPublicKeyJwk	string | null	no	—
signature	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.AssignDonorRegisterCaseRequest

Property	Type	Required	Description
assigneeId	string (uuid) | null	no	—

Essence.Consent.Core.Contracts.DTOs.AssignExecutorOfficerRequest

Property	Type	Required	Description
detail	string | null	no	—
officerUserId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.AssignOriginRecordsCaseRequest

Property	Type	Required	Description
assigneeId	string (uuid) | null	no	—

Essence.Consent.Core.Contracts.DTOs.AssuranceEstablishmentConsentDto

Property	Type	Required	Description
consentId	string (uuid)	no	—
grantedAt	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.AttorneyVisibilityPreviewDto

Property	Type	Required	Description
attorneyId	string (uuid)	no	—
donorId	string (uuid)	no	—
generatedAt	string (date-time)	no	—
outOfScopeCategories	string[] | null	no	—
recordId	string (uuid)	no	—
status	string | null	no	—
staysPrivateFields	Essence.Consent.Core.Contracts.DTOs.ScopeFieldDto[] | null	no	—
visibleFields	Essence.Consent.Core.Contracts.DTOs.ScopeFieldDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.BiometricProcessingConsentDto

Property	Type	Required	Description
consentId	string (uuid)	no	—
grantedAt	string (date-time)	no	—
isActive	boolean	no	—
lawfulBasis	string | null	no	—
noticeVersion	string | null	no	—
processorName	string | null	no	—
proofingSessionId	string (uuid)	no	—
purpose	string | null	no	—
retentionStatement	string | null	no	—
withdrawnAt	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.BoundaryFieldDto

Property	Type	Required	Description
accessStateNow	string | null	no	—
fieldName	string | null	no	—
guardianCouldSee	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.BoundarySnapshotDto

Property	Type	Required	Description
auditAnchorRef	string | null	no	—
capturedAt	string (date-time)	no	—
contactCardId	string (uuid)	no	—
dataSubjectId	string (uuid)	no	—
fields	Essence.Consent.Core.Contracts.DTOs.BoundaryFieldDto[] | null	no	—
formerGuardianId	string (uuid)	no	—
snapshotId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.BulkCreateDelegationsRequest

Property	Type	Required	Description
items	Essence.Consent.Core.Contracts.DTOs.CreateDelegationRequest[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.BulkReServeResultDto

Property	Type	Required	Description
batchId	string (uuid)	no	—
completedAt	string (date-time)	no	—
locale	string | null	no	—
organizationId	string (uuid)	no	—
reServedCount	integer (int32)	no	—
totalConsents	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.BulkRevokeDelegationsRequest

Property	Type	Required	Description
delegateId	string (uuid) | null	no	—
delegationIds	(string (uuid))[] | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.BulkRevokePseudonymousConsentGrantsRequest

Property	Type	Required	Description
reason	string | null	no	—
subjectPseudonym	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.BulkRevokePseudonymousConsentGrantsResultDto

Property	Type	Required	Description
revokedConsentIds	(string (uuid))[] | null	no	—
revokedCount	integer (int32)	no	—
subjectPseudonym	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.CapabilityPresentationDto

Property	Type	Required	Description
capabilityId	string (uuid)	no	—
holderKeyThumbprint	string | null	no	—
presentation	string | null	no	—
validUntil	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.CapabilityRedemptionDto

Property	Type	Required	Description
actionDigest	string | null	no	—
capabilityId	string (uuid)	no	—
exercisedAt	string (date-time) | null	no	—
id	string (uuid)	no	—
operation	string | null	no	—
releasedAt	string (date-time) | null	no	—
remainingUses	integer (int64) | null	no	—
replayed	boolean	no	—
reservationExpiresAt	string (date-time)	no	—
reservedAt	string (date-time)	no	—
rootAuthorityId	string (uuid)	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.CapabilityStatusListDto

Property	Type	Required	Description
freshnessSeconds	integer (int32)	no	—
issuedAt	string (date-time)	no	—
issuer	string | null	no	—
statusList	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.CareLinkValidationResultDto

Property	Type	Required	Description
consentGrantId	string (uuid) | null	no	—
expiresAt	string (date-time) | null	no	—
grantorId	string (uuid) | null	no	—
isValid	boolean	no	—
linkDocumentId	string (uuid) | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.CascadeVaultSplitConsentsRequest

Property	Type	Required	Description
counterpartyId	string (uuid) | null	no	—
documentIds	(string (uuid))[] | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ChildConsentRegisterDto

Property	Type	Required	Description
childId	string (uuid)	no	—
generatedAt	string (date-time)	no	—
releaseCount	integer (int32)	no	—
releases	Essence.Consent.Core.Contracts.DTOs.ChildRecordReleaseDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.ChildhoodConsentDto

Property	Type	Required	Description
consentId	string (uuid)	no	—
fields	string[] | null	no	—
provenanceLabel	string | null	no	—
recipient	string | null	no	—
recipientKind	string | null	no	—
title	string | null	no	—
withdrawnAtIso	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.ChildhoodConsentWithdrawResultDto

Property	Type	Required	Description
auditRecordId	string (uuid)	no	—
withdrawnAtIso	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.ChildRecordReleaseDto

Property	Type	Required	Description
accessExpiresAt	string (date-time) | null	no	—
authorityRule	string | null	no	—
category	string | null	no	—
childId	string (uuid)	no	—
courtNamedParentId	string (uuid) | null	no	—
deniedAt	string (date-time) | null	no	—
grantedAt	string (date-time) | null	no	—
grantors	Essence.Consent.Core.Contracts.DTOs.ReleaseGrantorDto[] | null	no	—
id	string (uuid)	no	—
pendingApprovalId	string (uuid) | null	no	—
purpose	string | null	no	—
recipientId	string (uuid)	no	—
requestedAt	string (date-time)	no	—
revokedAt	string (date-time) | null	no	—
scopeDescription	string | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ClassifyImportContactRequest

Property	Type	Required	Description
audience	string | null	no	—
contactId	string (uuid)	no	—
processingBasisNote	string | null	no	—
tier	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ClosureTransferAskDto

Property	Type	Required	Description
answeredAt	string (date-time) | null	no	—
consentGrantRef	string (uuid) | null	no	—
expiresAt	string (date-time)	no	—
id	string (uuid)	no	—
recipientUserId	string (uuid)	no	—
requestedAt	string (date-time)	no	—
requesterUserId	string (uuid)	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ClosureTransferAskListDto

Property	Type	Required	Description
asks	Essence.Consent.Core.Contracts.DTOs.ClosureTransferAskDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.ClosureTransferConsentDto

Property	Type	Required	Description
answeredAt	string (date-time) | null	no	—
closureId	string (uuid)	no	—
consentGrantRef	string (uuid) | null	no	—
expiresAt	string (date-time) | null	no	—
id	string (uuid)	no	—
kind	string | null	no	—
linkId	string (uuid)	no	—
reason	string | null	no	—
recipientUserId	string (uuid) | null	no	—
recordedAtIso	string (date-time)	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ClosureTransferConsentListDto

Property	Type	Required	Description
consents	Essence.Consent.Core.Contracts.DTOs.ClosureTransferConsentDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.CollectiveAcceptanceDto

Property	Type	Required	Description
consentId	string (uuid)	no	—
decisionId	string (uuid)	no	—
fields	string[] | null	no	—
grantedAtIso	string | null	no	—
grantorUserId	string (uuid)	no	—
participantKey	string | null	no	—
purpose	string | null	no	—
withdrawalReason	string | null	no	—
withdrawnAtIso	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.CollectiveAcceptanceListDto

Property	Type	Required	Description
acceptances	Essence.Consent.Core.Contracts.DTOs.CollectiveAcceptanceDto[] | null	no	—
decisionId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.CollectiveDecisionCapabilitiesDto

Property	Type	Required	Description
digestAlgorithm	string | null	no	—
purposes	string[] | null	no	—
recordType	string | null	no	—
supported	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.CollectiveDecisionDto

Property	Type	Required	Description
callerIsOrganiser	boolean	no	—
decisionKey	string | null	no	—
id	string (uuid)	no	—
myAcceptances	Essence.Consent.Core.Contracts.DTOs.CollectiveAcceptanceDto[] | null	no	—
openedAtIso	string | null	no	—
purpose	string | null	no	—
rollup	Essence.Consent.Core.Contracts.DTOs.CollectiveDecisionRollupDto	no	—

Essence.Consent.Core.Contracts.DTOs.CollectiveDecisionRollupDto

Property	Type	Required	Description
acceptedParticipants	integer (int32)	no	—
asOfIso	string | null	no	—
digest	string | null	no	—
firstGrantedAtIso	string | null	no	—
grantors	integer (int32)	no	—
lastGrantedAtIso	string | null	no	—
liveGrants	integer (int32)	no	—
withdrawnParticipants	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.ComplianceSnapshotDisclosedFieldDto

Property	Type	Required	Description
assuranceLevel	string | null	no	—
disclosedAt	string (date-time)	no	—
disclosureId	string (uuid)	no	—
disclosureStatus	string | null	no	—
fieldKey	string | null	no	—
firstOpenedAt	string (date-time) | null	no	—
revokedAt	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.ComplianceSnapshotDto

Property	Type	Required	Description
anonymizedAt	string (date-time) | null	no	—
article9Condition	string | null	no	—
blockchainTransactionId	string | null	no	—
consentId	string (uuid)	no	—
createdAt	string (date-time)	no	—
disclosedFields	Essence.Consent.Core.Contracts.DTOs.ComplianceSnapshotDisclosedFieldDto[] | null	no	—
documentId	string (uuid)	no	—
framework	string | null	no	—
isAnonymized	boolean	no	—
mustRetainUntil	string (date-time)	no	—
snapshotId	string (uuid)	no	—
trigger	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentAccessReportDto

Property	Type	Required	Description
accessCount	integer (int32)	no	—
accesses	Essence.Consent.Core.Contracts.DTOs.ConsentGrantAccessDto[] | null	no	—
consentId	string (uuid)	no	—
distinctAccessorCount	integer (int32)	no	—
documentId	string (uuid)	no	—
expiresAt	string (date-time) | null	no	—
granteeId	string (uuid)	no	—
granteeType	string | null	no	—
maxAccessCount	integer (int32) | null	no	—
recipientLawfulBasis	string | null	no	—
recipientLawfulBasisDeclaredAt	string (date-time) | null	no	—
rosterGated	boolean	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentAccessRequestDto

Property	Type	Required	Description
accessRequestId	string (uuid)	no	—
approvalExpiresAt	string (date-time) | null	no	—
consentId	string (uuid)	no	—
consumedAt	string (date-time) | null	no	—
decidedAt	string (date-time) | null	no	—
documentId	string (uuid)	no	—
expiresAt	string (date-time)	no	—
granteeId	string (uuid)	no	—
grantorId	string (uuid)	no	—
requestedAt	string (date-time)	no	—
requesterId	string (uuid)	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentCredentialDescriptorDto

Property	Type	Required	Description
credentialType	string | null	no	—
documentId	string (uuid)	no	—
expiryDate	string (date-time)	no	—
issuer	string | null	no	—
version	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentDelegatedAgencyDto

Property	Type	Required	Description
accessLevel	string | null	no	—
engagementReference	string | null	no	—
expiresAt	string (date-time) | null	no	—
filingPeriodId	string | null	no	—
roleId	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentDocumentIssuanceEvidenceDto

Property	Type	Required	Description
contentHash	string | null	no	—
hasSourceImage	boolean	no	—
isUserAttested	boolean	no	—
issuedAt	string (date-time)	no	—
issuerKeyFingerprint	string | null	no	—
issuerOrganizationId	string (uuid) | null	no	—
signature	string | null	no	—
signatureAlgorithm	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentGrantAccessDto

Property	Type	Required	Description
accessedAt	string (date-time)	no	—
accessorUserId	string (uuid)	no	—
channel	string | null	no	—
rosterId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentGrantDto

Property	Type	Required	Description
accessCount	integer (int32)	no	—
actingUserId	string (uuid) | null	no	—
blockchainTransactionId	string | null	no	—
cadence	string | null	no	—
complianceFramework	string | null	no	—
complianceSnapshotId	string (uuid) | null	no	—
consentId	string (uuid)	no	—
credentialDescriptor	Essence.Consent.Core.Contracts.DTOs.ConsentCredentialDescriptorDto	no	—
credentialRevocation	Essence.Consent.Core.Contracts.DTOs.SharedCredentialRevocationDto	no	—
dataCategory	string | null	no	—
documentId	string (uuid)	no	—
grantType	string | null	no	—
grantedAt	string (date-time)	no	—
granteeId	string (uuid)	no	—
granteeType	string | null	no	—
grantorId	string (uuid)	no	—
grantorType	string | null	no	—
isRegulatedData	boolean	no	—
issuanceEvidence	Essence.Consent.Core.Contracts.DTOs.ConsentDocumentIssuanceEvidenceDto	no	—
lastAccessedAt	string (date-time) | null	no	—
legalHold	Essence.Consent.Core.Contracts.DTOs.LegalHoldDetailDto	no	—
maxAccessCount	integer (int32) | null	no	—
organizationName	string | null	no	—
policy	Essence.Consent.Core.Contracts.DTOs.ConsentPolicyDto	no	—
principalOrganizationId	string (uuid) | null	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
receiptContext	Essence.Consent.Core.Contracts.DTOs.ConsentReceiptContextDto	no	—
remainingAccessCount	integer (int32) | null	no	—
requiredFieldKeys	string[] | null	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
revokedBy	string (uuid) | null	no	—
sensitivity	integer (int32) | null	no	—
sharedBlobReference	string | null	no	—
sharedCredentialId	string | null	no	—
sharedFields	string[] | null	no	—
status	string | null	no	—
supersedesConsentId	string (uuid) | null	no	—
terminalComplianceSnapshotId	string (uuid) | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentGrantValidationResultDto

Property	Type	Required	Description
documentId	string (uuid) | null	no	—
grantSubjectId	string (uuid) | null	no	—
grantSubjectType	string | null	no	—
grantorId	string (uuid) | null	no	—
isReportingOnlyPurpose	boolean	no	—
isValid	boolean	no	—
purposeLimitationDenied	boolean	no	—
reason	string | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentLawfulBasisDto

Property	Type	Required	Description
article6Basis	string | null	no	—
justification	string | null	no	—
retentionDaysAfterEnd	integer (int32) | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentModifiedResponse

Property	Type	Required	Description
changeType	string | null	no	—
consentId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentNoticeReServeDto

Property	Type	Required	Description
batchId	string (uuid) | null	no	—
consentId	string (uuid)	no	—
fromLocale	string | null	no	—
grantorId	string (uuid)	no	—
id	string (uuid)	no	—
isAwaitingReAffirmation	boolean	no	—
organizationId	string (uuid) | null	no	—
outcome	string | null	no	—
purpose	string | null	no	—
reAffirmedAt	string (date-time) | null	no	—
reServedAt	string (date-time)	no	—
reserveAuditRef	string | null	no	—
toLocale	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentPolicyDto

Property	Type	Required	Description
allowDownload	boolean	no	—
allowForward	boolean	no	—
allowPrint	boolean	no	—
expiresAt	string (date-time) | null	no	—
maxAccessCount	integer (int32) | null	no	—
requiresApproval	boolean | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentPresentationReceiptDto

Property	Type	Required	Description
algorithm	string | null	no	—
keyId	string | null	no	—
presentationId	string (uuid)	no	—
receipt	string | null	no	—
recordedAt	string (date-time)	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentProvenanceDto

Property	Type	Required	Description
expiresAt	string (date-time) | null	no	—
exposedDataFields	string[] | null	no	—
grantorDisplayName	string | null	no	—
recipientKind	string | null	no	—
recipientLabel	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentReceiptContextDto

Property	Type	Required	Description
filingType	string | null	no	—
identityAssurance	Essence.Consent.Core.Contracts.DTOs.ConsentReceiptIdentityAssuranceDto	no	—
journeySlug	string | null	no	—
publicDisclosureAcknowledged	boolean	no	—
publicFieldKeys	string[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentReceiptDto

Property	Type	Required	Description
anchoringState	string | null	no	—
anchoringStatement	string | null	no	—
cadence	string | null	no	—
expiresAt	string (date-time) | null	no	—
grantedAt	string (date-time)	no	—
grantorType	string | null	no	—
lawfulBasis	string | null	no	—
lawfulBasisJustification	string | null	no	—
presentationReceipts	Essence.Consent.Core.Contracts.DTOs.ConsentPresentationReceiptDto[] | null	no	—
principalOrganizationId	string (uuid) | null	no	—
purpose	string | null	no	—
receiptId	string | null	no	—
retentionDaysAfterEnd	integer (int32) | null	no	—
revocable	boolean	no	—
revoked	boolean	no	—
scope	string | null	no	—
sharedByLabel	string | null	no	—
specialCategoryCondition	string | null	no	—
subProcessorDisclosure	Essence.Consent.Core.Contracts.DTOs.ConsentReceiptSubProcessorDisclosureDto	no	—
withdrawalEffect	string | null	no	—
withdrawalEffectStatement	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentReceiptIdentityAssuranceDto

Property	Type	Required	Description
auditAnchorReference	string | null	no	—
level	string | null	no	—
plainStatement	string | null	no	—
provenance	string | null	no	—
source	string | null	no	—
stale	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentReceiptSubProcessorDisclosureDto

Property	Type	Required	Description
appId	string | null	no	—
subProcessorDigest	string | null	no	—
subProcessorDigestAlgorithm	string | null	no	—
subProcessorListAsOf	string (date-time)	no	—
subProcessorListVersion	integer (int32)	no	—
subprocessorChangePolicy	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentRosterRoutingDto

Property	Type	Required	Description
consentId	string (uuid)	no	—
declaredAt	string (date-time)	no	—
declaredByUserId	string (uuid)	no	—
lawfulBasis	string | null	no	—
rosterId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentSharingKeyDto

Property	Type	Required	Description
authTagBase64	string | null	no	—
consentId	string (uuid)	no	—
nonceBase64	string | null	no	—
sharedBlobReference	string | null	no	—
wrappedSharingKey	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentSpecialCategoryBasisDto

Property	Type	Required	Description
affirmationStatement	string | null	no	—
article9Condition	string | null	no	—
purposeLimitation	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ConsentSubProcessorDisclosureDto

Property	Type	Required	Description
appId	string | null	no	—
subProcessorDigest	string | null	no	—
subProcessorDigestAlgorithm	string | null	no	—
subProcessorListAsOf	string (date-time) | null	no	—
subProcessorListVersion	integer (int32) | null	no	—
subprocessorChangePolicy	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ContactChangeGrantImpactDto

Property	Type	Required	Description
consentGrantId	string (uuid)	no	—
impact	string | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ContactChangeImpactDto

Property	Type	Required	Description
affectedGrants	Essence.Consent.Core.Contracts.DTOs.ContactChangeGrantImpactDto[] | null	no	—
assessedAt	string (date-time)	no	—
changeId	string (uuid)	no	—
committedAt	string (date-time)	no	—
reviewRecommendedCount	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.CoParentApprovalDto

Property	Type	Required	Description
canUndo	boolean	no	—
childId	string (uuid)	no	—
decidedAt	string (date-time) | null	no	—
decidedByParentId	string (uuid) | null	no	—
decisionReason	string | null	no	—
expectedApproverParentId	string (uuid) | null	no	—
id	string (uuid)	no	—
releaseId	string (uuid)	no	—
requestingParentId	string (uuid)	no	—
status	string | null	no	—
undoCount	integer (int32)	no	—
undoWindowExpiresAt	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.CreateAgentDelegationRequest

Property	Type	Required	Description
actions	string[] | null	no	—
agentDelegateId	string (uuid)	no	—
agentReference	string | null	no	—
automatedDecisionMaking	boolean	no	—
automatedDecisionNote	string | null	no	—
capabilityMaxUses	integer (int32) | null	no	—
disclosureCeiling	string | null	no	—
documentTypes	string[] | null	no	—
expiresAt	string (date-time)	no	—
holderPublicJwk	string | null	no	—
label	string | null	no	—
operatorRole	string | null	no	—
reviewDueAt	string (date-time) | null	no	—
templateKey	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.CreateDelegationRequest

Property	Type	Required	Description
delegateId	string (uuid)	no	—
expiresAt	string (date-time)	no	—
label	string | null	no	—
reviewDueAt	string (date-time)	no	—
scopes	Essence.Consent.Core.Contracts.DTOs.DelegationScopeDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.CreateDriverCredentialStatusShareRequest

Property	Type	Required	Description
expiresAt	string (date-time) | null	no	—
organizationId	string (uuid)	no	—
purpose	string | null	no	—
scope	string[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.CreateOrgActOnBehalfGrantRequest

Property	Type	Required	Description
agentOrganizationId	string (uuid)	no	—
authorityBasis	string | null	no	—
capabilities	string[] | null	no	—
effectiveFrom	string (date-time) | null	no	—
expiresAt	string (date-time)	no	—
lawfulBasis	string | null	no	—
purpose	string | null	no	—
sourceReference	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.CreateScopeOfAuthorityRequest

Property	Type	Required	Description
attorneyId	string (uuid)	no	—
attorneyRole	string | null	no	—
authorityExpiresAt	string (date-time) | null	no	—
authorityReference	string | null	no	—
categories	Essence.Consent.Core.Contracts.DTOs.ScopeCategoryDto[] | null	no	—
fields	Essence.Consent.Core.Contracts.DTOs.ScopeFieldDto[] | null	no	—
issuedAt	string (date-time)	no	—
issuingAuthority	string | null	no	—
jurisdiction	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.CreateSupervisionControlTemplateRequest

Property	Type	Required	Description
changeNote	string | null	no	—
jurisdiction	string | null	no	—
lawfulBasis	string | null	no	—
majorityAge	integer (int32)	no	—
name	string | null	no	—
organisationId	string (uuid) | null	no	—
thresholds	Essence.Consent.Core.Contracts.DTOs.SupervisionGraduationThresholdDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.CredentialConsentImpactDto

Property	Type	Required	Description
recipients	Essence.Consent.Core.Contracts.DTOs.CredentialConsentImpactRecipientDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.CredentialConsentImpactRecipientDto

Property	Type	Required	Description
credentialIds	string[] | null	no	—
grantIds	(string (uuid))[] | null	no	—
recipientId	string (uuid)	no	—
recipientLabel	string | null	no	—
recipientType	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.CredentialConsentImpactRequest

Property	Type	Required	Description
credentialIds	string[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.CustodianGrantDto

Property	Type	Required	Description
asOf	string (date-time)	no	—
custodianOrgId	string (uuid)	no	—
expiresAt	string (date-time)	no	—
extensionCount	integer (int32)	no	—
externalReference	string | null	no	—
grantId	string (uuid)	no	—
granteeUserId	string (uuid)	no	—
lastExtendedAt	string (date-time) | null	no	—
lawfulBasis	string | null	no	—
provisionedAt	string (date-time)	no	—
provisionedBy	string (uuid)	no	—
recordDomains	string[] | null	no	—
revocationReasonCode	string | null	no	—
revokedAt	string (date-time) | null	no	—
state	string | null	no	—
subjectRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.CustodianGrantListDto

Property	Type	Required	Description
items	Essence.Consent.Core.Contracts.DTOs.CustodianGrantDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.DecideCoParentApprovalRequest

Property	Type	Required	Description
approve	boolean	no	—
authorityBasis	string | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.DecideGuardianGrantedConsentRequest

Property	Type	Required	Description
decision	string | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.DeclareSharedCredentialRequest

Property	Type	Required	Description
credentialId	string | null	no	—
issuerOrganizationId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.DeferredGrantRegisterDto

Property	Type	Required	Description
activatedCount	integer (int32)	no	—
dormantCount	integer (int32)	no	—
grantorId	string (uuid)	no	—
grants	Essence.Consent.Core.Contracts.DTOs.DeferredGrantSummaryDto[] | null	no	—
revokedCount	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.DeferredGrantSummaryDto

Property	Type	Required	Description
activatedAt	string (date-time) | null	no	—
authorityBasis	string | null	no	—
consentId	string (uuid)	no	—
dashboardState	string | null	no	—
isDormant	boolean	no	—
itemCount	integer (int32)	no	—
items	Essence.Consent.Core.Contracts.DTOs.ReleaseScopeItemDto[] | null	no	—
preAuthorisedAt	string (date-time)	no	—
purpose	string | null	no	—
recipientId	string (uuid)	no	—
recipientKind	string | null	no	—
releaseTier	string | null	no	—
revealedItemCount	integer (int32)	no	—
revocable	boolean	no	—
revokedAt	string (date-time) | null	no	—
status	string | null	no	—
triggerCondition	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.DelegatedCapabilityDetailDto

Property	Type	Required	Description
capability	Essence.Consent.Core.Contracts.DTOs.DelegatedCapabilityDto	no	—
chain	string[] | null	no	—
redemptions	Essence.Consent.Core.Contracts.DTOs.CapabilityRedemptionDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.DelegatedCapabilityDto

Property	Type	Required	Description
capabilityToken	string | null	no	—
credentialTypes	string[] | null	no	—
delegateAgentId	string (uuid) | null	no	—
delegateRef	string | null	no	—
delegationDepth	integer (int32)	no	—
disclosureCeiling	string | null	no	—
disclosureCeilingDescription	string | null	no	—
fields	string[] | null	no	—
holderKeyThumbprint	string | null	no	—
id	string (uuid)	no	—
isLive	boolean	no	—
issuedAt	string (date-time)	no	—
issuers	string[] | null	no	—
maxDepth	integer (int32)	no	—
maxUses	integer (int32)	no	—
operations	string[] | null	no	—
parentId	string (uuid)	no	—
parentKind	string | null	no	—
principalId	string (uuid)	no	—
purposes	string[] | null	no	—
recipients	string[] | null	no	—
redemptionCount	integer (int32)	no	—
resources	string[] | null	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
rootAuthorityId	string (uuid)	no	—
rootAuthorityKind	string | null	no	—
status	string | null	no	—
validUntil	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.DelegationActionDto

Property	Type	Required	Description
capability	string | null	no	—
delegateId	string (uuid)	no	—
delegationId	string (uuid)	no	—
description	string | null	no	—
id	string (uuid)	no	—
performedAt	string (date-time)	no	—
surface	string | null	no	—
targetRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.DelegationBulkRevocationDto

Property	Type	Required	Description
id	string (uuid)	no	—
lines	Essence.Consent.Core.Contracts.DTOs.DelegationBulkRevocationLineDto[] | null	no	—
operatorId	string (uuid)	no	—
outcome	string | null	no	—
performedAt	string (date-time)	no	—
principalId	string (uuid)	no	—
reason	string | null	no	—
requestedCount	integer (int32)	no	—
revokedCount	integer (int32)	no	—
targetDelegateId	string (uuid) | null	no	—

Essence.Consent.Core.Contracts.DTOs.DelegationBulkRevocationLineDto

Property	Type	Required	Description
closureRecord	Essence.Consent.Core.Contracts.DTOs.DelegationClosureRecordDto	no	—
delegateId	string (uuid) | null	no	—
delegationId	string (uuid)	no	—
result	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.DelegationCandidateDto

Property	Type	Required	Description
delegateId	string (uuid)	no	—
delegationCount	integer (int32)	no	—
label	string | null	no	—
lastDelegatedAt	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.DelegationClosureRecordDto

Property	Type	Required	Description
actionCount	integer (int32)	no	—
cachePurgeStatus	string | null	no	—
delegateId	string (uuid)	no	—
delegationId	string (uuid)	no	—
expiresAt	string (date-time)	no	—
generatedAt	string (date-time)	no	—
grantedAt	string (date-time)	no	—
label	string | null	no	—
principalId	string (uuid)	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
revokedBy	string (uuid) | null	no	—
scopes	Essence.Consent.Core.Contracts.DTOs.DelegationScopeDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.DelegationCollectionDto

Property	Type	Required	Description
collectionRef	string | null	no	—
surface	string | null	no	—
usedInDelegations	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.DelegationDto

Property	Type	Required	Description
cachePurgeStatus	string | null	no	—
delegateId	string (uuid)	no	—
expiresAt	string (date-time)	no	—
grantedAt	string (date-time)	no	—
id	string (uuid)	no	—
isActionable	boolean	no	—
label	string | null	no	—
lastReconfirmedAt	string (date-time) | null	no	—
principalId	string (uuid)	no	—
reconfirmCount	integer (int32)	no	—
reviewDueAt	string (date-time)	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
revokedBy	string (uuid) | null	no	—
scopes	Essence.Consent.Core.Contracts.DTOs.DelegationScopeDto[] | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.DelegationScopeDto

Property	Type	Required	Description
capabilities	string[] | null	no	—
collectionRefs	string[] | null	no	—
surface	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.DelegationTemplateDto

Property	Type	Required	Description
description	string | null	no	—
key	string | null	no	—
name	string | null	no	—
scopes	Essence.Consent.Core.Contracts.DTOs.DelegationScopeDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.DelegationValidationResultDto

Property	Type	Required	Description
delegateId	string (uuid) | null	no	—
delegationId	string (uuid) | null	no	—
expiresAt	string (date-time) | null	no	—
isValid	boolean	no	—
principalId	string (uuid) | null	no	—
reason	string | null	no	—
reviewDueAt	string (date-time) | null	no	—
revokedAt	string (date-time) | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.DenyConsentAccessRequestRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.DenyConsentRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.DonorCaseSummaryDto

Property	Type	Required	Description
assigneeId	string (uuid) | null	no	—
assigneeName	string | null	no	—
caseId	string (uuid)	no	—
caseReference	string | null	no	—
donorRef	string | null	no	—
eraKey	string | null	no	—
lawfulBasis	string | null	no	—
lodgedAt	string (date-time)	no	—
regimeId	string | null	no	—
requested	string[] | null	no	—
requesterRef	string | null	no	—
reviewWeeks	Essence.Consent.Core.Contracts.DTOs.DonorReviewWeeksDto	no	—
state	string | null	no	—
stateChangedAt	string (date-time)	no	—
wantsSupportFirst	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.DonorDisclosurePreferenceDto

Property	Type	Required	Description
donorRef	string | null	no	—
effectiveFrom	string (date-time)	no	—
effectiveTo	string (date-time) | null	no	—
isStatutoryReRegistration	boolean	no	—
preferenceId	string (uuid)	no	—
recordedAt	string (date-time)	no	—
scope	string | null	no	—
statutoryReRegistrationRef	string | null	no	—
version	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.DonorReviewWeeksDto

Property	Type	Required	Description
max	integer (int32)	no	—
min	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.DonorWithholdingRequest

Property	Type	Required	Description
groundCode	string | null	no	—
justification	string | null	no	—
plainReason	string | null	no	—
statuteRef	string | null	no	—
what	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.DriverCredentialStatusShareDto

Property	Type	Required	Description
blockchainTransactionId	string | null	no	—
driverSubjectId	string (uuid)	no	—
expiresAt	string (date-time) | null	no	—
grantRef	string | null	no	—
grantedAt	string (date-time)	no	—
organizationId	string (uuid)	no	—
purpose	string | null	no	—
revocationBlockchainTransactionId	string | null	no	—
revokedAt	string (date-time) | null	no	—
scope	string[] | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.EndVehicleLeaseRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.EstablishRelianceRequest

Property	Type	Required	Description
validUntil	string (date-time) | null	no	—
verificationId	string | null	no	—
verificationType	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ExecuteRingEnforcementRequest

Property	Type	Required	Description
decidedByUserId	string (uuid)	no	—
enforcementDecisionId	string (uuid)	no	—
reasonCode	string | null	no	—
ringId	string (uuid)	no	—
subjects	Essence.Consent.Core.Contracts.DTOs.RingEnforcementSubjectRequestDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.ExecutorAppointmentCaseDto

Property	Type	Required	Description
activatedAt	string (date-time) | null	no	—
appointedAt	string (date-time)	no	—
assignedOfficerUserId	string (uuid) | null	no	—
authorityBasis	string | null	no	—
clientId	string (uuid)	no	—
consentId	string (uuid)	no	—
itemCount	integer (int32)	no	—
items	Essence.Consent.Core.Contracts.DTOs.ReleaseScopeItemDto[] | null	no	—
releaseTier	string | null	no	—
revealedItemCount	integer (int32)	no	—
scopeWithheldWhileDormant	boolean	no	—
stage	string | null	no	—
status	string | null	no	—
withdrawnAt	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.ExecutorAppointmentCaseloadDto

Property	Type	Required	Description
awaitingOfficerCount	integer (int32)	no	—
cases	Essence.Consent.Core.Contracts.DTOs.ExecutorAppointmentCaseDto[] | null	no	—
dormantCount	integer (int32)	no	—
organizationId	string (uuid)	no	—
triggeredCount	integer (int32)	no	—
withdrawnCount	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.ExecutorBequestDonorGroupDto

Property	Type	Required	Description
activatedAt	string (date-time) | null	no	—
consentId	string (uuid)	no	—
donorId	string (uuid)	no	—
items	Essence.Consent.Core.Contracts.DTOs.ReleaseScopeItemDto[] | null	no	—
lawfulBasis	string | null	no	—
purpose	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ExecutorBequestDto

Property	Type	Required	Description
donors	Essence.Consent.Core.Contracts.DTOs.ExecutorBequestDonorGroupDto[] | null	no	—
recipientId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.ExecutorOfficerAccessDto

Property	Type	Required	Description
actingOfficerUserId	string (uuid)	no	—
actingOrganizationId	string (uuid)	no	—
action	string | null	no	—
detail	string | null	no	—
entryHash	string | null	no	—
itemId	string (uuid) | null	no	—
previousEntryHash	string | null	no	—
previousOfficerUserId	string (uuid) | null	no	—
recordedAt	string (date-time)	no	—
rosterAttested	boolean	no	—
sequence	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.ExerciseCapabilityRedemptionRequest

Property	Type	Required	Description
actionDigest	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ExtendCustodianGrantRequest

Property	Type	Required	Description
custodianOrgId	string (uuid) | null	no	—
expiresAt	string (date-time) | null	no	—
externalReference	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ExtendVehicleLeaseRequest

Property	Type	Required	Description
endsAtIso	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.FieldVisibilityGrantDto

Property	Type	Required	Description
contactRef	string | null	no	—
field	string | null	no	—
groupLabel	string | null	no	—
householdId	string | null	no	—
memberRef	string | null	no	—
visible	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.FileVisitorConsentRecordRequest

Property	Type	Required	Description
choices	Essence.Consent.Core.Contracts.DTOs.VisitorConsentChoicesDto	no	—
decidedVia	string | null	no	—
deviceAccessRule	string | null	no	—
jurisdiction	string | null	no	—
notice	Essence.Consent.Core.Contracts.DTOs.VisitorConsentNoticeDto	no	—
recordId	string | null	no	—
recordedAt	string | null	no	—
regime	string | null	no	—
regimeIsGdprLawfulBasis	boolean | null	no	—
regimeSource	string | null	no	—
schema	string | null	no	—
subject	string | null	no	—
supersedesRecordId	string | null	no	—
symmetry	Essence.Consent.Core.Contracts.DTOs.VisitorConsentSymmetryDto	no	—

Essence.Consent.Core.Contracts.DTOs.ForceRevokeAgentDelegationsRequest

Property	Type	Required	Description
agentReference	string | null	no	—
incidentId	string (uuid)	no	—
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.FrameModuleSwitchConsentRescopeRequest

Property	Type	Required	Description
incumbentGrants	Essence.Consent.Core.Contracts.DTOs.RescopeIncumbentGrantDto[] | null	no	—
policy	string | null	no	—
sourceModuleId	string | null	no	—
subjectRef	string | null	no	—
targetModuleId	string | null	no	—
targetRequests	Essence.Consent.Core.Contracts.DTOs.RescopeTargetRequestDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.GivePurposeScopedGrantRequest

Property	Type	Required	Description
expiresAt	string (date-time)	no	—
granteeOrganizationId	string (uuid)	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
subjectReference	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.GiveScamEvidenceDisclosureGrantRequest

Property	Type	Required	Description
claimReference	string | null	no	—
evidenceItemIds	string[] | null	no	—
expiresAt	string (date-time)	no	—
receivingBankOrganizationId	string (uuid) | null	no	—
sendingBankOrganizationId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.GraduationThresholdDto

Property	Type	Required	Description
ageYears	integer (int32)	no	—
capabilityUnlocked	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.GrantCollectiveAcceptanceRequest

Property	Type	Required	Description
fields	string[] | null	no	—
participantKey	string | null	no	—
purpose	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.GrantConsentRequest

Property	Type	Required	Description
authTagBase64	string | null	no	—
cadence	string | null	no	—
complianceFramework	string | null	no	—
delegatedAgency	Essence.Consent.Core.Contracts.DTOs.ConsentDelegatedAgencyDto	no	—
disclosedFieldKeys	string[] | null	no	—
documentId	string (uuid)	no	—
explicitlySpecialCategoryFields	string[] | null	no	—
grantAsOrganisation	boolean	no	—
grantRequestId	string (uuid) | null	no	—
grantType	string | null	no	—
granteeId	string (uuid)	no	—
granteeType	string | null	no	—
isRegulatedData	boolean	no	—
issuanceEvidence	Essence.Consent.Core.Contracts.DTOs.ConsentDocumentIssuanceEvidenceDto	no	—
lawfulBasis	Essence.Consent.Core.Contracts.DTOs.ConsentLawfulBasisDto	no	—
nonceBase64	string | null	no	—
policy	Essence.Consent.Core.Contracts.DTOs.ConsentPolicyDto	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
receiptContext	Essence.Consent.Core.Contracts.DTOs.ConsentReceiptContextDto	no	—
requiredFieldKeys	string[] | null	no	—
resumedInFlightActionId	string (uuid) | null	no	—
sharedBlobReference	string | null	no	—
specialCategoryBasis	Essence.Consent.Core.Contracts.DTOs.ConsentSpecialCategoryBasisDto	no	—
subProcessorDisclosure	Essence.Consent.Core.Contracts.DTOs.ConsentSubProcessorDisclosureDto	no	—
supersedesConsentId	string (uuid) | null	no	—
wrappedSharingKey	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.GrantConsentResponse

Property	Type	Required	Description
blockchainTransactionId	string | null	no	—
complianceSnapshotId	string (uuid) | null	no	—
consentId	string (uuid)	no	—
grantedAt	string (date-time)	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.GranteeRosterDto

Property	Type	Required	Description
activeMemberCount	integer (int32)	no	—
closedAt	string (date-time) | null	no	—
closedByUserId	string (uuid) | null	no	—
id	string (uuid)	no	—
members	Essence.Consent.Core.Contracts.DTOs.GranteeRosterMemberDto[] | null	no	—
openedAt	string (date-time)	no	—
openedByUserId	string (uuid)	no	—
organizationId	string (uuid)	no	—
reference	string | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.GranteeRosterListDto

Property	Type	Required	Description
items	Essence.Consent.Core.Contracts.DTOs.GranteeRosterDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.GranteeRosterMemberDto

Property	Type	Required	Description
active	boolean	no	—
addedAt	string (date-time)	no	—
addedByUserId	string (uuid)	no	—
removedAt	string (date-time) | null	no	—
removedByUserId	string (uuid) | null	no	—
userId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.GrantGuardianConsentRequest

Property	Type	Required	Description
ageAssurance	Essence.Consent.Core.Contracts.DTOs.AgeAssuranceDto	no	—
ageOfMajorityYears	integer (int32) | null	no	—
childAgeYears	integer (int32)	no	—
childId	string (uuid)	no	—
graduationSchedule	Essence.Consent.Core.Contracts.DTOs.GraduationThresholdDto[] | null	no	—
jurisdictionCode	string | null	no	—
provenance	Essence.Consent.Core.Contracts.DTOs.ConsentProvenanceDto	no	—
purpose	string | null	no	—
scopeDescription	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.GrantSecretDelegationRequest

Property	Type	Required	Description
expiresAt	string (date-time) | null	no	—
holderId	string (uuid)	no	—
holderKind	string | null	no	—
scope	string | null	no	—
secretId	string (uuid)	no	—
secretVersion	integer (int32)	no	—
wrappedSecretRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.GrantVehicleLeaseRequest

Property	Type	Required	Description
categories	string[] | null	no	—
deviceId	string | null	no	—
endsAtIso	string | null	no	—
operatorName	string | null	no	—
startsAtIso	string | null	no	—
vehicleLabel	string | null	no	—
windowUnit	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.GuardianConsentDto

Property	Type	Required	Description
ageAssurance	Essence.Consent.Core.Contracts.DTOs.AgeAssuranceDto	no	—
ageOfMajorityYears	integer (int32)	no	—
childAgeYears	integer (int32)	no	—
childId	string (uuid)	no	—
graduationSchedule	Essence.Consent.Core.Contracts.DTOs.GraduationThresholdDto[] | null	no	—
grantedAt	string (date-time)	no	—
guardianId	string (uuid)	no	—
id	string (uuid)	no	—
jurisdictionCode	string | null	no	—
lawfulBasis	string | null	no	—
majorityReachedAt	string (date-time) | null	no	—
projectedMajorityAt	string (date-time)	no	—
provenance	Essence.Consent.Core.Contracts.DTOs.ConsentProvenanceDto	no	—
provenanceLabel	string | null	no	—
purpose	string | null	no	—
reconsentDecidedAt	string (date-time) | null	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
scopeDescription	string | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.GuardianGrantedConsentDecisionResultDto

Property	Type	Required	Description
auditRecordId	string (uuid)	no	—
decidedAtIso	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.GuardianGrantedConsentDto

Property	Type	Required	Description
consentId	string (uuid)	no	—
decision	string | null	no	—
fields	string[] | null	no	—
grantedAtIso	string (date-time) | null	no	—
grantedByGuardianName	string | null	no	—
purposePlain	string | null	no	—
recipient	string | null	no	—
recipientKind	string | null	no	—
title	string | null	no	—
urgent	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.HandoverExecutorOfficerRequest

Property	Type	Required	Description
fromOfficerUserId	string (uuid)	no	—
reason	string | null	no	—
toOfficerUserId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.HolderDocumentStandingDto

Property	Type	Required	Description
current	Essence.Consent.Core.Contracts.DTOs.HolderDocumentVersionDto	no	—
kind	string | null	no	—
latest	Essence.Consent.Core.Contracts.DTOs.HolderLatestAnswerDto	no	—
reason	string | null	no	—
state	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.HolderDocumentVersionDto

Property	Type	Required	Description
href	string | null	no	—
sha256	string | null	no	—
text	string | null	no	—
textStatus	string | null	no	—
title	string | null	no	—
version	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.HolderLatestAnswerDto

Property	Type	Required	Description
outcome	string | null	no	—
recordedAt	string (date-time)	no	—
trigger	string | null	no	—
version	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.HolderUnderstandingStatusDto

Property	Type	Required	Description
documents	Essence.Consent.Core.Contracts.DTOs.HolderDocumentStandingDto[] | null	no	—
mode	string | null	no	—
reconfirmBy	string (date-time) | null	no	—
satisfied	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.HouseholdConsentLogDto

Property	Type	Required	Description
householdId	string | null	no	—
records	Essence.Consent.Core.Contracts.DTOs.IntraHouseholdConsentRecordDto[] | null	no	—
total	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.HouseholdMemberRevocationResultDto

Property	Type	Required	Description
consentLogRecordId	string | null	no	—
guarantee	string | null	no	—
householdId	string | null	no	—
memberRef	string | null	no	—
purgeRequested	boolean	no	—
replayed	boolean	no	—
revokedAtIso	string | null	no	—
revokedGrantCount	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.ImportClassificationLedgerDto

Property	Type	Required	Description
contacts	Essence.Consent.Core.Contracts.DTOs.ImportContactClassificationDto[] | null	no	—
importId	string (uuid)	no	—
ownerId	string (uuid)	no	—
shareableCount	integer (int32)	no	—
totalClassified	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.ImportContactClassificationDto

Property	Type	Required	Description
audience	string | null	no	—
contactId	string (uuid)	no	—
createdAt	string (date-time)	no	—
grantId	string (uuid)	no	—
importId	string (uuid)	no	—
ownerId	string (uuid)	no	—
processingBasisNote	string | null	no	—
revokedAt	string (date-time) | null	no	—
revokedReason	string | null	no	—
shareable	boolean	no	—
status	string | null	no	—
tier	string | null	no	—
updatedAt	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.InjectionConsentValidationResultDto

Property	Type	Required	Description
consentGrantId	string (uuid) | null	no	—
documentId	string (uuid) | null	no	—
expiresAt	string (date-time) | null	no	—
isValid	boolean	no	—
reason	string | null	no	—
requesterId	string (uuid) | null	no	—
status	string | null	no	—
targetUserId	string (uuid) | null	no	—

Essence.Consent.Core.Contracts.DTOs.IntraHouseholdConsentRecordDto

Property	Type	Required	Description
granteeRef	string | null	no	—
grantorRef	string | null	no	—
householdId	string | null	no	—
kind	string | null	no	—
occurredAtIso	string | null	no	—
recordId	string | null	no	—
scopeSummary	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.IssueChildCapabilityRequest

Property	Type	Required	Description
credentialTypes	string[] | null	no	—
delegateAgentId	string (uuid) | null	no	—
delegateRef	string | null	no	—
disclosureCeiling	string | null	no	—
fields	string[] | null	no	—
holderPublicJwk	string | null	no	—
issuers	string[] | null	no	—
maxDepth	integer (int32) | null	no	—
maxUses	integer (int32) | null	no	—
operations	string[] | null	no	—
purposes	string[] | null	no	—
recipients	string[] | null	no	—
resources	string[] | null	no	—
validUntil	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.IssueDelegatedCapabilityRequest

Property	Type	Required	Description
credentialTypes	string[] | null	no	—
delegateAgentId	string (uuid) | null	no	—
delegateRef	string | null	no	—
disclosureCeiling	string | null	no	—
fields	string[] | null	no	—
holderPublicJwk	string | null	no	—
issuers	string[] | null	no	—
maxDepth	integer (int32) | null	no	—
maxUses	integer (int32) | null	no	—
operations	string[] | null	no	—
parentId	string (uuid)	no	—
parentKind	string | null	no	—
purposes	string[] | null	no	—
recipients	string[] | null	no	—
resources	string[] | null	no	—
validUntil	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.IssueOrganisationDisclosureGrantRequest

Property	Type	Required	Description
documentRefs	string[] | null	no	—
expiresAt	string (date-time)	no	—
externalReference	string | null	no	—
organizationId	string (uuid) | null	no	—
purpose	string | null	no	—
recipientName	string | null	no	—
recipientRef	string | null	no	—
scopeDigest	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.IssueSelfExclusionCredentialRequest

Property	Type	Required	Description
jurisdiction	string | null	no	—
scheme	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.LeasePurgeReportDto

Property	Type	Required	Description
accessRevokedAtIso	string | null	no	—
attestation	Essence.Consent.Core.Contracts.DTOs.VehiclePurgeAttestationDto	no	—
auditAnchorId	string | null	no	—
deviceId	string | null	no	—
edgeErasedAtIso	string | null	no	—
leaseId	string (uuid)	no	—
outcomes	Essence.Consent.Core.Contracts.DTOs.PurgeCategoryOutcomeDto[] | null	no	—
vehicleLabel	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.LegalHoldDetailDto

Property	Type	Required	Description
expiresAt	string (date-time) | null	no	—
holdId	string (uuid)	no	—
owner	string | null	no	—
placedAt	string (date-time)	no	—
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.LodgeDonorRegisterCaseRequest

Property	Type	Required	Description
caseReference	string | null	no	—
donorRef	string | null	no	—
eraKey	string | null	no	—
identityProven	boolean	no	—
lawfulBasis	string | null	no	—
regimeId	string | null	no	—
requested	string[] | null	no	—
requesterRef	string | null	no	—
reviewWeeks	Essence.Consent.Core.Contracts.DTOs.DonorReviewWeeksDto	no	—
wantsSupportFirst	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.LodgeOriginRecordsApplicationRequest

Property	Type	Required	Description
action	string | null	no	—
agencyOrganizationId	string (uuid) | null	no	—
evidenceConfirmed	string[] | null	no	—
items	string[] | null	no	—
lawfulBasis	string | null	no	—
regimeKey	string | null	no	—
requiresIntermediary	boolean | null	no	—

Essence.Consent.Core.Contracts.DTOs.LodgeOriginRecordsCaseRequest

Property	Type	Required	Description
applicantRef	string | null	no	—
caseReference	string | null	no	—
citableExemptions	Essence.Consent.Core.Contracts.DTOs.OriginRecordsCitableExemptionRequest[] | null	no	—
identityProven	boolean	no	—
lawfulBasis	string | null	no	—
organizationId	string (uuid) | null	no	—
regimeKey	string | null	no	—
requestedItems	Essence.Consent.Core.Contracts.DTOs.OriginRecordsRequestedItemRequest[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.MajorityReconsentRequest

Property	Type	Required	Description
keep	boolean	no	—
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.MakeRetainedAttestationRequest

Property	Type	Required	Description
attestationType	string | null	no	—
organizationId	string (uuid)	no	—
sourceReference	string | null	no	—
statementDigest	string | null	no	—
statementTemplate	string | null	no	—
supersedesId	string (uuid) | null	no	—

Essence.Consent.Core.Contracts.DTOs.MinorConfidentialBreakGlassDto

Property	Type	Required	Description
explanation	string | null	no	—
includedInSummary	boolean	no	—
suppressedRecipients	(string (uuid))[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.MinorConfidentialConsentConfirmationDto

Property	Type	Required	Description
breakGlass	Essence.Consent.Core.Contracts.DTOs.MinorConfidentialBreakGlassDto	no	—
categoryLabel	string | null	no	—
confirmedAt	string (date-time)	no	—
consentGrantRef	string (uuid)	no	—
created	boolean	no	—
excludedGuardians	Essence.Consent.Core.Contracts.DTOs.MinorConfidentialExcludedGuardianDto[] | null	no	—
noNotificationSent	boolean	no	—
recordRef	string (uuid)	no	—
statusMessage	string | null	no	—
subjectRef	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.MinorConfidentialExcludedGuardianDto

Property	Type	Required	Description
displayLabel	string | null	no	—
guardianActorId	string (uuid)	no	—
proxyRole	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ModuleSwitchConsentRescopeDto

Property	Type	Required	Description
application	Essence.Consent.Core.Contracts.DTOs.RescopeApplicationDto	no	—
decisions	Essence.Consent.Core.Contracts.DTOs.RescopeDecisionDto[] | null	no	—
framedAt	string (date-time)	no	—
incumbentGrants	Essence.Consent.Core.Contracts.DTOs.RescopeIncumbentGrantDto[] | null	no	—
policy	string | null	no	—
sourceModuleId	string | null	no	—
subjectRef	string | null	no	—
switchId	string (uuid)	no	—
targetModuleId	string | null	no	—
targetRequests	Essence.Consent.Core.Contracts.DTOs.RescopeTargetRequestDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.ModuleSwitchEnvelopeOfEssence.Consent.Core.Contracts.DTOs.ModuleSwitchConsentRescopeDto

Property	Type	Required	Description
data	Essence.Consent.Core.Contracts.DTOs.ModuleSwitchConsentRescopeDto	no	—

Essence.Consent.Core.Contracts.DTOs.MyLocaleAssessmentDto

Property	Type	Required	Description
assessedAt	string (date-time) | null	no	—
entries	Essence.Consent.Core.Contracts.DTOs.ConsentNoticeReServeDto[] | null	no	—
posture	Essence.Consent.Core.Contracts.DTOs.ReServePostureDto	no	—
reAffirmationRequiredCount	integer (int32)	no	—
reServedCount	integer (int32)	no	—
reserveAuditRef	string | null	no	—
status	string | null	no	—
toLocale	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.NoticeCohortDto

Property	Type	Required	Description
awaitingReAffirmationCount	integer (int32)	no	—
consentCount	integer (int32)	no	—
locale	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.NoticeCohortsDto

Property	Type	Required	Description
cohorts	Essence.Consent.Core.Contracts.DTOs.NoticeCohortDto[] | null	no	—
organizationId	string (uuid)	no	—
reServeMode	string | null	no	—
totalConsents	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.OfficerAttributionExportDto

Property	Type	Required	Description
activationEventReference	string | null	no	—
authorityBasis	string | null	no	—
authorityReference	string | null	no	—
chainHeadHash	string | null	no	—
chainIntact	boolean	no	—
consentId	string (uuid)	no	—
donorId	string (uuid)	no	—
entries	Essence.Consent.Core.Contracts.DTOs.ExecutorOfficerAccessDto[] | null	no	—
firstBrokenSequence	integer (int32) | null	no	—
organizationId	string (uuid)	no	—
releaseTier	string | null	no	—
rosterBacked	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.OpenCollectiveDecisionRequest

Property	Type	Required	Description
decisionKey	string | null	no	—
purpose	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.OpenGranteeRosterRequest

Property	Type	Required	Description
reference	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.OpenSelfExclusionPresentationRequest

Property	Type	Required	Description
exclusionId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.OpenSuccessionApprovalRequest

Property	Type	Required	Description
caseId	string (uuid)	no	—
companyId	string (uuid)	no	—
currency	string | null	no	—
deceasedShareholderId	string (uuid)	no	—
parties	Essence.Consent.Core.Contracts.DTOs.SuccessionApprovalPartyRequest[] | null	no	—
pricePerShareMinor	integer (int64)	no	—
shareClass	string | null	no	—
shareCount	integer (int64)	no	—

Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfAuthorizationDto

Property	Type	Required	Description
at	string (date-time)	no	—
authorised	boolean	no	—
authorityBasis	string | null	no	—
capability	string | null	no	—
grantId	string (uuid)	no	—
purpose	string | null	no	—
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfGrantDto

Property	Type	Required	Description
acceptedAt	string (date-time) | null	no	—
agentOrganizationId	string (uuid)	no	—
authorityBasis	string | null	no	—
capabilities	string[] | null	no	—
effectiveFrom	string (date-time)	no	—
expiresAt	string (date-time)	no	—
grantedAt	string (date-time)	no	—
grantedByUserId	string (uuid)	no	—
id	string (uuid)	no	—
lawfulBasis	string | null	no	—
principalOrganizationId	string (uuid)	no	—
purpose	string | null	no	—
requiresAgentAcceptance	boolean	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
revokedByOrganizationId	string (uuid) | null	no	—
sourceReference	string | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfGrantListDto

Property	Type	Required	Description
grants	Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfGrantDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfGrantResultDto

Property	Type	Required	Description
changed	boolean	no	—
grant	Essence.Consent.Core.Contracts.DTOs.OrgActOnBehalfGrantDto	no	—

Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureAccessEventDto

Property	Type	Required	Description
accessedAt	string (date-time)	no	—
action	string | null	no	—
documentRef	string | null	no	—
eventId	string (uuid)	no	—
grantId	string (uuid)	no	—
inspectorRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureAccessEventListDto

Property	Type	Required	Description
items	Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureAccessEventDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureGrantCapabilitiesDto

Property	Type	Required	Description
accessActions	string[] | null	no	—
maxDocumentRefs	integer (int32)	no	—
maxValidityDays	integer (int32)	no	—
purposes	string[] | null	no	—
recordType	string | null	no	—
revocationReasons	string[] | null	no	—
supported	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureGrantDto

Property	Type	Required	Description
blockchainTransactionId	string | null	no	—
documentRefs	string[] | null	no	—
expiresAt	string (date-time)	no	—
externalGrantId	string (uuid)	no	—
externalReference	string | null	no	—
id	string (uuid)	no	—
issuedAt	string (date-time)	no	—
issuedByUserId	string (uuid)	no	—
organizationId	string (uuid)	no	—
purpose	string | null	no	—
recipientName	string | null	no	—
recipientRef	string | null	no	—
revocationBlockchainTransactionId	string | null	no	—
revocationReasonCode	string | null	no	—
revokedAt	string (date-time) | null	no	—
revokedByUserId	string (uuid) | null	no	—
scopeDigest	string | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureGrantListDto

Property	Type	Required	Description
items	Essence.Consent.Core.Contracts.DTOs.OrganisationDisclosureGrantDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.OrganisationGrantDto

Property	Type	Required	Description
actingUserId	string (uuid)	no	—
documentId	string (uuid)	no	—
expiresAt	string (date-time) | null	no	—
grantedAt	string (date-time)	no	—
granteeId	string (uuid)	no	—
granteeType	string | null	no	—
id	string (uuid)	no	—
principalOrganizationId	string (uuid)	no	—
purpose	string | null	no	—
reassigned	boolean	no	—
status	string | null	no	—
stewardUserId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.OrganisationGrantStewardReassignedDto

Property	Type	Required	Description
grant	Essence.Consent.Core.Contracts.DTOs.OrganisationGrantDto	no	—
previousStewardUserId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.OrgExecutorCaseDto

Property	Type	Required	Description
activatedAt	string (date-time) | null	no	—
activationOccurredAt	string (date-time) | null	no	—
assignedOfficerUserId	string (uuid) | null	no	—
authorityBasis	string | null	no	—
authorityReference	string | null	no	—
awaitingOfficerAssignment	boolean	no	—
consentId	string (uuid)	no	—
donorId	string (uuid)	no	—
itemCount	integer (int32)	no	—
officerChainLength	integer (int32)	no	—
releaseTier	string | null	no	—
releaseTierBlockedReason	string | null	no	—
releaseTierSatisfied	boolean	no	—
revealedItemCount	integer (int32)	no	—
rosterBacked	boolean	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.OrgExecutorCaseloadDto

Property	Type	Required	Description
cases	Essence.Consent.Core.Contracts.DTOs.OrgExecutorCaseDto[] | null	no	—
officerRosterAvailable	boolean	no	—
organizationId	string (uuid)	no	—
tierBlockedCount	integer (int32)	no	—
unassignedCount	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.OrgNoticeLocalePolicyDto

Property	Type	Required	Description
highRiskPurposes	string[] | null	no	—
lastSetBy	string | null	no	—
organizationId	string (uuid)	no	—
reServeMode	string | null	no	—
supportedLocales	string[] | null	no	—
updatedAt	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.OriginRecordsApplicationViewDto

Property	Type	Required	Description
caseId	string (uuid)	no	—
caseReference	string | null	no	—
decidedAt	string (date-time) | null	no	—
items	string[] | null	no	—
lawfulBasis	string | null	no	—
lodgedAt	string (date-time)	no	—
notifyOnDecision	boolean	no	—
regime	unspecified | null	no	—
requiresIntermediary	boolean	no	—
state	string | null	no	—
stateEnteredAt	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.OriginRecordsCapabilitiesDto

Property	Type	Required	Description
canonicalPayloadVersion	integer (int32)	no	—
dispositions	string[] | null	no	—
lawfulBases	string[] | null	no	—
maxRequestedItems	integer (int32)	no	—
preferenceScopes	string[] | null	no	—
preferenceStates	string[] | null	no	—
refusalCodes	string[] | null	no	—
supported	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.OriginRecordsCaseDto

Property	Type	Required	Description
applicantRef	string | null	no	—
caseId	string (uuid)	no	—
caseReference	string | null	no	—
citableExemptions	Essence.Consent.Core.Contracts.DTOs.OriginRecordsCitableExemptionDto[] | null	no	—
gatedSubjectRefs	string[] | null	no	—
identityProven	boolean	no	—
lawfulBasis	string | null	no	—
lodgedAt	string (date-time)	no	—
organizationId	string (uuid)	no	—
regimeKey	string | null	no	—
requestedItems	Essence.Consent.Core.Contracts.DTOs.OriginRecordsRequestedItemDto[] | null	no	—
state	string | null	no	—
stateEnteredAt	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.OriginRecordsCaseSummaryDto

Property	Type	Required	Description
applicantRef	string | null	no	—
assigneeId	string (uuid) | null	no	—
assigneeName	string | null	no	—
caseId	string (uuid)	no	—
caseReference	string | null	no	—
identityProven	boolean	no	—
lawfulBasis	string | null	no	—
lodgedAt	string (date-time)	no	—
regimeId	string | null	no	—
requestedItems	Essence.Consent.Core.Contracts.DTOs.OriginRecordsRequestedItemDto[] | null	no	—
state	string | null	no	—
stateEnteredAt	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.OriginRecordsCitableExemptionDto

Property	Type	Required	Description
code	string | null	no	—
justificationRequired	boolean	no	—
statuteRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.OriginRecordsCitableExemptionRequest

Property	Type	Required	Description
code	string | null	no	—
justificationRequired	boolean	no	—
statuteRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.OriginRecordsItemDeterminationDto

Property	Type	Required	Description
disposition	string | null	no	—
exemptionCode	string | null	no	—
itemId	string | null	no	—
justificationDigest	string | null	no	—
statuteRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.OriginRecordsItemDeterminationRequest

Property	Type	Required	Description
disposition	string | null	no	—
exemptionCode	string | null	no	—
itemId	string | null	no	—
justification	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.OriginRecordsRequestedItemDto

Property	Type	Required	Description
intermediaryGated	boolean	no	—
itemId	string | null	no	—
label	string | null	no	—
relatedSubjectRefs	string[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.OriginRecordsRequestedItemRequest

Property	Type	Required	Description
intermediaryGated	boolean	no	—
itemId	string | null	no	—
label	string | null	no	—
relatedSubjectRefs	string[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.OriginRecordsVetoCheckDto

Property	Type	Required	Description
checkedAt	string (date-time)	no	—
overrideJustificationDigest	string | null	no	—
scope	string | null	no	—
state	string | null	no	—
subjectRef	string | null	no	—
version	integer (int32) | null	no	—

Essence.Consent.Core.Contracts.DTOs.OriginRecordsVetoCheckRequest

Property	Type	Required	Description
overrideJustification	string | null	no	—
scope	string | null	no	—
state	string | null	no	—
subjectRef	string | null	no	—
version	integer (int32) | null	no	—

Essence.Consent.Core.Contracts.DTOs.ParentAccessConsentScopeRequest

Property	Type	Required	Description
parentOrganizationId	string (uuid)	no	—
subsidiaryOrganizationId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.ParentAccessConsentScopeResultDto

Property	Type	Required	Description
checkedAt	string (date-time)	no	—
subjectsConsentingToParent	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.PlaceScopeOfAuthorityOnStandbyRequest

Property	Type	Required	Description
conditionKind	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.PreAuthoriseReleaseOnDeathConsentRequest

Property	Type	Required	Description
authorityBasis	string | null	no	—
authorityEvidenceRef	string | null	no	—
authorityReference	string | null	no	—
issuingAuthority	string | null	no	—
items	Essence.Consent.Core.Contracts.DTOs.ReleaseScopeItemRequest[] | null	no	—
lawfulBasis	string | null	no	—
purpose	string | null	no	—
recipientId	string (uuid)	no	—
recipientKind	string | null	no	—
releaseTier	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.PrincipalGrantCountDto

Property	Type	Required	Description
activeBundleCount	integer (int32)	no	—
activeGrantCount	integer (int32)	no	—
principalId	string (uuid)	no	—
revocableTotal	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.ProcessingConsentDto

Property	Type	Required	Description
category	string | null	no	—
consentId	string (uuid)	no	—
grantedAt	string (date-time)	no	—
isActive	boolean	no	—
lawfulBasis	string | null	no	—
noticeVersion	string | null	no	—
purpose	string | null	no	—
recordType	string | null	no	—
sourceId	string (uuid)	no	—
sourceKind	string | null	no	—
withdrawnAt	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.ProgrammeGrantDto

Property	Type	Required	Description
basis	string | null	no	—
endReason	string | null	no	—
endedAt	string (date-time) | null	no	—
grantId	string (uuid)	no	—
grantedAt	string (date-time)	no	—
grantorUserId	string (uuid)	no	—
isConsent	boolean	no	—
memberOrganizationId	string (uuid) | null	no	—
memberType	string | null	no	—
programmeId	string (uuid)	no	—
programmeMemberId	string (uuid)	no	—
relation	string | null	no	—
requirementCodes	string[] | null	no	—
sponsorOrganizationId	string (uuid)	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ProgrammeGrantListDto

Property	Type	Required	Description
items	Essence.Consent.Core.Contracts.DTOs.ProgrammeGrantDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.ProtectionCaseProvenanceEntryDto

Property	Type	Required	Description
actorRef	string | null	no	—
actorRole	string | null	no	—
auditAnchor	string | null	no	—
basis	string | null	no	—
basisDocumentId	string (uuid) | null	no	—
caseId	string | null	no	—
confidence	string | null	no	—
entryDigest	string | null	no	—
entryId	string (uuid)	no	—
event	string | null	no	—
evidencePath	string | null	no	—
lawfulBasis	string | null	no	—
occurredAt	string (date-time)	no	—
previousDigest	string | null	no	—
recipientOrganizationId	string (uuid) | null	no	—
recordCompleteness	string | null	no	—
reviewOutcome	string | null	no	—
sequence	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.ProvisionCustodianGrantRequest

Property	Type	Required	Description
custodianOrgId	string (uuid) | null	no	—
expiresAt	string (date-time) | null	no	—
externalReference	string | null	no	—
granteeUserId	string (uuid) | null	no	—
lawfulBasis	string | null	no	—
recordDomains	string[] | null	no	—
subjectRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ProvisionPseudonymousConsentGrantRequest

Property	Type	Required	Description
expiresAt	string (date-time) | null	no	—
fieldScopes	string[] | null	no	—
granteeAlias	string | null	no	—
granteeUserId	string (uuid)	no	—
purpose	string | null	no	—
sourceRef	string | null	no	—
subjectPseudonym	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.PseudonymousConsentGrantDto

Property	Type	Required	Description
consentId	string (uuid)	no	—
expiresAt	string (date-time)	no	—
fieldScopes	string[] | null	no	—
grantedAt	string (date-time)	no	—
granteeAlias	string | null	no	—
granteeUserId	string (uuid)	no	—
legalBasis	string | null	no	—
provisionedByUserId	string (uuid)	no	—
purpose	string | null	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
revokedByUserId	string (uuid) | null	no	—
sourceRef	string | null	no	—
status	string | null	no	—
subjectPseudonym	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.PublishCredentialDescriptorRequest

Property	Type	Required	Description
credentialType	string | null	no	—
documentId	string (uuid)	no	—
expiryDate	string (date-time)	no	—
issuer	string | null	no	—
version	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.PurgeCategoryOutcomeDto

Property	Type	Required	Description
category	string | null	no	—
erasedAtIso	string | null	no	—
failureReason	string | null	no	—
holdReference	string | null	no	—
state	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.PurposeConsentCheckRequest

Property	Type	Required	Description
purpose	string | null	no	—
subjectIds	(string (uuid))[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.PurposeConsentCheckResultDto

Property	Type	Required	Description
checkedAt	string (date-time)	no	—
consentingSubjectIds	(string (uuid))[] | null	no	—
excludedCount	integer (int32)	no	—
purpose	string | null	no	—
requestedCount	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.PurposeScopedGrantCapabilitiesDto

Property	Type	Required	Description
maxValidityDays	integer (int32)	no	—
purposes	string[] | null	no	—
recordType	string | null	no	—
supported	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.PurposeScopedGrantDto

Property	Type	Required	Description
blockchainTransactionId	string | null	no	—
expiresAt	string (date-time)	no	—
grantedAt	string (date-time)	no	—
granteeOrganizationId	string (uuid)	no	—
id	string (uuid)	no	—
purpose	string | null	no	—
purposeDescription	string | null	no	—
revocationBlockchainTransactionId	string | null	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
status	string | null	no	—
subjectReference	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.PurposeScopedGrantListDto

Property	Type	Required	Description
items	Essence.Consent.Core.Contracts.DTOs.PurposeScopedGrantDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.QRCodeSessionDto

Property	Type	Required	Description
completedAt	string (date-time) | null	no	—
createdAt	string (date-time)	no	—
dataExchanged	boolean	no	—
expiresAt	string (date-time)	no	—
grantorPublicKey	string | null	no	—
id	string (uuid)	no	—
qrCodeShareId	string (uuid)	no	—
scannerPublicKey	string | null	no	—
scannerUserId	string (uuid)	no	—
status	Essence.Consent.Core.Domain.Enums.QRCodeSessionStatus	no	—

Essence.Consent.Core.Contracts.DTOs.QRCodeShareDto

Property	Type	Required	Description
consentGrantId	string (uuid) | null	no	—
createdAt	string (date-time)	no	—
customMessage	string | null	no	—
documentId	string (uuid)	no	—
expiresAt	string (date-time)	no	—
grantorId	string (uuid)	no	—
id	string (uuid)	no	—
isOneTimeUse	boolean	no	—
lastScannedAt	string (date-time) | null	no	—
lastScannedBy	string (uuid) | null	no	—
maxScans	integer (int32) | null	no	—
purpose	string | null	no	—
qrCodeImageData	string | null	no	—
requireAuthentication	boolean	no	—
scanCount	integer (int32)	no	—
status	Essence.Consent.Core.Domain.Enums.QRCodeStatus	no	—

Essence.Consent.Core.Contracts.DTOs.ReactivateConsentRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ReassignOrganisationGrantStewardRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RebroadcastSelfExclusionBroadcastRequest

Property	Type	Required	Description
operatorId	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecheckPurgeCategoryRequest

Property	Type	Required	Description
category	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecipientRedactionPreviewDto

Property	Type	Required	Description
documentId	string (uuid) | null	no	—
field	string | null	no	—
outcome	Essence.Consent.Core.Domain.Enums.RedactionPreviewOutcome	no	—
reason	Essence.Consent.Core.Domain.Enums.RedactionPreviewReason	no	—
reasonDescription	string | null	no	—
recipientId	string (uuid)	no	—
resolvedAt	string (date-time)	no	—
subjectId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.ReconfirmDelegationRequest

Property	Type	Required	Description
nextReviewDueAt	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.RecordAssuranceEstablishmentConsentRequestDto

Property	Type	Required	Description
organizationId	string | null	no	—
purpose	string	yes	—
templateVersion	string	yes	—

Essence.Consent.Core.Contracts.DTOs.RecordBiometricProcessingConsentRequestDto

Property	Type	Required	Description
noticeVersion	string	yes	—
processorName	string	yes	—
proofingSessionId	string (uuid)	yes	—
purpose	string	yes	—
retentionStatement	string	yes	—

Essence.Consent.Core.Contracts.DTOs.RecordClosureTransferConsentRequest

Property	Type	Required	Description
consentGrantRef	string | null	no	—
kind	string | null	no	—
reason	string | null	no	—
recipientUserId	string (uuid) | null	no	—
recordedAtIso	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecordDelegationActionRequest

Property	Type	Required	Description
capability	string | null	no	—
description	string | null	no	—
surface	string | null	no	—
targetRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecordDonorDeterminationRequest

Property	Type	Required	Description
caseId	string (uuid) | null	no	—
eraKey	string | null	no	—
laterObjectionHandling	string | null	no	—
outcome	string | null	no	—
preferenceAbsent	boolean	no	—
preferenceCheckedAt	string | null	no	—
preferenceVersion	integer (int32) | null	no	—
reasoning	string | null	no	—
regimeId	string | null	no	—
statuteRef	string | null	no	—
withholdings	Essence.Consent.Core.Contracts.DTOs.DonorWithholdingRequest[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecordDonorDisclosurePreferenceRequest

Property	Type	Required	Description
donorRef	string | null	no	—
effectiveFrom	string (date-time) | null	no	—
effectiveTo	string (date-time) | null	no	—
isStatutoryReRegistration	boolean	no	—
scope	string | null	no	—
statutoryReRegistrationRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecordHolderAnswerRequest

Property	Type	Required	Description
channel	string | null	no	—
kind	string | null	no	—
locale	string | null	no	—
moment	string | null	no	—
outcome	string | null	no	—
sha256	string | null	no	—
version	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecordMinorConfidentialConsentRequest

Property	Type	Required	Description
category	string | null	no	—
recordRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecordOrganisationDisclosureAccessRequest

Property	Type	Required	Description
action	string | null	no	—
documentRef	string | null	no	—
inspectorRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecordOriginRecordsDeterminationRequest

Property	Type	Required	Description
items	Essence.Consent.Core.Contracts.DTOs.OriginRecordsItemDeterminationRequest[] | null	no	—
noteToApplicant	string | null	no	—
organizationId	string (uuid) | null	no	—
vetoChecks	Essence.Consent.Core.Contracts.DTOs.OriginRecordsVetoCheckRequest[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecordProcessingConsentRequestDto

Property	Type	Required	Description
category	string	yes	—
noticeVersion	string	yes	—
purpose	string	yes	—
sourceId	string (uuid)	yes	—
sourceKind	string	yes	—

Essence.Consent.Core.Contracts.DTOs.RecordRelianceRevokedRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecordRevocationReviewDecisionRequest

Property	Type	Required	Description
consentId	string (uuid) | null	no	—
decision	string | null	no	—
reasonCode	string | null	no	—
revocationRef	string | null	no	—
snoozeUntil	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecordStatutoryDisclosureTransitionRequest

Property	Type	Required	Description
at	string (date-time)	no	—
courtOrderRef	string | null	no	—
firstServedAt	string (date-time) | null	no	—
fromState	string | null	no	—
issueNumber	integer (int32)	no	—
itemCount	integer (int32)	no	—
matterId	string | null	no	—
requestId	string | null	no	—
scheduleId	string | null	no	—
toState	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RecordVehiclePurgeReportRequest

Property	Type	Required	Description
attestation	Essence.Consent.Core.Contracts.DTOs.VehiclePurgeAttestationRequest	no	—
auditAnchorId	string | null	no	—
deviceId	string | null	no	—
grantId	string (uuid) | null	no	—
leaseId	string (uuid) | null	no	—
outcomes	Essence.Consent.Core.Contracts.DTOs.VehiclePurgeOutcomeRequest[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.RedeemCapabilityRequest

Property	Type	Required	Description
credentialType	string | null	no	—
fieldNames	string[] | null	no	—
issuerRef	string | null	no	—
operation	string | null	no	—
purpose	string | null	no	—
recipientRef	string | null	no	—
resourceRefs	string[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.RegisterSelfExclusionBroadcastRequest

Property	Type	Required	Description
electedTermDays	integer (int32) | null	no	—
jurisdiction	string | null	no	—
operators	Essence.Consent.Core.Contracts.DTOs.SelfExclusionOperatorRef[] | null	no	—
scheme	string | null	no	—
subjectMatchToken	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ReleaseCapabilityRedemptionRequest

Property	Type	Required	Description
evidenceReference	string | null	no	—
evidenceSource	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ReleaseGrantorDto

Property	Type	Required	Description
authorityBasis	string | null	no	—
parentId	string (uuid)	no	—
signedAt	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.ReleaseOnDeathConsentDto

Property	Type	Required	Description
activatedAt	string (date-time) | null	no	—
activationEventReference	string | null	no	—
activationOccurredAt	string (date-time) | null	no	—
assignedOfficerUserId	string (uuid) | null	no	—
authorityBasis	string | null	no	—
authorityEvidenceRef	string | null	no	—
authorityReference	string | null	no	—
consentId	string (uuid)	no	—
grantorId	string (uuid)	no	—
isOrganisationRecipient	boolean	no	—
issuingAuthority	string | null	no	—
items	Essence.Consent.Core.Contracts.DTOs.ReleaseScopeItemDto[] | null	no	—
lawfulBasis	string | null	no	—
officerAccessChain	Essence.Consent.Core.Contracts.DTOs.ExecutorOfficerAccessDto[] | null	no	—
preAuthorisedAt	string (date-time)	no	—
purpose	string | null	no	—
recipientId	string (uuid)	no	—
recipientKind	string | null	no	—
releaseTier	string | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ReleaseScopeItemDto

Property	Type	Required	Description
itemId	string (uuid)	no	—
itemKey	string | null	no	—
label	string | null	no	—
revealedAt	string (date-time) | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ReleaseScopeItemRequest

Property	Type	Required	Description
itemKey	string | null	no	—
label	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RelianceRevocationResultDto

Property	Type	Required	Description
applied	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.RelianceViewDto

Property	Type	Required	Description
consentId	string (uuid)	no	—
documentId	string (uuid)	no	—
failedClosed	boolean	no	—
granteeId	string (uuid)	no	—
isValid	boolean	no	—
lapsedAt	string (date-time) | null	no	—
reason	string | null	no	—
relianceStatus	string | null	no	—
validUntil	string (date-time) | null	no	—
verificationId	string | null	no	—
verificationType	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RenameSupervisionControlTemplateRequest

Property	Type	Required	Description
name	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RenewSelfExclusionBroadcastRequest

Property	Type	Required	Description
additionalDays	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.RequestChildRecordReleaseRequest

Property	Type	Required	Description
accessExpiresAt	string (date-time) | null	no	—
authorityBasis	string | null	no	—
authorityRule	string | null	no	—
category	string | null	no	—
childId	string (uuid)	no	—
courtNamedParentId	string (uuid) | null	no	—
expectedApproverParentId	string (uuid) | null	no	—
purpose	string | null	no	—
recipientId	string (uuid)	no	—
scopeDescription	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RequestLegalHoldReleaseRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RescopeApplicationDto

Property	Type	Required	Description
applicationNumber	integer (int32)	no	—
appliedAt	string (date-time)	no	—
appliedByUserId	string (uuid)	no	—
blockers	string[] | null	no	—
complete	boolean	no	—
dispositions	Essence.Consent.Core.Contracts.DTOs.RescopeDispositionDto[] | null	no	—
legalAttestation	Essence.Consent.Core.Contracts.DTOs.RescopeLegalAttestationDto	no	—
policy	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RescopeDecisionDto

Property	Type	Required	Description
confirmedBy	string | null	no	—
decidedAt	string (date-time) | null	no	—
granted	boolean	no	—
legalBasis	string | null	no	—
scope	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RescopeDispositionDto

Property	Type	Required	Description
confirmedBy	string | null	no	—
decidedAt	string (date-time) | null	no	—
disposition	string | null	no	—
equivalent	boolean	no	—
legalBasis	string | null	no	—
newPurpose	string | null	no	—
oldPurpose	string | null	no	—
required	boolean	no	—
scope	string | null	no	—
scopeLabel	string | null	no	—
subjectNotificationRequired	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.RescopeIncumbentGrantDto

Property	Type	Required	Description
grantedAt	string (date-time) | null	no	—
legalBasis	string | null	no	—
purpose	string | null	no	—
scope	string | null	no	—
scopeLabel	string | null	no	—
subjectRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RescopeLegalAttestationDto

Property	Type	Required	Description
actor	string | null	no	—
basis	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RescopeTargetRequestDto

Property	Type	Required	Description
purpose	string | null	no	—
required	boolean	no	—
scope	string | null	no	—
scopeLabel	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ResealSharedContentRequest

Property	Type	Required	Description
authTagBase64	string | null	no	—
documentVersion	integer (int32)	no	—
nonceBase64	string | null	no	—
sharedBlobReference	string | null	no	—
wrappedSharingKey	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ReServePostureDto

Property	Type	Required	Description
mode	string | null	no	—
source	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RetainedAttestationDto

Property	Type	Required	Description
attestationType	string | null	no	—
attestedAt	string (date-time)	no	—
attesterUserId	string (uuid)	no	—
id	string (uuid)	no	—
organizationId	string (uuid)	no	—
revocable	boolean	no	—
sourceReference	string | null	no	—
statementDigest	string | null	no	—
statementTemplate	string | null	no	—
status	string | null	no	—
supersededAt	string (date-time) | null	no	—
supersededById	string (uuid) | null	no	—
supersedesId	string (uuid) | null	no	—
withdrawalReason	string | null	no	—
withdrawnAt	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.RetainedAttestationInForceDto

Property	Type	Required	Description
at	string (date-time)	no	—
attestationId	string (uuid)	no	—
inForce	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.RetainedAttestationListDto

Property	Type	Required	Description
attestations	Essence.Consent.Core.Contracts.DTOs.RetainedAttestationDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.RetainedAttestationResultDto

Property	Type	Required	Description
attestation	Essence.Consent.Core.Contracts.DTOs.RetainedAttestationDto	no	—
changed	boolean	no	—
superseded	Essence.Consent.Core.Contracts.DTOs.RetainedAttestationDto	no	—

Essence.Consent.Core.Contracts.DTOs.ReverseRingEnforcementSubjectRequest

Property	Type	Required	Description
appealId	string (uuid) | null	no	—
reversedByUserId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.ReviseSupervisionControlTemplateRequest

Property	Type	Required	Description
changeNote	string | null	no	—
jurisdiction	string | null	no	—
lawfulBasis	string | null	no	—
majorityAge	integer (int32)	no	—
thresholds	Essence.Consent.Core.Contracts.DTOs.SupervisionGraduationThresholdDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevocationReviewDecisionDto

Property	Type	Required	Description
asOf	string (date-time)	no	—
consentId	string (uuid)	no	—
decidedAt	string (date-time)	no	—
decidedBy	string (uuid)	no	—
decision	string | null	no	—
decisionId	string (uuid)	no	—
firstDecidedAt	string (date-time)	no	—
reasonCode	string | null	no	—
requiresDecision	boolean	no	—
revisionCount	integer (int32)	no	—
revocationRef	string | null	no	—
snoozeUntil	string (date-time) | null	no	—
state	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevocationReviewDecisionListDto

Property	Type	Required	Description
items	Essence.Consent.Core.Contracts.DTOs.RevocationReviewDecisionDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeAgentAuthorityRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeAgentAuthorityResultDto

Property	Type	Required	Description
agentReference	string | null	no	—
alreadyEnded	integer (int32)	no	—
capabilitiesRevoked	integer (int32)	no	—
delegationsRevoked	integer (int32)	no	—
revokedAt	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeCapabilitiesForAgentRequest

Property	Type	Required	Description
agentReference	string | null	no	—
incidentId	string (uuid)	no	—
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeConsentRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeCustodianGrantRequest

Property	Type	Required	Description
custodianOrgId	string (uuid) | null	no	—
externalReference	string | null	no	—
reasonCode	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeDelegatedCapabilityRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeDelegatedCapabilityResultDto

Property	Type	Required	Description
capabilityId	string (uuid)	no	—
descendantsRevoked	integer (int32)	no	—
revokedAt	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeDelegationRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeDepartingHouseholdMemberRequest

Property	Type	Required	Description
actorRef	string | null	no	—
departureId	string | null	no	—
guarantee	string | null	no	—
managedDeviceRefs	string[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeExecutorOfficerRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeGuardianConsentRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeHouseholdMemberRequest

Property	Type	Required	Description
guarantee	string | null	no	—
managedDeviceRefs	string[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeImportContactClassificationRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeOrgActOnBehalfGrantRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeOrganisationDisclosureGrantRequest

Property	Type	Required	Description
externalReference	string | null	no	—
organizationId	string (uuid) | null	no	—
reasonCode	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokePseudonymousConsentGrantRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokePurposeScopedGrantRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeReleaseOnDeathConsentRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeScamEvidenceDisclosureGrantRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RevokeScopeOfAuthorityRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RewrapSharingKeyRequest

Property	Type	Required	Description
wrappedSharingKey	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.RingEnforcementDto

Property	Type	Required	Description
decidedByUserId	string (uuid)	no	—
enforcementDecisionId	string (uuid)	no	—
enforcementId	string (uuid)	no	—
executedByPrincipal	string | null	no	—
reasonCode	string | null	no	—
receivedAt	string (date-time)	no	—
replayed	boolean	no	—
ringId	string (uuid)	no	—
status	string | null	no	—
subjects	Essence.Consent.Core.Contracts.DTOs.RingEnforcementSubjectDto[] | null	no	—
totals	Essence.Consent.Core.Contracts.DTOs.RingEnforcementTotalsDto	no	—

Essence.Consent.Core.Contracts.DTOs.RingEnforcementGrantDto

Property	Type	Required	Description
actedAt	string (date-time)	no	—
consentId	string (uuid)	no	—
detail	string | null	no	—
outcome	string | null	no	—
priorStatus	string | null	no	—
restoredAt	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.RingEnforcementSubjectDto

Property	Type	Required	Description
enforcementActionId	string (uuid) | null	no	—
failureDetail	string | null	no	—
grants	Essence.Consent.Core.Contracts.DTOs.RingEnforcementGrantDto[] | null	no	—
processedAt	string (date-time) | null	no	—
reasonCode	string | null	no	—
reversalAppealId	string (uuid) | null	no	—
reversedAt	string (date-time) | null	no	—
reversedByUserId	string (uuid) | null	no	—
status	string | null	no	—
subjectUserId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.RingEnforcementSubjectRequestDto

Property	Type	Required	Description
enforcementActionId	string (uuid) | null	no	—
reasonCode	string | null	no	—
subjectUserId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.RingEnforcementTotalsDto

Property	Type	Required	Description
grantsFailed	integer (int32)	no	—
grantsNotRestorable	integer (int32)	no	—
grantsRestored	integer (int32)	no	—
grantsSuspended	integer (int32)	no	—
subjects	integer (int32)	no	—
subjectsCompleted	integer (int32)	no	—
subjectsFailed	integer (int32)	no	—
subjectsPartiallyFailed	integer (int32)	no	—
subjectsPending	integer (int32)	no	—
subjectsReversed	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.RotateDelegatedSecretRequest

Property	Type	Required	Description
reason	string | null	no	—
reshares	Essence.Consent.Core.Contracts.DTOs.SecretReshareTarget[] | null	no	—
secretId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.RotateDelegatedSecretResultDto

Property	Type	Required	Description
grants	Essence.Consent.Core.Contracts.DTOs.SecretDelegationGrantDto[] | null	no	—
newVersion	integer (int32)	no	—
reSharedCount	integer (int32)	no	—
retiredVersion	integer (int32)	no	—
revokedCount	integer (int32)	no	—
secretId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.RotationConsentReconciliationDto

Property	Type	Required	Description
allDispositioned	boolean	no	—
dispositions	Essence.Consent.Core.Contracts.DTOs.RotationGrantDispositionDto[] | null	no	—
id	string (uuid)	no	—
legalHoldExceptionCount	integer (int32)	no	—
newKeyGeneration	string | null	no	—
oldKeyGeneration	string | null	no	—
pendingReviewCount	integer (int32)	no	—
reconciledAt	string (date-time)	no	—
revokedCount	integer (int32)	no	—
rotationCompletedAt	string (date-time)	no	—
rotationSessionId	string (uuid)	no	—
totalGrants	integer (int32)	no	—
userId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.RotationGrantDispositionDto

Property	Type	Required	Description
grantCreatedAt	string (date-time)	no	—
grantId	string (uuid)	no	—
grantStatus	Essence.Consent.Core.Domain.Enums.ConsentStatus	no	—
granteeId	string (uuid)	no	—
outcome	Essence.Consent.Core.Domain.Entities.Rotation.RotationGrantDispositionOutcome	no	—

Essence.Consent.Core.Contracts.DTOs.RouteConsentToGranteeRosterRequest

Property	Type	Required	Description
lawfulBasis	string | null	no	—
rosterId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.ScamClaimConsentStateDto

Property	Type	Required	Description
activeGrantId	string (uuid) | null	no	—
activeRecipients	string[] | null	no	—
asOf	string (date-time)	no	—
claimReference	string | null	no	—
grants	Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureGrantDto[] | null	no	—
purpose	string | null	no	—
state	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ScamEvidenceAccessDecisionDto

Property	Type	Required	Description
allowed	boolean	no	—
asOf	string (date-time)	no	—
claimReference	string | null	no	—
evidenceItemId	string | null	no	—
grantId	string (uuid) | null	no	—
reason	string | null	no	—
recipientRole	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureGrantCapabilitiesDto

Property	Type	Required	Description
maxEvidenceItems	integer (int32)	no	—
maxValidityDays	integer (int32)	no	—
purpose	string | null	no	—
recipientRoles	string[] | null	no	—
recordType	string | null	no	—
supported	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureGrantDto

Property	Type	Required	Description
blockchainTransactionId	string | null	no	—
claimReference	string | null	no	—
evidenceItemIds	string[] | null	no	—
expiresAt	string (date-time)	no	—
grantId	string (uuid)	no	—
grantedAt	string (date-time)	no	—
purpose	string | null	no	—
recipientOrganisations	Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureRecipientDto[] | null	no	—
recipients	string[] | null	no	—
revocationBlockchainTransactionId	string | null	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
status	string | null	no	—
viewerRole	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureGrantListDto

Property	Type	Required	Description
items	Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureGrantDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.ScamEvidenceDisclosureRecipientDto

Property	Type	Required	Description
organizationId	string (uuid)	no	—
role	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ScopeAuthorityDto

Property	Type	Required	Description
authorityReference	string | null	no	—
expiresAt	string (date-time) | null	no	—
isVerified	boolean	no	—
issuedAt	string (date-time)	no	—
issuingAuthority	string | null	no	—
jurisdiction	string | null	no	—
verifiedAt	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.ScopeCategoryDto

Property	Type	Required	Description
categoryKey	string | null	no	—
displayLabel	string | null	no	—
inScope	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.ScopeFieldDto

Property	Type	Required	Description
categoryKey	string | null	no	—
displayLabel	string | null	no	—
fieldRef	string | null	no	—
visible	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.ScopeOfAuthorityRecordDto

Property	Type	Required	Description
accessState	string | null	no	—
activationCondition	Essence.Consent.Core.Contracts.DTOs.ActivationConditionDto	no	—
attorneyId	string (uuid)	no	—
attorneyRole	string | null	no	—
authority	Essence.Consent.Core.Contracts.DTOs.ScopeAuthorityDto	no	—
categories	Essence.Consent.Core.Contracts.DTOs.ScopeCategoryDto[] | null	no	—
createdAtUtc	string (date-time)	no	—
delegationType	string | null	no	—
donorId	string (uuid)	no	—
fields	Essence.Consent.Core.Contracts.DTOs.ScopeFieldDto[] | null	no	—
grantedAt	string (date-time) | null	no	—
id	string (uuid)	no	—
isEffective	boolean	no	—
revocationReason	string | null	no	—
revokedAt	string (date-time) | null	no	—
revokedBy	string (uuid) | null	no	—
standbyAt	string (date-time) | null	no	—
status	string | null	no	—
visibleFieldCount	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.SecretDelegationGrantDto

Property	Type	Required	Description
createdAt	string (date-time)	no	—
expiresAt	string (date-time) | null	no	—
grantId	string (uuid)	no	—
holderId	string (uuid)	no	—
holderKind	string | null	no	—
ownerId	string (uuid)	no	—
revokedAt	string (date-time) | null	no	—
revokedReason	string | null	no	—
scope	string | null	no	—
secretId	string (uuid)	no	—
secretVersion	integer (int32)	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SecretDelegationHolderTableDto

Property	Type	Required	Description
currentVersion	integer (int32)	no	—
grants	Essence.Consent.Core.Contracts.DTOs.SecretDelegationGrantDto[] | null	no	—
ownerId	string (uuid)	no	—
secretId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.SecretReshareTarget

Property	Type	Required	Description
expiresAt	string (date-time) | null	no	—
holderId	string (uuid)	no	—
holderKind	string | null	no	—
scope	string | null	no	—
wrappedSecretRef	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionAuditEntryDto

Property	Type	Required	Description
anchored	boolean	no	—
credentialId	string (uuid)	no	—
fieldsReleased	string[] | null	no	—
jurisdiction	string | null	no	—
scheme	string | null	no	—
timestamp	string (date-time)	no	—
type	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionAuditTrailDto

Property	Type	Required	Description
entries	Essence.Consent.Core.Contracts.DTOs.SelfExclusionAuditEntryDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastAssuranceDto

Property	Type	Required	Description
acknowledgedCount	integer (int32)	no	—
activeBroadcastCount	integer (int32)	no	—
enforcedCount	integer (int32)	no	—
fullyEnforced	boolean	no	—
fullyResolved	boolean	no	—
generatedAt	string (date-time)	no	—
hasActiveBroadcast	boolean	no	—
noAccountCount	integer (int32)	no	—
notifiedCount	integer (int32)	no	—
protectedUntil	string (date-time) | null	no	—
totalOperators	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastDto

Property	Type	Required	Description
broadcastId	string (uuid)	no	—
canRequestWithdrawal	boolean	no	—
expiryAlertRaisedAt	string (date-time) | null	no	—
isActive	boolean	no	—
isExpiring	boolean	no	—
jurisdiction	string | null	no	—
liftReason	string | null	no	—
liftedAt	string (date-time) | null	no	—
minimumTermEndsAt	string (date-time)	no	—
operators	Essence.Consent.Core.Contracts.DTOs.SelfExclusionOperatorProtectionDto[] | null	no	—
registeredAt	string (date-time)	no	—
renewalCount	integer (int32)	no	—
renewedAt	string (date-time) | null	no	—
scheme	string | null	no	—
status	string | null	no	—
subjectId	string (uuid)	no	—
termBasis	string | null	no	—
termDays	integer (int32) | null	no	—
validUntil	string (date-time)	no	—
withdrawalCoolingOffEndsAt	string (date-time) | null	no	—
withdrawalRequestedAt	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastOperatorDto

Property	Type	Required	Description
acknowledgedAt	string (date-time) | null	no	—
broadcastId	string (uuid)	no	—
enforcedAt	string (date-time) | null	no	—
jurisdiction	string | null	no	—
notifiedAt	string (date-time)	no	—
operatorId	string | null	no	—
operatorLabel	string | null	no	—
scheme	string | null	no	—
state	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastOperatorsDto

Property	Type	Required	Description
operators	Essence.Consent.Core.Contracts.DTOs.SelfExclusionBroadcastOperatorDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionCredentialDto

Property	Type	Required	Description
credentialId	string (uuid)	no	—
excludedAt	string (date-time)	no	—
jurisdiction	string | null	no	—
scheme	string | null	no	—
selfExcluded	boolean	no	—
status	string | null	no	—
validUntil	string (date-time)	no	—
verificationToken	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionOperatorProofDto

Property	Type	Required	Description
acknowledgedAt	string (date-time) | null	no	—
broadcastAt	string (date-time)	no	—
broadcastId	string (uuid)	no	—
enforcedAt	string (date-time) | null	no	—
jurisdiction	string | null	no	—
operatorId	string | null	no	—
operatorLabel	string | null	no	—
proofToken	string | null	no	—
scheme	string | null	no	—
state	string | null	no	—
validUntil	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionOperatorProtectionDto

Property	Type	Required	Description
acknowledgedAt	string (date-time) | null	no	—
broadcastCount	integer (int32)	no	—
enforcedAt	string (date-time) | null	no	—
lastBroadcastAt	string (date-time)	no	—
notifiedAt	string (date-time)	no	—
operatorId	string | null	no	—
operatorLabel	string | null	no	—
state	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionOperatorRef

Property	Type	Required	Description
operatorId	string | null	no	—
operatorLabel	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionOversightDto

Property	Type	Required	Description
checks	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionPolicyDto

Property	Type	Required	Description
allowReinstatement	boolean	no	—
coolingOffDays	integer (int32)	no	—
isDefault	boolean	no	—
jurisdiction	string | null	no	—
minExclusionDays	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionPresentationDto

Property	Type	Required	Description
auditRef	string | null	no	—
expiresAt	string (date-time)	no	—
fieldsReleased	string[] | null	no	—
paused	boolean	no	—
presentationCode	string | null	no	—
scheme	string | null	no	—
validUntil	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionRegisterExportDto

Property	Type	Required	Description
broadcastId	string (uuid)	no	—
expiryAlertRaisedAt	string (date-time) | null	no	—
exportedAt	string (date-time)	no	—
isActive	boolean	no	—
isExpiring	boolean	no	—
jurisdiction	string | null	no	—
minimumTermEndsAt	string (date-time)	no	—
operators	Essence.Consent.Core.Contracts.DTOs.SelfExclusionOperatorProtectionDto[] | null	no	—
registeredAt	string (date-time)	no	—
renewalCount	integer (int32)	no	—
renewedAt	string (date-time) | null	no	—
scheme	string | null	no	—
status	string | null	no	—
subjectId	string (uuid)	no	—
termBasis	string | null	no	—
termDays	integer (int32) | null	no	—
validUntil	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionReinstatementDto

Property	Type	Required	Description
coolingOffEndsAt	string (date-time) | null	no	—
credentialId	string (uuid)	no	—
reinstatedAt	string (date-time) | null	no	—
status	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SelfExclusionVerificationResult

Property	Type	Required	Description
checkLoggedRef	string | null	no	—
excluded	boolean	no	—
identityDisclosed	boolean	no	—
pseudonymousRef	string | null	no	—
scheme	string | null	no	—
selfExcluded	boolean	no	—
validUntil	string (date-time) | null	no	—
verdict	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SessionAccessConsentDto

Property	Type	Required	Description
accessType	string | null	no	—
agentPrincipalId	string (uuid)	no	—
asOf	string (date-time)	no	—
consentId	string (uuid)	no	—
consentType	string | null	no	—
endedAt	string (date-time) | null	no	—
expiresAt	string (date-time) | null	no	—
grantedAt	string (date-time)	no	—
partnerAppId	string (uuid)	no	—
reasonCode	string | null	no	—
scopes	string[] | null	no	—
sessionId	string (uuid)	no	—
state	string | null	no	—
subjectUserId	string (uuid)	no	—
ticketReference	string | null	no	—
timeBoxMinutes	integer (int32) | null	no	—

Essence.Consent.Core.Contracts.DTOs.SessionAccessConsentListDto

Property	Type	Required	Description
consents	Essence.Consent.Core.Contracts.DTOs.SessionAccessConsentDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.SessionAccessConsentReceiptDto

Property	Type	Required	Description
accessType	string | null	no	—
agentPrincipalId	string (uuid)	no	—
approverUserId	string (uuid)	no	—
consentId	string (uuid)	no	—
consentType	string | null	no	—
digestAlgorithm	string | null	no	—
expiresAt	string (date-time) | null	no	—
grantedAt	string (date-time)	no	—
issuedAt	string (date-time)	no	—
partnerAppId	string (uuid)	no	—
purpose	string | null	no	—
reasonCode	string | null	no	—
receiptDigest	string | null	no	—
scopes	string[] | null	no	—
state	string | null	no	—
terminalState	string | null	no	—
terminatedAt	string (date-time) | null	no	—
ticketReference	string | null	no	—
timeBoxMinutes	integer (int32) | null	no	—

Essence.Consent.Core.Contracts.DTOs.SetFieldVisibilityRequest

Property	Type	Required	Description
contactRef	string | null	no	—
field	string | null	no	—
groupLabel	string | null	no	—
visible	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.SetOriginRecordsDecisionNotificationRequest

Property	Type	Required	Description
notifyOnDecision	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.SetScopeCategoryRequest

Property	Type	Required	Description
categoryKey	string | null	no	—
inScope	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.SetScopeFieldVisibilityRequest

Property	Type	Required	Description
categoryKey	string | null	no	—
fieldRef	string | null	no	—
visible	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.SetSharedCredentialRoleRequest

Property	Type	Required	Description
granteeRef	string | null	no	—
role	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SharedCredentialRevocationDto

Property	Type	Required	Description
credentialLabel	string | null	no	—
institution	string | null	no	—
reasonCode	string | null	no	—
revokedAt	string (date-time)	no	—

Essence.Consent.Core.Contracts.DTOs.SharedCredentialRoleHistoryDto

Property	Type	Required	Description
credentialId	string | null	no	—
records	Essence.Consent.Core.Contracts.DTOs.SharedCredentialRoleHistoryRecordDto[] | null	no	—
total	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.SharedCredentialRoleHistoryRecordDto

Property	Type	Required	Description
action	string | null	no	—
credentialId	string | null	no	—
granteeRef	string | null	no	—
occurredAtIso	string | null	no	—
ownerRef	string | null	no	—
priorRole	string | null	no	—
recordId	string | null	no	—
role	string | null	no	—
scopeSummary	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SharedCredentialRoleMatrixDto

Property	Type	Required	Description
credentialId	string | null	no	—
entries	Essence.Consent.Core.Contracts.DTOs.SharedCredentialRoleMatrixEntryDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.SharedCredentialRoleMatrixEntryDto

Property	Type	Required	Description
granteeRef	string | null	no	—
role	string | null	no	—
sinceIso	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SharedCredentialRoleResultDto

Property	Type	Required	Description
action	string | null	no	—
credentialId	string | null	no	—
effectiveRole	string | null	no	—
granteeRef	string | null	no	—
occurredAtIso	string | null	no	—
recordId	string | null	no	—
recorded	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.SignedDonorDeterminationDto

Property	Type	Required	Description
anchorReference	string | null	no	—
canonicalPayload	string | null	no	—
caseId	string (uuid)	no	—
determinationId	string (uuid)	no	—
outcome	string | null	no	—
payloadDigest	string | null	no	—
signature	string | null	no	—
signedAt	string (date-time)	no	—
signedByRef	string | null	no	—
signingKeyId	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SignedOriginRecordsDeterminationDto

Property	Type	Required	Description
auditAnchorId	string | null	no	—
canonicalPayload	string | null	no	—
caseId	string (uuid)	no	—
caseReference	string | null	no	—
decisionMakerRef	string | null	no	—
determinationId	string (uuid)	no	—
items	Essence.Consent.Core.Contracts.DTOs.OriginRecordsItemDeterminationDto[] | null	no	—
noteDigest	string | null	no	—
regimeKey	string | null	no	—
signature	string | null	no	—
signedAt	string (date-time)	no	—
signingKeyId	string | null	no	—
vetoChecks	Essence.Consent.Core.Contracts.DTOs.OriginRecordsVetoCheckDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.SignOffSuccessionApprovalRequest

Property	Type	Required	Description
statement	string | null	no	—
termsVersion	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.StartSelfExclusionReinstatementRequest

Property	Type	Required	Description
credentialId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.StatutoryDisclosureRequestDto

Property	Type	Required	Description
courtOrderRef	string | null	no	—
elapsedFromFirstDemandToRulingSeconds	integer (int64) | null	no	—
firstDemandAt	string (date-time) | null	no	—
id	string (uuid)	no	—
issueNumber	integer (int32)	no	—
itemCount	integer (int32)	no	—
lawfulBasis	string | null	no	—
matterId	string | null	no	—
openedAt	string (date-time)	no	—
organizationId	string (uuid)	no	—
requestId	string | null	no	—
ruledAt	string (date-time) | null	no	—
scheduleId	string | null	no	—
state	string | null	no	—
transitions	Essence.Consent.Core.Contracts.DTOs.StatutoryDisclosureTransitionDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.StatutoryDisclosureRequestListDto

Property	Type	Required	Description
matterId	string | null	no	—
requests	Essence.Consent.Core.Contracts.DTOs.StatutoryDisclosureRequestDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.StatutoryDisclosureTransitionDto

Property	Type	Required	Description
at	string (date-time)	no	—
courtOrderRef	string | null	no	—
fromState	string | null	no	—
recordedAt	string (date-time)	no	—
sequence	integer (int32)	no	—
toState	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.StatutoryDisclosureTransitionResultDto

Property	Type	Required	Description
recorded	boolean	no	—
request	Essence.Consent.Core.Contracts.DTOs.StatutoryDisclosureRequestDto	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.ApprovePerSyncConsentRequestDto

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.ApproveSubscriptionRequestDto

Property	Type	Required	Description
notes	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.CancelSubscriptionRequestDto

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.DeclineMoreSyncsRequestDto

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.DeclinePerSyncConsentRequestDto

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.FieldSelectorDto

Property	Type	Required	Description
excludedFields	string[] | null	no	—
includeAllByDefault	boolean	no	—
includedFields	string[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.PerSyncConsentRequestDto

Property	Type	Required	Description
documentId	string (uuid)	no	—
expiresAt	string (date-time)	no	—
perSyncConsentId	string (uuid)	no	—
requestedAt	string (date-time)	no	—
status	string | null	no	—
subscriberId	string (uuid)	no	—
syncId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.RejectSubscriptionRequestDto

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.RequestMoreSyncsRequestDto

Property	Type	Required	Description
requestedIncrement	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.RequestMoreSyncsResponseDto

Property	Type	Required	Description
expiresAt	string (date-time)	no	—
requestId	string (uuid)	no	—
requestedIncrement	integer (int32)	no	—
status	string | null	no	—
subscriptionId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.RequestSubscriptionRequestDto

Property	Type	Required	Description
boundary	Essence.Consent.Core.Contracts.DTOs.Subscription.SubscriptionBoundaryDto	no	—
consentGrantId	string (uuid) | null	no	—
documentId	string (uuid)	no	—
fieldSelector	Essence.Consent.Core.Contracts.DTOs.Subscription.FieldSelectorDto	no	—
perSyncApprovalTtlHours	integer (int32) | null	no	—
policy	Essence.Consent.Core.Contracts.DTOs.Subscription.SubscriptionPolicyDto	no	—
purpose	string | null	no	—
subscriberType	string | null	no	—
webhookSecret	string | null	no	—
webhookUrl	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.SubscriptionBoundaryDto

Property	Type	Required	Description
maxSyncs	integer (int32) | null	no	—
syncType	string | null	no	—
syncsUsed	integer (int32)	no	—
validFrom	string (date-time) | null	no	—
validTo	string (date-time) | null	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.SubscriptionPolicyDto

Property	Type	Required	Description
autoRetry	boolean	no	—
conflictStrategy	string | null	no	—
expiresAt	string (date-time) | null	no	—
includeHistoricalData	boolean	no	—
maxRetries	integer (int32)	no	—
maxUpdatesPerPeriod	integer (int32) | null	no	—
notifyOnSync	boolean	no	—
updateCount	integer (int32)	no	—
updateFrequency	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.SyncJobDto

Property	Type	Required	Description
changeSetId	string (uuid) | null	no	—
completedAt	string (date-time) | null	no	—
createdAt	string (date-time)	no	—
errorMessage	string | null	no	—
id	string (uuid)	no	—
maxRetries	integer (int32)	no	—
metrics	Essence.Consent.Core.Contracts.DTOs.Subscription.SyncMetricsDto	no	—
nextRetryAt	string (date-time) | null	no	—
resultHash	string | null	no	—
retryCount	integer (int32)	no	—
scheduledAt	string (date-time)	no	—
startedAt	string (date-time) | null	no	—
status	string | null	no	—
subscriptionId	string (uuid)	no	—
workerId	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.SyncMetricsDto

Property	Type	Required	Description
averageLatencyMs	number (double)	no	—
bytesTransferred	integer (int64)	no	—
conflictsDetected	integer (int32)	no	—
conflictsResolved	integer (int32)	no	—
durationMs	integer (int64)	no	—
recordsFailed	integer (int32)	no	—
recordsSucceeded	integer (int32)	no	—
successRate	number (double)	no	—
throughputPerSecond	number (double)	no	—
totalRecordsProcessed	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.Subscription.SyncSubscriptionDto

Property	Type	Required	Description
approvedAt	string (date-time) | null	no	—
approvedBy	string (uuid) | null	no	—
boundary	Essence.Consent.Core.Contracts.DTOs.Subscription.SubscriptionBoundaryDto	no	—
cancellationReason	string | null	no	—
cancelledAt	string (date-time) | null	no	—
consentGrantId	string (uuid) | null	no	—
createdAt	string (date-time)	no	—
createdBy	string (uuid)	no	—
documentId	string (uuid)	no	—
failedSyncCount	integer (int32)	no	—
fieldSelector	Essence.Consent.Core.Contracts.DTOs.Subscription.FieldSelectorDto	no	—
grantorId	string (uuid)	no	—
id	string (uuid)	no	—
lastSyncedAt	string (date-time) | null	no	—
nextSyncAt	string (date-time) | null	no	—
policy	Essence.Consent.Core.Contracts.DTOs.Subscription.SubscriptionPolicyDto	no	—
purpose	string | null	no	—
rejectionReason	string | null	no	—
status	string | null	no	—
subscriberId	string (uuid)	no	—
subscriberType	string | null	no	—
successfulSyncCount	integer (int32)	no	—
updatedAt	string (date-time) | null	no	—
updatedBy	string (uuid) | null	no	—
webhookUrl	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SuccessionApprovalDto

Property	Type	Required	Description
approvedAt	string (date-time) | null	no	—
attestation	string | null	no	—
caseId	string (uuid)	no	—
companyId	string (uuid)	no	—
currency	string | null	no	—
deceasedShareholderId	string (uuid)	no	—
lawfulBasis	string | null	no	—
openedAt	string (date-time)	no	—
openedByUserId	string (uuid)	no	—
parties	Essence.Consent.Core.Contracts.DTOs.SuccessionApprovalPartyDto[] | null	no	—
pricePerShareMinor	integer (int64)	no	—
shareClass	string | null	no	—
shareCount	integer (int64)	no	—
status	string | null	no	—
termsAmendedAt	string (date-time) | null	no	—
termsAmendedByUserId	string (uuid) | null	no	—
termsVersion	integer (int32)	no	—
totalConsiderationMinor	integer (int64)	no	—

Essence.Consent.Core.Contracts.DTOs.SuccessionApprovalPartyDto

Property	Type	Required	Description
role	string | null	no	—
signedAt	string (date-time) | null	no	—
userId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.SuccessionApprovalPartyRequest

Property	Type	Required	Description
role	string | null	no	—
userId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.SupervisionControlTemplateDto

Property	Type	Required	Description
archivedAt	string (date-time) | null	no	—
createdAtUtc	string (date-time)	no	—
id	string (uuid)	no	—
jurisdiction	string | null	no	—
lawfulBasis	string | null	no	—
majorityAge	integer (int32)	no	—
name	string | null	no	—
organisationId	string (uuid) | null	no	—
status	string | null	no	—
supervisorId	string (uuid)	no	—
thresholds	Essence.Consent.Core.Contracts.DTOs.SupervisionGraduationThresholdDto[] | null	no	—
updatedAtUtc	string (date-time)	no	—
version	integer (int32)	no	—
versionHistory	Essence.Consent.Core.Contracts.DTOs.SupervisionControlTemplateVersionDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.SupervisionControlTemplateSummaryDto

Property	Type	Required	Description
id	string (uuid)	no	—
jurisdiction	string | null	no	—
majorityAge	integer (int32)	no	—
name	string | null	no	—
organisationId	string (uuid) | null	no	—
status	string | null	no	—
updatedAtUtc	string (date-time)	no	—
version	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.SupervisionControlTemplateVersionDto

Property	Type	Required	Description
changeNote	string | null	no	—
createdAtUtc	string (date-time)	no	—
createdBy	string (uuid)	no	—
jurisdiction	string | null	no	—
lawfulBasis	string | null	no	—
majorityAge	integer (int32)	no	—
thresholds	Essence.Consent.Core.Contracts.DTOs.SupervisionGraduationThresholdDto[] | null	no	—
versionNumber	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.SupervisionGraduationThresholdDto

Property	Type	Required	Description
atAge	integer (int32)	no	—
consentHeldBy	string | null	no	—
isMajority	boolean	no	—
unlocks	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.SupplierConsentBasisDto

Property	Type	Required	Description
epoch	integer (int32) | null	no	—
expiresAt	string (date-time) | null	no	—
grantId	string (uuid) | null	no	—
grantedAt	string (date-time) | null	no	—
kind	string | null	no	—
supplierId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.SupplierConsentCoverageRequest

Property	Type	Required	Description
organizationId	string (uuid) | null	no	—
suppliers	Essence.Consent.Core.Contracts.DTOs.SupplierConsentCoverageSubject[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.SupplierConsentCoverageSubject

Property	Type	Required	Description
supplierId	string (uuid)	no	—
supplierOrganizationId	string (uuid) | null	no	—

Essence.Consent.Core.Contracts.DTOs.SuspendConsentRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.UpdateConsentRequest

Property	Type	Required	Description
policy	Essence.Consent.Core.Contracts.DTOs.ConsentPolicyDto	no	—
purposeDescription	string | null	no	—
removeFieldKeys	string[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.UpdateDelegationScopeRequest

Property	Type	Required	Description
scopes	Essence.Consent.Core.Contracts.DTOs.DelegationScopeDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.UpdateScopeOfAuthorityRequest

Property	Type	Required	Description
categories	Essence.Consent.Core.Contracts.DTOs.ScopeCategoryDto[] | null	no	—
fields	Essence.Consent.Core.Contracts.DTOs.ScopeFieldDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.UpsertOrgNoticeLocalePolicyRequest

Property	Type	Required	Description
highRiskPurposes	string[] | null	no	—
reServeMode	string | null	no	—
supportedLocales	string[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.UpsertSelfExclusionPolicyRequest

Property	Type	Required	Description
allowReinstatement	boolean	no	—
coolingOffDays	integer (int32)	no	—
coolingOffZeroIsDeliberate	boolean	no	—
minExclusionDays	integer (int32)	no	—

Essence.Consent.Core.Contracts.DTOs.ValidateCareLinkRequest

Property	Type	Required	Description
consentGrantId	string (uuid)	no	—
organizationId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.ValidateConsentGrantRequest

Property	Type	Required	Description
consentGrantId	string (uuid)	no	—
documentId	string (uuid)	no	—
fieldId	string | null	no	—
processingContext	string | null	no	—
recipientType	Essence.Consent.Core.Domain.Enums.PartyType	no	—
recipientUserId	string (uuid) | null	no	—
userId	string (uuid) | null	no	—

Essence.Consent.Core.Contracts.DTOs.ValidateDelegationGrantRequest

Property	Type	Required	Description
capability	string | null	no	—
delegateUserId	string (uuid)	no	—
delegationGrantId	string (uuid)	no	—
principalUserId	string (uuid)	no	—
surface	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.ValidateInjectionConsentRequest

Property	Type	Required	Description
consentGrantId	string (uuid)	no	—
documentId	string (uuid)	no	—
requesterId	string (uuid)	no	—
targetUserId	string (uuid)	no	—

Essence.Consent.Core.Contracts.DTOs.VaultSplitConsentCascadeResultDto

Property	Type	Required	Description
counterpartyId	string (uuid)	no	—
documents	Essence.Consent.Core.Contracts.DTOs.VaultSplitDocumentCascadeDto[] | null	no	—
notice	string | null	no	—
splitId	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.VaultSplitDocumentCascadeDto

Property	Type	Required	Description
callerRole	string | null	no	—
cascadedAt	string (date-time) | null	no	—
documentId	string (uuid)	no	—
failedConsentIds	(string (uuid))[] | null	no	—
outcome	string | null	no	—
pendingConsentIds	(string (uuid))[] | null	no	—
retainedGrantCount	integer (int32)	no	—
revocationBatchId	string (uuid) | null	no	—
revokedConsentIds	(string (uuid))[] | null	no	—
skippedLegalHoldConsentIds	(string (uuid))[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.VehicleProfileLeaseDto

Property	Type	Required	Description
categories	string[] | null	no	—
deviceId	string | null	no	—
endsAtIso	string | null	no	—
grantId	string (uuid)	no	—
leaseId	string (uuid)	no	—
operatorName	string | null	no	—
startsAtIso	string | null	no	—
status	string | null	no	—
vehicleLabel	string | null	no	—
windowUnit	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.VehicleProfileLeaseListDto

Property	Type	Required	Description
leases	Essence.Consent.Core.Contracts.DTOs.VehicleProfileLeaseDto[] | null	no	—

Essence.Consent.Core.Contracts.DTOs.VehiclePurgeAttestationDto

Property	Type	Required	Description
certificateSerial	string | null	no	—
signatureAlgorithm	string | null	no	—
signatureDisplay	string | null	no	—
signatureVerified	boolean	no	—
signedAtIso	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.VehiclePurgeAttestationRequest

Property	Type	Required	Description
certificateSerial	string | null	no	—
deviceId	string | null	no	—
leaseId	string (uuid) | null	no	—
payloadHash	string | null	no	—
signatureAlgorithm	string | null	no	—
signatureHex	string | null	no	—
signatureVerified	boolean	no	—
signedAt	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.VehiclePurgeOutcomeRequest

Property	Type	Required	Description
category	string | null	no	—
erasedAt	string | null	no	—
failureReason	string | null	no	—
holdReference	string | null	no	—
state	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.VerifySelfExclusionRequest

Property	Type	Required	Description
attachPseudonymousRef	boolean	no	—
credentialId	string (uuid)	no	—
operatorRef	string | null	no	—
presentationCode	string | null	no	—
verificationToken	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.VisitorConsentChoicesDto

Property	Type	Required	Description
analytics	boolean | null	no	—
functional	boolean | null	no	—
marketing	boolean | null	no	—

Essence.Consent.Core.Contracts.DTOs.VisitorConsentFilingDto

Property	Type	Required	Description
contentDigest	string | null	no	—
receivedAt	string | null	no	—
replayed	boolean	no	—
supersededByRecordId	string | null	no	—
supersedesOnFile	boolean | null	no	—

Essence.Consent.Core.Contracts.DTOs.VisitorConsentNoticeDto

Property	Type	Required	Description
heading	string | null	no	—
introduction	string | null	no	—
purposes	Essence.Consent.Core.Contracts.DTOs.VisitorConsentNoticePurposeDto[] | null	no	—
version	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.VisitorConsentNoticePurposeDto

Property	Type	Required	Description
consequence	string | null	no	—
label	string | null	no	—
purpose	string | null	no	—
summary	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.VisitorConsentRecordDto

Property	Type	Required	Description
choices	Essence.Consent.Core.Contracts.DTOs.VisitorConsentChoicesDto	no	—
decidedVia	string | null	no	—
deviceAccessRule	string | null	no	—
filing	Essence.Consent.Core.Contracts.DTOs.VisitorConsentFilingDto	no	—
jurisdiction	string | null	no	—
notice	Essence.Consent.Core.Contracts.DTOs.VisitorConsentNoticeDto	no	—
recordId	string | null	no	—
recordedAt	string | null	no	—
regime	string | null	no	—
regimeIsGdprLawfulBasis	boolean	no	—
regimeSource	string | null	no	—
schema	string | null	no	—
subject	string | null	no	—
supersedesRecordId	string | null	no	—
symmetry	Essence.Consent.Core.Contracts.DTOs.VisitorConsentSymmetryDto	no	—

Essence.Consent.Core.Contracts.DTOs.VisitorConsentSymmetryDto

Property	Type	Required	Description
acceptClassName	string | null	no	—
acceptClicks	integer (int32)	no	—
acceptElement	string | null	no	—
identicalClassName	boolean	no	—
identicalClickCount	boolean	no	—
identicalElement	boolean	no	—
rejectClassName	string | null	no	—
rejectClicks	integer (int32)	no	—
rejectElement	string | null	no	—
symmetric	boolean	no	—

Essence.Consent.Core.Contracts.DTOs.WithdrawCollectiveAcceptanceRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.WithdrawHolderUnderstandingRequest

Property	Type	Required	Description
channel	string | null	no	—
locale	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.WithdrawOriginRecordsApplicationRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.WithdrawRetainedAttestationRequest

Property	Type	Required	Description
reason	string | null	no	—

Essence.Consent.Core.Contracts.DTOs.WrappedFileKeyEnvelopeDto

Property	Type	Required	Description
algorithm	string | null	no	—
authTagBase64	string | null	no	—
ciphertextBase64	string | null	no	—
nonceBase64	string | null	no	—
recipientPublicKeyFingerprint	string | null	no	—

Essence.Consent.Core.Domain.Entities.EmergencyAccess.EmergencyAccessLegalBasis

0 | 1 | 2 with no declared properties.

Essence.Consent.Core.Domain.Entities.EmergencyAccess.EmergencyAccessStatus

0 | 1 with no declared properties.

Essence.Consent.Core.Domain.Entities.LegalNameChange.IntakeAcceptanceMode

0 | 1 | 2 with no declared properties.

Essence.Consent.Core.Domain.Entities.LegalNameChange.IntakeCascadeState

0 | 1 | 2 with no declared properties.

Essence.Consent.Core.Domain.Entities.LegalNameChange.IntakeDecision

0 | 1 | 2 with no declared properties.

Essence.Consent.Core.Domain.Entities.MultiGrantee.GranteeDisclosureLine

Property	Type	Required	Description
explicitlyExcludedFields	string[] | null	no	—
granteeId	string (uuid)	no	—
granteeScopeId	string (uuid)	no	—
label	string | null	no	—
permittedReads	integer (int32)	no	—
refusedReads	integer (int32)	no	—
revokedAt	string (date-time) | null	no	—
role	string | null	no	—
sharedFields	string[] | null	no	—
status	Essence.Consent.Core.Domain.Enums.GranteeScopeStatus	no	—
withheldFields	string[] | null	no	—

Essence.Consent.Core.Domain.Entities.MultiGrantee.MultiGranteeDisclosureReport

Property	Type	Required	Description
affirmationStatement	string | null	no	—
article9Condition	Essence.Consent.Core.Domain.Enums.ConsentArticle9Condition	no	—
declaredFieldUniverse	string[] | null	no	—
description	string | null	no	—
enforcementPoint	string | null	no	—
expiresAt	string (date-time)	no	—
generatedAt	string (date-time)	no	—
grantId	string (uuid)	no	—
grantedAt	string (date-time)	no	—
grantees	Essence.Consent.Core.Domain.Entities.MultiGrantee.GranteeDisclosureLine[] | null	no	—
grantorId	string (uuid)	no	—
purpose	Essence.Consent.Core.Domain.Enums.ConsentPurpose	no	—
purposeLimitation	string | null	no	—
revokedAt	string (date-time) | null	no	—
specialCategoryFields	string[] | null	no	—
status	Essence.Consent.Core.Domain.Enums.MultiGranteeGrantStatus	no	—

Essence.Consent.Core.Domain.Entities.Rotation.RotationGrantDispositionOutcome

0 | 1 | 2 with no declared properties.

Essence.Consent.Core.Domain.Entities.VerifiedChange.PreviousNameDispositionChoice

0 | 1 | 2 with no declared properties.

Essence.Consent.Core.Domain.Entities.VerifiedChange.PreviousNameVisibilityState

0 | 1 | 2 | 3 with no declared properties.

Essence.Consent.Core.Domain.Entities.VerifiedChange.VerifiedChangeExclusionReason

0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 with no declared properties.

Essence.Consent.Core.Domain.Entities.VerifiedChange.VerifiedChangeRecipientOutcome

0 | 1 with no declared properties.

Essence.Consent.Core.Domain.Enums.AccountCaptureStatus

0 | 1 | 2 | 3 with no declared properties.

Essence.Consent.Core.Domain.Enums.AssistanceUnavailableReason

0 | 1 | 2 | 3 | 4 | 5 | 6 with no declared properties.

Essence.Consent.Core.Domain.Enums.CaptureEscrowStatus

0 | 1 | 2 | 3 | 4 with no declared properties.

Essence.Consent.Core.Domain.Enums.ComplianceFramework

0 | 1 | 2 | 3 | 4 | 99 with no declared properties.

Essence.Consent.Core.Domain.Enums.ConsentArticle49TransferBasis

0 | 1 | 2 | 3 | 4 with no declared properties.

Essence.Consent.Core.Domain.Enums.ConsentArticle9Condition

0 | 1 | 2 | 3 | 4 with no declared properties.

Essence.Consent.Core.Domain.Enums.ConsentChangeType

1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 with no declared properties.

Essence.Consent.Core.Domain.Enums.ConsentPurpose

0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 with no declared properties.

Essence.Consent.Core.Domain.Enums.ConsentStatus

0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 with no declared properties.

Essence.Consent.Core.Domain.Enums.DataResidencyRegion

0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 with no declared properties.

Essence.Consent.Core.Domain.Enums.DocumentDeliveryModel

0 | 1 with no declared properties.

Essence.Consent.Core.Domain.Enums.DocumentRequestRequesterVisibleStatus

0 | 1 | 2 with no declared properties.

Essence.Consent.Core.Domain.Enums.DocumentRequestStatus

0 | 1 | 2 | 3 with no declared properties.

Essence.Consent.Core.Domain.Enums.FitToFlyClearanceStatus

0 | 1 | 2 | 3 | 4 | 5 | 6 with no declared properties.

Essence.Consent.Core.Domain.Enums.FitToFlyDisclosureLevel

0 | 1 with no declared properties.

Essence.Consent.Core.Domain.Enums.FitToFlyInfoRequest

0 | 1 | 2 | 3 | 4 | 5 with no declared properties.

Essence.Consent.Core.Domain.Enums.GranteeAccessOutcome

0 | 1 | 2 | 3 | 4 | 5 with no declared properties.

Essence.Consent.Core.Domain.Enums.GranteeScopeStatus

0 | 1 with no declared properties.

Essence.Consent.Core.Domain.Enums.MultiGranteeGrantStatus

0 | 1 | 2 with no declared properties.

Essence.Consent.Core.Domain.Enums.PartyType

0 | 1 | 2 with no declared properties.

Essence.Consent.Core.Domain.Enums.PrmAssistanceCategory

0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 with no declared properties.

Essence.Consent.Core.Domain.Enums.QRCodeSessionStatus

0 | 1 | 2 | 3 with no declared properties.

Essence.Consent.Core.Domain.Enums.QRCodeStatus

0 | 1 | 2 | 3 | 4 with no declared properties.

Essence.Consent.Core.Domain.Enums.RecordsHandoverLawfulBasis

0 | 1 | 2 with no declared properties.

Essence.Consent.Core.Domain.Enums.RecordsHandoverStatus

0 | 1 | 2 | 3 | 4 with no declared properties.

Essence.Consent.Core.Domain.Enums.RedactionPreviewOutcome

0 | 1 with no declared properties.

Essence.Consent.Core.Domain.Enums.RedactionPreviewReason

0 | 1 | 2 | 3 with no declared properties.

Essence.Consent.Core.Domain.Enums.RevealAccessExpiry

0 | 1 | 2 with no declared properties.

Essence.Consent.Core.Domain.Enums.RevealGrantStatus

1 | 2 | 3 with no declared properties.

Essence.Consent.Core.Domain.Enums.RevealStage

1 | 2 with no declared properties.

Essence.Consent.Core.Domain.Enums.SpecialAssistanceStatus

0 | 1 | 2 | 3 | 4 | 5 with no declared properties.

Essence.Consent.Core.Domain.Enums.TransferMechanism

0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 with no declared properties.

Essence.Consent.Core.Domain.Merge.MergeGrantDisposition

0 | 1 | 2 | 3 with no declared properties.

Essence.Consent.Core.Domain.Merge.MergeGrantOutcome

0 | 1 | 2 | 3 | 4 with no declared properties.

Essence.Consent.Core.Domain.Merge.MergeGrantRole

0 | 1 with no declared properties.

Essence.Consent.Core.Domain.Merge.MergeRepointMode

0 | 1 | 2 with no declared properties.

Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Application.DTOs.ConsentHistoryDto

Property	Type	Required	Description
hasMore	boolean	no	—
items	Essence.Consent.Core.Application.DTOs.ConsentHistoryDto[] | null	no	—
nextCursor	string | null	no	—
pageSize	integer (int32)	no	—
previousCursor	string | null	no	—

Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto

Property	Type	Required	Description
hasMore	boolean	no	—
items	Essence.Consent.Core.Application.DTOs.ThirdParty.ThirdPartyConsentDto[] | null	no	—
nextCursor	string | null	no	—
pageSize	integer (int32)	no	—
previousCursor	string | null	no	—

Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Contracts.DTOs.ConsentGrantDto

Property	Type	Required	Description
hasMore	boolean	no	—
items	Essence.Consent.Core.Contracts.DTOs.ConsentGrantDto[] | null	no	—
nextCursor	string | null	no	—
pageSize	integer (int32)	no	—
previousCursor	string | null	no	—

Essence.Platform.Contracts.Pagination.CursorResultOfEssence.Consent.Core.Contracts.DTOs.OrganisationGrantDto

Property	Type	Required	Description
hasMore	boolean	no	—
items	Essence.Consent.Core.Contracts.DTOs.OrganisationGrantDto[] | null	no	—
nextCursor	string | null	no	—
pageSize	integer (int32)	no	—
previousCursor	string | null	no	—

Microsoft.AspNetCore.Mvc.ProblemDetails

Property	Type	Required	Description
detail	string | null	no	—
instance	string | null	no	—
status	integer (int32) | null	no	—
title	string | null	no	—
type	string | null	no	—

Microsoft.AspNetCore.Mvc.ValidationProblemDetails

Property	Type	Required	Description
detail	string | null	no	—
errors	map<string, string[]> | null	no	—
instance	string | null	no	—
status	integer (int32) | null	no	—
title	string | null	no	—
type	string | null	no	—

System.TimeSpan

Property	Type	Required	Description
days	integer (int32)	no	—
hours	integer (int32)	no	—
microseconds	integer (int32)	no	—
milliseconds	integer (int32)	no	—
minutes	integer (int32)	no	—
nanoseconds	integer (int32)	no	—
seconds	integer (int32)	no	—
ticks	integer (int64)	no	—
totalDays	number (double)	no	—
totalHours	number (double)	no	—
totalMicroseconds	number (double)	no	—
totalMilliseconds	number (double)	no	—
totalMinutes	number (double)	no	—
totalNanoseconds	number (double)	no	—
totalSeconds	number (double)	no	—