API

Integrate subject-request reads

Execution protocol scoped to one request and destination. Available for confirmation, access and portability, with integration implemented by the system owner.

Deliver a response in Profile

In Subject requests, open Profile response. With recorded identity verification and a current account reference, write the text response, its scope and access expiry. Check the preview and confirm recipient and content before publishing. A final response requires a resolved decision and destinations and a reviewed deadline; publication keeps the case open.

The subject opens Profile, selects the organization and opens Responses to my requests. First authenticated access is recorded before the API releases the text; it does not prove human reading. After hash verification, the interface offers optional acknowledgement without implying agreement. The administrator may review and close using a current final response with recorded access; this path does not require optional acknowledgement and does not determine legal deadline compliance.

Expired, revoked or changed-authority access is blocked. Revocation removes live database content; a startup and hourly job removes expired content. Receipts and hashes remain, and backups follow their own retention. The 90-day limit is a product limit, not a legal deadline. This path does not send email, deliver attachments or support external subjects. The dossier includes receipt metadata without response text.

Read ScaleQuality account data

To download your own account data, open Profile → My data in this organization. Select the organization and choose Download my data. Identity comes from the session; the API checks current membership and the browser verifies SHA-256. This personal copy does not generate a dossier execution receipt or close an administrative request. The separate administrator workflow follows below.

To read data already held by ScaleQuality, open a request by selecting a registered member. Add an inventory-linked destination and choose “ScaleQuality — account registration and organization memberships”. Record identity verification and the decision to accept. In Connector execution, use “Execute read and download JSON”.

Confirmation returns account presence only. Access and portability return JSON containing name, email, account creation date and current memberships in that organization. It excludes audit events, code authorship, AI usage, external systems and historical/deleted records. The JSON describes its scope; it does not constitute complete fulfillment of an access or portability request.

The API checks the member’s organization link again. Execution records native origin, receipt and SHA-256; the browser checks the hash before download. Personal content is not copied into the dossier. Source failure, authorization changes or failure to record the receipt prevent file release. If download fails, inspect the history before revoking and starting another read. An administrator download does not prove delivery to the subject.

Authorize

In Audit Evidence → Subject requests, record identity verification and the decision to accept. Link a destination to a current inventory activity. In Connector execution, enter the integration name and generate read authorization.

The credential is shown once and expires in one hour. It only permits claiming instructions and reporting a result for that job. Keep it in the integration’s secure environment, outside URLs, logs and source code. It does not replace subject authentication.

Execute with a receipt

The connector starts with POST /claim using the credential in the Authorization header. The response includes executionId, idempotencyKey, orgId, right, subjectReference, destination and expiresAt. Validate organization, destination and right against local configuration before accessing data. The source system must resolve the case reference to the already verified subject.

POST /api/insights/rights-executions/{executionId}/claim
Authorization: Bearer {executionToken}
Content-Type: application/json

{}

Perform only the authorized read. Persist the result by idempotencyKey before reporting success. On transport retry, reuse the artifact and receipt; do not unnecessarily repeat the read. The artifact and secure delivery remain with the responsible system.

POST /api/insights/rights-executions/{executionId}/result
Authorization: Bearer {executionToken}
Content-Type: application/json

{
  "outcome": "SUCCEEDED",
  "receiptId": "opaque-receipt-id",
  "summary": "Read completed; artifact retained in source system",
  "artifactSha256": "<64 lowercase hexadecimal characters>"
}

For failure, use outcome FAILED, receiptId and summary without personal data; artifactSha256 is optional. Do not send artifact contents, identity documents or credentials. An identical repeated result returns duplicate: true; a different result for the same execution is rejected.

Limits and failures

401/403: missing, invalid, revoked or expired credential. 409: authorization or source changed, concurrent revision or incompatible result. Do not automatically reauthorize: return the case to the administrator. Revocation blocks future calls but cannot stop work already started outside the platform.

For external connectors, the receipt is reported by the connector and its hash identifies the declared artifact. ScaleQuality does not inspect that content or establish completeness. Identity and deadline remain administrator-recorded; the final response requires a recorded external delivery receipt. Erasure, rectification, automatic discovery and delivery to the subject are not performed by this protocol.