API reference
Endpoint explorer
Search the current route catalogue by method, path or operation.
#Using the explorer
Search for transaction, SDK, comparison, an HTTP method or a path fragment. Expand a row to inspect its purpose and access conditions. sigillum.example is a placeholder for the institutional installation. Read authentication and revision requirements before making a mutating request.
Download JSON referenceGET
POST
GET
GET
GET
GET
POST
GET
GET
POST
POST
POST
POST
POST
GET
POST
POST
GET
GET
GET
POST
POST
POST
POST
POST
GET
POST
POST
GET
GET
POST
GET
GET
GET
POST
POST
POST
POST
POST
GET
GET
GET
POST
POST
GET
GET
GET
POST
POST
POST
GET
GET
GET
GET
GET
POST
GET
POST
POST
POST
GET
POST
POST
GET
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
GET
POST
POST
POST
82 endpoints
GET/api/platformProduct information
Returns product, SDK and architecture version information.
- Access
- Installation network policy; no portal session required.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
curl https://sigillum.example/api/platformPOST/api/transferSDK record transfer
Accepts the SDK-generated SFREC001 binary package. This is not a JSON business-data API. Acceptance does not establish final sealing.
- Access
- SDK service identity and protocol trust requirements.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/api/transfer/profilesSigned entry profiles
Returns entry profiles authorised for the calling service. The SDK verifies signatures and revisions.
- Access
- SDK service identity and protocol trust requirements.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/api/transfer/trustTransfer trust
Returns the installation’s transfer trust information.
- Access
- Installation network policy; no portal session required.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/health/liveLiveness
Reports process liveness. A live process does not by itself establish dependency readiness.
- Access
- Installation network policy; no portal session required.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/health/readyReadiness
Reports readiness according to the installation’s dependency checks.
- Access
- Installation network policy; no portal session required.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/account/passwordChange password
Changes the authenticated user’s password after validating the current request.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/activityAccess activity
Lists authorised account and access activity.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/application-reference-fieldsReference fields
Returns the configured record-reference fields.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/application-reference-fieldsConfigure reference fields
Saves record-reference field definitions in the selected scope.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/applicationsCreate application
Creates an application in the selected institution and environment.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/applications/{id}/retireRetire application
Retires the identified application definition.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/applications/{id}/updateUpdate application
Updates the application using the submitted revision requirements.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/comparison-catalogComparison field catalogue
Builds the available field catalogue for comparison setup.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/comparison-definitionsComparison definitions
Returns the application’s comparison definitions.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/comparison-definitionsSave comparison definition
Creates a versioned comparison definition.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/comparison-definitions/deactivateDeactivate comparison definition
Deactivates the selected definition without rewriting prior sealed evidence.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/dashboardDashboard summary
Returns the overview summary for the selected scope.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/dashboard/analyticsDashboard analytics
Returns the filtered dashboard analysis data.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/delivery-statusPending deliveries
Returns service-level delivery status and available backlog measurements.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/entry-pointsSave entry point
Saves an actual execution entry definition.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- JSON: { id, applicationId, serviceId, kind, operation, path, expectedRevision }.
- Response
- The saved actual entry-point definition.
POST/portal-api/entry-points/{id}/stateEntry-point state
Changes whether the selected entry definition is active.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/entry-points/{id}/updateUpdate entry point
Updates the identified entry definition.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/environmentsCreate environment
Creates an institutional operating environment.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/environments/{id}/retireRetire environment
Retires the identified environment definition.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/institution-sourcesInstitution record sources
Lists configured source connections for comparison.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/institution-sourcesSave record source
Creates or updates a versioned source connection.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/institution-sources/{id}/retireRetire record source
Retires the selected source connection.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/institution-sources/{id}/versionsSource version history
Returns the version history of the selected connection.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/institutionsInstitutions
Lists institutions visible to the authenticated user.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/institutionsCreate institution
Creates an institution using the required administrative authority.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/integration-statusIntegration status
Returns the current integration information for the selected scope.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/licenseInstitution licence
Returns licence periods and observation availability for the institution.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/license/historyLicence decision history
Returns imported licence decision history.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/license/importImport signed licence
Verifies a licence, renewal or revocation against the institution and installation. The issuer’s private key is not held at this endpoint.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- JSON: { document: string }. Signed file text, up to 32 KiB.
- Response
- Verified institution licence status or a specific licence error code.
POST/portal-api/license/requestLicence request
Produces the installation-bound request used for offline licence issuance.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/local-agent/{runtime}Download local agent
Downloads a published local-agent package after manifest size and SHA-256 verification.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- runtime: win-x64 or linux-x64. An authorised session and CSRF token are required.
- Response
- application/zip; 503 local_agent_unavailable when the deployment package is unavailable.
POST/portal-api/loginSign in
Authenticates user credentials and establishes a portal session.
- Access
- User credentials and same-origin validation.
- Request / parameters
- JSON: { username: string, password: string }. Same-origin validation applies.
- Response
- Session cookie and session response.
POST/portal-api/logoutSign out
Ends the current portal session.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/operations/logsOperational logs
Returns authorised product operational-log entries.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/operations/snapshotProduct health
Returns the current product-health snapshot.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/registryDefinition registry
Returns the selected scope’s configuration registry.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/scopeSelect institution and environment
Updates the authenticated session’s operating scope.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- JSON: { institutionId: UUID, environmentId: UUID }.
- Response
- Updated session scope.
POST/portal-api/sdk-downloadDownload SDK
Produces the service-specific SDK delivery package.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- JSON: { applicationId, serviceId, language, expectedRevision }. language is dotnet, java or python.
- Response
- Service-specific SDK download package.
GET/portal-api/sdk-packagesSDK package catalogue
Returns available SDK package information.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/security-alertsSecurity alerts
Lists security findings in the authorised scope.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/security-alerts/{alert}Security alert details
Returns the identified security finding.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/servicesCreate service
Creates a service definition.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/services/{id}/cancelCancel service
Cancels the service definition; this differs from disconnecting one application.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/services/{id}/updateUpdate service
Updates the identified service definition.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/sessionSession details
Returns the current user session, scope and CSRF information.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/transactionsTransaction records
Lists filtered transactions in the selected institution and environment. Business outcome and review readiness are separate fields.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/transactions/{execution}Transaction details
Returns the identified transaction’s review metadata.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/transactions/{execution}/comparison-definitionAttached comparison definition
Returns the definition bound to the completed transaction.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/transactions/{execution}/comparisonsComparison history
Lists saved comparison runs for the transaction.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/comparisonsCreate comparison
Runs a comparison with the submitted transaction and source material.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/transactions/{execution}/comparisons/{runId}Comparison run
Returns the saved result for the specified run.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/comparisons/{runId}/offline-packageOffline transaction package
Downloads the related files as an offline-verification package.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/comparisons/{runId}/offline-setupVerifier setup package
Downloads the installer package for opening the selected comparison.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/comparisons/{runId}/offline-toolOffline verifier
Downloads the verification tool for the selected comparison.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/transactions/{execution}/comparisons/{runId}/reportSaved report
Returns the saved report for a comparison run.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/comparisons/{runId}/report/downloadDownload report
Downloads the saved report with authorised access auditing.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/comparisons/{runId}/report/previewReport preview
Prepares a preview of the selected comparison report.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/transactions/{execution}/comparisons/{runId}/source-keysVerification keys
Returns verification-key information for the selected comparison.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/comparisons/{runId}/source-openingPrivate opening file
Downloads private opening material for the selected source comparison.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/comparisons/{runId}/source-proofEvidence package
Downloads the source-comparison evidence package.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/comparisons/{runId}/source-report-keyReport verification key
Downloads the report-signature verification key.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/comparisons/{runId}/source-seal-keySeal verification key
Downloads the seal verification key for the comparison.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/comparisons/{runId}/source-witness-keyWitness verification key
Downloads the witness verification key for the comparison.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/comparisons/from-sourceCompare with source
Starts a run using the attached comparison definition and selected institution source. An identical request can reuse its runId.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- JSON: runId, definitionId, version, definitionSha256, sourceId, sourceVersion, sourceFingerprint, referenceValue.
- Response
- New run or the existing run for an identical request. Reusing runId with different content returns 409.
POST/portal-api/transactions/{execution}/contentOpen original content
Returns an authorised page of the transaction’s original content and records the access.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Optional cursor in the JSON body, belonging to the same transaction.
- Response
- An authorised page of the transaction content.
POST/portal-api/transactions/{execution}/execution-proof/{revision}/offline-toolTransaction evidence verifier
Downloads the offline tool for the selected sealed evidence revision.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/execution-proof/{revision}/proofTransaction evidence
Downloads the selected sealed transaction evidence.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/execution-proof/{revision}/seal-keyTransaction seal key
Downloads the transaction seal verification key.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/execution-proof/{revision}/witness-keyTransaction witness key
Downloads the transaction witness verification key.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/institution-sourcesResolve transaction sources
Resolves available institution-source information for the selected transaction.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/progressTransaction progress
Reads observed steps and preparation state for an unfinished transaction. Reuse viewId while the same panel remains open.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- JSON: { viewId: UUID }. Retain the same viewId while refreshing the open panel.
- Response
- { transaction, progress }: stage, reason, receivedRecords, completedSteps, runningSteps, failedSteps, steps and measuredAt. Details may be shortened for ready records.
POST/portal-api/transactions/{execution}/revalidateRecheck integrity
Revalidates sealed record integrity and records the access.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
GET/portal-api/transactions/{execution}/statusTransaction status
Returns current transaction and review status.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/transactions/{execution}/summaryOpen transaction summary
Returns the prepared transaction summary with authorised content access.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- Path identifiers must be valid UUIDs. The selected institution and environment scope applies.
- Response
- A successful response contains the operation result. For failures, inspect both the HTTP status and response details.
POST/portal-api/usagesConnect service
Connects a service to the selected application.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- JSON: { applicationId, serviceId, expectedRevision }.
- Response
- Updated application/service connection.
POST/portal-api/usages/disconnectDisconnect service
Disconnects the service only from the selected application.
- Access
- Authorised portal session and institution/environment scope. Protected POST requests require CSRF and same-origin checks.
- Request / parameters
- JSON: { applicationId, serviceId, expectedRevision }.
- Response
- The selected application’s service connection is disabled.
No endpoints match these filters.
Sigillum Finans · Source-matched product reference