---
title: "List income checks"
method: GET
path: "/v2/income-checks"
tags: ["Risk.Income Check"]
---

# List income checks

`GET /v2/income-checks`

Lists income checks.

## Query parameters

- `pageSize` integer
- `pageToken` string
- `appIdEq` string
- `identity.ssnEq` string
- `externalReferenceEq` string
- `dateLte` string
- `dateGte` string

## Response `200`

A successful response.

- V2ListIncomeChecksResponse
  - `incomeChecks` V2IncomeCheckSummary[] — List of instances.
    - `appId` string — The identifier of the app that has been created by the client in console and linked to the income check product.
    - `createdTime` string, date-time — The creation time of the income check.
    - `engineVersion` string — The version of the engine that generated the income check.
    - `externalReference` string — An external reference given by the client when creating the income check.
    - `id` string, required — The internal identifier of the income check.
    - `identity` Incomechecksv2Identity
      - `name` string, required — The name of the user.
      - `ssn` string, required — User's social security number.
    - `userId` string — The internal identifier of the user linked to the request.
  - `nextPageToken` string — Pointer to the next page.
  - `prevPageToken` string — Pointer to the previous page.

## Other responses

- `400` — The request does not pass validation. This could for example be an invalid app id. Check the error message or the documentation of each field for more information.
- `401` — Wrong scopes associated with the access token.
- `403` — The resource does not belong to subject associated with the access token.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/tink/apis/tink-api.md) · [All operations](https://skmtc.net/tink/apis/tink-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tink/tink-api/revisions/23d8982b533d/schema)