Create an Attachment

Add a file to a RocketKOR entity such as an account, transaction, note, or LinX item.

Important You must use the Document APIs to add identity documents (used for Identity Verification) to Customer, Beneficial Owner, and Business accounts.

Endpoint

POST /v1/attachments

Authorization Header

Authorization: Bearer <access_token>

Request Body

file REQUIRED

string (binary)

File to upload.

entityType REQUIRED

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).

entityId REQUIRED

string (UUID)

ID of the entity that the attachment belongs to.

name

string, max length: 40

Name of the attachment.

description

string, max length: 1000

Description of the attachment.

metadata

string, max properties: 6, value max length: 1024

Key/value pairs used to store additional information about the attachment.

Returns

Returns the Attachment object. This object contains the attachment details, including the attachment ID and status.

SAMPLE REQUEST

				
					{
  "file": "contract.pdf",
  "entityType": "CUSTOMER",
  "entityId": "c924605d-0c65-446f-8f36-1db31df6e80a",
  "name": "Contract",
  "description": "contract",
  "metadata": {
    "type": "contract"
  }
}

SAMPLE RESPONSE

				
					{
  "businessAccountId": "e8800f5a-26a9-4435-8fec-5fc47126d1cb",
  "entityId": "c924605d-0c65-446f-8f36-1db31df6e80a",
  "entityType": "CUSTOMER",
  "name": "Contract",
  "description": "contract",
  "metadata": {
    "type": "contract"
  },
  "createdBy": {
    "id": "8d86a17a-4ba9-47b1-a510-214dda87d9f3",
    "type": "service-account"
  },
  "createdAt": "2024-06-20T17:13:43.181Z",
  "updatedBy": {
    "id": "8d86a17a-4ba9-47b1-a510-214dda87d9f3",
    "type": "service-account"
  },
  "updatedAt": "2024-06-20T17:14:43.181Z",
  "id": "22e27516-f2b9-469c-a204-15a963e37753",
  "status": "SCANNED",
  "extension": "PDF"
}