API Reference
  1. Viv Public API
  2. Applicants

Create applicant

post
https://{apiHost}/api/v2/public/applicants

Create a new caregiver application.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Applicant input for create/update operations

string

Applicant's first name

string

Applicant's last name

string

Primary phone number (will be normalized to digits only)

string

Email address (will be normalized to lowercase)

date

Date of birth (YYYY-MM-DD)

string
enum

Gender (only 'male' or 'female' accepted)

Allowed:
address
object

Standard address format used across the API (matches internal manualAddressSchema)

string

Geographic location ID

string
enum

Application status

source
object

Referral source information

string

External system identifier

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?