Link a transaction to a signing session. This endpoint associates a transaction with a signing session based on the provided ID.

POST /api/v1/signings/{signingId}/link-transaction

Sample request:

POST /signings/{signingId}/link-transaction

Request Body:

{
    "TransactionId": "example-transaction-id",
    "Documents": [
        {
            "Id": "example-document-id-1",
            "BFMDocumentId": "BFMDoc-001"
        },
        {
            "Id": "example-document-id-2",
            "BFMDocumentId": "BFMDoc-002"
        }
        // ... add more documents as required
    ]
}

Path parameters

  • signingId string(uuid) Required

    The identifier of the signing session.

Query parameters

  • TransactionId

    Get or Set the unique identifier of the transaction.

  • Documents

    Get or Set the list of documents associated with the transaction.

Body

The data required to link the transaction.

  • transactionId string(uuid)
  • documents array[object] | null
    Hide documents attributes Show documents attributes object
    • id string(uuid)
    • bfmDocumentId string | null

Body

The data required to link the transaction.

  • transactionId string(uuid)
  • documents array[object] | null
    Hide documents attributes Show documents attributes object
    • id string(uuid)
    • bfmDocumentId string | null

Body

The data required to link the transaction.

  • transactionId string(uuid)
  • documents array[object] | null
    Hide documents attributes Show documents attributes object
    • id string(uuid)
    • bfmDocumentId string | null

Responses

  • 200

    Success

  • default

    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 /api/v1/signings/{signingId}/link-transaction 
curl \
 --request POST 'https://api.lwolf.com/authentisign/api/v1/signings/{signingId}/link-transaction' \
 --header "Content-Type: application/json" \
 --data '{"transactionId":"string","documents":[{"id":"string","bfmDocumentId":"string"}]}'
curl \
 --request POST 'https://api.lwolf.com/authentisign/api/v1/signings/{signingId}/link-transaction' \
 --header "Content-Type: text/json"
curl \
 --request POST 'https://api.lwolf.com/authentisign/api/v1/signings/{signingId}/link-transaction' \
 --header "Content-Type: application/*+json"
Request examples 
{
  "transactionId": "string",
  "documents": [
    {
      "id": "string",
      "bfmDocumentId": "string"
    }
  ]
}
Request examples 
{
  "transactionId": "string",
  "documents": [
    {
      "id": "string",
      "bfmDocumentId": "string"
    }
  ]
}
Request examples 
{
  "transactionId": "string",
  "documents": [
    {
      "id": "string",
      "bfmDocumentId": "string"
    }
  ]
}
Response examples (default) 
{
  "code": 42,
  "message": "string",
  "details": [
    "string"
  ]
}
Response examples (default) 
{
  "code": 42,
  "message": "string",
  "details": [
    "string"
  ]
}