Attachment Object

The Attachment object represents a file that has been added to a RocketKOR entity.

Attributes

businessAccountId

string (UUID)

Business Account ID.

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.

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.

createdBy

object

Entity that created the attachment.

string (UUID)

ID of the entity. Will be blank if createdBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
internal Internal service call.
kor_employee Rocket Financial employee.
service-account Service Account using APIs.

createdAt

string (date-time)

Date and time the attachment was created in the RocketKOR system.

updatedBy

object

Entity that last updated the attachment.

string (UUID)

ID of the entity. Will be blank if updatedBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
internal Internal service call.
kor_employee Rocket Financial employee.
service-account Service Account using APIs.

updatedAt

string (date-time)

Date and time the attachment was last updated.

string (UUID)

ID of the attachment.

status

string enum, values: NEW, UPLOADED, MALICIOUS, INCOMPLETE, SCANNED

Attachment status. The following values are supported:

NEW The initial document has been uploaded to RocketKOR. The document has not yet been scanned.
UPLOADED A new version of the document has been uploaded to RocketKOR. The document has not yet been scanned.
INCOMPLETE The document malware scan could not be completed.
SCANNED The document has been scanned successfully.
MALICIOUS The document contains malware.

extension

string enum, values: PNG, JPG, JPEG, PDF

Attachment file extension.

url

object

Content URL for the attachment. Returned for GET /v1/attachments/{attachmentId} if the attachment status is SCANNED.

value

string (URI)

Content URL.

allow

string enum, values: GET

Allowed HTTP method for the URL. Value must be GET (download the attachment).

expiresIn

integer (int64)

URL expiry period (in seconds).

thumbnailUrl

object

Content URL for the attachment’s thumbnail image. Returned for GET /v1/attachments/{attachmentId} if the attachment status is SCANNED.

The thumbnail image is used in the RocketKOR Portal. A default thumbnail image is generated automatically when the attachment is first uploaded.

value

string (URI)

Content URL.

allow

string enum, values: GET

Allowed HTTP method for the URL. Value must be GET (download the thumbnail image).

expiresIn

integer (int64)

URL expiry period (in seconds).

Attachment Object

				
					{
  "businessAccountId": "string(UUID)",
  "entityId": "string(UUID)",
  "entityType": "BENEFICIARY | BUSINESS_ACCOUNT | CUSTOMER| FINANCIAL_ACCOUNT | LINX_TEMPLATE | LINX_WORKFLOW | MULTI_LEG_TRANSACTION | NOTE | RECIPIENT | SCHEDULED_TRANSACTION | TRANSACTION",
  "name": "string",
  "description": "string",
  "metadata": {
    "key": "value"
  },
  "createdBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "createdAt": "string(UUID)",
  "updatedBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "updatedAt": "string(date-time)",
  "id": "string(UUID)",
  "status": "NEW | UPLOADED | MALICIOUS | INCOMPLETE | SCANNED",
  "extension": "PNG | JPG | JPEG | PDF",
  "url": {
    "value": "string(URI)",
    "allow": "GET",
    "expiresIn": integer(int64)
  },
  "thumbnailUrl": {
    "value": "string(URI)",
    "allow": "GET",
    "expiresIn": integer(int64)
  }
}