Create a signing. This endpoint allows for the creation of a new signing, including the ability to add a webhook callback URL.

POST /users/{userId}/signings

Sample request:

POST v3/users/{userId}/signings

Request Body:

{
    "Id": "example-guid-1",
    "Name": "Test Layout",
    "AccountId": "example-guid-2",
    "StatusId": 1,
    "IsOrdered": false,
    "DateCreated": "2023-04-20T02:59:00Z",
    "LastModified": "2023-04-21T02:59:00Z",
    "ExpirationDate": "2023-04-26T02:59:00Z",
    "IdPosition": 1,
    "ReminderDay": 5,
    "ReminderHour": 2,
    "TransactionId": "example-guid-3",
    "TechnologyProvider": "TechProviderName",
    "CallbackUrl": "https://yourcallbackurl.com",
    "Files": ["File1", "File2"],
    "FilesWithStrikeoutsDisabled": ["FileName1", "FileName2"]
}

Note: Replace "example-guid-1", "example-guid-2", etc., with actual GUID values and "File1", "File2" with your file objects.

Path parameters

  • userId string(uuid) Required

    The external identifier associated with the signing.

Query parameters

  • api-version string Required

    The requested API version

    Default value is 3.0.

multipart/form-data

Body

  • Files array[string(binary)]
  • FilesWithStrikeoutsDisabled array[string]
  • Fields object
    Hide Fields attribute Show Fields attribute object
    • * string Additional properties
  • Participants array[object] Required
    Hide Participants attributes Show Participants attributes object
    • 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
  • Id string(uuid)
  • Name string Required
  • AccountId string(uuid)
  • StatusId integer(int32)
  • IsOrdered boolean
  • DateCreated string(date-time)
  • LastModified string(date-time)
  • ExpirationDate string(date-time)
  • IdPosition integer(int32)
  • ReminderDay integer(int32)
  • ReminderHour integer(int32)
  • TransactionId string(uuid)
  • TechnologyProvider string
  • CallbackUrl string
  • LayoutId string(uuid)
  • ApplyLayout boolean

Responses

  • 200

    Success

  • Error

    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string | null
    • details array[string] | null
    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string | null
    • details array[string] | null
    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string | null
    • details array[string] | null
POST /users/{userId}/signings
curl \
 --request POST 'https://api.lwolf.com/authentisign/users/{userId}/signings?api-version=3.0' \
 --header "Content-Type: multipart/form-data" \
 --form "Files[]=@file" \
 --form "FilesWithStrikeoutsDisabled[]=string" \
 --form 'Fields={"additionalProperty1":"string","additionalProperty2":"string"}' \
 --form "Participants[]={"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}" \
 --form "Id=string" \
 --form "Name=string" \
 --form "AccountId=string" \
 --form "StatusId=42" \
 --form "IsOrdered=true" \
 --form "DateCreated=2026-05-04T09:42:00Z" \
 --form "LastModified=2026-05-04T09:42:00Z" \
 --form "ExpirationDate=2026-05-04T09:42:00Z" \
 --form "IdPosition=42" \
 --form "ReminderDay=42" \
 --form "ReminderHour=42" \
 --form "TransactionId=string" \
 --form "TechnologyProvider=string" \
 --form "CallbackUrl=string" \
 --form "LayoutId=string" \
 --form "ApplyLayout=true"
Response examples (default)
{
  "code": 42,
  "message": "string",
  "details": [
    "string"
  ]
}
Response examples (default)
{
  "code": 42,
  "message": "string",
  "details": [
    "string"
  ]
}