A valid request URL is required to generate request examples{
"screening": {
"id": "<string>",
"metadata": {},
"checkType": "<string>",
"coveScore": 123,
"creditScore": 123,
"equifaxResult": {},
"flinksBankAccounts": [
{
"accountNumber": "<string>",
"accountType": "<string>",
"balance": {
"available": 123,
"current": 123,
"limit": "<string>"
},
"category": "<string>",
"currency": "<string>",
"holder": {
"address": {
"city": "<string>",
"civicAddress": "<string>",
"country": "<string>",
"poBox": "<string>",
"postalCode": "<string>",
"province": "<string>"
},
"email": "<string>",
"name": "<string>",
"phoneNumber": "<string>"
},
"id": "<string>",
"institutionNumber": "<string>",
"title": "<string>",
"transactions": [
{
"balance": 123,
"credit": 123,
"date": "<string>",
"debit": 123,
"description": "<string>",
"id": "<string>"
}
],
"transitNumber": "<string>",
"type": "<string>"
}
],
"greenFlags": [
"<string>"
],
"incomeTransactions": [
{
"accountId": "<string>",
"amount": 123,
"date": "<string>",
"isoCurrencyCode": "<string>",
"originalDescription": "<string>",
"pending": true,
"transactionId": "<string>"
}
],
"landlordReviews": [
{
"email": "<string>",
"phone": "<string>",
"wouldRentToThemAgain": 123,
"paysRentOnTime": 123,
"cleanliness": 123,
"didNotDamageProperty": 123,
"additionalDetails": "<string>"
}
],
"monthlyData": [
{
"month": "<string>",
"averageBalance": 123,
"income": 123,
"spending": 123
}
],
"nonSufficientFunds": [
{
"dateReported": "2023-11-07T05:31:56Z",
"creditorEntity": "<string>",
"nsfamount": 123,
"details": "<string>",
"verificationDate": "2023-11-07T05:31:56Z"
}
],
"normBAB": 123,
"normCSC": 123,
"normECS": 123,
"normMI": 123,
"redFlags": [
"<string>"
],
"reportStatus": "<string>",
"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>"
},
"rentTransactions": [
{
"id": "<string>",
"type": "<string>",
"amount": 123,
"isoCurrencyCode": "<string>",
"description": "<string>",
"date": "<string>"
}
],
"updatedAt": "2023-11-07T05:31:56Z",
"customFormData": [
{
"question": "<string>",
"value": "<string>",
"type": "<string>"
}
],
"monthlyIncome": 123,
"monthlyDebt": 123,
"debtLimit": 123,
"rent": 123,
"publicRecords": [
{
"topic": "<string>",
"matchConfidence": 123,
"landlordName": "<string>",
"amountOwed": 123,
"url": "<string>"
}
],
"autoLoansMonthlyPayments": 123,
"autoLoansTotalBalance": 123,
"revolvingCreditMonthlyPayments": 123,
"revolvingCreditTotalBalance": 123,
"otherCreditMonthlyPayments": 123,
"otherCreditTotalBalance": 123,
"otherDebtsMonthlyPayments": 123,
"otherDebtsTotalBalance": 123,
"mortgageLoansMonthlyPayments": 123,
"mortgageLoansTotalBalance": 123,
"studentLoansMonthlyPayments": 123,
"studentLoansTotalBalance": 123,
"totalCurrentBankBalance": 123,
"totalDebt": 123
},
"user": {
"id": "<string>",
"phoneNumber": "<string>",
"proofOfIncome": [
"<string>"
],
"checkComplete": true,
"idPhotoUrls": [
"<string>"
],
"selfieUrls": [
"<string>"
],
"rentals": [
{
"address": {
"street": "<string>",
"city": "<string>",
"provinceState": "<string>",
"country": "<string>",
"postalCode": "<string>",
"fullAddress": "<string>"
},
"start": "<string>",
"reasonForMoving": "<string>",
"rentAmount": 123,
"landlordName": "<string>",
"landlordEmail": "<string>",
"landlordPhone": "<string>",
"id": "<string>"
}
],
"addressOnId": {
"street": "<string>",
"city": "<string>",
"provinceState": "<string>",
"country": "<string>",
"postalCode": "<string>",
"fullAddress": "<string>"
},
"currentAddress": {
"street": "<string>",
"city": "<string>",
"provinceState": "<string>",
"country": "<string>",
"postalCode": "<string>",
"fullAddress": "<string>"
},
"dateOfBirth": "<string>",
"firstName": "<string>",
"identityVerification": {
"source": "<string>",
"name": {
"first": "<string>",
"last": "<string>"
},
"phone": "<string>",
"email": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"verifications": {
"liveness": true,
"faceMatch": true,
"nameMatch": true
},
"idNumber": "<string>",
"at": "2023-11-07T05:31:56Z"
},
"lastName": "<string>",
"email": "<string>",
"employmentAnnualSalary": 123,
"employmentCompanyName": "<string>",
"employmentCompanyPosition": "<string>",
"employmentReferenceFirstName": "<string>",
"employmentReferenceLastName": "<string>",
"employmentReferencePhoneNumber": "<string>",
"employmentReferenceWorkEmail": "<string>",
"employmentStartDate": "<string>",
"employmentStatus": "<string>",
"reasonForMoving": "<string>",
"residentialStatus": "<string>",
"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>"
},
"income": {
"income": 123,
"incomeType": "<string>",
"annualIncome": "<string>",
"hourlyIncome": 123,
"netHourlyRate": 123,
"payCycle": "<string>",
"nextExpectedPayDate": "2023-11-07T05:31:56Z",
"currentPayPeriodStart": "2023-11-07T05:31:56Z",
"currentPayPeriodEnd": "2023-11-07T05:31:56Z"
},
"employment": {
"employeeType": "<string>",
"employmentStatus": "<string>",
"jobTitle": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"minimumMonthsOfEmployment": 123,
"weeklyHours": 123,
"employer": {
"name": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
}
}
}
}
}Get the screening data
A valid request URL is required to generate request examples{
"screening": {
"id": "<string>",
"metadata": {},
"checkType": "<string>",
"coveScore": 123,
"creditScore": 123,
"equifaxResult": {},
"flinksBankAccounts": [
{
"accountNumber": "<string>",
"accountType": "<string>",
"balance": {
"available": 123,
"current": 123,
"limit": "<string>"
},
"category": "<string>",
"currency": "<string>",
"holder": {
"address": {
"city": "<string>",
"civicAddress": "<string>",
"country": "<string>",
"poBox": "<string>",
"postalCode": "<string>",
"province": "<string>"
},
"email": "<string>",
"name": "<string>",
"phoneNumber": "<string>"
},
"id": "<string>",
"institutionNumber": "<string>",
"title": "<string>",
"transactions": [
{
"balance": 123,
"credit": 123,
"date": "<string>",
"debit": 123,
"description": "<string>",
"id": "<string>"
}
],
"transitNumber": "<string>",
"type": "<string>"
}
],
"greenFlags": [
"<string>"
],
"incomeTransactions": [
{
"accountId": "<string>",
"amount": 123,
"date": "<string>",
"isoCurrencyCode": "<string>",
"originalDescription": "<string>",
"pending": true,
"transactionId": "<string>"
}
],
"landlordReviews": [
{
"email": "<string>",
"phone": "<string>",
"wouldRentToThemAgain": 123,
"paysRentOnTime": 123,
"cleanliness": 123,
"didNotDamageProperty": 123,
"additionalDetails": "<string>"
}
],
"monthlyData": [
{
"month": "<string>",
"averageBalance": 123,
"income": 123,
"spending": 123
}
],
"nonSufficientFunds": [
{
"dateReported": "2023-11-07T05:31:56Z",
"creditorEntity": "<string>",
"nsfamount": 123,
"details": "<string>",
"verificationDate": "2023-11-07T05:31:56Z"
}
],
"normBAB": 123,
"normCSC": 123,
"normECS": 123,
"normMI": 123,
"redFlags": [
"<string>"
],
"reportStatus": "<string>",
"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>"
},
"rentTransactions": [
{
"id": "<string>",
"type": "<string>",
"amount": 123,
"isoCurrencyCode": "<string>",
"description": "<string>",
"date": "<string>"
}
],
"updatedAt": "2023-11-07T05:31:56Z",
"customFormData": [
{
"question": "<string>",
"value": "<string>",
"type": "<string>"
}
],
"monthlyIncome": 123,
"monthlyDebt": 123,
"debtLimit": 123,
"rent": 123,
"publicRecords": [
{
"topic": "<string>",
"matchConfidence": 123,
"landlordName": "<string>",
"amountOwed": 123,
"url": "<string>"
}
],
"autoLoansMonthlyPayments": 123,
"autoLoansTotalBalance": 123,
"revolvingCreditMonthlyPayments": 123,
"revolvingCreditTotalBalance": 123,
"otherCreditMonthlyPayments": 123,
"otherCreditTotalBalance": 123,
"otherDebtsMonthlyPayments": 123,
"otherDebtsTotalBalance": 123,
"mortgageLoansMonthlyPayments": 123,
"mortgageLoansTotalBalance": 123,
"studentLoansMonthlyPayments": 123,
"studentLoansTotalBalance": 123,
"totalCurrentBankBalance": 123,
"totalDebt": 123
},
"user": {
"id": "<string>",
"phoneNumber": "<string>",
"proofOfIncome": [
"<string>"
],
"checkComplete": true,
"idPhotoUrls": [
"<string>"
],
"selfieUrls": [
"<string>"
],
"rentals": [
{
"address": {
"street": "<string>",
"city": "<string>",
"provinceState": "<string>",
"country": "<string>",
"postalCode": "<string>",
"fullAddress": "<string>"
},
"start": "<string>",
"reasonForMoving": "<string>",
"rentAmount": 123,
"landlordName": "<string>",
"landlordEmail": "<string>",
"landlordPhone": "<string>",
"id": "<string>"
}
],
"addressOnId": {
"street": "<string>",
"city": "<string>",
"provinceState": "<string>",
"country": "<string>",
"postalCode": "<string>",
"fullAddress": "<string>"
},
"currentAddress": {
"street": "<string>",
"city": "<string>",
"provinceState": "<string>",
"country": "<string>",
"postalCode": "<string>",
"fullAddress": "<string>"
},
"dateOfBirth": "<string>",
"firstName": "<string>",
"identityVerification": {
"source": "<string>",
"name": {
"first": "<string>",
"last": "<string>"
},
"phone": "<string>",
"email": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"verifications": {
"liveness": true,
"faceMatch": true,
"nameMatch": true
},
"idNumber": "<string>",
"at": "2023-11-07T05:31:56Z"
},
"lastName": "<string>",
"email": "<string>",
"employmentAnnualSalary": 123,
"employmentCompanyName": "<string>",
"employmentCompanyPosition": "<string>",
"employmentReferenceFirstName": "<string>",
"employmentReferenceLastName": "<string>",
"employmentReferencePhoneNumber": "<string>",
"employmentReferenceWorkEmail": "<string>",
"employmentStartDate": "<string>",
"employmentStatus": "<string>",
"reasonForMoving": "<string>",
"residentialStatus": "<string>",
"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>"
},
"income": {
"income": 123,
"incomeType": "<string>",
"annualIncome": "<string>",
"hourlyIncome": 123,
"netHourlyRate": 123,
"payCycle": "<string>",
"nextExpectedPayDate": "2023-11-07T05:31:56Z",
"currentPayPeriodStart": "2023-11-07T05:31:56Z",
"currentPayPeriodEnd": "2023-11-07T05:31:56Z"
},
"employment": {
"employeeType": "<string>",
"employmentStatus": "<string>",
"jobTitle": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"minimumMonthsOfEmployment": 123,
"weeklyHours": 123,
"employer": {
"name": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
}
}
}
}
}API authentication token
A successful response.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes