Screening Data API
The Screening Data API allows you to retrieve comprehensive screening results for an applicant, including credit information, bank account details, income verification, and landlord reviews. View the OpenAPI specification for this endpoint at Get Screening Data.Endpoint
Copy
GET /v2/screening/data/{screeningId}
Authentication
All requests must include an API token in the Authorization header.Path Parameters
| Parameter | Type | Description |
|---|---|---|
| screeningId | string | The unique identifier of the screening session |
Response Object
Contains the comprehensive screening results including:- Credit and financial information
- Income and debt analysis
- Bank account details
- Landlord reviews
- Risk assessment flags
- The metadata you provided when creating the screening session
Copy
{
"user": "string",
"flowId": "string",
"userInfo": {
"phoneNumber": "string"
},
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"screeningSteps": [
{
"id": "string",
"name": "string",
"status": "string",
"timestamp": "string",
"provider": "string",
"idData": {
"idValid": true,
"documentType": "string",
"expirationDate": "string",
"idNumber": "string",
"name": {
"first": "string",
"last": "string"
},
"email": "string",
"dateOfBirth": "string",
"address": {
"street": "string",
"city": "string",
"provinceState": "string",
"postalCode": "string",
"country": "string"
},
"verifications": {
"liveness": true,
"faceMatch": true,
"idValid": true
},
"idPhotoUrls": [
"string"
],
"selfieUrls": [
"string"
],
"watchlistCheck": {
"hasMatch": true,
"matchedLists": [
{
"countryCode": "string",
"entities": [
{
"aliasType": "string",
"birthdate": {
"@type": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"name": "string"
}
],
"listType": "string",
"listTypes": [
"string"
],
"matchTypes": [
"string"
],
"name": "string",
"url": "string"
}
]
}
},
"personalData": {
"citizenship": "string",
"maritalStatus": "string"
},
"employmentData": {
"employmentDetails": {
"identity": {
"firstname": "string",
"lastname": "string",
"dateofbirth": "2025-06-02T20:35:02.095Z",
"email": "string",
"phone": "string",
"ssn": "string",
"address": "string",
"city": "string",
"state": "string",
"postalcode": "string"
},
"proofOfIncome": [
"string"
],
"employment": {
"employeeType": "string",
"employmentStatus": "string",
"jobTitle": "string",
"startDate": "string",
"minimumMonthsOfEmployment": 0,
"weeklyHours": 0,
"employer": {
"name": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
}
},
"reference": {
"firstname": "string",
"lastname": "string",
"phone": "string",
"email": "string"
}
},
"income": {
"annualIncome": 0
}
}
},
"bankData": {
"infoWithBank": {
"name": "string",
"address": {
"street": "string",
"city": "string",
"provinceState": "string",
"country": "string",
"postalCode": "string",
"fullAddress": "string"
}
},
"incomeTransactions": [
{
"balance": 0,
"code": {
"@type": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"credit": 0,
"date": "string",
"debit": {
"@type": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"description": "string",
"id": "string"
}
],
"rentTransactions": [
{
"@type": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
],
"monthlySummary": [
{
"month": "string",
"averageBalance": 0,
"income": 0,
"spending": 0
}
]
},
"residenceHistoryData": {
"addresses": [
{
"residentialStatus": "string",
"address": {
"street": "string",
"city": "string",
"provinceState": "string",
"country": "string",
"postalCode": "string",
"fullAddress": "string"
},
"startDate": "string",
"endDate": "string",
"reasonForMoving": "string",
"rentAmount": 0,
"landlordName": "string",
"landlordEmail": "string",
"landlordPhone": "string",
"landlordReview": {
"email": "string",
"phone": "string",
"wouldRentToThemAgain": 1,
"paysRentOnTime": 1,
"cleanliness": 1,
"didNotDamageProperty": 1,
"additionalDetails": "string"
}
}
]
},
"customFormData": {
"entries": [
{
"question": "string",
"value": "string",
"type": "string"
}
]
}
}
],
"data": {
"equifaxCredit": {},
"scanStatus": {
"criminalScan": "string",
"criminalScanLabel": "string",
"fraudScan": "string",
"fraudScanLabel": "string",
"globalClearanceScan": "string",
"globalClearanceScanLabel": "string",
"knownAffiliationScan": "string",
"knownAffiliationScanLabel": "string",
"ofacGlobalTerroristScan": "string",
"ofacGlobalTerroristScanLabel": "string",
"otherScan": "string",
"otherScanLabel": "string",
"politicallyExposedPersonScan": "string",
"politicallyExposedPersonScanLabel": "string",
"publicCourtRecords": "string",
"publicCourtRecordsLabel": "string",
"publicProfileScan": "string",
"publicProfileScanLabel": "string",
"publicSafetyScan": "string",
"publicSafetyScanLabel": "string",
"sexOffenderScan": "string",
"sexOffenderScanLabel": "string"
},
"publicRecords": [
{
"topic": "string",
"matchConfidence": 1,
"landlordName": "string",
"amountOwed": 1,
"url": "string"
}
]
}
}
Error Responses
| Status Code | Description |
|---|---|
| 400 | Bad Request - Invalid screeningId or malformed request |
| 401 | Unauthorized - Missing or invalid API token |
| 404 | Not Found - Screening data not found for the specified user |
| 500 | Internal Server Error - Something went wrong on our end |