VerifyRentalRequirements

Run rental verification

post

Verifies rental information using the provided profile and returns the verification results.

Authorizations

Query parameters

verifiedIdstringOptional

Verified ID associated with the request

clientIdstringOptional

Client ID associated with the request

caseIdstringOptional

Case ID for the verification request

walletIdstringOptional

Wallet ID associated with the user

Body

FirstNamestringOptional

First name of the applicant

LastNamestringOptional

Last name of the applicant

DateOfBirthstring · dateOptional

Date of birth of the applicant

SSNstringOptional

Social Security Number of the applicant

StreetAddressstringOptional

Street address of the applicant

CitystringOptional

City of residence of the applicant

StatestringOptional

State of residence of the applicant

Emailstring · emailOptional

Email address of the applicant

PostalCodestringOptional

Postal code of the applicant

OpenBankingSubscriptionIdstringOptional

Open banking subscription ID for income verification

OpenBankingTokenstringOptional

Token associated with open banking subscription

Responses

200

Successful verification

application/json

500

Internal server error

post

HTTPcURLJavaScriptPython

POST /verifyRentalRequirements HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "FirstName": "text",
  "LastName": "text",
  "DateOfBirth": "2025-05-03",
  "SSN": "text",
  "StreetAddress": "text",
  "City": "text",
  "State": "text",
  "Email": "[e-mail]",
  "PostalCode": "text",
  "OpenBankingSubscriptionId": "text",
  "OpenBankingToken": "text"
}

{
  "tokenId": "text",
  "verificationResults": {
    "Id": "text",
    "IncomEstimate": 1,
    "QualifiedViaCredit": true
  }
}