Document Summary Object

The Document Summary object provides condensed information for an identity document. Identity documents are used for Identity Verification (IDV) for Business Accounts, Customer Accounts, and Beneficial Owners.

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 Beneficial Owners.
passport Passport. Can be added for Individual Customers and Beneficial Owners.
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, Beneficial Owners, and Business Accounts.

name

string, min length: 1, max length: 40

Name of the document (example: Bob Smith Driver’s License).

description

string, min length: 1, max length: 100

Description of the document. Required if documentType is formation, tax, ownership, or other.

status

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

Document status. The following values are supported:

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

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, 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), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

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

Document Summary Object

				
					{
  "id": "string(UUID)",
  "documentType": "string",
  "name": "string",
  "description": "string",
  "status": "NEW | UPLOADED | INCOMPLETE | SCANNED | MALICIOUS",
  "createdBy": {
    "id": "string(UUID)",
    "type": "employee | internal | service-account"
  },
  "createdAt": "string(date-time)"
}