Documents

Retrieves a list of voided checks

get

This endpoint uses the eDoc service to retrieve details of all documents in the voided check category for a specified merchant number. The response provides information such as the Document ID, file name, description, and category details.

Path parameters

merchantNumberstringRequired

Merchant Number used to filter voided checks.

Responses

200

Returns a collection of voided checks successfully.

application/json

204

No Content

400

Bad Request: Returns when merchantNumber is null or empty.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

get

/api/demographics/v1/Documents/{merchantNumber}/VoidedChecks

HTTPcURLJavaScriptPython

GET /api/demographics/v1/Documents/{merchantNumber}/VoidedChecks HTTP/1.1
Accept: */*

{
  "content": [
    {
      "category": 1,
      "categoryDescription": "Voided Check",
      "description": "VoidedCheck",
      "documentId": "2f934e9e-ac8c-48e6-b1ec-77baa3e5c247",
      "fileName": "test",
      "merchantNumber": "345685697696",
      "metaData": [
        {
          "metadataKey": "dateuploaded",
          "metadataValue": "01/16/2025 14:25:52"
        }
      ],
      "fileExtension": ".png",
      "dateUploaded": "2025-01-16T14:32:25.3992399Z"
    }
  ]
}

Upload Voided Checks

post

Upload voided check documents for the specified merchant.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

fileNamestringRequired

Specifies the name of the file to upload.

bankAccountIdstringRequired

The unique identifier of the bank account for which the voided check is provided. This value is returned when creating, updating, or retrieving a bank account.

Body

application/json

string · byteOptional

Responses

200

OK

application/json

Responsestring

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/VoidedChecks

HTTPcURLJavaScriptPython

POST /api/demographics/v1/Documents/{merchantNumber}/VoidedChecks?fileName=text&bankAccountId=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 10

"Ynl0ZXM="

text

Upload Voided Check (Base64 Format)

post

Upload a voided check document for the specified merchant by passing the file content in Base64 format.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

fileNamestringRequired

Specifies the name of the file to upload.

bankAccountIdstringRequired

The unique identifier of the bank account for which the voided check is provided. This value is returned when creating, updating, or retrieving a bank account.

Body

application/json

stringOptional

Responses

200

OK

application/json

Responsestring

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/VoidedChecks/Base64Format

HTTPcURLJavaScriptPython

POST /api/demographics/v1/Documents/{merchantNumber}/VoidedChecks/Base64Format?fileName=text&bankAccountId=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

text

Upload Multiple Documents (Base64 Format)

post

Upload a single file containing multiple documents of the same type for the specified merchant in Base64 Format.

Note: Only one Base64 string can be included per request.

For multiple documents of the same type, the request supports attaching metadata to specify the number of documents included (for example, a PDF with several months of statements).

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

fileNamestringRequired

Specifies the name of the file to upload.

documentCategoryinteger · enumOptional

Specifies the category of the document included in the uploaded file.

Possible values:

countinteger · int32Optional

The number of documents provided in this file

Body

application/json

stringOptional

Responses

200

OK

application/json

Responsestring

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/MultipleDocuments/Base64Format

HTTPcURLJavaScriptPython

POST /api/demographics/v1/Documents/{merchantNumber}/MultipleDocuments/Base64Format?fileName=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

text

Upload Multiple Documents

post

Upload a single file containing multiple documents of the same type for the specified merchant.

Note: If the file contains multiple documents of the same type, you can attach metadata to indicate the number of documents included (for example, a PDF with several months of statements).

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

fileNamestringRequired

Specifies the name of the file to upload.

documentCategoryinteger · enumOptional

Specifies the category of the document included in the uploaded file.

Possible values:

countinteger · int32Optional

Specifies the total number of documents included in the uploaded file.

Body

application/json

string · byteOptional

Responses

200

OK

application/json

Responsestring

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/MultipleDocuments

HTTPcURLJavaScriptPython

POST /api/demographics/v1/Documents/{merchantNumber}/MultipleDocuments?fileName=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 10

"Ynl0ZXM="

text

Upload Document (Base64 Format)

post

Upload a document for the specified merchant by passing the file content in Base64 format.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

fileNamestringRequired

Specifies the name of the file to upload.

documentCategoryinteger · enumRequired

Specifies the category of the document included in the uploaded file.

Possible values:

Body

application/json

stringOptional

Responses

200

OK

application/json

Responsestring

404

Not Found

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/Base64Format

HTTPcURLJavaScriptPython

POST /api/demographics/v1/Documents/{merchantNumber}/Base64Format?fileName=text&documentCategory=0 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

text

Get Documents by Category

get

Retrieve documents for the specified merchant filtered by document category.

Note: The category is validated against a predefined whitelist, and only valid categories (for example, Financial = 1, IRS = 2) are processed.

If the provided category is not in the allowed list, the system returns an error and the request is not processed.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

documentCategoryinteger · enumRequired

Specifies the document category for the documents included in the file.

Possible values:

Responses

200

Returns a collection of documents successfully.

application/json

400

Bad Request: Returns when merchantNumber or documentCategory is null or empty or Invalid.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

get

/api/demographics/v1/Documents/{merchantNumber}

HTTPcURLJavaScriptPython

GET /api/demographics/v1/Documents/{merchantNumber}?documentCategory=0 HTTP/1.1
Accept: */*

{
  "content": [
    {
      "category": 1,
      "categoryDescription": "Voided Check",
      "description": "VoidedCheck",
      "documentId": "2f934e9e-ac8c-48e6-b1ec-77baa3e5c247",
      "fileName": "test",
      "merchantNumber": "345685697696",
      "metaData": [
        {
          "metadataKey": "dateuploaded",
          "metadataValue": "01/16/2025 14:25:52"
        }
      ],
      "fileExtension": ".png",
      "dateUploaded": "2025-01-16T14:32:25.3992399Z"
    }
  ]
}

Upload Document

post

Upload a document for the specified merchant using a standard file upload.

Note: The file must be provided as a single byte array.

Metadata can be attached in the request to indicate additional information such as document category or number of documents.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

fileNamestringRequired

Specifies the name of the file to upload.

documentCategoryinteger · enumRequired

Specifies the category of the document included in the uploaded file.

Possible values:

Body

application/json

string · byteOptional

Responses

200

OK

application/json

Responsestring

404

Not Found

application/json

post

/api/demographics/v1/Documents/{merchantNumber}

HTTPcURLJavaScriptPython

POST /api/demographics/v1/Documents/{merchantNumber}?fileName=text&documentCategory=0 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 10

"Ynl0ZXM="

text

Upload Signed Application (Base64 Format)

post

Upload a signed application for the specified merchant by providing the document content in Base64 format.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

fileNamestringRequired

Specifies the name of the file to upload.

Body

application/json

filestring · nullableOptional

The signed application document as a Base64-encoded string (Optional).

Example: SGVsbG8gV29ybGQ=

Responses

200

OK

application/json

Responsestring

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/SignedApplication/Base64Format

HTTPcURLJavaScriptPython

POST /api/demographics/v1/Documents/{merchantNumber}/SignedApplication/Base64Format?fileName=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "mapping": [
    {
      "businessContactId": 1,
      "documentType": "text"
    }
  ],
  "file": "SGVsbG8gV29ybGQ="
}

text

Upload Signed Application

post

Upload a signed application document for the specified merchant.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

fileNamestringRequired

Specifies the name of the file to upload.

Body

application/json

filestring · byte · nullableOptional

Responses

200

OK

application/json

Responsestring

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/SignedApplication

HTTPcURLJavaScriptPython

POST /api/demographics/v1/Documents/{merchantNumber}/SignedApplication?fileName=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "mapping": [
    {
      "businessContactId": 1,
      "documentType": "text"
    }
  ],
  "file": "Ynl0ZXM="
}

text

Get a List of Documents

get

Retrieve a list of all documents for the specified merchant.

Note: The documents are grouped by category, and the response provides detailed information for each document.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Responses

200

Returns a collection of documents successfully.

application/json

400

Bad Request: Returns when merchantNumber is null or empty.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

get

/api/demographics/v1/Documents/{merchantNumber}/List

HTTPcURLJavaScriptPython

GET /api/demographics/v1/Documents/{merchantNumber}/List HTTP/1.1
Accept: */*

{
  "content": [
    {
      "category": 1,
      "categoryDescription": "Voided Check",
      "description": "VoidedCheck",
      "documentId": "2f934e9e-ac8c-48e6-b1ec-77baa3e5c247",
      "fileName": "test",
      "merchantNumber": "345685697696",
      "metaData": [
        {
          "metadataKey": "dateuploaded",
          "metadataValue": "01/16/2025 14:25:52"
        }
      ],
      "fileExtension": ".png",
      "dateUploaded": "2025-01-16T14:32:25.3992399Z"
    }
  ]
}

Retrieve Document by Document ID

get

Retrieve a specific document for the specified merchant using its unique document ID.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

documentIdstring · uuidRequired

The unique identifier of the document to retrieve. This value is returned when the document is initially uploaded.

Responses

200

OK

application/json

Responsestring · binary

404

Not Found

application/json

get

/api/demographics/v1/Documents/{merchantNumber}/{documentId}

HTTPcURLJavaScriptPython

GET /api/demographics/v1/Documents/{merchantNumber}/{documentId} HTTP/1.1
Accept: */*

binary

Delete a Document for a Merchant

delete

Delete a document associated with the specified merchant and document ID.

Note: The request requires proper authorization in accordance with the MID policy.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

documentIdstring · uuidRequired

The unique identifier of the document to retrieve. This value is returned when the document is initially uploaded.

Responses

200

Document is deleted successfully.

No content

400

Bad Request: Returns when either the Merchant number or the Document ID provided is null or invalid.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

delete

/api/demographics/v1/Documents/{merchantNumber}/{documentId}

HTTPcURLJavaScriptPython

DELETE /api/demographics/v1/Documents/{merchantNumber}/{documentId} HTTP/1.1
Accept: */*

No content

Update Voided Check Bank Account Number

post

Update the bank account number associated with a specific voided check for the specified merchant using documentID.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

documentIdstring · uuidRequired

The unique identifier of the document for which the voided check is provided. This value is returned when creating, updating, or retrieving a document.

Query parameters

bankAccountIdstringRequired

The unique identifier of the bank account.

Responses

200

OK

application/json

Responsestring

404

Not Found

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/{documentId}/VoidedChecks

HTTPcURLJavaScriptPython

POST /api/demographics/v1/Documents/{merchantNumber}/{documentId}/VoidedChecks?bankAccountId=text HTTP/1.1
Accept: */*

text

Delete a Voided Check

delete

Delete a voided check document for the specified merchant from the document storage associated with a given bank account.

Note: Once the document is deleted, the corresponding bank account record is also updated to remove the reference to the deleted voided check.

Require proper authorization in accordance with the MID policy.

Path parameters

documentIdstring · uuidRequired

Specifies the unique identifier of the document to retrieve. This value is returned when the document is uploaded.

merchantNumberstringRequired

Query parameters

bankAccountIdstringRequired

Indicates the account for which this voided check was provided. This value will be returned when creating, updating, or retrieving a bank account.

Responses

200

Document is deleted successfully.

No content

400

Bad Request: Returns when any of the input parameters like the Merchant number, DocumentId or the BankAccountID provided is null or invalid.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

delete

/api/demographics/v1/Documents/{merchantNumber}/{documentId}/VoidedChecks

HTTPcURLJavaScriptPython

DELETE /api/demographics/v1/Documents/{merchantNumber}/{documentId}/VoidedChecks?bankAccountId=text HTTP/1.1
Accept: */*

No content