List All Documents

Retrieve all documents for a Beneficiary, Customer Account, or Business Account.

To retrieve documents for a specific Beneficiary, Customer Account, or Business Account, provide their RocketKOR ID in the holderId query parameter.
To retrieve documents for all Beneficiaries and Customer Accounts within a Business Account, omit the holderId query parameter from the request. Documents will be returned for the Business Account associated with the request access token.

Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.

Endpoint

GET /v1/documents

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

holderId

string (UUID)

ID of the Beneficiary, Customer Account, or Business Account for which you want to retrieve documents.

To retrieve documents for a specific Beneficiary, Customer Account, or Business Account, provide their RocketKOR ID.
To retrieve documents for all Beneficiaries and Customer Accounts within a Business Account, omit this parameter. Documents will be returned for the Business Account associated with the request access token.

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

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

documentStatus

string enum, values: NEW, UPLOADED

Filter the results by the document status. The following values are supported:

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

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 index.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Document Quick Info objects.

SAMPLE RESPONSE

				
					{
  "totalElements": 0,
  "totalPages": 0,
  "number": 0,
  "numberOfElements": 0,
  "hasNext": true,
  "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"
    },
    {...},
    {...}
  ]
}