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

idstring or nullformat: "uuid"

idempotencyIdstring or nullformat: "uuid"

statusenum or null

Allowed values:

screeningobject or null

screeningMethodslist of objects or null

List of screening methods configured for the property

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