LegalDocuments

Get A Specific Legal Document

get
Path parameters
merchantNumberstring | nullableRequired

The identifier for the merchant for whom this legal document should be collected.

legalDocumentIdinteger · int32Required

The identifier for the legal document to return.

Responses
200
Returns a list of the legal documents that have been provided for a specific merchant.
get
GET /api/legaldocuments/v2/documents/{merchantNumber}/{legalDocumentId} HTTP/1.1
Host: 
Accept: */*
{
  "legalDocumentId": 1,
  "legalDocumentTypeName": "text",
  "content": [
    {
      "ipAddress": "text",
      "timestamp": "2025-07-09T02:40:48.657Z",
      "signatureSourceTypeId": 1,
      "signatureSectionTypeId": 1,
      "signerViewedLegalText": true,
      "businessContactId": 1,
      "documentId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "modifyDateTimeUtc": "2025-07-09T02:40:48.657Z"
}

Updates an existing legal document

put
Path parameters
merchantNumberstring | nullableRequired

The identifier for the merchant for whom this legal document should be collected.

legalDocumentIdinteger · int32Required

The legalDocumentId of the document to update.

Body
legalDocumentIdinteger · int32Optional

Identifies a specific legal document in the system. A new value will be generated by the backend and returned a legal document is initially created.

legalDocumentTypeNamestring | nullableOptional

A textual identifier for a legal document. This will be consistent across environments and can safely be used when programatically interacting with signatures. Potential values for this field can be retrieved by calling the settings endpoint.

modifyDateTimeUtcstring · date-time | nullableRead-onlyOptional
Responses
200
Returns a list of the legal documents that have been provided for a specific merchant.
put
PUT /api/legaldocuments/v2/documents/{merchantNumber}/{legalDocumentId} HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 280

{
  "legalDocumentId": 1,
  "legalDocumentTypeName": "text",
  "content": [
    {
      "ipAddress": "text",
      "timestamp": "2025-07-09T02:40:48.657Z",
      "signatureSourceTypeId": 1,
      "signatureSectionTypeId": 1,
      "signerViewedLegalText": true,
      "businessContactId": 1,
      "documentId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}
{
  "legalDocumentId": 1,
  "legalDocumentTypeName": "text",
  "content": [
    {
      "ipAddress": "text",
      "timestamp": "2025-07-09T02:40:48.657Z",
      "signatureSourceTypeId": 1,
      "signatureSectionTypeId": 1,
      "signerViewedLegalText": true,
      "businessContactId": 1,
      "documentId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "modifyDateTimeUtc": "2025-07-09T02:40:48.657Z"
}

Deletes a Legal Document

delete
Path parameters
merchantNumberstring | nullableRequired

The identifier for the merchant for whom this legal document should be collected.

legalDocumentIdinteger · int32Required

The identifier for the legal document to return.

Responses
200
Returns a list of the legal documents that have been provided for a specific merchant.
delete
DELETE /api/legaldocuments/v2/documents/{merchantNumber}/{legalDocumentId} HTTP/1.1
Host: 
Accept: */*
{
  "legalDocumentId": 1,
  "legalDocumentTypeName": "text",
  "content": [
    {
      "ipAddress": "text",
      "timestamp": "2025-07-09T02:40:48.657Z",
      "signatureSourceTypeId": 1,
      "signatureSectionTypeId": 1,
      "signerViewedLegalText": true,
      "businessContactId": 1,
      "documentId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "modifyDateTimeUtc": "2025-07-09T02:40:48.657Z"
}

Get All Legal Documents For A Merchant

get
Path parameters
merchantNumberstring | nullableRequired

The identifier for the merchant whose legal documents should be returned.

Responses
200
Returns a list of the legal documents that have been provided for a specific merchant.
get
GET /api/legaldocuments/v2/documents/{merchantNumber} HTTP/1.1
Host: 
Accept: */*
{
  "content": [
    {
      "legalDocumentId": 1,
      "legalDocumentTypeName": "text",
      "content": [
        {
          "ipAddress": "text",
          "timestamp": "2025-07-09T02:40:48.657Z",
          "signatureSourceTypeId": 1,
          "signatureSectionTypeId": 1,
          "signerViewedLegalText": true,
          "businessContactId": 1,
          "documentId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "modifyDateTimeUtc": "2025-07-09T02:40:48.657Z"
    }
  ]
}

Get Legal Document Settings

get
Responses
200
Returns information about all legal documents that can be collected through the API.
get
GET /api/legaldocuments/v2/documents/settings HTTP/1.1
Host: 
Accept: */*
{
  "content": [
    {
      "legalDocumentTypeName": "telesales-addendum",
      "legalDocumentTypeId": 2,
      "isUploadedAsPdf": true,
      "displayName": "Telesales Addendum",
      "isActive": true,
      "availableSignatures": [
        {
          "signatureSectionTypeId": 7,
          "signatureSectionTypeName": "TelesalesAddendum",
          "displayOrder": 1,
          "printSignatureBlock": [
            {
              "printBlockID": 1,
              "printBlockName": "principal-authorized-signer"
            }
          ],
          "termsAndConditionsTypes": [
            {
              "termsAndConditionsTypeID": 10,
              "termsAndConditionsTypeName": "telesales-addendum-terms",
              "description": "Terms and conditions for the telesales addendum to the merchant application."
            }
          ],
          "isRequiredToSubmitLegalDocument": true,
          "isRequiredToSubmitElectronicSignatures": false,
          "displayName": "Telesales Addendum Signature"
        }
      ]
    }
  ]
}

Get Legal Document Settings For A Specific Legal Document

get
Path parameters
legalDocumentTypeNamestring | nullableRequired
Responses
200
Returns information about a specific legal document.
get
GET /api/legaldocuments/v2/documents/settings/{legalDocumentTypeName} HTTP/1.1
Host: 
Accept: */*
{
  "legalDocumentTypeName": "telesales-addendum",
  "legalDocumentTypeId": 2,
  "isUploadedAsPdf": true,
  "displayName": "Telesales Addendum",
  "isActive": true,
  "availableSignatures": [
    {
      "signatureSectionTypeId": 7,
      "signatureSectionTypeName": "TelesalesAddendum",
      "displayOrder": 1,
      "printSignatureBlock": [
        {
          "printBlockID": 1,
          "printBlockName": "principal-authorized-signer"
        }
      ],
      "termsAndConditionsTypes": [
        {
          "termsAndConditionsTypeID": 10,
          "termsAndConditionsTypeName": "telesales-addendum-terms",
          "description": "Terms and conditions for the telesales addendum to the merchant application."
        }
      ],
      "isRequiredToSubmitLegalDocument": true,
      "isRequiredToSubmitElectronicSignatures": false,
      "displayName": "Telesales Addendum Signature"
    }
  ]
}

Creates a new legal document

post
Path parameters
merchantNumberstring | nullableRequired

The identifier for the merchant for whom this legal document should be collected.

Body
legalDocumentIdinteger · int32Optional
legalDocumentTypeNamestring | nullableOptional
modifyDateTimeUtcstring · date-time | nullableRead-onlyOptional
Responses
200
Returns a list of the legal documents that have been provided for a specific merchant.
post
POST /api/legaldocuments/v3/documents/{merchantNumber} HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 312

{
  "legalDocumentId": 1,
  "legalDocumentTypeName": "text",
  "content": [
    {
      "ipAddress": "text",
      "timestamp": "2025-07-09T02:40:48.657Z",
      "signatureSourceTypeId": 1,
      "signatureSectionTypeId": 1,
      "signerViewedLegalText": true,
      "businessContactId": 1,
      "documentId": "123e4567-e89b-12d3-a456-426614174000",
      "allowNullBusinessContact": true
    }
  ]
}
{
  "legalDocumentId": 1,
  "legalDocumentTypeName": "text",
  "content": [
    {
      "ipAddress": "text",
      "timestamp": "2025-07-09T02:40:48.657Z",
      "signatureSourceTypeId": 1,
      "signatureSectionTypeId": 1,
      "signerViewedLegalText": true,
      "businessContactId": 1,
      "documentId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "modifyDateTimeUtc": "2025-07-09T02:40:48.657Z"
}

Was this helpful?