Sign in
Risk.Income Check

Get an income check

Gets an income check by id.

get/v2/income-checks/{id}

Path parameters

idstring required

The internal identifier of an income check.

Response

A successful response.

appIdstring

The identifier of the app that has been created by the client in console and linked to the income check product.

createdTimestring date-time

The creation time of the income check.

engineVersionstring

The version of the engine that generated the income check.

externalReferencestring

An external reference given by the client when creating the income check.

idstring required

The internal identifier of the income check.

userIdstring

The internal identifier of the user linked to the request.

Example response

{
  "appId": "56a33be25eb9443fbb696f7c61eabd94",
  "createdTime": "2021-04-22T09:59:56.966Z",
  "engineVersion": "1.0.0",
  "externalReference": "ext-abc-123",
  "id": "a8efc70a24a5e4aed0f8d3e5380b01fd74fc9cd1",
  "userId": "9e0b1c0d74967147744f0d076e805dfb2df7b4b3"
}

Changes

No recorded changes to this endpoint across all 10 revisions of this API.