Search Applicants
Allows you to search for active applicants by phone number. Formatting of the phone number doesn't matter, and the number can be partial.
A simplified profile is returned so you're able to determine if you've found the applicant you're looking for. Complete details on the applicant can be returned with a GET request for the Applicant Details.
Request
Requires Authorization
GET: https://sandbox.approveowl.com/api/v1/applicants/?q=:search_string
| Parameter | Type | Description |
|---|---|---|
| :search_string | string | A partial name or partial phone number |
Example Response
[
{
"id": "e13a342e-01ee-46ec-828d-e6dbc10896d0",
"full_name": "James T. Hardesty",
"primary_phone_number": "+12145559744",
"created_at": "2023-08-14T12:50:40.480-05:00",
"social_security_number": "111-11-1111",
"date_of_birth": "1970-07-06"
},
{
"id": "27e4eaca-29f1-455d-a396-13e8559f57a5",
"full_name": "Susan R. Holmes",
"primary_phone_number": "+12145559838",
"created_at": "2023-08-09T10:35:58.045-05:00",
"social_security_number": "111-11-1111",
"date_of_birth": "1982-04-16"
}
]