Document Object

id

string (UUID)

ID of the document.

businessAccountId

string (UUID)

Business Account ID.

holderId  

string (UUID)

ID of the account holder for the document. The account holder can be a Customer Account, Beneficiary, or Business Account.

holderType  

string enum, values: BUSINESS_ACCOUNT, CUSTOMER, BENEFICIARY

Type of entity referenced by the accountHolderId field.

documentType  

string enum, values: driving-license, passport, formation, tax, ownership, other

Type of document. The following values are supported:

• driving-license  Driver’s license. Can be added for Individual Customers and Beneficiaries.
• passport  Passport. Can be added for Individual Customers and Beneficiaries.
• formation  Formation document. Can be added for Business Customers.
• tax  Tax document. Can be added for Business Customers.
• ownership  Ownership document. Can be added for Business Customers.
• other  Other type of document. Can be added for Individual Customers, Business Customers, Beneficiaries, and Business Accounts.

name  

string

Name of the document. Example: Bob Smith Driver’s License

description

string

Description of the document.

number  

string

Document number. Required if documentType is driving-license.

issuingDate

string (date)

Date the document was issued. Cannot be a future date.

issuingCountryCode  

string, min length: 2, max length: 3

Country where the document was issued. Must be an ISO 3166-1 uppercase alpha 2-character or 3-character country code. For example, the United States is US or USA. Required if documentType is driving-license.

issuingStateCode  

string, min length: 2, max length: 3

State or province where the document was issued. Must be an ISO 3166-2 uppercase alpha 2-character or 3-character country subdivision code. For example, Missouri is MO. Required if documentType is driving-license.

extension  

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

Document file extension. Allowed values are JPG, JPEG, PNG, and PDF.

contentLength  

integer (int64), max size: 5,242,880 bytes (5 MB)

File content size in bytes.

version

string

Document version. This field is incremented automatically when a new version of the document is uploaded.

expiryDate  

string (date)

Expiry date for the document. Required if documentType is driving-license.

url

object

Content URL for the document. Can be used to download the document or upload a new version of the document. Note that the URL will not be set if the document status is NEW.

status

string enum, values: NEW, UPLOADED

Document status. The following values are supported:

• NEW  The document is being processed.
• UPLOADED  The document has been added to the account.

metadata

string, max items: 5, value max length: 1024

Use a maximum of 5 key/value pairs to store additional information about the document.

createdBy

object

Entity that created the document.

createdAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

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

updatedBy

object

Entity that last updated the document.

updatedAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the document was last updated.