Ga naar inhoud
buildinglinksbuildinglinks

Send a new signing request

POST
/api/v1/onboarding/applications/{id}/signing-request
curl --request POST \
  --url https://example.com/api/v1/onboarding/applications/example/signing-request \
  --header 'Content-Type: application/json' \
  --cookie bl_authority_session=<bl_authority_session> \
  --data '{ "signatory_name": "example", "signatory_email": "example" }'

Sends the signatory, or another one, a new link to sign; the previous link stops working. By an operator of the authority or by the applicant’s connector; at most 10 per hour per application.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

The id of the application.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
signatory_name

Another signatory; default: the one of the application.

string | null
signatory_email
string | null

Example generated

{
  "signatory_name": "example",
  "signatory_email": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json

The latest signing request of an application: documents the JSON built in [summaries].

object
id
required
string
state
required

open, signed, expired or superseded.

string
signatory_name
required
string
signatory_email
required
string
terms
required

What is signed: rulebook version and hash, roles, validity.

object
error

Why signing failed, if it did.

string | null
mail_error

Why the e-mail could not be sent, if it could not.

string | null
signer

The signer as the qualified certificate names them.

object | null
signer_matches

Whether the certificate’s name matches the signatory of the application.

boolean | null
expires_at
required
string format: date-time
sent_at
string | null format: date-time
signed_at
string | null format: date-time
created_at
required
string format: date-time
documents
required

The documents: kind, title, unsigned_sha256, signed_sha256, validation.

Array<object>
object

Example generated

{
  "id": "example",
  "state": "example",
  "signatory_name": "example",
  "signatory_email": "example",
  "terms": {},
  "error": "example",
  "mail_error": "example",
  "signer": "example",
  "signer_matches": true,
  "expires_at": "2026-04-15T12:00:00Z",
  "sent_at": "2026-04-15T12:00:00Z",
  "signed_at": "2026-04-15T12:00:00Z",
  "created_at": "2026-04-15T12:00:00Z",
  "documents": [
    {}
  ]
}

400

Section titled “400”

Not a valid e-mail address.

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

401

Section titled “401”

Not authenticated.

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

403

Section titled “403”

The caller lacks the role this operation needs; or a change with the session cookie came from a page of another site (cross_site_request, decisions #83).

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

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

429

Section titled “429”

Too many signing requests.

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