Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Risk.Income Check

Create an income check

Creates a request and returns the income of an end-user as a JSON response.

post/v2/income-checks

Request body

engineVersionstring

Optional version of the engine that generates the income check. If omitted, the latest engine version will be used. See Changelog for more details.

externalReferencestring

Optional reference given by the customer to add information, such as UID, to the generated report. (Validation: allowed lowercase and uppercase letters, numbers and dashes. Max 50 characters in length).

Example request

{
  "engineVersion": "1.0.0",
  "externalReference": "ln-123456789"
}

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"
}