Snappt Properties API

openapi: 3.2.0
info:
  version: 1.75.3
  title: Snappt Properties API
  description: Welcome to the Snappt API! API endpoints require a Snappt partner API key passed in the HTTP Authorization header.
servers:
- url: https://enterprise-api.demo.snappt.com
security:
- {}
- bearerAuth: []
tags:
- name: Properties
paths:
  /properties:
    get:
      tags:
      - Properties
      summary: List properties
      parameters:
      - schema:
          type: number
          description: The total number of rows to respond with. Defaults to 5000.
        required: false
        name: rowsPerPage
        in: query
      - schema:
          type: number
          description: The current page. Defaults to 0.
        required: false
        name: page
        in: query
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                    shortId:
                      type: string
                    name:
                      type: string
                    entityName:
                      type:
                      - string
                      - 'null'
                    logo:
                      type:
                      - string
                      - 'null'
                    phone:
                      type:
                      - string
                      - 'null'
                    phoneIsRequired:
                      type:
                      - boolean
                      - 'null'
                    website:
                      type:
                      - string
                      - 'null'
                    unit:
                      type:
                      - string
                      - 'null'
                    unitIsRequired:
                      type:
                      - boolean
                      - 'null'
                    address:
                      type: string
                    city:
                      type: string
                    state:
                      type:
                      - string
                      - 'null'
                    zip:
                      type: string
                    status:
                      type: string
                      enum:
                      - ACTIVE
                      - ARCHIVED
                      - DISABLED
                    supportedDoctypes:
                      type:
                      - object
                      - 'null'
                      properties:
                        paystub:
                          type: number
                        bank_statement:
                          type: number
                        cash_app_statement:
                          type: number
                        credit_debit_card_statement:
                          type: number
                        department_of_veterans_affairs_benefit_letter:
                          type: number
                        investment_account:
                          type: number
                        social_security_benefits_letter:
                          type: number
                        social_security_statement:
                          type: number
                        tax_transcript:
                          type: number
                        utility_bill:
                          type: number
                        payroll_statement:
                          type: number
                        bank_linking_verification_of_income:
                          type: number
                        tax_return_linking_report:
                          type: number
                        w2:
                          type: number
                        child_support:
                          type: number
                        financial_aid:
                          type: number
                        offer_letter:
                          type: number
                        student_visa:
                          type: number
                    bankStatement:
                      type:
                      - number
                      - 'null'
                    paystub:
                      type:
                      - number
                      - 'null'
                    email:
                      type:
                      - string
                      - 'null'
                      format: email
                    companyId:
                      type:
                      - string
                      - 'null'
                      format: uuid
                    companyShortId:
                      type:
                      - string
                      - 'null'
                    pmcName:
                      type:
                      - string
                      - 'null'
                    applicantLink:
                      type: string
                    leasingTeamLink:
                      type: string
                    identityVerificationEnabled:
                      type:
                      - boolean
                      - 'null'
                    incomeVerificationEnabled:
                      type:
                      - boolean
                      - 'null'
                    assetVerificationEnabled:
                      type:
                      - boolean
                      - 'null'
                    payrollLinkingEnabled:
                      type:
                      - boolean
                      - 'null'
                    bankLinkingEnabled:
                      type:
                      - boolean
                      - 'null'
                    insertedAt:
                      type: string
                      description: An ISO-formattted datetime
                    updatedAt:
                      type: string
                      description: An ISO-formattted datetime
                    propertyFeature:
                      type:
                      - object
                      - 'null'
                      properties:
                        featureCode:
                          type: string
                          enum:
                          - payroll_linking
                          - bank_linking
                          - rental_history
                          - income_verification
                          - asset_verification
                          - identity_verification
                          - reference_completed_notification
                        state:
                          type: string
                          enum:
                          - enabled
                          - disabled
                      required:
                      - featureCode
                      - state
                  required:
                  - id
                  - shortId
                  - name
                  - entityName
                  - logo
                  - phone
                  - phoneIsRequired
                  - website
                  - unit
                  - unitIsRequired
                  - address
                  - city
                  - state
                  - zip
                  - status
                  - bankStatement
                  - paystub
                  - email
                  - companyId
                  - companyShortId
                  - applicantLink
                  - leasingTeamLink
                  - identityVerificationEnabled
                  - insertedAt
                  - updatedAt
        '400':
          description: The request payload or query string parameter you passed was not valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '401':
          description: The Authorization header or Snappt applicant session token you passed was not valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
    post:
      tags:
      - Properties
      summary: Create a new property
      description: 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.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                email:
                  type: string
                  format: email
                address:
                  type: string
                city:
                  type: string
                zip:
                  type: string
                state:
                  type:
                  - string
                  - 'null'
                entityName:
                  type:
                  - string
                  - 'null'
                logo:
                  type:
                  - string
                  - 'null'
                phone:
                  type: string
                phoneIsRequired:
                  type:
                  - boolean
                  - 'null'
                website:
                  type:
                  - string
                  - 'null'
                unit:
                  type: number
                  exclusiveMinimum: 1
                pmcName:
                  type:
                  - string
                  - 'null'
                unitIsRequired:
                  type:
                  - boolean
                  - 'null'
                status:
                  type: string
                  enum:
                  - ACTIVE
                  - ARCHIVED
                  - DISABLED
                bankStatement:
                  type:
                  - number
                  - 'null'
                paystub:
                  type:
                  - number
                  - 'null'
                supportedDoctypes:
                  type:
                  - object
                  - 'null'
                  properties:
                    paystub:
                      type: number
                    bank_statement:
                      type: number
                    cash_app_statement:
                      type: number
                    credit_debit_card_statement:
                      type: number
                    department_of_veterans_affairs_benefit_letter:
                      type: number
                    investment_account:
                      type: number
                    social_security_benefits_letter:
                      type: number
                    social_security_statement:
                      type: number
                    tax_transcript:
                      type: number
                    utility_bill:
                      type: number
                    payroll_statement:
                      type: number
                    bank_linking_verification_of_income:
                      type: number
                    tax_return_linking_report:
                      type: number
                    w2:
                      type: number
                    child_support:
                      type: number
                    financial_aid:
                      type: number
                    offer_letter:
                      type: number
                    student_visa:
                      type: number
                identityVerificationReportImageTypes:
                  type: array
                  items:
                    type: string
                    enum:
                    - selfie
                    - document
                    - none
                incomeVerificationEnabled:
                  type: boolean
                  description: Pass true to enable Income Verification. If omitted, the current value is unchanged.
                assetVerificationEnabled:
                  type: boolean
                  description: Pass true to enable Asset Verification. If omitted, the current value is unchanged.
                identityVerificationEnabled:
                  type: boolean
                  description: Pass true to enable Identity Verification. If omitted, the current value is unchanged.
                payrollLinkingEnabled:
                  type: boolean
                  description: Pass true to enable Payroll Linking. If omitted, the current value is unchanged.
                bankLinkingEnabled:
                  type: boolean
                  description: Pass true to enable Bank Linking. If omitted, the current value is unchanged.
                referenceCompletedNotificationEnabled:
                  type: boolean
                  description: Pass true to enable Reference Completed Notification. If omitted, the current value is unchanged.
              required:
              - name
              - email
              - address
              - city
              - zip
              - unit
              - status
              additionalProperties: false
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                    shortId:
                      type: string
                    name:
                      type: string
                    entityName:
                      type:
                      - string
                      - 'null'
                    logo:
                      type:
                      - string
                      - 'null'
                    phone:
                      type:
                      - string
                      - 'null'
                    phoneIsRequired:
                      type:
                      - boolean
                      - 'null'
                    website:
                      type:
                      - string
                      - 'null'
                    unit:
                      type:
                      - string
                      - 'null'
                    unitIsRequired:
                      type:
                      - boolean
                      - 'null'
                    address:
                      type: string
                    city:
                      type: string
                    state:
                      type:
                      - string
                      - 'null'
                    zip:
                      type: string
                    status:
                      type: string
                      enum:
                      - ACTIVE
                      - ARCHIVED
                      - DISABLED
                    supportedDoctypes:
                      type:
                      - object
                      - 'null'
                      properties:
                        paystub:
                          type: number
                        bank_statement:
                          type: number
                        cash_app_statement:
                          type: number
                        credit_debit_card_statement:
                          type: number
                        department_of_veterans_affairs_benefit_letter:
                          type: number
                        investment_account:
                          type: number
                        social_security_benefits_letter:
                          type: number
                        social_security_statement:
                          type: number
                        tax_transcript:
                          type: number
                        utility_bill:
                          type: number
                        payroll_statement:
                          type: number
                        bank_linking_verification_of_income:
                          type: number
                        tax_return_linking_report:
                          type: number
                        w2:
                          type: number
                        child_support:
                          type: number
                        financial_aid:
                          type: number
                        offer_letter:
                          type: number
                        student_visa:
                          type: number
                    bankStatement:
                      type:
                      - number
                      - 'null'
                    paystub:
                      type:
                      - number
                      - 'null'
                    email:
                      type:
                      - string
                      - 'null'
                      format: email
                    companyId:
                      type:
                      - string
                      - 'null'
                      format: uuid
                    companyShortId:
                      type:
                      - string
                      - 'null'
                    pmcName:
                      type:
                      - string
                      - 'null'
                    applicantLink:
                      type: string
                    leasingTeamLink:
                      type: string
                    identityVerificationEnabled:
                      type:
                      - boolean
                      - 'null'
                    incomeVerificationEnabled:
                      type:
                      - boolean
                      - 'null'
                    assetVerificationEnabled:
                      type:
                      - boolean
                      - 'null'
                    payrollLinkingEnabled:
                      type:
                      - boolean
                      - 'null'
                    bankLinkingEnabled:
                      type:
                      - boolean
                      - 'null'
                    insertedAt:
                      type: string
                      description: An ISO-formattted datetime
                    updatedAt:
                      type: string
                      description: An ISO-formattted datetime
                    propertyFeature:
                      type:
                      - object
                      - 'null'
                      properties:
                        featureCode:
                          type: string
                          enum:
                          - payroll_linking
                          - bank_linking
                          - rental_history
                          - income_verification
                          - asset_verification
                          - identity_verification
                          - reference_completed_notification
                        state:
                          type: string
                          enum:
                          - enabled
                          - disabled
                      required:
                      - featureCode
                      - state
                  required:
                  - id
                  - shortId
                  - name
                  - entityName
                  - logo
                  - phone
                  - phoneIsRequired
                  - website
                  - unit
                  - unitIsRequired
                  - address
                  - city
                  - state
                  - zip
                  - status
                  - bankStatement
                  - paystub
                  - email
                  - companyId
                  - companyShortId
                  - applicantLink
                  - leasingTeamLink
                  - identityVerificationEnabled
                  - insertedAt
                  - updatedAt
                - type: object
                  properties:
                    error:
                      type: string
                    propertyId:
                      type: string
                      format: uuid
                  required:
                  - error
                  additionalProperties: false
        '400':
          description: The request payload or query string parameter you passed was not valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '401':
          description: The Authorization header or Snappt applicant session token you passed was not valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
  /properties/{propertyId}:
    get:
      tags:
      - Properties
      summary: Retrieve a property
      parameters:
      - schema:
          type: string
        required: true
        name: propertyId
        in: path
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                    shortId:
                      type: string
                    name:
                      type: string
                    entityName:
                      type:
                      - string
                      - 'null'
                    logo:
                      type:
                      - string
                      - 'null'
                    phone:
                      type:
                      - string
                      - 'null'
                    phoneIsRequired:
                      type:
                      - boolean
                      - 'null'
                    website:
                      type:
                      - string
                      - 'null'
                    unit:
                      type:
                      - string
                      - 'null'
                    unitIsRequired:
                      type:
                      - boolean
                      - 'null'
                    address:
                      type: string
                    city:
                      type: string
                    state:
                      type:
                      - string
                      - 'null'
                    zip:
                      type: string
                    status:
                      type: string
                      enum:
                      - ACTIVE
                      - ARCHIVED
                      - DISABLED
                    supportedDoctypes:
                      type:
                      - object
                      - 'null'
                      properties:
                        paystub:
                          type: number
                        bank_statement:
                          type: number
                        cash_app_statement:
                          type: number
                        credit_debit_card_statement:
                          type: number
                        department_of_veterans_affairs_benefit_letter:
                          type: number
                        investment_account:
                          type: number
                        social_security_benefits_letter:
                          type: number
                        social_security_statement:
                          type: number
                        tax_transcript:
                          type: number
                        utility_bill:
                          type: number
                        payroll_statement:
                          type: number
                        bank_linking_verification_of_income:
                          type: number
                        tax_return_linking_report:
                          type: number
                        w2:
                          type: number
                        child_support:
                          type: number
                        financial_aid:
                          type: number
                        offer_letter:
                          type: number
                        student_visa:
                          type: number
                    bankStatement:
                      type:
                      - number
                      - 'null'
                    paystub:
                      type:
                      - number
                      - 'null'
                    email:
                      type:
                      - string
                      - 'null'
                      format: email
                    companyId:
                      type:
                      - string
                      - 'null'
                      format: uuid
                    companyShortId:
                      type:
                      - string
                      - 'null'
                    pmcName:
                      type:
                      - string
                      - 'null'
                    applicantLink:
                      type: string
                    leasingTeamLink:
                      type: string
                    identityVerificationEnabled:
                      type:
                      - boolean
                      - 'null'
                    incomeVerificationEnabled:
                      type:
                      - boolean
                      - 'null'
                    assetVerificationEnabled:
                      type:
                      - boolean
                      - 'null'
                    payrollLinkingEnabled:
                      type:
                      - boolean
                      - 'null'
                    bankLinkingEnabled:
                      type:
                      - boolean
                      - 'null'
                    insertedAt:
                      type: string
                      description: An ISO-formattted datetime
                    updatedAt:
                      type: string
                      description: An ISO-formattted datetime
                    propertyFeature:
                      type:
                      - object
                      - 'null'
                      properties:
                        featureCode:
                          type: string
                          enum:
                          - payroll_linking
                          - bank_linking
                          - rental_history
                          - income_verification
                          - asset_verification
                          - identity_verification
                          - reference_completed_notification
                        state:
                          type: string
                          enum:
                          - enabled
                          - disabled
                      required:
                      - featureCode
                      - state
                  required:
                  - id
                  - shortId
                  - name
                  - entityName
                  - logo
                  - phone
                  - phoneIsRequired
                  - website
                  - unit
                  - unitIsRequired
                  - address
                  - city
                  - state
                  - zip
                  - status
                  - bankStatement
                  - paystub
                  - email
                  - companyId
                  - companyShortId
                  - applicantLink
                  - leasingTeamLink
                  - identityVerificationEnabled
                  - insertedAt
                  - updatedAt
                - type: object
                  properties:
                    error:
                      type: string
                  required:
                  - error
        '401':
          description: The Authorization header or Snappt applicant session token you passed was not valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: The item you requested could not be found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
    put:
      tags:
      - Properties
      summary: Update a property
      parameters:
      - schema:
          type: string
        required: true
        name: propertyId
        in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                email:
                  type: string
                  format: email
                address:
                  type: string
                city:
                  type: string
                zip:
                  type: string
                state:
                  type:
                  - string
                  - 'null'
                entityName:
                  type:
                  - string
                  - 'null'
                logo:
                  type:
                  - string
                  - 'null'
                phone:
                  type: string
                phoneIsRequired:
                  type:
                  - boolean
                  - 'null'
                website:
                  type:
                  - string
                  - 'null'
                unit:
                  type: number
                  exclusiveMinimum: 1
                pmcName:
                  type:
                  - string
                  - 'null'
                unitIsRequired:
                  type:
                  - boolean
                  - 'null'
                status:
                  type: string
                  enum:
                  - ACTIVE
                  - ARCHIVED
                  - DISABLED
                bankStatement:
                  type:
                  - number
                  - 'null'
                paystub:
                  type:
                  - number
                  - 'null'
                supportedDoctypes:
                  type:
                  - object
                  - 'null'
                  properties:
                    paystub:
                      type: number
                    bank_statement:
                      type: number
                    cash_app_statement:
                      type: number
                    credit_debit_card_statement:
                      type: number
                    department_of_veterans_affairs_benefit_letter:
                      type: number
                    investment_account:
                      type: number
                    social_security_benefits_letter:
                      type: number
                    social_security_statement:
                      type: number
                    tax_transcript:
                      type: number
                    utility_bill:
                      type: number
                    payroll_statement:
                      type: number
                    bank_linking_verification_of_income:
                      type: number
                    tax_return_linking_report:
                

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/snappt/refs/heads/main/openapi/snappt-properties-api-openapi.yml