Send a one-time code

POST

/participant/{participantId}/otp

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

• Sandbox
• Production

Sends a six-digit code by the case’s multiFactorType, valid ten minutes; a new one replaces the previous. At most five an hour. See One-time codes.

Authorizations

• participantToken

Parameters

Path Parameters

participantId

required

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

string format: uuid

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

200

Where the code went, masked, and until when it works.

Media typeapplication/json

object

sentTo

required

string

channel

required

string

Allowed values: EMAIL SMS

expiresAt

required

string

Example

{
  "channel": "EMAIL"
}

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

Example^generated

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

404

No such participant or case.

Media typetext/plain

string

Example

Case not found

409

No code can be sent. code: OTP_NOT_REQUIRED, OTP_NO_DESTINATION.

Media typeapplication/json

object

code

string

message

required

string

Example^generated

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

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

Example^generated

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

429

Five codes were sent in the last hour; retryAfterSeconds says when the next can go. code: OTP_RATE_LIMITED.

Media typeapplication/json

object

code

string

message

required

string

Example^generated

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

501

The channel is not available yet. code: OTP_CHANNEL_UNAVAILABLE.

Media typeapplication/json

object

code

string

message

required

string

Example^generated

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

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"
}