List All Attachments

Retrieve all attachments for the entities within a Business Account. You can use the following query parameters to filter the results:

entityId Return attachments for a specific entity (for example, a specific Customer Account).
entityType Return attachments for a specific entity type (for example, all Customer Accounts).
name Return attachments with a specific name.

You can also sort the results and limit the number of results returned.

Note Attachments will be retrieved for the Business Account associated with the request access token.

Endpoint

GET /v1/attachments

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

entityId

string (UUID)

ID of the entity that the attachment belongs to.

entityType

string enum, values: BENEFICIARY, BUSINESS_ACCOUNT, CUSTOMER, FINANCIAL_ACCOUNT, LINX_TEMPLATE, LINX_WORKFLOW, MULTI_LEG_TRANSACTION, NOTE, RECIPIENT, SCHEDULED_TRANSACTION, TRANSACTION

Type of entity that the attachment belongs to. The following values are supported:

BENEFICIARY Beneficial Owner.
BUSINESS_ACCOUNT Business Account.
CUSTOMER Customer Account.
FINANCIAL_ACCOUNT Financial Account.
LINX_TEMPLATE LinX template.
LINX_WORKFLOW LinX workflow.
MULTI_LEG_TRANSACTION Multi-leg transaction (MLT).
NOTE Note.
RECIPIENT Recipient Account.
SCHEDULED_TRANSACTION Scheduled transaction.
TRANSACTION Single-leg transaction (SLT).

name

string, max length: 40

Name of the attachment.

sort

array of strings

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

page

integer (int32)

Page number to return, based on zero-based page indexing.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Attachment Summary objects. This object contains a summary of the attachment details, including the attachment ID and status.

If the attachment status is SCANNED, a thumbnail URL is also returned. You can download the thumbnail image by calling the URL (thumbnailUrl.value) with an HTTP GET request.

SAMPLE RESPONSE

				
					{
  "totalElements": 3,
  "totalPages": 1,
  "number": 0,
  "numberOfElements": 3,
  "hasNext": false,
  "content": [
    {
      "id": "22e27516-f2b9-469c-a204-15a963e37753",
      "businessAccountId": "e8800f5a-26a9-4435-8fec-5fc47126d1cb",
      "entityId": "c924605d-0c65-446f-8f36-1db31df6e80a",
      "entityType": "CUSTOMER",
      "extension": "PDF",
      "status": "SCANNED",
      "name": "Contract",
      "description": "contract",
      "createdAt": "2024-06-20T17:13:43.181Z",
      "thumbnailUrl": {
        "value": "https://documents.rocketkor.net/652908",
        "allow": "GET",
        "expiresIn": 600
      }
    },
    {...},
    {...}
  ]
}