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.
Correlation Id for the request
GET /api/demographics/v1/Documents/{merchantNumber}/VoidedChecks HTTP/1.1
Host: localhost:5000
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"
}
]
}The name of the file to upload.
The bankAccountId of the account for which the voided check is being provided. This value will be returned when creating, updating, or retreiving a bank account.
Correlation Id for the request
POST /api/demographics/v1/Documents/{merchantNumber}/VoidedChecks HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 10
"Ynl0ZXM="textThe name of the file to upload.
The bankAccountId of the account for which the voided check is being provided. This value will be returned when creating, updating, or retreiving a bank account.
Correlation Id for the request
POST /api/demographics/v1/Documents/{merchantNumber}/VoidedChecks/Base64Format HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 6
"text"textUpload Document with count. Used if you have a single file that contains multiple documents of the same type.
This allows you to attach metadata indicating that the number of files of that type which are included.
An example would be a PDF containing statements multiple months worth of statements.
The name of the file to upload.
The document category of the documents in the provided file.
The number of documents provided in this file
Correlation Id for the request
POST /api/demographics/v1/Documents/{merchantNumber}/MultipleDocuments/Base64Format HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 6
"text"textUpload Document with count. Used if you have a single file that contains multiple documents of the same type.
This allows you to attach metadata indicating that the number of files of that type which are included.
An example would be a PDF containing statements multiple months worth of statements.
The name of the file to upload.
The document category of the documents in the provided file.
The number of documents provided in this file
Correlation Id for the request
POST /api/demographics/v1/Documents/{merchantNumber}/MultipleDocuments HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 10
"Ynl0ZXM="textMerchant Number
The name of the file to upload.
The document category of the provided document.
Correlation Id for the request
POST /api/demographics/v1/Documents/{merchantNumber}/Base64Format HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 6
"text"textThis endpoint retrieves documents based on the provided merchant ID and document category ID (like Financial = 1, IRS = 2, etc). The document category is validated against a predefined whitelist. If the category is not present in the whitelist, an error is generated, and the process is halted.
MerchantNumber used to find particular merchant.
The document category for filtering particular document type.
Correlation Id for the request
GET /api/demographics/v1/Documents/{merchantNumber} HTTP/1.1
Host: localhost:5000
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"
}
]
}Merchant Number
The name of the file to upload.
The document category of the provided document.
Correlation Id for the request
POST /api/demographics/v1/Documents/{merchantNumber} HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 10
"Ynl0ZXM="textThe name of the file to upload.
Correlation Id for the request
POST /api/demographics/v1/Documents/{merchantNumber}/SignedApplication/Base64Format HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 73
{
"mapping": [
{
"businessContactId": 1,
"documentType": "text"
}
],
"file": "text"
}textThe name of the file to upload.
Correlation Id for the request
POST /api/demographics/v1/Documents/{merchantNumber}/SignedApplication HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 77
{
"mapping": [
{
"businessContactId": 1,
"documentType": "text"
}
],
"file": "Ynl0ZXM="
}textThis endpoint retrieves a list of all documents for a specified merchant number. The documents are categorized into different groups, and the response includes comprehensive details about each document within these categories.
MerchantNumber used to filter documents.
Correlation Id for the request
GET /api/demographics/v1/Documents/{merchantNumber}/List HTTP/1.1
Host: localhost:5000
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"
}
]
}The documentId of the document to retrieve. This value is returned when the document is initially uploaded.
Correlation Id for the request
GET /api/demographics/v1/Documents/{merchantNumber}/{documentId} HTTP/1.1
Host: localhost:5000
Accept: */*
binaryThis endpoint deletes a document associated with the specified merchantNumber and documentId. The documentId represents the unique identifier assigned to the document during the upload process. The request requires proper authorization based on the MID policy.
MerchantNumber used to find a merchant.
The Id associated with a document. This was returned when the document is initially uploaded.
Correlation Id for the request
DELETE /api/demographics/v1/Documents/{merchantNumber}/{documentId} HTTP/1.1
Host: localhost:5000
Accept: */*
No content
Merchant Number
Correlation Id for the request
POST /api/demographics/v1/Documents/{merchantNumber}/{documentId}/VoidedChecks HTTP/1.1
Host: localhost:5000
Accept: */*
textThis endpoint deletes a voided check document from the document storage associated with a given bank account. It also updates the associated bank account to remove the reference to the deleted voided check.
The request requires proper authorization based on the MID policy.
The documentId of the document to delete. This value is returned when the document is initially uploaded.
The bankAccountId of the account for which this voided check was provided. This value will be returned when creating, updating, or retreiving a bank account.
Correlation Id for the request
DELETE /api/demographics/v1/Documents/{merchantNumber}/{documentId}/VoidedChecks HTTP/1.1
Host: localhost:5000
Accept: */*
No content
Was this helpful?