Read the audit trail of a case

GET

/cases/{caseId}/events

curl --request GET \
  --url https://api-sandbox.trustink.io/cases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/events \
  --header 'Authorization: Bearer <token>'

• Sandbox
• Production

Who did what to the case, when and from where, newest first. See Audit trail.

Authorizations

• tenantIdToken

Parameters

Path Parameters

caseId

required

The case id POST /cases answered.

string format: uuid

Query Parameters

limit

Events per page, 1 to 100 (default 100).

string

/^\d+$/

cursor

The nextCursor of the previous page.

string

Responses

200

A page of events; nextCursor is set while older ones remain.

Media typeapplication/json

object

events

required

Array<object>

object

eventId

required

string

type

required

string

Allowed values: case.created document.uploaded document.rejected participant.created participant.invited participant.viewed participant.otp_sent participant.otp_failed participant.otp_verified participant.consented participant.signed participant.certificate_issued participant.signature_applied participant.downloaded case.finalised case.completed case.expired case.cancelled case.failed participant.certificate_revoked

occurredAt

required

string

actor

required

string

Allowed values: tenant participant system

participantId

string

ip

string

userAgent

string

documentSha256

string

data

required

object

key

additional properties

nextCursor

string

Example

{
  "events": [
    {
      "type": "case.created",
      "actor": "tenant"
    }
  ]
}

400

The limit or the cursor is not valid. code: INVALID_LIMIT, INVALID_CURSOR.

Media typeapplication/json

object

code

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}

401

No or an invalid Cognito ID token (API Gateway answers {message} only).

Media typeapplication/json

object

code

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}

404

The tenant has no such case.

Media typetext/plain

string

Example

Case not found

default

Something failed on the platform, or the request timed out (code TIMEOUT, 503); try again.

Media typeapplication/json

object

code

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}