Create an automatic signature

post

https://{base_url}/v2/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

friendly_name

string

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_id

string

required

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

sender_id

string

required

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

receiver_id

string

required

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

template_id

string

required

Signature template identifier.

string

required

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

phone

string

required

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

first_name

string

required

Receiver's first name.

last_name

string

required

Receiver's last name.

document

file

required

the document to sign.

fiscal_code

string

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

email_cc

string

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

Responses

202

provider_id for downloading the signed document when completed.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

422Unprocessable Content