Invite Applicant

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

POST: https://sandbox.approveowl.com/api/v1/applicant_invites/

Required Parameters:

Parameter	Type	Description
full_name	`string`	The full name of the applicant
phone_number	`string`	Must be a valid mobile phone number for the applicant

Optional Parameters:

Parameter	Type	Description
username	`string`	Attribute the invite to a user in your system. It should be the email address of the user
send_sms	`boolean`	(defaults to true) If you are sending the returned invite url through your integration, set to false
channel	`string`	The medium which the applicant was created, Only one of a enumerated lists of options
channel_source	`string`	Additional context for the channel
notes	`string`	Notes to be added to profile. Will be attributed to the integration’s name

Deprecated Parameters:

Parameter	Type	Description
referrer	`string`	This now enters the system as a `channel_source` with a default `channel` of “other”

Channels

other - The default channel
current_customer - When the applicant is a current customer
rep_referral - When the applicant is referred by a rep
web - When the applicant profile is created from a web property
text_message - When the applicant profile is created from an inbound text
phone_call - When the applicant profile is created from an inbound phone call

Channel Sources

This can be any additional information to further segment the channel. For example, for the “web” channel, you might have a channel source of “Facebook” or for “Current Customer” you might have a channel source of the reps name or the account number.

Example Request Body

{
  "full_name": "Jon Smith",
  "phone_number": "254-555-1111",
  "channel": "web",
  "channel_source": "Facebook",
  "send_sms": false,
  "username": "[email protected]"
}

Example Response

You’re returned the applicant ID as well as the URL the applicant can use to complete their application. If you opted to send the SMS invite, the applicant will have received the invite URL via SMS.

{
  "applicant_id": "bafeb9a4-0aec-4bef-afbd-f7af33cc549c",
  "invite_url": "https://demo.approveowl.com/i/BHydmuI"
}