Applicant SPII

The Applicant SPII object represents sensitive personally identifiable information for an applicant applying for a lease transaction within the Funnel Leasing system. This includes data such as Social Security Number (SSN), detailed financial information, and employer details. Proper care and security protocols must be followed when accessing or processing this information to comply with privacy regulations.

SPII is encrypted for security purposes. To access decrypted information,
simply make a request to the specified proxy endpoint, providing your
API key as you would for direct API calls. We use VGS (Very Good Proxy)
for encrypting and decrypting sensitive data. The proxy will automatically
return the data in decrypted form.

GET https://tntdv44mdst.live.verygoodproxy.com/api/v2/applicants/:id/spii

Attributes

Name
ID
Type
integer
Description
A unique Funnel identifier for the applicant.
Name
lease_transaction_id
Type
integer
Description
The ID of the lease transaction associated with the applicant.
Name
role
Type
string
Description
The role of the applicant in the lease transaction (e.g., "Primary Applicant").
Name
first_name
Type
string
Description
The first name of the applicant.
Name
middle_name
Type
string
Description
The middle name of the applicant.
Name
last_name
Type
string
Description
The last name of the applicant.
Name
suffix
Type
string
Description
The suffix of the applicant's name (e.g., "Jr").
Name
email
Type
string
Description
The email address of the applicant.
Name
address_street
Type
string
Description
The street address of the applicant.
Name
address_line_2
Type
string
Description
Additional line of address (e.g., apartment or business name).
Name
address_city
Type
string
Description
The city of the applicant's address.
Name
address_state
Type
string
Description
The state of the applicant's address.
Name
address_postal_code
Type
string
Description
The postal code of the applicant's address.
Name
ssn
Type
string
Description
The Social Security Number (SSN) of the applicant.
Name
date_of_birth
Type
string
Description
The date of birth of the applicant in ISO 8601 format.
Name
financial_data
Type
object
Description
Financial information of the applicant.
Name
employer
Type
object
Description
Employer details of the applicant.

{
    "id": 564323,
    "lease_transaction_id": 347612,
    "role": "Primary Applicant",
    "first_name": "John",
    "middle_name": "Mary",
    "last_name": "Doe",
    "suffix": "Jr",
    "email": "john.doe@gmail.com",
    "address_street": "21 Jump St.",
    "address_line_2": "Gelato Bar",
    "address_city": "New York",
    "address_state": "NY",
    "address_postal_code": "10001",
    "ssn": "123-45-6789",
    "date_of_birth": "2003-12-04",
    "financial_data": {
        "income_total": "10,000.00",
        "asset_total": "20,000.00",
        "vouchers_total": "30,000.00"
    },
    "employer": {
        "name": "Nestio",
        "address_street": "150 W 22nd St",
        "address_line_2": "Flr 8",
        "address_city": "New York",
        "address_state": "NY",
        "address_postal_code": "10011"
    }
}