A valid request URL is required to generate request examples{
"user": "<string>",
"flowId": "<string>",
"userInfo": {
"phoneNumber": "<string>"
},
"metadata": {},
"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>",
"country": "<string>",
"postalCode": "<string>"
},
"verifications": {
"liveness": true,
"faceMatch": true,
"idValid": true
},
"idPhotoUrls": [
"<string>"
],
"selfieUrls": [
"<string>"
],
"watchlistCheck": {
"hasMatch": true,
"matchedLists": [
{
"countryCode": "<string>",
"entities": [
{
"aliasType": "<string>",
"birthdate": {
"@type": "<string>"
},
"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": "2023-11-07T05:31:56Z",
"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": 123,
"weeklyHours": 123,
"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": 123
}
}
},
"bankData": {
"infoWithBank": {
"name": "<string>",
"address": {
"street": "<string>",
"city": "<string>",
"provinceState": "<string>",
"country": "<string>",
"postalCode": "<string>",
"fullAddress": "<string>"
}
},
"incomeTransactions": [
{
"balance": 123,
"code": {
"@type": "<string>"
},
"credit": 123,
"date": "<string>",
"debit": {
"@type": "<string>"
},
"description": "<string>",
"id": "<string>"
}
],
"rentTransactions": [
{
"@type": "<string>"
}
],
"monthlySummary": [
{
"month": "<string>",
"averageBalance": 123,
"income": 123,
"spending": 123
}
]
},
"residenceHistoryData": {
"addresses": [
{
"residentialStatus": "<string>",
"address": {
"street": "<string>",
"city": "<string>",
"provinceState": "<string>",
"country": "<string>",
"postalCode": "<string>",
"fullAddress": "<string>"
},
"startDate": "<string>",
"endDate": "<string>",
"reasonForMoving": "<string>",
"rentAmount": 123,
"landlordName": "<string>",
"landlordEmail": "<string>",
"landlordPhone": "<string>",
"landlordReview": {
"email": "<string>",
"phone": "<string>",
"wouldRentToThemAgain": 123,
"paysRentOnTime": 123,
"cleanliness": 123,
"didNotDamageProperty": 123,
"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": 123,
"landlordName": "<string>",
"amountOwed": 123,
"url": "<string>"
}
]
}
}Get the screening data
A valid request URL is required to generate request examples{
"user": "<string>",
"flowId": "<string>",
"userInfo": {
"phoneNumber": "<string>"
},
"metadata": {},
"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>",
"country": "<string>",
"postalCode": "<string>"
},
"verifications": {
"liveness": true,
"faceMatch": true,
"idValid": true
},
"idPhotoUrls": [
"<string>"
],
"selfieUrls": [
"<string>"
],
"watchlistCheck": {
"hasMatch": true,
"matchedLists": [
{
"countryCode": "<string>",
"entities": [
{
"aliasType": "<string>",
"birthdate": {
"@type": "<string>"
},
"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": "2023-11-07T05:31:56Z",
"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": 123,
"weeklyHours": 123,
"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": 123
}
}
},
"bankData": {
"infoWithBank": {
"name": "<string>",
"address": {
"street": "<string>",
"city": "<string>",
"provinceState": "<string>",
"country": "<string>",
"postalCode": "<string>",
"fullAddress": "<string>"
}
},
"incomeTransactions": [
{
"balance": 123,
"code": {
"@type": "<string>"
},
"credit": 123,
"date": "<string>",
"debit": {
"@type": "<string>"
},
"description": "<string>",
"id": "<string>"
}
],
"rentTransactions": [
{
"@type": "<string>"
}
],
"monthlySummary": [
{
"month": "<string>",
"averageBalance": 123,
"income": 123,
"spending": 123
}
]
},
"residenceHistoryData": {
"addresses": [
{
"residentialStatus": "<string>",
"address": {
"street": "<string>",
"city": "<string>",
"provinceState": "<string>",
"country": "<string>",
"postalCode": "<string>",
"fullAddress": "<string>"
},
"startDate": "<string>",
"endDate": "<string>",
"reasonForMoving": "<string>",
"rentAmount": 123,
"landlordName": "<string>",
"landlordEmail": "<string>",
"landlordPhone": "<string>",
"landlordReview": {
"email": "<string>",
"phone": "<string>",
"wouldRentToThemAgain": 123,
"paysRentOnTime": 123,
"cleanliness": 123,
"didNotDamageProperty": 123,
"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": 123,
"landlordName": "<string>",
"amountOwed": 123,
"url": "<string>"
}
]
}
}API authentication token