Read Screening Request

Onboarding Required

Retrieve a specific screening request by its ID.

Screening endpoints require an additional onboarding process. Please contact our team to begin the onboarding process for screening integration.

<Badge>Onboarding Required</Badge> Retrieve a specific screening request by its ID. <Info> Screening endpoints require an additional onboarding process. Please contact our team to begin the onboarding process for screening integration. </Info>

Path parameters

screeningRequestIdstringRequired

The ID of the screening request to retrieve.

Response

Expected response to a valid request

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

statusenum

Allowed values:

screeningobject

screeningMethodslist of objects

List of screening methods configured for the request

1	{
2	"id": "id",
3	"idempotencyId": "idempotencyId",
4	"status": "NOT_STARTED",
5	"screening": {
6	"householdId": "householdId",
7	"isAffordable": true,
8	"screeningAmount": 1.1,
9	"payload": {
10	"depositAmount": 1.1,
11	"leaseTerm": "leaseTerm",
12	"applicants": [
13	{}
14	]
15	}
16	},
17	"screeningMethods": [
18	{
19	"id": "id",
20	"method": "credit"
21	}
22	]
23	}