Document Object

id

string (UUID)

ID of the document.

providerExternalId

string

ID of the document in the external provider’s system.

provider

string

Name of the external provider.

businessAccountId

string (UUID)

Business Account ID.

holderId  

string (UUID)

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

holderType  

string enum, values: BENEFICIARY, BUSINESS_ACCOUNT, CUSTOMER

Type of entity referenced by the accountHolderId field. The following values are supported:

• BENEFICIARY  Beneficial Owner.
• BUSINESS_ACCOUNT  Business Account.
• CUSTOMER  Individual or Business Customer Account.

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.

number  

string

Document number. Required if documentType is driving-license or passport.

issuingDate

string (date), format: yyyy-mm-dd

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 or passport.

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), format: yyyy-mm-dd

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

url

object

Upload or download content URL for the document. Download content URLs are only returned if the document status is SCANNED.

thumbnailUrl

object

Content URL for the document’s thumbnail image. Returned for GET /v1/documents/{documentId} if the document status is SCANNED.

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

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.

verificationStatus

string, enum values: UNVERIFIED, VERIFIED

Document’s Identity Verification (IDV) status.

metadata

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

Key/value pairs used 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.