Create Verification Request
Generate verification links for applicants and send them to their email/mobile phone.
Create Verification Request
POST
https://api.numaly.com/v1/requests
Request Body
first_name
string
true
Applicants first name
last_name
string
true
Applicants last name
string
true
Applicants email address
phone_number
String
false
Applicants phone number to send the verification request to. Although optional phone numbers almost guarantee a faster response.
reference
string
true
Reference for your record keeping (e.g property address etc)
applicant_pays
boolean
true
Do you want the applicant to pay the screening charge. if false
your screening credits will be used.
property_rent
integer
true
Rent amount of the property applicant is applying for. Used to calculate the income to rent multiple.
verify_income
boolean
true
Do you want to verify applicants income via the bank
verify_identity
boolean
true
Do you want the appllicants identity to be verified as part of the income verification
verify_employment
boolean
true
Do you want to verify applicants employment via payroll account
send_to_applicant
boolean
true
True if you want the verification to be sent to the applicant. If ommited this defaults to True
{
"id": "4ab1e5530-fb76-4621-b11a-c4480708fb2f",
"verification_url": "https://example.numaly.com/request/1af90f9f-8640-4a53-8dbc-5a8f593a32a0"
"expiry_date": "2021-03-10"
}
Last updated
Was this helpful?