Skip to main content
GET
/
private-records
/
{record_id}
/
financial-files
Error
A valid request URL is required to generate request examples
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "original_filename": "<string>",
      "mime_type": "<string>",
      "size_bytes": 123,
      "sha256": "<string>",
      "currency": "<string>",
      "status": "uploaded",
      "uploaded_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "file_message": "<string>"
    }
  ],
  "total_items": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Requester-Organization-ID
string<uuid>
required

The unique identifier of the organization making the request. This ID is used to authorize the requester within the system.

​
Target-Organization-ID
string<uuid>
required

The unique identifier of the organization that is the target of the request. The Target-Organization-ID may match the Requester-Organization-ID if the requester accesses their own resources. If the Target-Organization-ID differs from the Requester-Organization-ID, the requester can access third-party resources if the requester has a connection with the target organization and is authorized to perform such actions.

Path Parameters

​
record_id
string<uuid>
required

Query Parameters

​
statuses
enum<string>[] | null
Available options:
uploaded,
processing,
valid,
invalid,
failed
​
order_by
enum<string>
default:uploaded_at
Available options:
created_at,
updated_at,
uploaded_at,
original_filename
​
order_dir
enum<string>
default:desc
Available options:
asc,
desc
​
limit
integer
required
Required range: x <= 100
​
offset
integer
required
Required range: x >= 0

Response

Successful Response

​
items
PrivateRecordsFinancialFile · object[]
required
​
total_items
integer
required
Required range: x >= 0