Search files

Search files based on file name or file number. One of the fields (fileName or fileNumber) is mandatory. File number must be numeric only.

SecurityoAuth2
Request
query Parameters
page
integer
Default: 1
Example: page=1
limit
integer
Default: 10
Example: limit=10
Request Body schema: application/json
required
fileName
string

The name of the file to search for.
At least one of fileName or fileNumber must be provided.
If both are provided, the search will use both.
This value is typically the filename as uploaded or processed in the system.

fileNumber
string^[0-9]+$

Number of the file to search. At least one of fileName or fileNumber must be provided.
If both are provided, the search will use both.

Responses
200

Successfully processed request

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

post/v1/files/search
Request samples
application/json
{
  • "fileName": "FEDWIRE_CSV_TEST",
  • "fileNumber": "1045"
}
Response samples
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}