openapi: 3.2.0
info:
  title: Proof Real Estate API Specification Eligibilities API
  version: v2
servers:
- url: https://api.proof.com
  description: Public API URL
tags:
- name: Eligibilities
paths:
  /mortgage/v2/recording_locations:
    get:
      summary: Retrieve Recording Locations
      tags:
      - Eligibilities
      operationId: getRecordingLocations
      security:
      - api_key: []
      parameters:
      - name: transaction_type
        in: query
        schema:
          type: string
          enum:
          - refinance
          - trailing_docs
          - purchase_seller
          - purchase_buyer_cash
          - purchase_buyer_loan
          - heloc
          - loan_mod_borrower
          - other
          - hybrid_refinance
          - hybrid_trailing_docs
          - hybrid_purchase_seller
          - hybrid_purchase_buyer_cash
          - hybrid_purchase_buyer_loan
          - hybrid_heloc
          - hybrid_other
          - wet_sign
          - real_estate_esign
          - real_estate_proof
        required: true
        description: 'Transaction type to be looked up. Will fail on non-mortgage transactions. Valid types are: refinance,trailing_docs,purchase_seller,purchase_buyer_cash,purchase_buyer_loan,heloc,loan_mod_borrower,other,hybrid_refinance,hybrid_trailing_docs,hybrid_purchase_seller,hybrid_purchase_buyer_cash,hybrid_purchase_buyer_loan,hybrid_heloc,hybrid_other,wet_sign,real_estate_esign,real_estate_proof'
        x-example: purchase_buyer_loan
      - name: organization_id
        in: query
        required: false
        description: The organization to check eligibility for. If not included, the organization will be pulled from the API key.
        schema:
          type: string
      - name: street_address[line1]
        in: query
        x-example: 123 test st
        schema:
          type: string
      - name: street_address[line2]
        in: query
        x-example: '6'
        schema:
          type: string
      - name: street_address[city]
        in: query
        x-example: Kane
        schema:
          type: string
      - name: street_address[state]
        in: query
        x-example: IA
        schema:
          type: string
      - name: street_address[postal]
        in: query
        x-example: '51503'
        schema:
          type: string
      - name: street_address[country]
        in: query
        x-example: US
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              example: []
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/recording_location'
        '400':
          description: Bad Request
          content:
            application/json:
              example:
                errors:
                - Transaction type is invalid
              schema:
                $ref: '#/components/schemas/errors_object'
  /mortgage/v2/transactions/title_underwriters:
    get:
      summary: Get Valid Underwriters
      tags:
      - Eligibilities
      operationId: getValidUnderwriters
      security:
      - api_key: []
      parameters:
      - name: transaction_type
        in: query
        schema:
          type: string
          enum:
          - refinance
          - trailing_docs
          - purchase_seller
          - purchase_buyer_cash
          - purchase_buyer_loan
          - heloc
          - loan_mod_borrower
          - other
          - hybrid_refinance
          - hybrid_trailing_docs
          - hybrid_purchase_seller
          - hybrid_purchase_buyer_cash
          - hybrid_purchase_buyer_loan
          - hybrid_heloc
          - hybrid_other
          - wet_sign
          - real_estate_esign
          - real_estate_proof
        required: true
        description: Type of the transaction
        x-example: refinance
      - name: state_abbreviation
        in: query
        required: true
        description: State Transaction is occuring
        x-example: CO
        schema:
          type: string
      - name: title_agent_email
        in: query
        required: false
        description: Title Agent Email
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                title_agent_found: false
                eligible_title_underwriters:
                - id: orxdw5mdg
                  name: Trantow, Hermann and Krajcik
              schema:
                type: object
                properties:
                  title_agent_found:
                    type: boolean
                  eligible_title_underwriters:
                    type: array
                    items:
                      $ref: '#/components/schemas/organization'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                errors:
                - Only available to lenders and title agencies
              schema:
                $ref: '#/components/schemas/errors_object'
        '422':
          description: Unprocessible Entity
          content:
            application/json:
              example:
                errors:
                - 'Invalid state code: XX'
              schema:
                $ref: '#/components/schemas/errors_object'
  /mortgage/v2/transactions/verify_address:
    get:
      summary: Verify Property Address
      tags:
      - Eligibilities
      operationId: verifyPropertyAddress
      security:
      - api_key: []
      parameters:
      - name: transaction_type
        in: query
        schema:
          type: string
          enum:
          - refinance
          - trailing_docs
          - purchase_seller
          - purchase_buyer_cash
          - purchase_buyer_loan
          - heloc
          - loan_mod_borrower
          - other
          - hybrid_refinance
          - hybrid_trailing_docs
          - hybrid_purchase_seller
          - hybrid_purchase_buyer_cash
          - hybrid_purchase_buyer_loan
          - hybrid_heloc
          - hybrid_other
          - wet_sign
          - real_estate_esign
          - real_estate_proof
        required: true
        description: Type of the transaction.
        x-example: purchase_buyer_cash
      - name: organization_id
        in: query
        description: The organization id of a child account. If the authenticated account has child accounts, specifying this parameter will verify the closing property address using the child account's eligibility rules. If this is not provided, we will verify the closing property address using the eligibility rules of the authenticated account.
        x-example: or_rn6o8dq
        schema:
          type: string
      - name: street_address[line1]
        in: query
        required: true
        x-example: 123 test st
        schema:
          type: string
      - name: street_address[line2]
        in: query
        x-example: '5'
        schema:
          type: string
      - name: street_address[city]
        in: query
        required: true
        x-example: Boston
        schema:
          type: string
      - name: street_address[state]
        in: query
        required: true
        x-example: MA
        schema:
          type: string
      - name: street_address[postal]
        in: query
        required: true
        x-example: '20001'
        schema:
          type: string
      - name: street_address[country]
        in: query
        x-example: USA
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              example: []
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/recording_location'
        '400':
          description: Bad Request
          content:
            application/json:
              example:
                errors:
                - Transaction type is invalid
              schema:
                $ref: '#/components/schemas/errors_object'
        '404':
          description: Not Found
          content:
            application/json:
              example:
                errors:
                - 'Not Found: Organization'
              schema:
                $ref: '#/components/schemas/errors_object'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              example:
                errors:
                - Only available to lenders and title agencies
              schema:
                $ref: '#/components/schemas/errors_object'
components:
  schemas:
    title_agency:
      type: object
      properties:
        id:
          type: string
          maxLength: 5000
          description: The ID of the title agency.
        name:
          type: string
          maxLength: 5000
          description: The name of the title agency.
        alta_id:
          type:
          - string
          - 'null'
          maxLength: 5000
          description: The ALTA ID of the title agency.
        address:
          type:
          - string
          - 'null'
          maxLength: 5000
          description: The address of the title agency.
        eligible_underwriters:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/organization'
          description: The list of title underwriters that the title agency works with.
        company_notaries:
          type: boolean
          description: Whether the title agency has company notaries.
    recording_location:
      type: object
      properties:
        id:
          type: string
          maxLength: 5000
          description: The ID of the recording location.
        name:
          type: string
          maxLength: 5000
          description: The name of the recording location.
        state:
          type: string
          maxLength: 5000
          description: The US state of the recording location.
        supported:
          type: boolean
          description: Whether erecording is supported at the recording location
        recording_type:
          type: string
          maxLength: 5000
          description: The type of recording supported at the location. ELECTRONIC, PAPER, or NONE.
        eligible:
          type: boolean
          description: Allowed legally and by organizations preferences.
        eligible_title_agencies:
          type: array
          items:
            $ref: '#/components/schemas/title_agency'
          description: The title agencies that are eligible for the recording location.
        eligible_title_underwriters:
          type: array
          items:
            $ref: '#/components/schemas/organization'
          description: The title underwriters that are eligible for the recording location.
    errors_object:
      type: object
      properties:
        message:
          type: string
          maxLength: 5000
          description: Deprecated; prefer using the errors array instead
        errors:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
          - type: object
    organization:
      type: object
      properties:
        id:
          type: string
          maxLength: 5000
          description: The ID of the organization.
        name:
          type: string
          maxLength: 5000
          description: The name of the organization.
  securitySchemes:
    api_key:
      type: apiKey
      name: ApiKey
      in: header
x-provenance:
  method: searched
  source: https://dev.proof.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://dev.proof.com/reference/addenote.md
  - https://dev.proof.com/reference/addmortgagedocument.md
  - https://dev.proof.com/reference/addmortgageexternaldocument.md
  - https://dev.proof.com/reference/cancelmortgagetransaction.md
  - https://dev.proof.com/reference/createmortgagenotary.md
  - https://dev.proof.com/reference/createmortgagepartnerorganization.md
  - https://dev.proof.com/reference/createmortgagetransaction.md
  - https://dev.proof.com/reference/createmortgagewebhookurl.md
  - https://dev.proof.com/reference/createmortgagewebhookv2.md
  - https://dev.proof.com/reference/createtestwebhook-1.md
  - https://dev.proof.com/reference/deleteenote.md
  - https://dev.proof.com/reference/deletemortgagedocument.md
  - https://dev.proof.com/reference/deletemortgagenotary.md
  - https://dev.proof.com/reference/deletemortgagetransaction.md
  - https://dev.proof.com/reference/deletemortgagewebhookurl.md
  - https://dev.proof.com/reference/deletemortgagewebhookv2.md
  - https://dev.proof.com/reference/forcecompletetransaction-1.md
  - https://dev.proof.com/reference/get_mortgage-v2-title-agencies.md
  - https://dev.proof.com/reference/getalleligiblenotaries-1.md
  - https://dev.proof.com/reference/getallmortgagenotaries.md
  - https://dev.proof.com/reference/getallmortgagetransactions.md
  - https://dev.proof.com/reference/getallmortgagewebhooksv2.md
  - https://dev.proof.com/reference/getallrealestatecostcenters.md
  - https://dev.proof.com/reference/getallrealestatetemplates.md
  - https://dev.proof.com/reference/getmortgagedocument.md
  - https://dev.proof.com/reference/getmortgagenotarizationrecord.md
  - https://dev.proof.com/reference/getmortgagenotary.md
  - https://dev.proof.com/reference/getmortgagetransaction.md
  - https://dev.proof.com/reference/getmortgagewebhookeventsv2.md
  - https://dev.proof.com/reference/getmortgagewebhooksubscriptionsv2.md
  - https://dev.proof.com/reference/getmortgagewebhookurl.md
  - https://dev.proof.com/reference/getmortgagewebhookv2.md
  - https://dev.proof.com/reference/getrecordinglocations.md
  - https://dev.proof.com/reference/getvalidunderwriters.md
  - https://dev.proof.com/reference/patchmortgagedocuments.md
  - https://dev.proof.com/reference/placeorder.md
  - https://dev.proof.com/reference/recalltransaction.md
  - https://dev.proof.com/reference/resendmortgagecontactsemail.md
  - https://dev.proof.com/reference/resendmortgagetransactionemail.md
  - https://dev.proof.com/reference/resendmortgagetransactionsms.md
  - https://dev.proof.com/reference/updatemortgagedocuments.md
  - https://dev.proof.com/reference/updatemortgagepartnerorganization.md
  - https://dev.proof.com/reference/updatemortgagetransaction.md
  - https://dev.proof.com/reference/updatemortgagewebhookv2.md
  - https://dev.proof.com/reference/verifypropertyaddress.md
  merge:
    pages: 45
    deduped: 416
    conflicts_kept_first: 0