Create a new property

post

https://enterprise-api.demo.snappt.com/properties

To set up your account, add one or more properties. All applicant sessions are associated with a company and property ID. Note that you cannot delete properties through the Snappt Enterprise API. If you no longer need a property, use the PUT /properties/:id API to set it's status to DISABLED.

Body Params

name

string

required

string

required

address

string

required

city

string

required

zip

string

required

state

string | null

entityName

string | null

logo

string | null

phone

string

phoneIsRequired

boolean | null

website

string | null

unit

number

required

> 1

pmcName

string | null

unitIsRequired

boolean | null

status

string

enum

required

Allowed:

bankStatement

number | null

paystub

number | null

supportedDoctypes

object | null

identityVerificationReportImageTypes

array of strings

identityVerificationReportImageTypes

incomeVerificationEnabled

boolean

Pass true to enable Income Verification. If omitted, the current value is unchanged.

assetVerificationEnabled

boolean

Pass true to enable Asset Verification. If omitted, the current value is unchanged.

identityVerificationEnabled

boolean

Pass true to enable Identity Verification. If omitted, the current value is unchanged.

payrollLinkingEnabled

boolean

Pass true to enable Payroll Linking. If omitted, the current value is unchanged.

bankLinkingEnabled

boolean

Pass true to enable Bank Linking. If omitted, the current value is unchanged.

referenceCompletedNotificationEnabled

boolean

Pass true to enable Reference Completed Notification. If omitted, the current value is unchanged.

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400The request payload or query string parameter you passed was not valid

401The Authorization header or Snappt applicant session token you passed was not valid