Overview

TrustInk Core API 1.0.0-SNAPSHOT

The REST API of TrustInk Core: tenants create signature cases, participants sign them through their signing link.

• Tenants authenticate with a Cognito ID token (tenantIdToken).
• Participants authenticate with the token of their signing link (participantToken). A case with multiFactorType also wants a verified one-time code (Trustink-Otp-Session).
• Errors answer {code, message} plus details; code is what clients act on. A body that fails validation answers 400 {message, validationErrors}.
• Verification: POST /verify/upload and POST /verify need no authorization; API Gateway throttles them instead (429).
• CORS: the participant routes allow the stage’s web signer origins; tenant routes have none.
• Real-time events, webhooks and the audit trail are described in the guides: real-time events, webhooks and the audit trail.

This file is generated from the domain’s Zod schemas by @trustink/api-spec; do not edit it by hand.

Information

• OpenAPI version: 3.1.0

Operations

POST

/cases

GET

/cases/{caseId}

DELETE

/cases/{caseId}

GET

/cases/{caseId}/events

POST

/cases/{caseId}/participants/{participantId}/open

POST

/tenant/devices

GET

/participant/{participantId}/caseDefinition

GET

/participant/{participantId}/signedDocument

POST

/participant/{participantId}/signature

POST

/participant/{participantId}/otp

POST

/participant/{participantId}/otp/verify

POST

/verify/upload

POST

/verify

Authentication

tenantIdToken

The Cognito ID token of the tenant (user pool trustink-tenants, USER_PASSWORD_AUTH). An access token is refused.

Security scheme type: http

Bearer format: JWT

participantToken

The participant token of a signing link: the apiToken query parameter of the participant’s signerUrl.

Security scheme type: http

Bearer format: JWT