Propertyware SOAPApplicants

Create Applicant: Propertyware

Create Applicant: Propertyware | Method | |---| | createApplicant | | attachDocumentToContact |

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
property_idstringRequired
The Propexo unique identifier for the property
integration_idstringRequired
The Propexo unique identifier for the integration
address_1stringOptional
First line of the street address for the applicant. This maps to the addressLine1 property of the Applicant's primary address
address_2stringOptional
Second line of the street address for the applicant. This maps to the addressLine2 property of the Applicant's primary address.
citystringOptional
City of the applicant's primary address. This maps to the city property of the Applicant's primary address.
date_of_birthstringOptionalformat: "date-time"
Date of birth of the applicant. This maps to the birthDate property of the Applicant object.
email_1stringOptionalformat: "email"
The primary email address for the applicant. This value maps to the email property of the Applicant object
first_namestringOptional
The first name of the applicant. This value maps to the firstName property of the Applicant object.
last_namestringOptional
The last name of the applicant. This value maps to the lastName property of the Applicant object
phone_1stringOptional
Applicant's primary phone number. This maps to the phoneNumber property of the Applicant object.
phone_1_typeenumOptional
The type of the applicant's primary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. This maps to the phoneNumberTypeId property of the Applicant object.
Allowed values:
phone_2stringOptional
Applicant's secondary phone number. This maps to the phoneNumber property of the Applicant object.
phone_2_typeenumOptional
The type of the applicant's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. This maps to the phoneNumberTypeId property of the Applicant object.
Allowed values:
statestringOptional
State of the resident's primary address. This maps to the stateCode property of the Applicant's primary address.
unit_idstringOptional
The Propexo unique identifier for the unit
zipstringOptional

Zip/Postal Code of the resident’s primary address. This maps to the postalCode property of the Applicant’s primary address.

attachmentslist of objectsOptional
Files to upload to the applicant.
custom_dataobjectOptionalDeprecated

Deprecated: Field is no longer applicable

Response

Successful response
metaobject
resultobject

Errors