Document Quick Info Object

The Document Quick Info object represents summary information for a document that has been added to a Beneficiary, Customer Account, or Business Account.

Attributes

string (UUID)

ID of the document.

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.

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.

createdBy

object

Entity that created the document.

string (UUID)

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

type

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

Type of entity. The following values are supported:

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

createdAt

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

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

Document Quick Info Object

				
					{
  "id": "b175994b-fd5b-46d6-aba9-73638902f4a0",
  "documentType": "driving-license",
  "name": "John Doe Driving License",
  "description": "driving license",
  "status": "NEW",
  "createdBy": {
    "id": "c503092d-e6c4-4f7a-b893-46ebe56b18a8",
    "type": "service-account"
  },
  "createdAt": "2023-05-03T23:11:59.656Z"
}