LIlightsparkdev
Documents

List documents

Changed on

Retrieve a list of documents with optional filtering by document holder.

get/documents

Request

  • Base URL
    https://api.lightspark.com/grid/2025-10-13
  • URL
    https://api.lightspark.com/grid/2025-10-13/documents
  • Auth
    HTTP basic

Query parameters

documentHolderstring

Filter by document holder ID (Customer or BeneficialOwner)

limitinteger

Maximum number of results to return (default 20, max 100)

cursorstring

Cursor for pagination (returned from previous request)

Response

Successful operation

hasMoreboolean required

Indicates if more results are available beyond this page

nextCursorstring

Cursor to retrieve the next page of results (only present if hasMore is true)

totalCountinteger

Total number of results matching the criteria

Example response

{
  "data": [
    {
      "id": "Document:019542f5-b3e7-1d02-0000-000000000001",
      "documentHolder": "BeneficialOwner:019542f5-b3e7-1d02-0000-000000000001",
      "documentType": "PASSPORT",
      "side": "FRONT",
      "country": "US",
      "documentNumber": "A12345678",
      "issuingAuthority": "U.S. Department of State",
      "fileName": "passport_scan.pdf",
      "createdAt": "2025-10-03T12:00:00Z",
      "updatedAt": "2025-10-03T12:00:00Z"
    }
  ]
}

Changes

  • 9e646a130ea0Revision changes
    • warning

      added the new RESIDENCE_PERMIT enum value to the // response property for the response status

  • d996ddfb9d2bRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status