Skip to content
Docs
Start free

What the signing page shows

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

The case, the participant and their signature fields, and a presigned link to the original document (the signed one once DONE). With multiFactorType and no valid Trustink-Otp-Session the links are left out and otpRequired is true. participants counts the case’s participants and how many have signed, without naming them; sender is the sender’s name when the tenant gave one.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
participantId
required

The participant id: the path of the signing link, or participants[].id of the case.

string format: uuid

Header Parameters

Section titled “Header Parameters”
Trustink-Otp-Session

The otpSession of POST .../otp/verify. Needed for a case with multiFactorType: the document links, the signature and the signed document.

string
Trustink-Pin

Deprecated: the case PIN, for a case created with pin and without multiFactorType.

string

Responses

Section titled “ Responses ”

200

Section titled “200”

The case definition.

Media typeapplication/json
object
caseId
required
string
title
required
string
status
required
string
Allowed values: NEW IN_PROGRESS DONE UPLOAD_REJECTED EXPIRED CANCELLED FAILED
validUntil
required
string
multiFactorType
string
Allowed values: SMS EMAIL
participant
required
object
id
required
string
firstName
required
string
lastName
required
string
status
required
string
Allowed values: UNSIGNED SIGNED
signatureFields
required
Array<object>
object
id
required
string
page
required
number
x
required
number
y
required
number
width
required
number
height
required
number
unit
required
string
Allowed values: pt fraction
originalDocument
object
url
required
string
sha256
string
signedDocument
object
url
required
string
evidenceDocument
object
url
required
string
otpRequired
required
boolean
participants
required
object
total
required
integer
signed
required
integer
sender
object
name
required
string
Example
{
  "status": "NEW",
  "multiFactorType": "SMS",
  "participant": {
    "status": "UNSIGNED",
    "signatureFields": [
      {
        "unit": "pt"
      }
    ]
  }
}

401

Section titled “401”

The signing link is not valid: no or a forged token, another participant’s, or a link not active before the upload (the authorizer answers {message} only).

Media typeapplication/json
object
code
string
message
required
string
Examplegenerated
{
  "code": "example",
  "message": "example"
}

404

Section titled “404”

No such participant or case.

Media typetext/plain
string
Example
Case not found

410

Section titled “410”

Nobody can sign the case any more (status says why), or a DONE case’s link has passed validUntil; senderName names who sent the request when the tenant gave a sender name. code: CASE_NOT_ACTIVE, LINK_EXPIRED.

Media typeapplication/json
object
code
string
message
required
string
Examplegenerated
{
  "code": "example",
  "message": "example"
}

default

Section titled “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
Examplegenerated
{
  "code": "example",
  "message": "example"
}