Documents
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.
Merchant Number used to filter voided checks.
Returns a collection of voided checks successfully.
No Content
Bad Request: Returns when merchantNumber is null or empty.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/Documents/{merchantNumber}/VoidedChecks HTTP/1.1
Host:
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 check documents for the specified merchant.
The merchant's unique identification number.
Specifies the name of the file to upload.
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.
OK
Bad Request
Internal Server Error
POST /api/demographics/v1/Documents/{merchantNumber}/VoidedChecks?fileName=text&bankAccountId=text HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 10
"Ynl0ZXM="textUpload a voided check document for the specified merchant by passing the file content in Base64 format.
The merchant's unique identification number.
Specifies the name of the file to upload.
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.
OK
Bad Request
Internal Server Error
POST /api/demographics/v1/Documents/{merchantNumber}/VoidedChecks/Base64Format?fileName=text&bankAccountId=text HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 6
"text"textUpload 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).
The merchant's unique identification number.
Specifies the name of the file to upload.
Specifies the category of the document included in the uploaded file. Possible values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
The number of documents provided in this file
OK
Bad Request
Internal Server Error
POST /api/demographics/v1/Documents/{merchantNumber}/MultipleDocuments/Base64Format?fileName=text HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 6
"text"textUpload 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).
The merchant's unique identification number.
Specifies the name of the file to upload.
Specifies the category of the document included in the uploaded file. Possible values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
Specifies the total number of documents included in the uploaded file.
OK
Bad Request
Internal Server Error
POST /api/demographics/v1/Documents/{merchantNumber}/MultipleDocuments?fileName=text HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 10
"Ynl0ZXM="textUpload a document for the specified merchant by passing the file content in Base64 format.
The merchant's unique identification number.
Specifies the name of the file to upload.
Specifies the category of the document included in the uploaded file. Possible values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
OK
Not Found
POST /api/demographics/v1/Documents/{merchantNumber}/Base64Format?fileName=text&documentCategory=0 HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 6
"text"textRetrieve 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.
The merchant's unique identification number.
Specifies the document category for the documents included in the file. Possible values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
Returns a collection of documents successfully.
Bad Request: Returns when merchantNumber or documentCategory is null or empty or Invalid.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/Documents/{merchantNumber}?documentCategory=0 HTTP/1.1
Host:
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 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.
The merchant's unique identification number.
Specifies the name of the file to upload.
Specifies the category of the document included in the uploaded file. Possible values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
OK
Not Found
POST /api/demographics/v1/Documents/{merchantNumber}?fileName=text&documentCategory=0 HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 10
"Ynl0ZXM="textUpload a signed application for the specified merchant by providing the document content in Base64 format.
The merchant's unique identification number.
Specifies the name of the file to upload.
The signed application document as a Base64-encoded string (Optional).
SGVsbG8gV29ybGQ=OK
Bad Request
Internal Server Error
POST /api/demographics/v1/Documents/{merchantNumber}/SignedApplication/Base64Format?fileName=text HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 85
{
"mapping": [
{
"businessContactId": 1,
"documentType": "text"
}
],
"file": "SGVsbG8gV29ybGQ="
}textUpload a signed application document for the specified merchant.
The merchant's unique identification number.
Specifies the name of the file to upload.
OK
Bad Request
Internal Server Error
POST /api/demographics/v1/Documents/{merchantNumber}/SignedApplication?fileName=text HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"mapping": [
{
"businessContactId": 1,
"documentType": "text"
}
],
"file": "Ynl0ZXM="
}textRetrieve 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.
The merchant's unique identification number.
Returns a collection of documents successfully.
Bad Request: Returns when merchantNumber is null or empty.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/Documents/{merchantNumber}/List HTTP/1.1
Host:
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 a specific document for the specified merchant using its unique document ID.
The merchant's unique identification number.
The unique identifier of the document to retrieve. This value is returned when the document is initially uploaded.
OK
Not Found
GET /api/demographics/v1/Documents/{merchantNumber}/{documentId} HTTP/1.1
Host:
Accept: */*
binaryDelete a document associated with the specified merchant and document ID.
Note: The request requires proper authorization in accordance with the MID policy.
The merchant's unique identification number.
The unique identifier of the document to retrieve. This value is returned when the document is initially uploaded.
Document is deleted successfully.
No content
Bad Request: Returns when either the Merchant number or the Document ID provided is null or invalid.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Internal Server Error: This could be due to system errors. Please contact support for assistance
DELETE /api/demographics/v1/Documents/{merchantNumber}/{documentId} HTTP/1.1
Host:
Accept: */*
No content
Update the bank account number associated with a specific voided check for the specified merchant using documentID.
The merchant's unique identification number.
The unique identifier of the document for which the voided check is provided. This value is returned when creating, updating, or retrieving a document.
The unique identifier of the bank account.
OK
Not Found
POST /api/demographics/v1/Documents/{merchantNumber}/{documentId}/VoidedChecks?bankAccountId=text HTTP/1.1
Host:
Accept: */*
textDelete 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.
Specifies the unique identifier of the document to retrieve. This value is returned when the document is uploaded.
Indicates the account for which this voided check was provided. This value will be returned when creating, updating, or retrieving a bank account.
Document is deleted successfully.
No content
Bad Request: Returns when any of the input parameters like the Merchant number, DocumentId or the BankAccountID provided is null or invalid.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Internal Server Error: This could be due to system errors. Please contact support for assistance
DELETE /api/demographics/v1/Documents/{merchantNumber}/{documentId}/VoidedChecks?bankAccountId=text HTTP/1.1
Host:
Accept: */*
No content
Was this helpful?