Batch creation of signing participants for a signing process.

POST /api/v1/participants/batch

Sample request:

POST /api/v1/participants/batch Header: externalId Request Body: [ { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "SigningId": "5c192f97-41e4-ed11-8e8b-00224827d18c", "FirstName": "John", "MiddleName": "D", "LastName": "Doe", "Email": "john.doe@example.com", "ParticipantRole": "Buyer", "CustomSignature": "JD_Signature", "CustomInitials": "JD", "SigningPin": "123456", "Type": 0, "DisplayOrder": 1, "SignerGroup": 1, "CustomInvitationSubject": "Invitation to Sign", "CustomInvitationMessage": "Please review and sign the document.", "ExternalId": "External12345", "TransactionId": "3fb95f64-5717-4562-b3fc-2c963f66bfa7", "Language": "en", "StaticSignatureEnabled": true, "ScriptedSignatureEnabled": true, "ImageSignatureEnabled": true, "TrestleRole": "Role1" } ]

Headers

externalId string(uuid)

External identifier provided in the header.

Body

List of participant data transfer objects to be created.

id string(uuid)
signingId string(uuid)
firstName string Required

Minimum length is 1.
middleName string | null
lastName string Required

Minimum length is 1.
email string | null
participantRole string | null
customSignature string | null
customInitials string | null
signingPin string | null
type integer(int32) Required
displayOrder integer(int32)
signerGroup integer(int32)
customInvitationSubject string | null
customInvitationMessage string | null
externalId string | null
transactionId string(uuid) | null
language string | null
staticSignatureEnabled boolean | null
scriptedSignatureEnabled boolean | null
imageSignatureEnabled boolean | null
trestleRole string | null
crmId integer(int32) | null

Body

List of participant data transfer objects to be created.

id string(uuid)
signingId string(uuid)
firstName string Required

Minimum length is 1.
middleName string | null
lastName string Required

Minimum length is 1.
email string | null
participantRole string | null
customSignature string | null
customInitials string | null
signingPin string | null
type integer(int32) Required
displayOrder integer(int32)
signerGroup integer(int32)
customInvitationSubject string | null
customInvitationMessage string | null
externalId string | null
transactionId string(uuid) | null
language string | null
staticSignatureEnabled boolean | null
scriptedSignatureEnabled boolean | null
imageSignatureEnabled boolean | null
trestleRole string | null
crmId integer(int32) | null

Body

List of participant data transfer objects to be created.

id string(uuid)
signingId string(uuid)
firstName string Required

Minimum length is 1.
middleName string | null
lastName string Required

Minimum length is 1.
email string | null
participantRole string | null
customSignature string | null
customInitials string | null
signingPin string | null
type integer(int32) Required
displayOrder integer(int32)
signerGroup integer(int32)
customInvitationSubject string | null
customInvitationMessage string | null
externalId string | null
transactionId string(uuid) | null
language string | null
staticSignatureEnabled boolean | null
scriptedSignatureEnabled boolean | null
imageSignatureEnabled boolean | null
trestleRole string | null
crmId integer(int32) | null

Responses

200

Success
400

text/plain

text/plain application/json text/json

Bad Request
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
401

text/plain

text/plain application/json text/json

Unauthorized
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
default

text/plain

text/plain application/json text/json

Error
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null

POST /api/v1/participants/batch

curl \
 --request POST 'https://api.lwolf.com/authentisign/api/v1/participants/batch' \
 --header "Content-Type: application/json" \
 --header "externalId: string" \
 --data '[{"id":"string","signingId":"string","firstName":"string","middleName":"string","lastName":"string","email":"string","participantRole":"string","customSignature":"string","customInitials":"string","signingPin":"string","type":42,"displayOrder":42,"signerGroup":42,"customInvitationSubject":"string","customInvitationMessage":"string","externalId":"string","transactionId":"string","language":"string","staticSignatureEnabled":true,"scriptedSignatureEnabled":true,"imageSignatureEnabled":true,"trestleRole":"string","crmId":42}]'

curl \
 --request POST 'https://api.lwolf.com/authentisign/api/v1/participants/batch' \
 --header "Content-Type: text/json" \
 --header "externalId: string"

curl \
 --request POST 'https://api.lwolf.com/authentisign/api/v1/participants/batch' \
 --header "Content-Type: application/*+json" \
 --header "externalId: string"

Request examples

# Headers
externalId: string

# Payload
[
  {
    "id": "string",
    "signingId": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "email": "string",
    "participantRole": "string",
    "customSignature": "string",
    "customInitials": "string",
    "signingPin": "string",
    "type": 42,
    "displayOrder": 42,
    "signerGroup": 42,
    "customInvitationSubject": "string",
    "customInvitationMessage": "string",
    "externalId": "string",
    "transactionId": "string",
    "language": "string",
    "staticSignatureEnabled": true,
    "scriptedSignatureEnabled": true,
    "imageSignatureEnabled": true,
    "trestleRole": "string",
    "crmId": 42
  }
]

Request examples

# Headers
externalId: string

# Payload
[
  {
    "id": "string",
    "signingId": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "email": "string",
    "participantRole": "string",
    "customSignature": "string",
    "customInitials": "string",
    "signingPin": "string",
    "type": 42,
    "displayOrder": 42,
    "signerGroup": 42,
    "customInvitationSubject": "string",
    "customInvitationMessage": "string",
    "externalId": "string",
    "transactionId": "string",
    "language": "string",
    "staticSignatureEnabled": true,
    "scriptedSignatureEnabled": true,
    "imageSignatureEnabled": true,
    "trestleRole": "string",
    "crmId": 42
  }
]

Request examples

# Headers
externalId: string

# Payload
[
  {
    "id": "string",
    "signingId": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "email": "string",
    "participantRole": "string",
    "customSignature": "string",
    "customInitials": "string",
    "signingPin": "string",
    "type": 42,
    "displayOrder": 42,
    "signerGroup": 42,
    "customInvitationSubject": "string",
    "customInvitationMessage": "string",
    "externalId": "string",
    "transactionId": "string",
    "language": "string",
    "staticSignatureEnabled": true,
    "scriptedSignatureEnabled": true,
    "imageSignatureEnabled": true,
    "trestleRole": "string",
    "crmId": 42
  }
]

Response examples (400)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (400)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (401)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (401)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (default)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (default)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}