API Reference

/documents/ofp

post
https://api-v2.insuresign.io/documents/ofp
Form Data

Multipart payload for document creation: one or more files plus the document configuration.

string
enum

Action to be taken at the conclusion of the create process.

Allowed:
boolean

Whether to allow typed signatures on this specific document. This will override group setting. By default value is the same as group setting.

callback
object

Webhook event subscription configuration.

cc
array of objects
length between 0 and 2147483647

List of participants who should receive a carbon copy of the finalized document.

cc
string

Custom logo URL.

boolean
fields
array of objects

List of signature fields to be added to the document.

fields
file
array of files
required

Files to be used to create the Document.

string
enum
string
required

Message from the sender intended for the participants.

string
required

Name for the document.

participants
array of objects
required
length between 1 and 2147483647

List of participants who will sign the document.

participants*
string
enum
Allowed:
string
string
string
boolean
boolean
string

Password to protect the document.

string

URL to redirect the signers upon completion.

string
enum

The reminder interval to be set on the document.

Allowed:
boolean

Whether to suppress emails for this document.

templates
array of objects

List of templates containing participants and fields.

templates
boolean

Indicates if the document contains text tags.

Headers
string
enum
Defaults to application/x-www-form-urlencoded

Generated from available request content types

Allowed:
Response

Updated 15 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.hal+json

Updated 15 days ago