Skip to navigation
API ReferenceApplications

Add Customer To Application

Add a customer (adult occupant) to an application. This can be used to add additional adults to the application.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

applicationIdstringRequiredformat: "uuid"
The id of the application

Request

This endpoint expects an object.
isPrimarybooleanRequired
Whether this customer is the primary applicant
firstNamestringRequired
lastNamestringRequired
phonedoubleRequired
applicantTypeenumRequired
emailstringOptionalformat: "email"
relationshipenumOptional

Response

Customer added successfully
idstringOptionalformat: "uuid"
firstNamestringOptional
lastNamestringOptional
middleNamestringOptional
preferredNamestringOptional
statusstringOptional
genderstringOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional
deletedAtdatetimeOptional
phonedoubleOptional
emailstringOptional
birthDatedateOptional
idempotencyIdstring or nullOptional
readableIdstring or nullOptional