LegalDocuments

Get a Specific Legal Document

get

Retrieve a specific legal document for the given merchant using the unique legal document ID.

Path parameters
merchantNumberstringRequired

The merchant's unique identification number.

legalDocumentIdinteger · int32Required

The unique identifier of the legal document.

Responses
chevron-right
200

Returns a list of the legal documents that have been provided for a specific merchant.

application/json
legalDocumentIdinteger · int32Optional

A unique ID of a specific legal document. A new value is generated by the backend when a document is initially created.

legalDocumentTypeNamestring · nullableOptional

A name or identifier for the legal document. Consistent across environment used when interacting with signatures. Potential values can be retrieved via the Get Legal Document Settings endpoint.

modifyDateTimeUtcstring · date-time · nullableRead-onlyOptional

UTC timestamp indicating when the legal document was last modified.

get
/api/legaldocuments/v2/documents/{merchantNumber}/{legalDocumentId}

Update a Specific Legal Document

put

Update an existing legal document for the specified merchant using the unique legal document ID.

Path parameters
merchantNumberstringRequired

The merchant's unique identification number.

legalDocumentIdinteger · int32Required

The unique identifier of the legal document.

Body
legalDocumentIdinteger · int32Optional

A unique ID of a specific legal document. A new value is generated by the backend when a document is initially created.

legalDocumentTypeNamestring · nullableOptional

A name or identifier for the legal document. Consistent across environment used when interacting with signatures. Potential values can be retrieved via the Get Legal Document Settings endpoint.

modifyDateTimeUtcstring · date-time · nullableRead-onlyOptional

UTC timestamp indicating when the legal document was last modified.

Responses
chevron-right
200

Returns a list of the legal documents that have been provided for a specific merchant.

application/json
legalDocumentIdinteger · int32Optional

A unique ID of a specific legal document. A new value is generated by the backend when a document is initially created.

legalDocumentTypeNamestring · nullableOptional

A name or identifier for the legal document. Consistent across environment used when interacting with signatures. Potential values can be retrieved via the Get Legal Document Settings endpoint.

modifyDateTimeUtcstring · date-time · nullableRead-onlyOptional

UTC timestamp indicating when the legal document was last modified.

put
/api/legaldocuments/v2/documents/{merchantNumber}/{legalDocumentId}

Delete a Legal Document

delete

Deletes the specified legal document for the specified merchant.

Path parameters
merchantNumberstringRequired

The merchant's unique identification number.

legalDocumentIdinteger · int32Required

A unique identifier of the legal document.

Responses
chevron-right
200

Returns a list of the legal documents that have been provided for a specific merchant.

application/json
legalDocumentIdinteger · int32Optional

A unique ID of a specific legal document. A new value is generated by the backend when a document is initially created.

legalDocumentTypeNamestring · nullableOptional

A name or identifier for the legal document. Consistent across environment used when interacting with signatures. Potential values can be retrieved via the Get Legal Document Settings endpoint.

modifyDateTimeUtcstring · date-time · nullableRead-onlyOptional

UTC timestamp indicating when the legal document was last modified.

delete
/api/legaldocuments/v2/documents/{merchantNumber}/{legalDocumentId}

Get All Legal Documents

get

Retrieve all legal documents associated with the specified merchant.

Path parameters
merchantNumberstringRequired

The merchant's unique identification number.

Responses
chevron-right
200

Returns a list of the legal documents that have been provided for a specific merchant.

application/json
get
/api/legaldocuments/v2/documents/{merchantNumber}

Get Legal Document Settings

get

Retrieve the settings and configuration for legal documents.

Responses
chevron-right
200

Returns information about all legal documents that can be collected through the API.

application/json
get
/api/legaldocuments/v2/documents/settings

Get Legal Document Settings for a Specific Legal Document

get

Retrieve the settings and configuration for a specific legal document.

Path parameters
legalDocumentTypeNamestringRequired

Name of the legal document type used to retrieve its configuration settings.

Responses
chevron-right
200

Returns information about a specific legal document.

application/json
legalDocumentTypeNamestring · nullableOptional

A textual identifier or name of the legal document. Consistent across environments and safe for programmatic use to interact with signatures.

legalDocumentTypeIdinteger · int32Optional

A numeric identifier for a legal document. May differ between environments and should not be used programmatically.

isUploadedAsPdfbooleanOptional

Indicates whether this legal document type will trigger the creation of a PDF in the system (internal use only).

displayNamestring · nullableOptional

A user-friendly name for the legal document type.

isActivebooleanOptional

Indicates whether this legal document type is active in the system and can be used. Sending in an inactive legal document will result an error.

get
/api/legaldocuments/v2/documents/settings/{legalDocumentTypeName}

Create a New Legal Document

post

Create a new legal document for the specified merchant.

Path parameters
merchantNumberstringRequired

The merchant's unique identification number.

Body
legalDocumentIdinteger · int32Optional

A unique ID of a specific legal document. A new value is generated by the backend when a document is initially created.

legalDocumentTypeNamestring · nullableOptional

A name or identifier for the legal document. Consistent across environment used when interacting with signatures.

Potential values can be retrieved via the Get Legal Document Settings endpoint.

modifyDateTimeUtcstring · date-time · nullableRead-onlyOptional

UTC timestamp indicating when the legal document was last modified.

Responses
chevron-right
200

Returns a list of the legal documents that have been provided for a specific merchant.

application/json
legalDocumentIdinteger · int32Optional

A unique ID of a specific legal document. A new value is generated by the backend when a document is initially created.

legalDocumentTypeNamestring · nullableOptional

A name or identifier for the legal document. Consistent across environment used when interacting with signatures. Potential values can be retrieved via the Get Legal Document Settings endpoint.

modifyDateTimeUtcstring · date-time · nullableRead-onlyOptional

UTC timestamp indicating when the legal document was last modified.

post
/api/legaldocuments/v3/documents/{merchantNumber}

Last updated

Was this helpful?