KAkaleyra
Signature

Create an automatic signature

In an active call, an operator can create a signature document using this endpoint that will fill the information and send a notification to the client to sign the document. After that, the operator can download the signed document. A webhook event on_signature_enveloped_inserted is sent after a signature is created.

post/v2/signature

Request

  • Base URL
    https://api.sandbox.eu.bandyer.com
  • URL
    https://api.sandbox.eu.bandyer.com/v2/signature
  • Auth
    API key in header apikey

Request body multipart/form-data

friendly_namestring required

Envelope name. This is a string which describes the name of the document to be signed. This name will be seen by the sender in the status window and by the receiver in the signing request.

room_idstring required

Room Id of the active room in which to issue a signing request.

sender_idstring required

Operator's user id. The operator must be a plus user with signing feature enabled.

receiver_idstring required

Client's user id. The client is generally a basic user.

template_idstring required

Signature template identifier.

emailstring required

Receiver's email where to receive a copy of the signed document.

phonestring required

Receiver's phone number. It must match the following regex /^(\+|00)[0-9]{6,20}$/

first_namestring required

Receiver's first name.

last_namestring required

Receiver's last name.

documentstring binary required

the document to sign.

fiscal_codestring

Fiscal or VAT code of the receiver. Requirement depends on local fiscal laws.

email_ccstring

CSV delimited string of the additional emails on which to receive notifications about the signing process. Currently supported only by GoSign provider.

Response

provider_id for downloading the signed document when completed.

Changes

No recorded changes to this operation across all 1 revision of this API.