---
title: "List Documents"
method: GET
path: "/documents"
tags: ["Documents"]
---

# List Documents

`GET /documents`

Get the user's documents from employment data sources.

## Query parameters

- `size` integer
- `cursor` string
- `userId` string
- `accountId` string
- `sourceId` string

## Response `200`

OK

- DocumentListResponse
  - `code` 'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED' — Request status code
  - `message` string — Message response to the request
  - `requestId` string — Unique ID that is added to the body of every response for easy traceability of the request in our logs.
  - `data` DocumentListData
    - `nextCursor` string — The next cursor value that can be used in the following query.
    - `items` Document[]
      - `id` string, required — Unique ID of this object
      - `name` string, required — Document name
      - `docId` string, nullable — Document number
      - `status` string, nullable — Document status，only for NBI verification, It's VALID if the NBI verification status is valid.
      - `documentType` 'IDENTIFICATION' | 'PAYSLIP' | 'CLEARANCE' | 'CERTIFICATE' — Document Type
      - `issueDate` string, date, nullable — Issue date
      - `expiryDate` string, date, nullable — Expiry date
      - `fileUrl` string, nullable — Publicly available URL reference for the document
      - `remarks` string, nullable — Remarks section
      - `metadata` ObjectReferenceMetadata, required — Metadata related to account-specific data
        - `itemCreatedAt` string, date-time, required — Date and time
        - `createdAt` string, date-time, required — Date and time
        - `accountId` string — The accountId of this object
        - `sourceId` string, required — The ACCOUNT or ARCHIVE ID associated with this object
        - `sourceType` 'ACCOUNT' | 'UPLOAD' | 'ARCHIVE', nullable, required — Source Type
        - `userId` string, required — The user ID associated with this object
        - `providerId` string, required — The provider ID associated with this object

## Other responses

- `400` — Standard error response
- `401` — Standard error response
- `403` — Standard error response
- `404` — Standard error response
- `415` — Standard error response
- `429` — Standard error response
- `500` — Standard error response
- `501` — Standard error response
- `503` — Standard error response
- `504` — Standard error response

## Changes

- **2024-06-27** (v1) `4f4b86b82632` — 1 breaking
  - the response property `data/items/items/allOf[subschema #2]/metadata/sourceType` became nullable for the status `200`

[Change history](https://skmtc.dev/smileapi/apis/smile-api/changes/documents/get.md)

---

[API](https://skmtc.dev/smileapi/apis/smile-api.md) · [All operations](https://skmtc.dev/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smileapi/smile-api/revisions/4f4b86b82632/schema)