List All Documents

Retrieve all documents for a Business Account. This includes documents for the Business Account itself as well as documents for the Beneficial Owners and Customer Accounts within the Business Account.

You can use the following query parameters to filter the results:

holderId Retrieve documents for a specific Beneficial Owner or Customer Account.
documentTypes Retrieve specific document types.
documentStatus Retrieve documents with a specific status.

You can also sort the results and limit the number of results returned.

Note Documents will be retrieved for the Business Account associated with the request access token.

Endpoint

GET /v1/documents

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

holderId

string (UUID)

To retrieve documents for a specific Beneficial Owner or Customer Account, provide their RocketKOR account ID.

documentTypes

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

Filter the results by the 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.

Use a comma-separated list to specify multiple values (example: driving-license,passport).

documentStatus

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

Filter the results by document 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.

sort

array of strings

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

page

integer (int32)

Page number to return, based on zero-based page indexing.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Document Summary objects.

SAMPLE RESPONSE

				
					{
  "totalElements": 3,
  "totalPages": 1,
  "number": 0,
  "numberOfElements": 3,
  "hasNext": false,
  "content": [
    {
      "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"
    },
    {...},
    {...}
  ]
}