Skip to main content
PUT
Set quote signers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
signers
object[]
required

Signature circuit of the quote, replaced as a whole.

Signers sign step by step, in ascending step_order. Signers sharing a step sign in parallel, and the next step opens once all of them have signed. The circuit needs at least one external signer, and a countersigner must sign after the first external step.

Signers who already signed cannot be removed or moved. Once the quote is out for signature at an electronic signature provider, the circuit can no longer be changed.

Maximum array length: 50

Response

id
string
required

Quote signer ID.

Example:

"quor_4XyQhGd8P3CYaX"

kind
enum<string>
required

Signer kind.

  • external: A signer on the customer side.
  • countersigner: A signer on your side, who signs after the customer.
Available options:
external,
countersigner
Example:

"external"

step_order
integer
required

Position of the signer in the signature circuit, starting at 1. Signers with the same step order sign in parallel.

Example:

1

user_id
string | null
required

ID of the Hyperline user acting as the countersigner. Only allowed on a countersigner; their email and name are then taken from the user.

Example:

null

email
string<email>
required

Email address of the signer.

Example:

"jane@customer.com"

first_name
string | null
required

First name of the signer. Required by electronic signature providers.

Example:

"Jane"

last_name
string | null
required

Last name of the signer. Required by electronic signature providers.

Example:

"Doe"

language
enum<string> | null
required

Language of the emails and signature page sent to the signer. Defaults to the customer language.

Available options:
fr,
en,
de,
it,
lt,
nl,
es,
pt,
pl
Example:

"en"

status
enum<string>
required

Signer status.

  • pending: Not notified yet.
  • notified: The signer received the quote by email.
  • viewed: The signer opened the quote.
  • signed: The signer signed the quote.
  • declined: The signer declined the quote.
Available options:
pending,
notified,
viewed,
signed,
declined
Example:

"notified"

notified_at
string<date-time> | null
required

Date the signer was last notified. UTC date time string in the ISO 8601 format.

Example:

"2024-04-24T09:12:00.000Z"

viewed_at
string<date-time> | null
required

Date the signer first opened the quote. UTC date time string in the ISO 8601 format.

Example:

null

signed_at
string<date-time> | null
required

Date the signer signed the quote. UTC date time string in the ISO 8601 format.

Example:

null

declined_at
string<date-time> | null
required

Date the signer declined the quote. UTC date time string in the ISO 8601 format.

Example:

null

decline_reason
string | null
required

Reason given by the signer when declining the quote.

Example:

null

created_at
string<date-time>
required

Signer creation date. UTC date time string in the ISO 8601 format.

Example:

"2024-04-24T09:10:00.220Z"

updated_at
string<date-time>
required

Signer last update date. UTC date time string in the ISO 8601 format.

Example:

"2024-04-24T09:12:00.000Z"