Record that a document was opened

POST

/api/v1/sign/{token}/view-opened

curl --request POST \
  --url https://sign-api.binarybridges.co/api/v1/sign/example/view-opened

• Production

Telemetry for the audit trail — a signer must open each document before signing is enabled. Idempotent within a short dedup window.

Parameters

Path Parameters

token

required

string

Responses

204

No Content

400

The request was malformed or failed validation.

Media typeapplication/json

object

code

required

string

error

required

string

message

required

string

path

required

string

quota

object

current

required

integer format: int64

dimension

required

string

limit

required

integer format: int64

status

required

integer format: int32

timestamp

required

string format: date-time

traceId

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "message": "example",
  "path": "example",
  "quota": {
    "current": 1,
    "dimension": "example",
    "limit": 1
  },
  "status": 1,
  "timestamp": "2026-04-15T12:00:00Z",
  "traceId": "example"
}

404

No such resource, or it belongs to another organisation. Deliberately not a 403: a 403 across a tenant boundary confirms the id exists.

Media typeapplication/json

object

code

required

string

error

required

string

message

required

string

path

required

string

quota

object

current

required

integer format: int64

dimension

required

string

limit

required

integer format: int64

status

required

integer format: int32

timestamp

required

string format: date-time

traceId

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "message": "example",
  "path": "example",
  "quota": {
    "current": 1,
    "dimension": "example",
    "limit": 1
  },
  "status": 1,
  "timestamp": "2026-04-15T12:00:00Z",
  "traceId": "example"
}

409

The resource is not in a state that allows this — for example sending an envelope that is already sent.

Media typeapplication/json

object

code

required

string

error

required

string

message

required

string

path

required

string

quota

object

current

required

integer format: int64

dimension

required

string

limit

required

integer format: int64

status

required

integer format: int32

timestamp

required

string format: date-time

traceId

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "message": "example",
  "path": "example",
  "quota": {
    "current": 1,
    "dimension": "example",
    "limit": 1
  },
  "status": 1,
  "timestamp": "2026-04-15T12:00:00Z",
  "traceId": "example"
}

422

A domain rule rejected the request.

Media typeapplication/json

object

code

required

string

error

required

string

message

required

string

path

required

string

quota

object

current

required

integer format: int64

dimension

required

string

limit

required

integer format: int64

status

required

integer format: int32

timestamp

required

string format: date-time

traceId

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "message": "example",
  "path": "example",
  "quota": {
    "current": 1,
    "dimension": "example",
    "limit": 1
  },
  "status": 1,
  "timestamp": "2026-04-15T12:00:00Z",
  "traceId": "example"
}

429

An organisation quota is exhausted.

Media typeapplication/json

object

code

required

string

error

required

string

message

required

string

path

required

string

quota

object

current

required

integer format: int64

dimension

required

string

limit

required

integer format: int64

status

required

integer format: int32

timestamp

required

string format: date-time

traceId

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "message": "example",
  "path": "example",
  "quota": {
    "current": 1,
    "dimension": "example",
    "limit": 1
  },
  "status": 1,
  "timestamp": "2026-04-15T12:00:00Z",
  "traceId": "example"
}