List documents

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

GET /documents

cURL

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/documents \
  --header 'Authorization: Basic <encoded-value>'

200

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

Authorizations

Authorization · string · header · required

API token authentication using format <api token id>:<api client secret>

Query Parameters

documentHolder · string

Filter by document holder ID (Customer or BeneficialOwner)

limit · integer · default: 20

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

Required range: 1 <= x <= 100

cursor · string

Cursor for pagination (returned from previous request)

Response

200

application/json

Successful operation

data · object[] · required

List of documents matching the filter criteria

Show child attributes

hasMore · boolean · required

Indicates if more results are available beyond this page

nextCursor · string

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

totalCount · integer

Total number of results matching the criteria