Ga naar inhoud
buildinglinksbuildinglinks

A signing request (public page)

GET
/api/v1/signing/{token}
curl --request GET \
  --url https://example.com/api/v1/signing/example

What the signatory sees before signing: the organisation, the terms and the documents.

Authorizations

Section titled “Authorizations”
  • None

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
token
required
string

The token from the link in the e-mail.

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json

What the public signing page shows: documents the JSON built in [view].

object
state
required
string
current
required

False when a newer request replaced the one of this link.

boolean
organisation
required

name, legal_name, kvk_number.

object
participant_did
required
string
signatory_name
required
string
terms
required
object
error
string | null
signer_name
string | null
signed_at
string | null format: date-time
expires_at
required
string format: date-time
signing_available
required

Whether the QTSP and the DSS are configured.

boolean
documents
required

kind, title, sha256, signed_sha256, url.

Array<object>
object

Example generated

{
  "state": "example",
  "current": true,
  "organisation": {},
  "participant_did": "example",
  "signatory_name": "example",
  "terms": {},
  "error": "example",
  "signer_name": "example",
  "signed_at": "2026-04-15T12:00:00Z",
  "expires_at": "2026-04-15T12:00:00Z",
  "signing_available": true,
  "documents": [
    {}
  ]
}

404

Section titled “404”

Not found.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}