Fee

Closing-cost computation: the fee set on a closing disclosure, comparison between successive disclosures, and buy-up and buy-down mechanics.

A caller sends the loan and the fees known so far and receives the computed closing-cost set, itemised into the sections the disclosure requires.

Comparison between two disclosures is a first-class operation rather than a diff left to the caller: the answer is whether a change is one the tolerance rules permit, which is a computation over the pair.

How it works

Buy-up and buy-down are handled as an adjustment to the rate-price pair rather than as a separate fee line, because that is what they are: paying points moves the price, and the fee schedule follows from it. Keeping the mechanic where the price lives is what keeps the disclosure consistent with the lock.

Operations

Setup

GET /ernst/credentials

Get Ernst Credentials

getErnstCredentials

Get credentials of Ernst saved beforehand

Response

application/json

Setup API Triggered Successfully

{
  "username": "--------",
  "password": "<redacted>",
  "title_provider_orderings": {
    "default_ordering": [
      "fidelity",
      "first_american",
      "stewart"
    ]
  }
}

application/json

Setup API Triggered Successfully

{
  "username": "--------",
  "password": "<redacted>",
  "title_provider_orderings": {
    "states": [
      {
        "state_code": "CA",
        "default_ordering": [
          "first_american",
          "stewart"
        ]
      }
    ]
  }
}

application/json

Setup API Triggered Successfully

{
  "username": "--------",
  "password": "<redacted>",
  "title_provider_orderings": {
    "states": [
      {
        "state_code": "CA",
        "default_ordering": [
          "first_american",
          "stewart"
        ],
        "counties": [
          {
            "county_name": "Alameda County",
            "default_ordering": [
              "first_american",
              "stewart"
            ]
          }
        ]
      }
    ]
  }
}

application/json

Setup API Triggered Successfully

{
  "username": "--------",
  "password": "<redacted>",
  "title_provider_orderings": {
    "default_ordering": [
      "stewart",
      "fidelity",
      "first_american"
    ],
    "states": [
      {
        "state_code": "NY",
        "default_ordering": [
          "stewart",
          "fidelity"
        ],
        "counties": [
          {
            "county_name": "Suffolk",
            "default_ordering": [
              "fidelity",
              "stewart"
            ],
            "cities": [
              {
                "city_name": "Riverhead",
                "default_ordering": [
                  "fidelity",
                  "first_american"
                ]
              }
            ]
          }
        ]
      },
      {
        "state_code": "CA",
        "default_ordering": [
          "first_american",
          "fidelity"
        ]
      }
    ]
  }
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`	Staircase Environment API Key

Response `200application/json`

3 fields

Setup API Triggered Successfully

Field	Type	Description
`username`	`string`	Ernst username
`password`	`string`	Ernst password
`title_provider_orderings`	`object`	An object to set default title fees' provider list for states, counties and cities
`default_ordering`	`string[]`	Root default ordering for title fees' provider
`states`	`object[]`	States
`state_code`	`string`	State code
`default_ordering`	`string[]`	Default title provider ordering for the state
`counties`	`object[]`	Counties
`county_name`	`string`	County name
`default_ordering`	`string[]`	Default title provider ordering for the county
`cities`	`object[]`	Cities

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`string`	Message

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `404application/json`

1 fields

Setup API Triggered Successfully

Field	Type	Description
`message`	`string`	Message

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

POST /ernst/credentials

Set Ernst Credentials

setErnstCredentials

Set credentials to be used when Ernst is selected as Fees vendor.

Usage

You need to set your Ernst credentials to use Ernst as a vendor in Fees product. username and password are required credentials.

For title fees Ernst works with three providers. You can choose the provider that is going to be used for the title fees. There are three available providers: Stewart, Fidelity and First American.title_provider_orderings is an array field that you can use to set your default provider choices for states, counties and cities.

Show the rest

Example:

{
 "title_provider_orderings": {
 "default_ordering": [
 "stewart",
 "fidelity",
 "first_american"
 ],
 "states": [
 {
 "state_code": "NY",
 "default_ordering": [
 "stewart",
 "fidelity"
 ],
 "counties": [
 {
 "county_name": "Suffolk",
 "default_ordering": [
 "fidelity",
 "stewart"
 ],
 "cities": [
 {
 "city_name": "Riverhead",
 "default_ordering": [
 "fidelity",
 "first_american"
 ]
 }
 ]
 }
 ]
 },
 {
 "state_code": "CA",
 "default_ordering": [
 "first_american",
 "fidelity"
 ]
 }
 ]
 }
}

Fees will check your default choices and find the most specific address in title_provider_ordering matching the address sent in the request.

For example if your address object in the request is the following :

{
 "has_county_name": {
 "has_value": "Suffolk"
 },
 "has_state_code": {
 "has_value": "NY"
 },
 "has_city_name": {
 "has_value": "Riverhead"
 }
}

Fees will first try Fidelity, and then First American, since this is the ordering for Riverhead, NY, according to configuration.

If the address in the request is in NY state but in Westchester County, Fees will first try Stewart, and then Fidelity because that is the default ordering for NY according to configuration and there is no default ordering specified for Westchester County.

If the request has an address in TX state, the root ordering in title_provider_orderings will be used meaning that Fees will first try Stewart , then Fidelity, and only if all of them fails First American will be tried.

Request

application/json

{
  "username": "--------",
  "password": "<redacted>",
  "title_provider_orderings": {
    "default_ordering": [
      "fidelity",
      "first_american",
      "stewart"
    ]
  }
}

application/json

{
  "username": "--------",
  "password": "<redacted>",
  "title_provider_orderings": {
    "states": [
      {
        "state_code": "CA",
        "default_ordering": [
          "first_american",
          "stewart"
        ]
      }
    ]
  }
}

application/json

{
  "username": "--------",
  "password": "<redacted>",
  "title_provider_orderings": {
    "states": [
      {
        "state_code": "CA",
        "default_ordering": [
          "first_american",
          "stewart"
        ],
        "counties": [
          {
            "county_name": "Alameda County",
            "default_ordering": [
              "first_american",
              "stewart"
            ]
          }
        ]
      }
    ]
  }
}

application/json

{
  "username": "--------",
  "password": "<redacted>",
  "title_provider_orderings": {
    "default_ordering": [
      "stewart",
      "fidelity",
      "first_american"
    ],
    "states": [
      {
        "state_code": "NY",
        "default_ordering": [
          "stewart",
          "fidelity"
        ],
        "counties": [
          {
            "county_name": "Suffolk",
            "default_ordering": [
              "fidelity",
              "stewart"
            ],
            "cities": [
              {
                "city_name": "Riverhead",
                "default_ordering": [
                  "fidelity",
                  "first_american"
                ]
              }
            ]
          }
        ]
      },
      {
        "state_code": "CA",
        "default_ordering": [
          "first_american",
          "fidelity"
        ]
      }
    ]
  }
}

Response

application/json

Setup API Triggered Successfully

{
  "message": "Credentials are saved"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`	Staircase Environment API Key

Request body`application/json`

3 fields

Field	Type	Description
`username`	`string`	Ernst username
`password`	`string`	Ernst password
`title_provider_orderings`	`object`	An object to set default title fees' provider list for states, counties and cities
`default_ordering`	`string[]`	Root default ordering for title fees' provider
`states`	`object[]`	States
`state_code`	`string`	State code
`default_ordering`	`string[]`	Default title provider ordering for the state
`counties`	`object[]`	Counties
`county_name`	`string`	County name
`default_ordering`	`string[]`	Default title provider ordering for the county
`cities`	`object[]`	Cities

Response `200application/json`

1 fields

Setup API Triggered Successfully

Field	Type	Description
`message`	`string`	Message

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`string`	Message

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `404application/json`

1 fields

Setup API Triggered Successfully

Field	Type	Description
`message`	`string`	Message

Response `422application/json`

2 fields

Request data failed validation

Field	Type	Description
`message`	`string`	Message
`error`	`string`	Message

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Fees

GET /products/fees/info

Fees Info

Fees Info

Get Fees Product Info

Response

application/json

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `200application/json`

1 fields

Setup API Triggered Successfully

Field	Type	Description
`message`	`string`	Message

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`string`	Message

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `422application/json`

2 fields

Request data failed validation

Field	Type	Description
`message`	`string`	Message
`error`	`string`	Message

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

404

Workflow

POST /products/fees/invocations

Invoke Product Flow

InvokeSpecificProductFlow

This endpoint retrieves the fees that may arise during closing.

Usage

You can send a request in two different ways:

Using request_data: If you provide this parameter, flow invocation would use the data here as input. If you also provide a transaction_id in the request body, Response Collection would be created in the related Transaction object. If you don't provide a transaction_id we will automatically create a Transaction for you and Response Collection would be created in this new Transaction as well.
Using transaction_id and request_collection_id: If you already have a request collection, you can provide its details using these two parameters. Note that in this case Response Collection would be created in the provided Transaction.

Note: You cannot provide product_flow_name and vendor_name parameters together. When provided together, simply product_flow_name is used.

Show the rest

Retrieving the Invocation Result

After invocation, endpoint returns an invocation_id which you can poll for its status using /products/fees/invocations/{invocation_id} endpoint. Once the invocation is completed, the Response Collection is populated with these search results.

If you would rather receive a callback once the invocation is completed instead of polling it, you can set callback_url parameter in the request body.

Request Collection Description

Mortgage & Deed Recording Taxes & Fees

Each State requests specific information to calculate recording fees & taxes. Based on this information expected fees may increase or decrease. The set of questions asked by states change according to the loan purpose (purchase, refinancing or a modification).

Purchase, Refinancing, Modification Purposes

Following questions are answered for all loan purpose types:

Impacting States	Question	Provided In	Default
AL, FL, GA, NY, OK	Is Lender a Credit Union?	`organizations[@type=lender].has_credit_union_indicator.has_value`	`false`
CA, HI, IL, MD, VT	Will Buyer stay in the newly purchased House?	`declarations[0].has_intent_to_occupy_indicator.has_value`	`false`
N/A	DC, ME, TN	Fair Market Value	`property_valuations[0].has_property_valuation_amount.has_value`
DC, DE, MA, MD	Is this Buyer's first home purchase?	`declarations[0].has_borrower_first_time_home_buyer_indicator.has_value`	`false`
DC, NY	Property Project Type	`properties[@type=subject_property].has_project_type.has_value`	N/A
FL, KS, LA, NY	Number of Units in Property	`properties[@type=subject_property].has_number_of_units_type.has_value`	N/A
IL	Age / Birth Date of Borrower	`people[@type=borrower].has_birth_date.has_value`	N/A
CT, KY	Is the document being recorded a MERS document	`loans[0].has_mers_mortgage_identification_number.has_value`	N/A
PA	Are the seller/developer and the builder affiliated?	`declarations[0].has_seller_or_developer_affiliated_with_builder_indicator.has_value`	`false`
NJ	Is the borrower senior citizen, blind or disabled person?	`declarations[0].current_owner_is_senior_citizen_blind_or_disabled_person_indicator.has_value`
N/A	CA, MI, NJ, TN	Is this a taxable Quit Claim Deed?	`documents[@type=conveyance_deed_quit_claim_deed]` should exist
MD	Is the Deed of Trust being recorded an Indemnity Deed of Trust?	`documents[@type=indemnity_deed_of_trust]` should exist	N/A
CA, CT, DC, DE, IL, MD, NY	Property Usage Type	`properties[@type=subject_property].has_land_use_type.has_value`	N/A
DC, ME, NJ, TN, VA	Sales Price	`sales_contracts[@type=subject_property].has_sales_contract_amount.has_value`	N/A
MD	Loan Closing Date	`loans[0].has_loan_closing_date.has_value`	N/A
CA, DE, MD	Is the property occupied by the owner?	`properties[@type=subject_property].has_property_current_occupancy_type.has_value`	N/A
AL, CA, DC, LA, MD	Loan Purpose Type	`loans[@id={current_loan_id}].with_loan_terms,loan_terms[0].has_loan_purpose_type.has_value`	N/A
NY	Does borrower owe liability with heloc type	First add a liability with 'heloc' type: `liabilities[has_liability_type=heloc]` then connect it to your borrower object by adding liability id to following field: `people[@type=borrower].owes_liability`	N/A
CA, NY	Parcel count related to property	First add parcel identifications to following container `parcel_identifications` then connect the parcels to your legal descriptions by adding their ids to following field: `legal_descriptions[0].with_parcel_identification`	N/A
FL	Land description count	First add land descriptions to the following containers identifications to following container `unplatted_lands` `platted_lands` then reference them by adding their ids into the following field of related parsed_legal_descriptions `parsed_legal_descriptions[*].with_unplatted_land` `parsed_legal_descriptions[0].platted_land`	N/A
AL	Is the time to pay being extended?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_al_modification_time_to_pay_extended_indicator.has_value`	N/A
AL	Is the amount of the loan increasing from the original amount?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_al_modification_loan_amount_increasing_from_original_indicator.has_value`	N/A
CA	Is the recording exempt from the additional Real Estate Fraud Prosecution Trust Fund Fee pursuant to Cal Govt. Code § 27388?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_ca_all_recording_exempt_from_additional_real_estate_fraud_prosecution_trust_fund_fee_indicator.has_value`	N/A
CA	Is this a taxable Quit Claim Deed?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_ca_deed_taxable_quit_claim_deed_indicator.has_value`	N/A
CA	Is this document a Multi-Caption document?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_ca_release_multicaption_document_indicator.has_value`	N/A
CA	How many captions or titles on this document?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_ca_release_captions_number.has_value`	N/A
FL	Does the new money Intangible Tax exemption for mortgage modifications and refinances apply to this transaction?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_fl_modification_exempt_from_intangible_tax_indicator.has_value`	N/A
FL	What is the amount of the taxable new money associated with this transaction?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_fl_modification_taxable_new_money_amount.has_value`	N/A
GA	Is the debt to be refinanced with the original lender and the original borrower (must be all the original borrowers if more than one)?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_ga_modification_lender_and_borrower_unchanged_indicator.has_value`	N/A
IL	Are the documents being recorded not subject to the $5.00 mail handling fee?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_il_all_recorded_documents_exempt_from_mail_handling_fee_indicator.has_value`	N/A
MA	Will a Municipal Lien Certificate be recorded as part of this transaction?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_ma_deed_municipal_lien_certificate_being_recorded_indicator.has_value`	N/A
MD	Is this a purchase-money mortgage (associated with a purchase) being recorded at the same time with a deed?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_deed_mortgage_and_deed_recorded_at_same_time_indicator.has_value`	N/A
MD	Is the property a non-principal residence and is the borrower the same or has the borrower assumed this debt from the previous mortgagor?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_md_modification_lender_assumed_previous_debt_indicator.has_value`	N/A
MD	On this refinance, has the original purchase money mortgage been on record more than 12 months??	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_md_refinance_original_purchase_money_mortgage_older_than_12_months_indicator.has_value`	N/A
MN	Is there a well certificate being recorded with this document?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_mn_deed_well_certificate_being_recorded_indicator.has_value`	N/A
NY	Number of references to consolidations in document?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_fee_ny_modification_number_of_colsolidation_references.has_value`	N/A
NY	Number of references to assignments in document?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_ny_modification_references_to_assignment_number.has_value`	N/A
NY	What is the Percentage of this property that is residential real property?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_ny_deed_residential_real_property_ratio.has_value`	N/A
NY	Is this document a CEMA?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_ny_modification_cema_indicator.has_value`	N/A
NY	Has the mortgagor recorded any other mortgages against this property in the past 12 months, which had values of less than $500,000 but, when taken together with this mortgage, cumulatively total $500,000 or more?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_ny_refinance_previous_mortgage_in_past_12_months_amount.has_value`	N/A
PA	Does this transaction involve an executory construction contract which is effective prior to, or contemporaneously with, the transfer of the title to the real estate?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_pa_deed_executory_construction_contract_prior_to_or_during_title_transfer_indicator.has_value`	N/A
VA	Is the amount of the existing debt certified?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_va_modification_existing_debt_certified_indicator.has_value`	N/A
WA	Is the second title on a multiple instrument an Assignment of Deed of Trust or a Trustee Change (appointment, substitution, or resignation)?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_wa_release_second_title_type.has_value`	N/A
WA	How many captions or titles on this document?	`loans[@id={current_loan_id}].with_closing_cost_fee_information,closing_cost_fee_information[0].has_closing_cost_fee_wa_release_captions_or_titles_number.has_value`	N/A

Refinancing, Modification Purposes

In case of a refinancing, we also need to collect the information of the old loan. We do not support getting and processing old loan information yet. We will update here when this operation is available for the clients.

Modification Purpose

In case of a loan modification, Fees API expects there to be a modifications objects in the request collection. If there's no modifications object, this refinancing operation will not be regarded as a modification, and different fees and taxes may apply.

When the loan purpose is loan modification, following questions are answered:

Question	Provided In	Default	Impacting States
Is this a modification of an existing mortgage/deed of trust	`modifications[]`	N/A	AL, FL, TN
Is the time to pay being extended?	`modification_aspects.[].has_loan_modification_type.has_value`	N/A	AL
Is the amount of the loan changing from the original amount?	`modification_aspects.[].has_loan_modification_type.has_value == principal_amount`	N/A	AL, MN, OK

Title Insurance Fees

Fees product returns title insurance fees including followings:

Lender and Owner Premium Calculations
Itemized Settlement Fees
Endorsements

Title Insurance Fees Providers

For title fees Ernst works with three providers. You can choose the provider that is going to be used for the title fees. You can send your preference of the providers in the options field while invoking the product as following:

{
 "vendor_name": "ernst",
 "request_data": {
 },
 "options": {
 "title_provider_orderings": ["first_american", "stewart", "fidelity"]
 }
}

For the configuration above, Fees will first try to get title fees using First American. If Fees fails, Fees will use Stewart next. If Fees fails again, it finally will try to get title providers using Fidelity.

You can also set default title fees configurations for specific states, counties and cities. Check Set Ernst Credentials

Endorsement Fees

By default, Fees return only default endorsement fees. Based on the property & loan parameters, the set of returned endorsements fees are updated.

Endorsement Type	Provided In
Adjustable Rate endorsement	`loan_terms[0].has_loan_amortization_type.has_value == "adjustable_rate"`
Condominium endorsement	`properties[@type=subject_property].has_project_type.has_value == "condominium"`
Balloon Mortgage endorsement	`loan_terms[0].has_balloon_indicator.has_value == true`
Manufactured Home endorsement	`properties[@type=subject_property].has_construction_method_type.has_value == "manufactured"`
Planned Unit Development (PUD) endorsement	`properties[@type=subject_property].has_planned_unit_development_pud_indicator.has_value == true`

Inspection Fees

If you'd like to calculate inspection fees along with recording & title insurance fees, you'll need to provide inspections array in the request collection.

Request

application/json

{
  "vendor_name": "ernst",
  "transaction_id": "01F6NAMXWN2XVBD1YJ92A6S6R4",
  "request_collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN"
}

application/json

{
  "vendor_name": "ernst",
  "request_data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_inspection": [
          "01FMM41S2R86Q33TC28H9RC191",
          "01FMM41S2R86Q33TC28H9RC192"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "has_property_structure_built_year": {
          "has_value": 2020
        },
        "has_gross_living_area_square_feet_number": {
          "has_value": 120
        },
        "has_planned_unit_development_pud_indicator": {
          "has_value": true
        },
        "has_project_type": {
          "has_value": "condominium"
        },
        "has_construction_method_type": {
          "has_value": "manufactured"
        }
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "has_mers_mortgage_identification_number": {
          "has_value": "id123"
        },
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_balloon_indicator": {
          "has_value": true
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "inspections": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC191",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "home_inspection"
        }
      },
      {
        "@id": "01FMM41S2R86Q33TC28H9RC192",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "pest"
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 800000
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 14
        },
        "has_page_number_last": {
          "has_value": 16
        }
      },
      {
        "@id": "01FMM23S2R86Q22TC28K9RC191",
        "@type": "conveyance_deed_bargain_and_sale_deed",
        "has_page_number_first": {
          "has_value": 17
        },
        "has_page_number_last": {
          "has_value": 20
        }
      },
      {
        "@id": "01FMM24S2R86Q33TC28T9RC191",
        "@type": "conveyance_deed_quit_claim_deed",
        "has_page_number_first": {
          "has_value": 21
        },
        "has_page_number_last": {
          "has_value": 24
        }
      },
      {
        "@id": "01FMM25S2R86Q44TC28X9RC191",
        "@type": "conveyance_deed_warranty_deed",
        "has_page_number_first": {
          "has_value": 25
        },
        "has_page_number_last": {
          "has_value": 30
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 13
        }
      }
    ]
  }
}

application/json

{
  "vendor_name": "ernst",
  "request_data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "has_property_current_occupancy_type": {
          "has_value": "owner_occupied"
        },
        "has_project_type": {
          "has_value": "condominium"
        },
        "has_number_of_units_type": {
          "has_value": "one"
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 500000
        }
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5A"
        ],
        "with_borrower": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "funded_by": [
          "01FMM41S2RE99T8XGQJCMTE8E"
        ],
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        },
        "has_mers_mortgage_identification_number": {
          "has_value": "id123"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5A",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_balloon_indicator": {
          "has_value": true
        },
        "has_loan_maturity_due_date": {
          "has_value": "2021-10-22"
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 4
        },
        "has_page_number_last": {
          "has_value": 5
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 3
        }
      }
    ],
    "organizations": [
      {
        "@id": "01FMM41S2RE99T8XGQJCMTE8E",
        "@type": "lender",
        "has_organization_name": {
          "has_value": "lender_organization"
        },
        "has_credit_union_indicator": {
          "has_value": true
        }
      }
    ],
    "declarations": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCKUHDF5J",
        "@type": "declaration",
        "has_intent_to_occupy_indicator": {
          "has_value": true
        },
        "has_borrower_first_time_home_buyer_indicator": {
          "has_value": true
        }
      }
    ],
    "people": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "borrower",
        "has_birth_date": {
          "has_value": "1950-10-10"
        }
      }
    ]
  }
}

application/json

{
  "vendor_name": "ernst",
  "request_data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "has_planned_unit_development_pud_indicator": {
          "has_value": true
        },
        "has_project_type": {
          "has_value": "condominium"
        },
        "has_construction_method_type": {
          "has_value": "manufactured"
        }
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "has_mers_mortgage_identification_number": {
          "has_value": "id123"
        },
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_balloon_indicator": {
          "has_value": true
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 800000
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 3
        },
        "has_page_number_last": {
          "has_value": 6
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 2
        }
      }
    ]
  }
}

application/json

{
  "vendor_name": "ernst",
  "request_data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "has_property_structure_built_year": {
          "has_value": 2020
        },
        "has_gross_living_area_square_feet_number": {
          "has_value": 120
        },
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "with_inspection": [
          "01FMM41S2R86Q33TC28H9RC191",
          "01FMM41S2R86Q33TC28H9RC192"
        ]
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "inspections": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC191",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "home_inspection"
        }
      },
      {
        "@id": "01FMM41S2R86Q33TC28H9RC192",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "pest"
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 800000
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 3
        },
        "has_page_number_last": {
          "has_value": 6
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 2
        }
      }
    ]
  }
}

Response

application/json

Successfully started flow invocation.

{
  "product_flow_name": "ErnstFees",
  "metadata": {},
  "request_collection_id": "01FFHJ4JCWGHV38SC1NJ8TVNFY",
  "invocation_id": "08f0f7bd-0158-4ab8-845c-f94eafa3859c",
  "invocation_status": "STARTED",
  "transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD"
}

application/json

403 invalid error

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

application/json

Internal server error

{
  "message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}

Parameters

Parameter	Type	Description
`x-api-key` required	`string` header	Environment API Key.

Response `201application/json`

7 fields

Successfully started flow invocation.

Field	Type	Description
`invocation_id`	`string`	Invocation ID.
`invocation_status`	`string`	The status of the invocation.`STARTED`
`transaction_id`	`string`	Transaction ID.
`product_flow_name`	`string`	Product flow name.`ErnstFees`
`metadata`	`object`	The metadata of the invoked product flow.
`callback_url`	`string`	Callback URL.
`request_data`	`object`	The data for the request collection.

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`string`	Message

Response `403application/json`

2 fields

403 invalid error

Field	Type	Description
`message`	`string`	Error message.
`url`	`string`	Error additional URL.

Response `404application/json`

1 fields

Resource not found

Field	Type	Description
`message`	`string`	Message

Response `500application/json`

1 fields

Internal server error

Field	Type	Description
`message`	`string`	Error message.

GET /products/fees/invocations/{invocation_id}

Retrieve Invocation Status

RetrieveProductFlowInvocationStatus

Retrieve status of a Product Flow Invocation

Retrieves the status of running Product flow invocation.

Response

application/json

Successfully returned status of the Product flow Invocation.

{
  "request_collection_id": "01FFHJ4JCWGHV38SC1NJ8TVNFY",
  "response_collection_id": "01FFHKS6W9J0JDTGTQJB9Y2RWB",
  "metadata": {},
  "invocation_id": "08f0f7bd-0158-4ab8-845c-f94eafa3859c",
  "invocation_status": "RUNNING",
  "transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
  "product_flow_name": "ErnstFees",
  "request_collection": {
    "metadata": {
      "created_at": "2021-09-14T03:08:00.284090-04:00",
      "validation": false
    },
    "transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
    "collection_id": "01FFHJ4JCWGHV38SC1NJ8TVNFY",
    "data": {
      "properties": [
        {
          "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
          "@type": "subject_property",
          "with_address": [
            "01FMM41S2R86Q33TC28H9RC197"
          ],
          "with_sales_contract": [
            "01FDTQ5PJTJLYZ444RCH7TDF5J"
          ],
          "with_inspection": [
            "01FMM41S2R86Q33TC28H9RC191",
            "01FMM41S2R86Q33TC28H9RC192"
          ],
          "with_value": [
            "01FDTQGB9FVMF9YTFBTX95D2KH"
          ],
          "has_property_structure_built_year": {
            "has_value": 2020
          },
          "has_gross_living_area_square_feet_number": {
            "has_value": 120
          },
          "has_planned_unit_development_pud_indicator": {
            "has_value": true
          },
          "has_project_type": {
            "has_value": "condominium"
          },
          "has_construction_method_type": {
            "has_value": "manufactured"
          }
        }
      ],
      "addresses": [
        {
          "@id": "01FMM41S2R86Q33TC28H9RC197",
          "@type": "residential_address",
          "has_county_name": {
            "has_value": "Suffolk"
          },
          "has_state_code": {
            "has_value": "NY"
          },
          "has_city_name": {
            "has_value": "Riverhead"
          },
          "has_postal_code": {
            "has_value": "77069"
          },
          "has_address_line_1_text": {
            "has_value": "5118 Westerham Pl"
          }
        }
      ],
      "loans": [
        {
          "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
          "@type": "loan",
          "with_loan_terms": [
            "01FDTQ5PJTJBJZ777RCH7TDF5J"
          ],
          "has_mers_mortgage_identification_number": {
            "has_value": "id123"
          },
          "has_loan_closing_date": {
            "has_value": "2021-12-25"
          }
        }
      ],
      "loan_terms": [
        {
          "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
          "@type": "loan_term",
          "has_note_amount": {
            "has_value": 800000
          },
          "has_loan_amortization_type": {
            "has_value": "adjustable_rate"
          },
          "has_loan_purpose_type": {
            "has_value": "purchase"
          },
          "has_balloon_indicator": {
            "has_value": true
          }
        }
      ],
      "sales_contracts": [
        {
          "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
          "@type": "sales_contract",
          "has_sales_contract_amount": {
            "has_value": 1100000
          }
        }
      ],
      "inspections": [
        {
          "@id": "01FMM41S2R86Q33TC28H9RC191",
          "@type": "inspection",
          "has_property_inspection_purpose_type": {
            "has_value": "home_inspection"
          }
        },
        {
          "@id": "01FMM41S2R86Q33TC28H9RC192",
          "@type": "inspection",
          "has_property_inspection_purpose_type": {
            "has_value": "pest"
          }
        }
      ],
      "property_valuations": [
        {
          "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
          "@type": "property_valuation",
          "has_property_valuation_amount": {
            "has_value": 800000
          }
        }
      ],
      "documents": [
        {
          "@id": "01FMM22S2R86Q77TC28H9RC191",
          "@type": "conveyance_deed",
          "has_page_number_first": {
            "has_value": 14
          },
          "has_page_number_last": {
            "has_value": 16
          }
        },
        {
          "@id": "01FMM23S2R86Q22TC28K9RC191",
          "@type": "conveyance_deed_bargain_and_sale_deed",
          "has_page_number_first": {
            "has_value": 17
          },
          "has_page_number_last": {
            "has_value": 20
          }
        },
        {
          "@id": "01FMM24S2R86Q33TC28T9RC191",
          "@type": "conveyance_deed_quit_claim_deed",
          "has_page_number_first": {
            "has_value": 21
          },
          "has_page_number_last": {
            "has_value": 24
          }
        },
        {
          "@id": "01FMM25S2R86Q44TC28X9RC191",
          "@type": "conveyance_deed_warranty_deed",
          "has_page_number_first": {
            "has_value": 25
          },
          "has_page_number_last": {
            "has_value": 30
          }
        },
        {
          "@id": "01FMM26S2R86Q99TC28R9RC191",
          "@type": "note",
          "has_page_number_first": {
            "has_value": 1
          },
          "has_page_number_last": {
            "has_value": 13
          }
        }
      ]
    }
  },
  "response_collection": {
    "metadata": {
      "created_at": "2021-09-14T03:36:45.193268-04:00",
      "validation": false
    },
    "transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
    "collection_id": "01FFHKS6W9J0JDTGTQJB9Y2RWB",
    "data": {
      "fees": [
        {
          "@id": "01FNTJW9GGM6GHQSVYN73NX630",
          "@type": "fee",
          "has_fee_type": {
            "has_value": "recording_fee_for_deed"
          },
          "with_fee_payment": [
            "01FNTJWAE246AVTJYDXTEQK7SA"
          ]
        },
        {
          "@id": "01FNTJW9GSNCSF7TGQ3JAQTCE8",
          "@type": "fee",
          "has_fee_type": {
            "has_value": "recording_fee_for_mortgage"
          },
          "with_fee_payment": [
            "01FNTJWAE2W17RB50Y00R4EWH3"
          ]
        },
        {
          "@id": "01FNTJW9H20TWMS42FGB7HT4RR",
          "@type": "fee",
          "has_fee_type": {
            "has_value": "tax_stamp_for_state_mortgage"
          },
          "paid_to": [
            "01FNTJWAE5527FEKVY4M1398EV"
          ],
          "with_fee_payment": [
            "01FNTJWAE2TAZGAVXR2E3KTPM6",
            "01FNTJWAE2HEEGCMB5PW56T9PZ"
          ]
        },
        {
          "@id": "01FNTJW9H27FS1YNC6QCMFY4A5",
          "@type": "fee",
          "has_fee_type": {
            "has_value": "tax_stamp_for_state_deed"
          },
          "paid_to": [
            "01FNTJWAE5527FEKVY4M1398EV"
          ],
          "with_fee_payment": [
            "01FNTJWAE33DFB3WWQHW6W20G3"
          ]
        },
        {
          "@id": "01FNTJW9H2JWWRZHG05NEDTWPM",
          "@type": "fee",
          "has_fee_type": {
            "has_value": "tax_stamp_for_city_mortgage"
          },
          "paid_to": [
            "01FNTJWAE58VZ8ZXCSZ88ZDV4P"
          ],
          "with_fee_payment": [
            "01FNTJWAE38989RS7JM88AQSWE"
          ]
        }
      ],
      "fee_payments": [
        {
          "@id": "01FNTJWAE246AVTJYDXTEQK7SA",
          "@type": "fee_payment",
          "has_fee_estimated_payment_amount": {
            "has_value": 405
          },
          "has_fee_payment_responsible_party_type": {
            "has_value": "buyer"
          }
        },
        {
          "@id": "01FNTJWAE2W17RB50Y00R4EWH3",
          "@type": "fee_payment",
          "has_fee_estimated_payment_amount": {
            "has_value": 460
          },
          "has_fee_payment_responsible_party_type": {
            "has_value": "buyer"
          }
        },
        {
          "@id": "01FNTJWAE2TAZGAVXR2E3KTPM6",
          "@type": "fee_payment",
          "has_fee_estimated_payment_amount": {
            "has_value": 6400
          },
          "has_fee_payment_responsible_party_type": {
            "has_value": "buyer"
          }
        },
        {
          "@id": "01FNTJWAE2HEEGCMB5PW56T9PZ",
          "@type": "fee_payment",
          "has_fee_estimated_payment_amount": {
            "has_value": 2000
          },
          "has_fee_payment_responsible_party_type": {
            "has_value": "lender"
          }
        },
        {
          "@id": "01FNTJWAE33DFB3WWQHW6W20G3",
          "@type": "fee_payment",
          "has_fee_estimated_payment_amount": {
            "has_value": 4400
          },
          "has_fee_payment_responsible_party_type": {
            "has_value": "seller"
          }
        },
        {
          "@id": "01FNTJWAE38989RS7JM88AQSWE",
          "@type": "fee_payment",
          "has_fee_estimated_payment_amount": {
            "has_value": 19000
          },
          "has_fee_payment_responsible_party_type": {
            "has_value": "buyer"
          }
        }
      ],
      "organizations": [
        {
          "@id": "01FNTJWAE5527FEKVY4M1398EV",
          "@type": "organization",
          "has_organization_name": {
            "has_value": "New York State"
          }
        },
        {
          "@id": "01FNTJWAE58VZ8ZXCSZ88ZDV4P",
          "@type": "organization",
          "has_organization_name": {
            "has_value": "Riverhead City"
          }
        }
      ]
    }
  }
}

application/json

403 invalid error

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

application/json

Internal server error

{
  "message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	—	Environment API Key.
`invocation_id` required	`string (ulid)` path	`01F0KHKADN0HRFXMCQQXPA6AFZ`	Product flow invocation identifier

Response `200application/json`

9 fields

Successfully returned status of the Product flow Invocation.

Field	Type	Description
`invocation_status`required	`string`	Invocation Status.`ACTION_REQUIREDCOMPLETEDFAILEDRUNNINGSTARTED`
`transaction_id`required	`string`	Transaction ID used for invocation.
`request_collection_id`	`string`	Request Collection ID.
`request_collection`	`object`	Collection.
`transaction_id`	`string (ulid)`	Transaction ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF`
`collection_id`	`string (ulid)`	Collection ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF`
`data`	`object`	Data in Staircase language schema.
`metadata`	`object`	Metadata about collection, f.e version of used Staircase schema.
`response_collection_id`	`string`	Response Collection ID.
`response_collection`	`object`	Collection.
`transaction_id`	`string (ulid)`	Transaction ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF`
`collection_id`	`string (ulid)`	Collection ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF`
`data`	`object`	—
`fees`required	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	—
`with_fee_payment`required	`string[]`	—
`paid_to`	`string[]`	—
`has_fee_type`required	`object`	—
`fee_payments`required	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	—
`has_fee_estimated_payment_amount`required	`object`	—
`has_fee_payment_responsible_party_type`required	`object`	—
`organizations`required	`object[]`	—
`@id`	`string`	—
`@type`	`string`	—
`has_organization_name`	`object`	—
`metadata`	`object`	Metadata about collection, f.e version of used Staircase schema.
`callback_url`	`string`	URL that was specified in flow invocation and will be used to send the callback when flow invocation will be finished.
`widget_url`	`string (uri)`	URL of the widget.
`metadata`	`object`	Response Collection ID.

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`string`	Message

Response `403application/json`

2 fields

403 invalid error

Field	Type	Description
`message`	`string`	Error message.
`url`	`string`	Error additional URL.

Response `404application/json`

1 fields

Resource not found

Field	Type	Description
`message`	`string`	Message

Response `500application/json`

1 fields

Internal server error

Field	Type	Description
`message`	`string`	Error message.

GET /products/fees/request-schema

Retrieve Request Schema

retrieveRequestSchema

Retrieve Request Schema retrieves a JSON schema for the request collection that you can provide to the invocation.

If you'd like to retrieve some examples for the request collection, use return_examples=True query parameter.

Response

application/json

Request schema (possibly with examples) is successfully returned.

{
  "schema": {
    "type": "object",
    "required": [
      "properties",
      "addresses",
      "sales_contracts",
      "loans",
      "loan_terms",
      "documents"
    ],
    "properties": {
      "properties": {
        "type": "array",
        "description": "Add the Property related with the Loan in this container",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_address",
            "with_sales_contract"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "subject_property"
              ]
            },
            "with_address": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_sales_contract": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_value": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_inspection": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_property_title": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_legal_description": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "has_property_structure_built_year": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            },
            "has_gross_living_area_square_feet_number": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "has_planned_unit_development_pud_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_project_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "common_interest_apartment",
                    "condominium",
                    "cooperative",
                    "other"
                  ]
                }
              }
            },
            "has_number_of_units_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "four",
                    "one",
                    "three",
                    "two",
                    "two_to_four"
                  ]
                }
              }
            },
            "has_property_current_occupancy_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "abandoned",
                    "adverse_occupied",
                    "occupied_by_unknown",
                    "owner_occupied",
                    "partially_vacant",
                    "tenant_occupied",
                    "unknown",
                    "vacant"
                  ]
                }
              }
            },
            "has_construction_method_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "manufactured",
                    "mobile_home",
                    "modular",
                    "on_frame_modular",
                    "other",
                    "site_built"
                  ]
                }
              }
            },
            "has_land_use_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "manufactured",
                    "mobile_home",
                    "modular",
                    "on_frame_modular",
                    "other",
                    "site_built"
                  ]
                }
              }
            }
          }
        }
      },
      "addresses": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_state_code",
            "has_county_name",
            "has_city_name",
            "has_postal_code"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_state_code": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_county_name": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_city_name": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_postal_code": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_address_line_1_text": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "sales_contracts": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_sales_contract_amount"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "sales_contract"
              ]
            },
            "has_sales_contract_amount": {
              "type": "object",
              "description": "Deed Taxes & Fees are calculated according to this parameter",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            }
          }
        }
      },
      "loans": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_loan_terms"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "loan"
              ]
            },
            "with_loan_terms": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_borrower": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_modification_information": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_closing_cost_fee_information": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "funded_by": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "has_mers_mortgage_identification_number": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_loan_closing_date": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_current_unpaid_principal_balance_upb_amount": {
              "type": "object",
              "description": "Old loans unpaid principal balance",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            }
          }
        }
      },
      "loan_terms": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_note_amount"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "loan_term"
              ]
            },
            "has_note_amount": {
              "type": "object",
              "description": "Mortgage Taxes & Fees are calculated according to this parameter",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "has_loan_amortization_type": {
              "type": "object",
              "description": "Title Insurance: When provided endorsements are updated accordingly",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "adjustable_rate",
                    "fixed_rate",
                    "home_equity_line_of_credit",
                    "payment_option_adjustable_rate"
                  ]
                }
              }
            },
            "has_balloon_indicator": {
              "type": "object",
              "description": "Title Insurance: When provided an additional endorsement for Balloon Mortgage is returned",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_loan_purpose_type": {
              "required": [
                "has_value"
              ],
              "type": "object",
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "other",
                    "purchase",
                    "refinance"
                  ]
                }
              }
            },
            "has_loan_maturity_due_date": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "documents": {
        "type": "array",
        "description": "Documents: Mortgage and Deed recording fees are calculated based on these documents page count.",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_page_number_first",
            "has_page_number_last"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "conveyance_deed",
                "conveyance_deed_bargain_and_sale_deed",
                "conveyance_deed_quit_claim_deed",
                "conveyance_deed_warranty_deed",
                "note"
              ]
            },
            "has_page_number_first": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            },
            "has_page_number_last": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            }
          }
        }
      },
      "people": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_birth_date"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "borrower"
              ]
            },
            "owes_liability": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "has_birth_date": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "inspections": {
        "type": "array",
        "description": "Inspections: When provided inspection fees are returned accordingly.",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_property_inspection_purpose_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "inspection"
              ]
            },
            "has_property_inspection_purpose_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "home_inspection",
                    "pest"
                  ]
                }
              }
            }
          }
        }
      },
      "organizations": {
        "type": "array",
        "description": "Includes organizations such as lenders.",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_organization_name"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "lender"
              ]
            },
            "has_organization_name": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_credit_union_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "description": "Indicates whether this organization (only applies to lenders) is a Federal or state-accredited credit union or not.",
              "properties": {
                "has_value": {
                  "type": "boolean",
                  "default": false
                }
              }
            }
          }
        }
      },
      "declarations": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "declaration"
              ]
            },
            "has_intent_to_occupy_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean",
                  "default": false
                }
              }
            },
            "has_borrower_first_time_home_buyer_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean",
                  "default": false
                }
              }
            },
            "current_owner_is_senior_citizen_blind_or_disabled_person_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean",
                  "default": false
                }
              }
            }
          }
        }
      },
      "property_valuations": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_property_valuation_amount"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "property_valuation"
              ]
            },
            "has_property_valuation_amount": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            }
          }
        }
      },
      "modification_information": {
        "type": "array",
        "description": "Connects Loan object with Modification object",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_modification"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "modification_information"
              ]
            },
            "with_modification": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "modifications": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_modification_aspect"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "modification_information"
              ]
            },
            "with_modification_aspect": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "modification_aspects": {
        "type": "array",
        "description": "Includes information about what is being changed in a loan",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_loan_modification_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "modification_aspect"
              ]
            },
            "has_loan_modification_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "amortization_method",
                    "interest_rate",
                    "maturity_date",
                    "other",
                    "payment_amount",
                    "payment_frequency",
                    "principal_amount"
                  ]
                }
              }
            }
          }
        }
      },
      "liabilities": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_liability_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "liability"
              ]
            },
            "has_liability_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "heloc"
                  ]
                }
              }
            }
          }
        }
      },
      "property_titles": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "property_title"
              ]
            }
          }
        }
      },
      "legal_descriptions": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_parsed_legal_description",
            "with_parcel_identification"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "legal_description"
              ]
            },
            "with_parsed_legal_description": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_parcel_identification": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "parcel_identifications": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "platted_land"
              ]
            }
          }
        }
      },
      "parsed_legal_descriptions": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_platted_land",
            "with_unplatted_land"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "parsed_legal_description"
              ]
            },
            "with_platted_land": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_unplatted_land": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "platted_lands": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "platted_land"
              ]
            }
          }
        }
      },
      "unplatted_lands": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "unplatted_land"
              ]
            }
          }
        }
      },
      "closing_cost_fee_information": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "closing_cost_fee_information"
              ]
            },
            "has_closing_cost_fee_al_modification_time_to_pay_extended_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_al_modification_loan_amount_increasing_from_original_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ca_all_recording_exempt_from_additional_real_estate_fraud_prosecution_trust_fund_fee_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ca_deed_taxable_quit_claim_deed_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ca_release_multicaption_document_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ca_release_captions_number": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            },
            "has_closing_cost_fee_ca_release_any_document_has_assignment_of_mortgage_or_rent_as_second_title_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_deed_mortgage_and_deed_recorded_at_same_time_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_fl_modification_exempt_from_intangible_tax_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ga_modification_lender_and_borrower_unchanged_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_il_all_recorded_documents_exempt_from_mail_handling_fee_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ma_deed_municipal_lien_certificate_being_recorded_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_md_modification_lender_assumed_previous_debt_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_md_refinance_original_purchase_money_mortgage_older_than_12_months_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_fee_ny_modification_number_of_colsolidation_references": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            },
            "has_closing_cost_fee_ny_modification_references_to_assignment_number": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            },
            "has_closing_cost_fee_ny_modification_cema_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ny_deed_residential_real_property_ratio": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "has_closing_cost_fee_ny_refinance_previous_mortgage_in_past_12_months_amount": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "has_closing_cost_fee_pa_deed_executory_construction_contract_prior_to_or_during_title_transfer_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_va_modification_existing_debt_certified_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_wa_release_second_title_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_wa_release_captions_or_titles_number": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    },
    "description": "The data that is needed for invocation. It should follow the request schema"
  }
}

application/json

Request schema (possibly with examples) is successfully returned.

{
  "schema": {
    "type": "object",
    "required": [
      "properties",
      "addresses",
      "sales_contracts",
      "loans",
      "loan_terms",
      "documents"
    ],
    "properties": {
      "properties": {
        "type": "array",
        "description": "Add the Property related with the Loan in this container",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_address",
            "with_sales_contract"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "subject_property"
              ]
            },
            "with_address": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_sales_contract": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_value": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_inspection": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_property_title": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_legal_description": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "has_property_structure_built_year": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            },
            "has_gross_living_area_square_feet_number": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "has_planned_unit_development_pud_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_project_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "common_interest_apartment",
                    "condominium",
                    "cooperative",
                    "other"
                  ]
                }
              }
            },
            "has_number_of_units_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "four",
                    "one",
                    "three",
                    "two",
                    "two_to_four"
                  ]
                }
              }
            },
            "has_property_current_occupancy_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "abandoned",
                    "adverse_occupied",
                    "occupied_by_unknown",
                    "owner_occupied",
                    "partially_vacant",
                    "tenant_occupied",
                    "unknown",
                    "vacant"
                  ]
                }
              }
            },
            "has_construction_method_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "manufactured",
                    "mobile_home",
                    "modular",
                    "on_frame_modular",
                    "other",
                    "site_built"
                  ]
                }
              }
            },
            "has_land_use_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "manufactured",
                    "mobile_home",
                    "modular",
                    "on_frame_modular",
                    "other",
                    "site_built"
                  ]
                }
              }
            }
          }
        }
      },
      "addresses": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_state_code",
            "has_county_name",
            "has_city_name",
            "has_postal_code"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_state_code": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_county_name": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_city_name": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_postal_code": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_address_line_1_text": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "sales_contracts": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_sales_contract_amount"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "sales_contract"
              ]
            },
            "has_sales_contract_amount": {
              "type": "object",
              "description": "Deed Taxes & Fees are calculated according to this parameter",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            }
          }
        }
      },
      "loans": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_loan_terms"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "loan"
              ]
            },
            "with_loan_terms": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_borrower": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_modification_information": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_closing_cost_fee_information": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "funded_by": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "has_mers_mortgage_identification_number": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_loan_closing_date": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_current_unpaid_principal_balance_upb_amount": {
              "type": "object",
              "description": "Old loans unpaid principal balance",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            }
          }
        }
      },
      "loan_terms": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_note_amount"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "loan_term"
              ]
            },
            "has_note_amount": {
              "type": "object",
              "description": "Mortgage Taxes & Fees are calculated according to this parameter",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "has_loan_amortization_type": {
              "type": "object",
              "description": "Title Insurance: When provided endorsements are updated accordingly",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "adjustable_rate",
                    "fixed_rate",
                    "home_equity_line_of_credit",
                    "payment_option_adjustable_rate"
                  ]
                }
              }
            },
            "has_balloon_indicator": {
              "type": "object",
              "description": "Title Insurance: When provided an additional endorsement for Balloon Mortgage is returned",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_loan_purpose_type": {
              "required": [
                "has_value"
              ],
              "type": "object",
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "other",
                    "purchase",
                    "refinance"
                  ]
                }
              }
            },
            "has_loan_maturity_due_date": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "documents": {
        "type": "array",
        "description": "Documents: Mortgage and Deed recording fees are calculated based on these documents page count.",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_page_number_first",
            "has_page_number_last"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "conveyance_deed",
                "conveyance_deed_bargain_and_sale_deed",
                "conveyance_deed_quit_claim_deed",
                "conveyance_deed_warranty_deed",
                "note"
              ]
            },
            "has_page_number_first": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            },
            "has_page_number_last": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            }
          }
        }
      },
      "people": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_birth_date"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "borrower"
              ]
            },
            "owes_liability": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "has_birth_date": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "inspections": {
        "type": "array",
        "description": "Inspections: When provided inspection fees are returned accordingly.",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_property_inspection_purpose_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "inspection"
              ]
            },
            "has_property_inspection_purpose_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "home_inspection",
                    "pest"
                  ]
                }
              }
            }
          }
        }
      },
      "organizations": {
        "type": "array",
        "description": "Includes organizations such as lenders.",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_organization_name"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "lender"
              ]
            },
            "has_organization_name": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_credit_union_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "description": "Indicates whether this organization (only applies to lenders) is a Federal or state-accredited credit union or not.",
              "properties": {
                "has_value": {
                  "type": "boolean",
                  "default": false
                }
              }
            }
          }
        }
      },
      "declarations": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "declaration"
              ]
            },
            "has_intent_to_occupy_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean",
                  "default": false
                }
              }
            },
            "has_borrower_first_time_home_buyer_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean",
                  "default": false
                }
              }
            },
            "current_owner_is_senior_citizen_blind_or_disabled_person_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean",
                  "default": false
                }
              }
            }
          }
        }
      },
      "property_valuations": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_property_valuation_amount"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "property_valuation"
              ]
            },
            "has_property_valuation_amount": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            }
          }
        }
      },
      "modification_information": {
        "type": "array",
        "description": "Connects Loan object with Modification object",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_modification"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "modification_information"
              ]
            },
            "with_modification": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "modifications": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_modification_aspect"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "modification_information"
              ]
            },
            "with_modification_aspect": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "modification_aspects": {
        "type": "array",
        "description": "Includes information about what is being changed in a loan",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_loan_modification_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "modification_aspect"
              ]
            },
            "has_loan_modification_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "amortization_method",
                    "interest_rate",
                    "maturity_date",
                    "other",
                    "payment_amount",
                    "payment_frequency",
                    "principal_amount"
                  ]
                }
              }
            }
          }
        }
      },
      "liabilities": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_liability_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "liability"
              ]
            },
            "has_liability_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "heloc"
                  ]
                }
              }
            }
          }
        }
      },
      "property_titles": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "property_title"
              ]
            }
          }
        }
      },
      "legal_descriptions": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_parsed_legal_description",
            "with_parcel_identification"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "legal_description"
              ]
            },
            "with_parsed_legal_description": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_parcel_identification": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "parcel_identifications": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "platted_land"
              ]
            }
          }
        }
      },
      "parsed_legal_descriptions": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_platted_land",
            "with_unplatted_land"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "parsed_legal_description"
              ]
            },
            "with_platted_land": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_unplatted_land": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "platted_lands": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "platted_land"
              ]
            }
          }
        }
      },
      "unplatted_lands": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "unplatted_land"
              ]
            }
          }
        }
      },
      "closing_cost_fee_information": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string",
              "enum": [
                "closing_cost_fee_information"
              ]
            },
            "has_closing_cost_fee_al_modification_time_to_pay_extended_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_al_modification_loan_amount_increasing_from_original_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ca_all_recording_exempt_from_additional_real_estate_fraud_prosecution_trust_fund_fee_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ca_deed_taxable_quit_claim_deed_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ca_release_multicaption_document_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ca_release_captions_number": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            },
            "has_closing_cost_fee_ca_release_any_document_has_assignment_of_mortgage_or_rent_as_second_title_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_deed_mortgage_and_deed_recorded_at_same_time_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_fl_modification_exempt_from_intangible_tax_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ga_modification_lender_and_borrower_unchanged_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_il_all_recorded_documents_exempt_from_mail_handling_fee_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ma_deed_municipal_lien_certificate_being_recorded_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_md_modification_lender_assumed_previous_debt_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_md_refinance_original_purchase_money_mortgage_older_than_12_months_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_fee_ny_modification_number_of_colsolidation_references": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            },
            "has_closing_cost_fee_ny_modification_references_to_assignment_number": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            },
            "has_closing_cost_fee_ny_modification_cema_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_ny_deed_residential_real_property_ratio": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "has_closing_cost_fee_ny_refinance_previous_mortgage_in_past_12_months_amount": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "has_closing_cost_fee_pa_deed_executory_construction_contract_prior_to_or_during_title_transfer_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_va_modification_existing_debt_certified_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_wa_release_second_title_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_closing_cost_fee_wa_release_captions_or_titles_number": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    },
    "description": "The data that is needed for invocation. It should follow the request schema"
  },
  "examples": [
    {
      "properties": [
        {
          "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
          "@type": "subject_property",
          "with_address": [
            "01FMM41S2R86Q33TC28H9RC197"
          ],
          "with_sales_contract": [
            "01FDTQ5PJTJLYZ444RCH7TDF5J"
          ],
          "with_inspection": [
            "01FMM41S2R86Q33TC28H9RC191",
            "01FMM41S2R86Q33TC28H9RC192"
          ],
          "with_value": [
            "01FDTQGB9FVMF9YTFBTX95D2KH"
          ],
          "has_property_structure_built_year": {
            "has_value": 2020
          },
          "has_gross_living_area_square_feet_number": {
            "has_value": 120
          },
          "has_planned_unit_development_pud_indicator": {
            "has_value": true
          },
          "has_project_type": {
            "has_value": "condominium"
          },
          "has_construction_method_type": {
            "has_value": "manufactured"
          }
        }
      ],
      "addresses": [
        {
          "@id": "01FMM41S2R86Q33TC28H9RC197",
          "@type": "residential_address",
          "has_county_name": {
            "has_value": "Suffolk"
          },
          "has_state_code": {
            "has_value": "NY"
          },
          "has_city_name": {
            "has_value": "Riverhead"
          },
          "has_postal_code": {
            "has_value": "77069"
          },
          "has_address_line_1_text": {
            "has_value": "5118 Westerham Pl"
          }
        }
      ],
      "loans": [
        {
          "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
          "@type": "loan",
          "with_loan_terms": [
            "01FDTQ5PJTJBJZ777RCH7TDF5J"
          ],
          "has_mers_mortgage_identification_number": {
            "has_value": "id123"
          },
          "has_loan_closing_date": {
            "has_value": "2021-12-25"
          }
        }
      ],
      "loan_terms": [
        {
          "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
          "@type": "loan_term",
          "has_note_amount": {
            "has_value": 800000
          },
          "has_loan_amortization_type": {
            "has_value": "adjustable_rate"
          },
          "has_loan_purpose_type": {
            "has_value": "purchase"
          },
          "has_balloon_indicator": {
            "has_value": true
          }
        }
      ],
      "sales_contracts": [
        {
          "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
          "@type": "sales_contract",
          "has_sales_contract_amount": {
            "has_value": 1100000
          }
        }
      ],
      "inspections": [
        {
          "@id": "01FMM41S2R86Q33TC28H9RC191",
          "@type": "inspection",
          "has_property_inspection_purpose_type": {
            "has_value": "home_inspection"
          }
        },
        {
          "@id": "01FMM41S2R86Q33TC28H9RC192",
          "@type": "inspection",
          "has_property_inspection_purpose_type": {
            "has_value": "pest"
          }
        }
      ],
      "property_valuations": [
        {
          "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
          "@type": "property_valuation",
          "has_property_valuation_amount": {
            "has_value": 800000
          }
        }
      ],
      "documents": [
        {
          "@id": "01FMM22S2R86Q77TC28H9RC191",
          "@type": "conveyance_deed",
          "has_page_number_first": {
            "has_value": 14
          },
          "has_page_number_last": {
            "has_value": 16
          }
        },
        {
          "@id": "01FMM23S2R86Q22TC28K9RC191",
          "@type": "conveyance_deed_bargain_and_sale_deed",
          "has_page_number_first": {
            "has_value": 17
          },
          "has_page_number_last": {
            "has_value": 20
          }
        },
        {
          "@id": "01FMM24S2R86Q33TC28T9RC191",
          "@type": "conveyance_deed_quit_claim_deed",
          "has_page_number_first": {
            "has_value": 21
          },
          "has_page_number_last": {
            "has_value": 24
          }
        },
        {
          "@id": "01FMM25S2R86Q44TC28X9RC191",
          "@type": "conveyance_deed_warranty_deed",
          "has_page_number_first": {
            "has_value": 25
          },
          "has_page_number_last": {
            "has_value": 30
          }
        },
        {
          "@id": "01FMM26S2R86Q99TC28R9RC191",
          "@type": "note",
          "has_page_number_first": {
            "has_value": 1
          },
          "has_page_number_last": {
            "has_value": 13
          }
        }
      ]
    },
    {
      "properties": [
        {
          "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
          "@type": "subject_property",
          "with_address": [
            "01FMM41S2R86Q33TC28H9RC197"
          ],
          "with_sales_contract": [
            "01FDTQ5PJTJLYZ444RCH7TDF5J"
          ],
          "with_value": [
            "01FDTQGB9FVMF9YTFBTX95D2KH"
          ],
          "has_property_current_occupancy_type": {
            "has_value": "owner_occupied"
          },
          "has_project_type": {
            "has_value": "condominium"
          },
          "has_number_of_units_type": {
            "has_value": "one"
          }
        }
      ],
      "property_valuations": [
        {
          "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
          "@type": "property_valuation",
          "has_property_valuation_amount": {
            "has_value": 500000
          }
        }
      ],
      "addresses": [
        {
          "@id": "01FMM41S2R86Q33TC28H9RC197",
          "@type": "residential_address",
          "has_county_name": {
            "has_value": "Suffolk"
          },
          "has_state_code": {
            "has_value": "NY"
          },
          "has_city_name": {
            "has_value": "Riverhead"
          },
          "has_postal_code": {
            "has_value": "77069"
          },
          "has_address_line_1_text": {
            "has_value": "5118 Westerham Pl"
          }
        }
      ],
      "sales_contracts": [
        {
          "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
          "@type": "sales_contract",
          "has_sales_contract_amount": {
            "has_value": 1100000
          }
        }
      ],
      "loans": [
        {
          "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
          "@type": "loan",
          "with_loan_terms": [
            "01FDTQ5PJTJBJZ777RCH7TDF5A"
          ],
          "with_borrower": [
            "01FDTQ5PJTJBJZ777RCH7TDF5J"
          ],
          "funded_by": [
            "01FMM41S2RE99T8XGQJCMTE8E"
          ],
          "has_loan_closing_date": {
            "has_value": "2021-12-25"
          },
          "has_mers_mortgage_identification_number": {
            "has_value": "id123"
          }
        }
      ],
      "loan_terms": [
        {
          "@id": "01FDTQ5PJTJBJZ777RCH7TDF5A",
          "@type": "loan_term",
          "has_note_amount": {
            "has_value": 800000
          },
          "has_loan_amortization_type": {
            "has_value": "adjustable_rate"
          },
          "has_loan_purpose_type": {
            "has_value": "purchase"
          },
          "has_balloon_indicator": {
            "has_value": true
          },
          "has_loan_maturity_due_date": {
            "has_value": "2021-10-22"
          }
        }
      ],
      "documents": [
        {
          "@id": "01FMM22S2R86Q77TC28H9RC191",
          "@type": "conveyance_deed",
          "has_page_number_first": {
            "has_value": 4
          },
          "has_page_number_last": {
            "has_value": 5
          }
        },
        {
          "@id": "01FMM26S2R86Q99TC28R9RC191",
          "@type": "note",
          "has_page_number_first": {
            "has_value": 1
          },
          "has_page_number_last": {
            "has_value": 3
          }
        }
      ],
      "organizations": [
        {
          "@id": "01FMM41S2RE99T8XGQJCMTE8E",
          "@type": "lender",
          "has_organization_name": {
            "has_value": "lender_organization"
          },
          "has_credit_union_indicator": {
            "has_value": true
          }
        }
      ],
      "declarations": [
        {
          "@id": "01FDTQ5PJTJBJZ777RCKUHDF5J",
          "@type": "declaration",
          "has_intent_to_occupy_indicator": {
            "has_value": true
          },
          "has_borrower_first_time_home_buyer_indicator": {
            "has_value": true
          }
        }
      ],
      "people": [
        {
          "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
          "@type": "borrower",
          "has_birth_date": {
            "has_value": "1950-10-10"
          }
        }
      ]
    },
    {
      "properties": [
        {
          "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
          "@type": "subject_property",
          "with_address": [
            "01FMM41S2R86Q33TC28H9RC197"
          ],
          "with_sales_contract": [
            "01FDTQ5PJTJLYZ444RCH7TDF5J"
          ],
          "with_value": [
            "01FDTQGB9FVMF9YTFBTX95D2KH"
          ],
          "has_planned_unit_development_pud_indicator": {
            "has_value": true
          },
          "has_project_type": {
            "has_value": "condominium"
          },
          "has_construction_method_type": {
            "has_value": "manufactured"
          }
        }
      ],
      "addresses": [
        {
          "@id": "01FMM41S2R86Q33TC28H9RC197",
          "@type": "residential_address",
          "has_county_name": {
            "has_value": "Suffolk"
          },
          "has_state_code": {
            "has_value": "NY"
          },
          "has_city_name": {
            "has_value": "Riverhead"
          },
          "has_postal_code": {
            "has_value": "77069"
          },
          "has_address_line_1_text": {
            "has_value": "5118 Westerham Pl"
          }
        }
      ],
      "loans": [
        {
          "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
          "@type": "loan",
          "with_loan_terms": [
            "01FDTQ5PJTJBJZ777RCH7TDF5J"
          ],
          "has_mers_mortgage_identification_number": {
            "has_value": "id123"
          },
          "has_loan_closing_date": {
            "has_value": "2021-12-25"
          }
        }
      ],
      "loan_terms": [
        {
          "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
          "@type": "loan_term",
          "has_note_amount": {
            "has_value": 800000
          },
          "has_loan_amortization_type": {
            "has_value": "adjustable_rate"
          },
          "has_loan_purpose_type": {
            "has_value": "purchase"
          },
          "has_balloon_indicator": {
            "has_value": true
          }
        }
      ],
      "sales_contracts": [
        {
          "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
          "@type": "sales_contract",
          "has_sales_contract_amount": {
            "has_value": 1100000
          }
        }
      ],
      "property_valuations": [
        {
          "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
          "@type": "property_valuation",
          "has_property_valuation_amount": {
            "has_value": 800000
          }
        }
      ],
      "documents": [
        {
          "@id": "01FMM22S2R86Q77TC28H9RC191",
          "@type": "conveyance_deed",
          "has_page_number_first": {
            "has_value": 3
          },
          "has_page_number_last": {
            "has_value": 6
          }
        },
        {
          "@id": "01FMM26S2R86Q99TC28R9RC191",
          "@type": "note",
          "has_page_number_first": {
            "has_value": 1
          },
          "has_page_number_last": {
            "has_value": 2
          }
        }
      ]
    },
    {
      "properties": [
        {
          "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
          "@type": "subject_property",
          "has_property_structure_built_year": {
            "has_value": 2020
          },
          "has_gross_living_area_square_feet_number": {
            "has_value": 120
          },
          "with_address": [
            "01FMM41S2R86Q33TC28H9RC197"
          ],
          "with_sales_contract": [
            "01FDTQ5PJTJLYZ444RCH7TDF5J"
          ],
          "with_value": [
            "01FDTQGB9FVMF9YTFBTX95D2KH"
          ],
          "with_inspection": [
            "01FMM41S2R86Q33TC28H9RC191",
            "01FMM41S2R86Q33TC28H9RC192"
          ]
        }
      ],
      "addresses": [
        {
          "@id": "01FMM41S2R86Q33TC28H9RC197",
          "@type": "residential_address",
          "has_county_name": {
            "has_value": "Suffolk"
          },
          "has_state_code": {
            "has_value": "NY"
          },
          "has_city_name": {
            "has_value": "Riverhead"
          },
          "has_postal_code": {
            "has_value": "77069"
          },
          "has_address_line_1_text": {
            "has_value": "5118 Westerham Pl"
          }
        }
      ],
      "inspections": [
        {
          "@id": "01FMM41S2R86Q33TC28H9RC191",
          "@type": "inspection",
          "has_property_inspection_purpose_type": {
            "has_value": "home_inspection"
          }
        },
        {
          "@id": "01FMM41S2R86Q33TC28H9RC192",
          "@type": "inspection",
          "has_property_inspection_purpose_type": {
            "has_value": "pest"
          }
        }
      ],
      "loans": [
        {
          "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
          "@type": "loan",
          "with_loan_terms": [
            "01FDTQ5PJTJBJZ777RCH7TDF5J"
          ],
          "has_loan_closing_date": {
            "has_value": "2021-12-25"
          }
        }
      ],
      "loan_terms": [
        {
          "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
          "@type": "loan_term",
          "has_note_amount": {
            "has_value": 800000
          },
          "has_loan_purpose_type": {
            "has_value": "purchase"
          },
          "has_loan_amortization_type": {
            "has_value": "adjustable_rate"
          }
        }
      ],
      "sales_contracts": [
        {
          "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
          "@type": "sales_contract",
          "has_sales_contract_amount": {
            "has_value": 1100000
          }
        }
      ],
      "property_valuations": [
        {
          "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
          "@type": "property_valuation",
          "has_property_valuation_amount": {
            "has_value": 800000
          }
        }
      ],
      "documents": [
        {
          "@id": "01FMM22S2R86Q77TC28H9RC191",
          "@type": "conveyance_deed",
          "has_page_number_first": {
            "has_value": 3
          },
          "has_page_number_last": {
            "has_value": 6
          }
        },
        {
          "@id": "01FMM26S2R86Q99TC28R9RC191",
          "@type": "note",
          "has_page_number_first": {
            "has_value": 1
          },
          "has_page_number_last": {
            "has_value": 2
          }
        }
      ]
    }
  ]
}

application/json

403 invalid error

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

application/json

Internal server error

{
  "message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}

Parameters

Parameter	Type	Description
`x-api-key` required	`string` header	Environment API Key.
`return_examples`	`boolean` query	If included and set to `true`, returns one or more pre-filled examples that conform to the schema. Default to `false`

Response `200application/json`

2 fields

Request schema (possibly with examples) is successfully returned.

Field	Type	Description
`schema`required	`object`	Schema for the Request Collection
`examples`	`object`	Each item in the dictionary corresponds to the name of the example and dictionary content is the sample response.

Response `400application/json`

1 fields

Error

Field	Type	Description
`message`	`string`	Message

Response `403application/json`

2 fields

403 invalid error

Field	Type	Description
`message`	`string`	Error message.
`url`	`string`	Error additional URL.

Response `404application/json`

1 fields

Resource not found

Field	Type	Description
`message`	`string`	Error Message.

Response `500application/json`

1 fields

Internal server error

Field	Type	Description
`message`	`string`	Error message.

GET /products/fees/response-schema

Retrieve Response Schema

retrieveResponseSchema

Retrieve Response Schema returns the JSON schema for the response collection, created by an invocation.

If you would like to retrieve examples along with the schema, you can provide return_examples=True query parameter.

Response

application/json

Response schema (possibly with examples) is successfully returned.

{
  "schema": {
    "type": "object",
    "additionalProperties": false,
    "required": [
      "fees",
      "fee_payments",
      "organizations"
    ],
    "properties": {
      "fees": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_fee_payment",
            "has_fee_type"
          ],
          "additionalProperties": false,
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "with_fee_payment": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "paid_to": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "has_fee_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "additionalProperties": false,
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "203k_consultant_fee",
                    "203k_discount_on_repairs",
                    "203k_inspection_fee",
                    "203k_permits",
                    "203k_supplemental_origination_fee",
                    "203k_title_update",
                    "application_fee",
                    "appraisal_desk_review_fee",
                    "appraisal_fee",
                    "appraisal_field_review_fee",
                    "appraisal_management_company_fee",
                    "arm_conversion_fee",
                    "asbestos_inspection_fee",
                    "assignment_preparation_fee",
                    "assumption_fee",
                    "attorney_fee",
                    "automated_underwriting_fee",
                    "avm_fee",
                    "bankruptcy_monitoring_fee",
                    "bond_fee",
                    "bond_review_fee",
                    "certification_fee",
                    "chosen_interest_rate_credit_or_charge_total",
                    "commitment_fee",
                    "condominium_association_dues",
                    "condominium_association_special_assessment",
                    "construction_handling_fee",
                    "construction_inspection_fee",
                    "cooperative_association_dues",
                    "cooperative_association_special_assessment",
                    "copy_or_fax_fee",
                    "courier_fee",
                    "credit_disability_insurance_premium",
                    "credit_life_insurance_premium",
                    "credit_property_insurance_premium",
                    "credit_report_fee",
                    "credit_unemployment_insurance_premium",
                    "debt_cancellation_insurance_premium",
                    "debt_suspension_insurance_premium",
                    "deed_preparation_fee",
                    "disaster_inspection_fee",
                    "discount_on_repairs_fee",
                    "document_preparation_fee",
                    "documentary_stamp_fee",
                    "down_payment_protection_fee",
                    "dry_wall_inspection_fee",
                    "electrical_inspection_fee",
                    "electronic_document_delivery_fee",
                    "environmental_inspection_fee",
                    "escrow_holdback_fee",
                    "escrow_service_fee",
                    "escrow_waiver_fee",
                    "filing_fee",
                    "flood_certification",
                    "foundation_inspection_fee",
                    "heating_cooling_inspection_fee",
                    "heloc_annual_fee",
                    "heloc_over_limit_fee",
                    "high_cost_mortgage_counseling_fee",
                    "home_inspection_fee",
                    "home_warranty_fee",
                    "homeowners_association_dues",
                    "homeowners_association_service_fee",
                    "homeowners_association_special_assessment",
                    "late_charge",
                    "lead_inspection_fee",
                    "lenders_attorney_fee",
                    "loan_discount_points",
                    "loan_level_price_adjustment",
                    "loan_origination_fee",
                    "loan_originator_compensation",
                    "manual_underwriting_fee",
                    "manufactured_housing_inspection_fee",
                    "manufactured_housing_processing_fee",
                    "mers_registration_fee",
                    "modification_fee",
                    "mold_inspection_fee",
                    "mortgage_broker_fee",
                    "mortgage_insurance_initial_premium",
                    "mortgage_insurance_upfront_premium",
                    "mortgage_surcharge_county_or_parish",
                    "mortgage_surcharge_municipal",
                    "mortgage_surcharge_state",
                    "mortgage_tax_credit_service_fee",
                    "multiple_loans_closing_fee",
                    "municipal_lien_certificate_fee",
                    "non_sufficient_funds_fee",
                    "notary_fee",
                    "other",
                    "our_origination_charge_total",
                    "partial_lien_release_fee",
                    "payoff_request_fee",
                    "pest_inspection_fee",
                    "plumbing_inspection_fee",
                    "power_of_attorney_preparation_fee",
                    "power_of_attorney_recording_fee",
                    "preclosing_verification_control_fee",
                    "processing_fee",
                    "program_guarantee_fee",
                    "property_inspection_waiver_fee",
                    "radon_inspection_fee",
                    "rate_lock_fee",
                    "real_estate_commission_buyers_broker",
                    "real_estate_commission_sellers_broker",
                    "reconveyance_fee",
                    "reconveyance_tracking_fee",
                    "recording_fee_for_assignment",
                    "recording_fee_for_deed",
                    "recording_fee_for_mortgage",
                    "recording_fee_for_municipal_lien_certificate",
                    "recording_fee_for_other_document",
                    "recording_fee_for_release",
                    "recording_fee_for_subordination",
                    "recording_fee_total",
                    "recording_service_fee",
                    "redraw_fee",
                    "reinspection_fee",
                    "renovation_consultant_fee",
                    "repairs_fee",
                    "roof_inspection_fee",
                    "septic_inspection_fee",
                    "settlement_fee",
                    "signing_agent_fee",
                    "smoke_detector_inspection_fee",
                    "state_title_insurance_fee",
                    "structural_inspection_fee",
                    "subordination_fee",
                    "survey_fee",
                    "tax_service_fee",
                    "tax_stamp_for_city_deed",
                    "tax_stamp_for_city_mortgage",
                    "tax_stamp_for_county_deed",
                    "tax_stamp_for_county_mortgage",
                    "tax_stamp_for_state_deed",
                    "tax_stamp_for_state_mortgage",
                    "tax_status_research_fee",
                    "temporary_buydown_administration_fee",
                    "temporary_buydown_points",
                    "title_abstract_fee",
                    "title_borrower_closing_protection_letter_fee",
                    "title_certification_fee",
                    "title_closing_coordination_fee",
                    "title_closing_fee",
                    "title_closing_protection_letter_fee",
                    "title_commitment_fee",
                    "title_document_preparation_fee",
                    "title_endorsement_fee",
                    "title_examination_fee",
                    "title_final_policy_short_form_fee",
                    "title_insurance_binder_fee",
                    "title_insurance_fee",
                    "title_lenders_coverage_premium",
                    "title_notary_fee",
                    "title_owners_coverage_premium",
                    "title_search_fee",
                    "title_services_fee_total",
                    "title_services_sales_tax",
                    "title_sub_escrow_fee",
                    "title_subordination_processing_fee",
                    "title_underwriting_issue_resolution_fee",
                    "transfer_tax_total",
                    "underwriting_fee",
                    "usda_rural_development_guarantee_fee",
                    "va_funding_fee",
                    "verification_of_assets_fee",
                    "verification_of_employment_fee",
                    "verification_of_income_fee",
                    "verification_of_residency_status_fee",
                    "verification_of_tax_return_fee",
                    "verification_of_taxpayer_identification_fee",
                    "water_testing_fee",
                    "well_inspection_fee",
                    "wire_transfer_fee"
                  ]
                }
              }
            }
          }
        }
      },
      "fee_payments": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_fee_estimated_payment_amount",
            "has_fee_payment_responsible_party_type"
          ],
          "additionalProperties": false,
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_fee_estimated_payment_amount": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "additionalProperties": false,
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "has_fee_payment_responsible_party_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "additionalProperties": false,
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "branch",
                    "broker",
                    "buyer",
                    "lender",
                    "other",
                    "seller"
                  ]
                }
              }
            }
          }
        }
      },
      "organizations": {
        "type": "array",
        "required": [
          "@id",
          "@type",
          "has_organization_name"
        ],
        "items": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_organization_name": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "additionalProperties": false,
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

application/json

Response schema (possibly with examples) is successfully returned.

{
  "schema": {
    "type": "object",
    "additionalProperties": false,
    "required": [
      "fees",
      "fee_payments",
      "organizations"
    ],
    "properties": {
      "fees": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "with_fee_payment",
            "has_fee_type"
          ],
          "additionalProperties": false,
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "with_fee_payment": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "paid_to": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "has_fee_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "additionalProperties": false,
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "203k_consultant_fee",
                    "203k_discount_on_repairs",
                    "203k_inspection_fee",
                    "203k_permits",
                    "203k_supplemental_origination_fee",
                    "203k_title_update",
                    "application_fee",
                    "appraisal_desk_review_fee",
                    "appraisal_fee",
                    "appraisal_field_review_fee",
                    "appraisal_management_company_fee",
                    "arm_conversion_fee",
                    "asbestos_inspection_fee",
                    "assignment_preparation_fee",
                    "assumption_fee",
                    "attorney_fee",
                    "automated_underwriting_fee",
                    "avm_fee",
                    "bankruptcy_monitoring_fee",
                    "bond_fee",
                    "bond_review_fee",
                    "certification_fee",
                    "chosen_interest_rate_credit_or_charge_total",
                    "commitment_fee",
                    "condominium_association_dues",
                    "condominium_association_special_assessment",
                    "construction_handling_fee",
                    "construction_inspection_fee",
                    "cooperative_association_dues",
                    "cooperative_association_special_assessment",
                    "copy_or_fax_fee",
                    "courier_fee",
                    "credit_disability_insurance_premium",
                    "credit_life_insurance_premium",
                    "credit_property_insurance_premium",
                    "credit_report_fee",
                    "credit_unemployment_insurance_premium",
                    "debt_cancellation_insurance_premium",
                    "debt_suspension_insurance_premium",
                    "deed_preparation_fee",
                    "disaster_inspection_fee",
                    "discount_on_repairs_fee",
                    "document_preparation_fee",
                    "documentary_stamp_fee",
                    "down_payment_protection_fee",
                    "dry_wall_inspection_fee",
                    "electrical_inspection_fee",
                    "electronic_document_delivery_fee",
                    "environmental_inspection_fee",
                    "escrow_holdback_fee",
                    "escrow_service_fee",
                    "escrow_waiver_fee",
                    "filing_fee",
                    "flood_certification",
                    "foundation_inspection_fee",
                    "heating_cooling_inspection_fee",
                    "heloc_annual_fee",
                    "heloc_over_limit_fee",
                    "high_cost_mortgage_counseling_fee",
                    "home_inspection_fee",
                    "home_warranty_fee",
                    "homeowners_association_dues",
                    "homeowners_association_service_fee",
                    "homeowners_association_special_assessment",
                    "late_charge",
                    "lead_inspection_fee",
                    "lenders_attorney_fee",
                    "loan_discount_points",
                    "loan_level_price_adjustment",
                    "loan_origination_fee",
                    "loan_originator_compensation",
                    "manual_underwriting_fee",
                    "manufactured_housing_inspection_fee",
                    "manufactured_housing_processing_fee",
                    "mers_registration_fee",
                    "modification_fee",
                    "mold_inspection_fee",
                    "mortgage_broker_fee",
                    "mortgage_insurance_initial_premium",
                    "mortgage_insurance_upfront_premium",
                    "mortgage_surcharge_county_or_parish",
                    "mortgage_surcharge_municipal",
                    "mortgage_surcharge_state",
                    "mortgage_tax_credit_service_fee",
                    "multiple_loans_closing_fee",
                    "municipal_lien_certificate_fee",
                    "non_sufficient_funds_fee",
                    "notary_fee",
                    "other",
                    "our_origination_charge_total",
                    "partial_lien_release_fee",
                    "payoff_request_fee",
                    "pest_inspection_fee",
                    "plumbing_inspection_fee",
                    "power_of_attorney_preparation_fee",
                    "power_of_attorney_recording_fee",
                    "preclosing_verification_control_fee",
                    "processing_fee",
                    "program_guarantee_fee",
                    "property_inspection_waiver_fee",
                    "radon_inspection_fee",
                    "rate_lock_fee",
                    "real_estate_commission_buyers_broker",
                    "real_estate_commission_sellers_broker",
                    "reconveyance_fee",
                    "reconveyance_tracking_fee",
                    "recording_fee_for_assignment",
                    "recording_fee_for_deed",
                    "recording_fee_for_mortgage",
                    "recording_fee_for_municipal_lien_certificate",
                    "recording_fee_for_other_document",
                    "recording_fee_for_release",
                    "recording_fee_for_subordination",
                    "recording_fee_total",
                    "recording_service_fee",
                    "redraw_fee",
                    "reinspection_fee",
                    "renovation_consultant_fee",
                    "repairs_fee",
                    "roof_inspection_fee",
                    "septic_inspection_fee",
                    "settlement_fee",
                    "signing_agent_fee",
                    "smoke_detector_inspection_fee",
                    "state_title_insurance_fee",
                    "structural_inspection_fee",
                    "subordination_fee",
                    "survey_fee",
                    "tax_service_fee",
                    "tax_stamp_for_city_deed",
                    "tax_stamp_for_city_mortgage",
                    "tax_stamp_for_county_deed",
                    "tax_stamp_for_county_mortgage",
                    "tax_stamp_for_state_deed",
                    "tax_stamp_for_state_mortgage",
                    "tax_status_research_fee",
                    "temporary_buydown_administration_fee",
                    "temporary_buydown_points",
                    "title_abstract_fee",
                    "title_borrower_closing_protection_letter_fee",
                    "title_certification_fee",
                    "title_closing_coordination_fee",
                    "title_closing_fee",
                    "title_closing_protection_letter_fee",
                    "title_commitment_fee",
                    "title_document_preparation_fee",
                    "title_endorsement_fee",
                    "title_examination_fee",
                    "title_final_policy_short_form_fee",
                    "title_insurance_binder_fee",
                    "title_insurance_fee",
                    "title_lenders_coverage_premium",
                    "title_notary_fee",
                    "title_owners_coverage_premium",
                    "title_search_fee",
                    "title_services_fee_total",
                    "title_services_sales_tax",
                    "title_sub_escrow_fee",
                    "title_subordination_processing_fee",
                    "title_underwriting_issue_resolution_fee",
                    "transfer_tax_total",
                    "underwriting_fee",
                    "usda_rural_development_guarantee_fee",
                    "va_funding_fee",
                    "verification_of_assets_fee",
                    "verification_of_employment_fee",
                    "verification_of_income_fee",
                    "verification_of_residency_status_fee",
                    "verification_of_tax_return_fee",
                    "verification_of_taxpayer_identification_fee",
                    "water_testing_fee",
                    "well_inspection_fee",
                    "wire_transfer_fee"
                  ]
                }
              }
            }
          }
        }
      },
      "fee_payments": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_fee_estimated_payment_amount",
            "has_fee_payment_responsible_party_type"
          ],
          "additionalProperties": false,
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_fee_estimated_payment_amount": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "additionalProperties": false,
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "has_fee_payment_responsible_party_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "additionalProperties": false,
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "branch",
                    "broker",
                    "buyer",
                    "lender",
                    "other",
                    "seller"
                  ]
                }
              }
            }
          }
        }
      },
      "organizations": {
        "type": "array",
        "required": [
          "@id",
          "@type",
          "has_organization_name"
        ],
        "items": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_organization_name": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "additionalProperties": false,
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "examples": [
    {
      "fees": [
        {
          "@id": "01FNTJW9GGM6GHQSVYN73NX630",
          "@type": "fee",
          "has_fee_type": {
            "has_value": "recording_fee_for_deed"
          },
          "with_fee_payment": [
            "01FNTJWAE246AVTJYDXTEQK7SA"
          ]
        },
        {
          "@id": "01FNTJW9GSNCSF7TGQ3JAQTCE8",
          "@type": "fee",
          "has_fee_type": {
            "has_value": "recording_fee_for_mortgage"
          },
          "with_fee_payment": [
            "01FNTJWAE2W17RB50Y00R4EWH3"
          ]
        },
        {
          "@id": "01FNTJW9H20TWMS42FGB7HT4RR",
          "@type": "fee",
          "has_fee_type": {
            "has_value": "tax_stamp_for_state_mortgage"
          },
          "paid_to": [
            "01FNTJWAE5527FEKVY4M1398EV"
          ],
          "with_fee_payment": [
            "01FNTJWAE2TAZGAVXR2E3KTPM6",
            "01FNTJWAE2HEEGCMB5PW56T9PZ"
          ]
        },
        {
          "@id": "01FNTJW9H27FS1YNC6QCMFY4A5",
          "@type": "fee",
          "has_fee_type": {
            "has_value": "tax_stamp_for_state_deed"
          },
          "paid_to": [
            "01FNTJWAE5527FEKVY4M1398EV"
          ],
          "with_fee_payment": [
            "01FNTJWAE33DFB3WWQHW6W20G3"
          ]
        },
        {
          "@id": "01FNTJW9H2JWWRZHG05NEDTWPM",
          "@type": "fee",
          "has_fee_type": {
            "has_value": "tax_stamp_for_city_mortgage"
          },
          "paid_to": [
            "01FNTJWAE58VZ8ZXCSZ88ZDV4P"
          ],
          "with_fee_payment": [
            "01FNTJWAE38989RS7JM88AQSWE"
          ]
        }
      ],
      "fee_payments": [
        {
          "@id": "01FNTJWAE246AVTJYDXTEQK7SA",
          "@type": "fee_payment",
          "has_fee_estimated_payment_amount": {
            "has_value": 405
          },
          "has_fee_payment_responsible_party_type": {
            "has_value": "buyer"
          }
        },
        {
          "@id": "01FNTJWAE2W17RB50Y00R4EWH3",
          "@type": "fee_payment",
          "has_fee_estimated_payment_amount": {
            "has_value": 460
          },
          "has_fee_payment_responsible_party_type": {
            "has_value": "buyer"
          }
        },
        {
          "@id": "01FNTJWAE2TAZGAVXR2E3KTPM6",
          "@type": "fee_payment",
          "has_fee_estimated_payment_amount": {
            "has_value": 6400
          },
          "has_fee_payment_responsible_party_type": {
            "has_value": "buyer"
          }
        },
        {
          "@id": "01FNTJWAE2HEEGCMB5PW56T9PZ",
          "@type": "fee_payment",
          "has_fee_estimated_payment_amount": {
            "has_value": 2000
          },
          "has_fee_payment_responsible_party_type": {
            "has_value": "lender"
          }
        },
        {
          "@id": "01FNTJWAE33DFB3WWQHW6W20G3",
          "@type": "fee_payment",
          "has_fee_estimated_payment_amount": {
            "has_value": 4400
          },
          "has_fee_payment_responsible_party_type": {
            "has_value": "seller"
          }
        },
        {
          "@id": "01FNTJWAE38989RS7JM88AQSWE",
          "@type": "fee_payment",
          "has_fee_estimated_payment_amount": {
            "has_value": 19000
          },
          "has_fee_payment_responsible_party_type": {
            "has_value": "buyer"
          }
        }
      ],
      "organizations": [
        {
          "@id": "01FNTJWAE5527FEKVY4M1398EV",
          "@type": "organization",
          "has_organization_name": {
            "has_value": "New York State"
          }
        },
        {
          "@id": "01FNTJWAE58VZ8ZXCSZ88ZDV4P",
          "@type": "organization",
          "has_organization_name": {
            "has_value": "Riverhead City"
          }
        }
      ]
    }
  ]
}

application/json

403 invalid error

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

application/json

Internal server error

{
  "message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}

Parameters

Parameter	Type	Description
`x-api-key` required	`string` header	Environment API Key.
`return_examples`	`boolean` query	If included and set to `true`, returns one or more pre-filled examples that conform to the schema. Default to `false`

Response `200application/json`

2 fields

Response schema (possibly with examples) is successfully returned.

Field	Type	Description
`schema`required	`object`	JSON-Schema as a single object
`examples`	`object`	A key-value pair for the examples. Keys are the example names, while values correspond to the example values for the response collections you can retrieve.

Response `400application/json`

1 fields

Error

Field	Type	Description
`message`	`string`	Message

Response `403application/json`

2 fields

403 invalid error

Field	Type	Description
`message`	`string`	Error message.
`url`	`string`	Error additional URL.

Response `404application/json`

1 fields

Resource not found

Field	Type	Description
`message`	`string`	Error Message.

Response `500application/json`

1 fields

Internal server error

Field	Type	Description
`message`	`string`	Error message.

Platform

POST /transactions

Create Transaction

createTransaction

Create Transaction creates a transaction in Staircase. Transactions in Staircase are containers for all the data related to an instance of a transaction type. They enable you to correlate the output of various products to a single transaction type, where the transaction type depends on your line of business.

Transactions are identified by a unique key called transaction_id. As you use different Staircase products to gather the data needed for a specific instance of your transaction type, and receive different sets of output from each product, use the same transaction_id to correlate all the outputs to the same transaction. A transaction_id, when used properly, gives you a holistic view of the data related to the transaction you’ve assembled.

To access all collections associated with a given transaction_id, try out /transactions/{transaction_id}/collections

Response

application/json

Transaction created successfully

{
  "transaction_id": "01F0KHK7DN3H5JZ4QJKMYAM6GB",
  "created_at": "03/04/2021, 1:04:05 PM EST"
}

application/json

403 invalid error

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

application/json

Internal server error

{
  "message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}

Parameters

Parameter	Type	Description
`x-api-key` required	`string` header	Environment API Key.

Response `201application/json`

2 fields

Transaction created successfully

Field	Type	Description
`transaction_id`	`string (ulid)`	Staircase Transaction IdentifierExample `01F0KHK7DN3H5JZ4QJKMYAM6GB`
`created_at`	`string`	Staircase time string.Example `03/03/2021, 8:24:04 AM EST`

Response `403application/json`

2 fields

403 invalid error

Field	Type	Description
`message`	`string`	Error message.
`url`	`string`	Error additional URL.

Response `500application/json`

1 fields

Internal server error

Field	Type	Description
`message`	`string`	Error message.

Other responses

400

POST /transactions/{transaction_id}/collections

Create Collection

createCollection

Create Collection creates a collection of data points required for product invocation. A collection contains a digital representation of the input or output data for the product and is identified by collection_id.

The Example below contains a sample collection that you can use to make the product invocation in /products/fees/invocations

Request

application/json

{
  "data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_inspection": [
          "01FMM41S2R86Q33TC28H9RC191",
          "01FMM41S2R86Q33TC28H9RC192"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "has_property_structure_built_year": {
          "has_value": 2020
        },
        "has_gross_living_area_square_feet_number": {
          "has_value": 120
        },
        "has_planned_unit_development_pud_indicator": {
          "has_value": true
        },
        "has_project_type": {
          "has_value": "condominium"
        },
        "has_construction_method_type": {
          "has_value": "manufactured"
        }
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "has_mers_mortgage_identification_number": {
          "has_value": "id123"
        },
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_balloon_indicator": {
          "has_value": true
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "inspections": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC191",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "home_inspection"
        }
      },
      {
        "@id": "01FMM41S2R86Q33TC28H9RC192",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "pest"
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 800000
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 14
        },
        "has_page_number_last": {
          "has_value": 16
        }
      },
      {
        "@id": "01FMM23S2R86Q22TC28K9RC191",
        "@type": "conveyance_deed_bargain_and_sale_deed",
        "has_page_number_first": {
          "has_value": 17
        },
        "has_page_number_last": {
          "has_value": 20
        }
      },
      {
        "@id": "01FMM24S2R86Q33TC28T9RC191",
        "@type": "conveyance_deed_quit_claim_deed",
        "has_page_number_first": {
          "has_value": 21
        },
        "has_page_number_last": {
          "has_value": 24
        }
      },
      {
        "@id": "01FMM25S2R86Q44TC28X9RC191",
        "@type": "conveyance_deed_warranty_deed",
        "has_page_number_first": {
          "has_value": 25
        },
        "has_page_number_last": {
          "has_value": 30
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 13
        }
      }
    ]
  }
}

application/json

{
  "data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "has_property_current_occupancy_type": {
          "has_value": "owner_occupied"
        },
        "has_project_type": {
          "has_value": "condominium"
        },
        "has_number_of_units_type": {
          "has_value": "one"
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 500000
        }
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5A"
        ],
        "with_borrower": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "funded_by": [
          "01FMM41S2RE99T8XGQJCMTE8E"
        ],
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        },
        "has_mers_mortgage_identification_number": {
          "has_value": "id123"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5A",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_balloon_indicator": {
          "has_value": true
        },
        "has_loan_maturity_due_date": {
          "has_value": "2021-10-22"
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 4
        },
        "has_page_number_last": {
          "has_value": 5
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 3
        }
      }
    ],
    "organizations": [
      {
        "@id": "01FMM41S2RE99T8XGQJCMTE8E",
        "@type": "lender",
        "has_organization_name": {
          "has_value": "lender_organization"
        },
        "has_credit_union_indicator": {
          "has_value": true
        }
      }
    ],
    "declarations": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCKUHDF5J",
        "@type": "declaration",
        "has_intent_to_occupy_indicator": {
          "has_value": true
        },
        "has_borrower_first_time_home_buyer_indicator": {
          "has_value": true
        }
      }
    ],
    "people": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "borrower",
        "has_birth_date": {
          "has_value": "1950-10-10"
        }
      }
    ]
  }
}

application/json

{
  "data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "has_planned_unit_development_pud_indicator": {
          "has_value": true
        },
        "has_project_type": {
          "has_value": "condominium"
        },
        "has_construction_method_type": {
          "has_value": "manufactured"
        }
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "has_mers_mortgage_identification_number": {
          "has_value": "id123"
        },
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_balloon_indicator": {
          "has_value": true
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 800000
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 3
        },
        "has_page_number_last": {
          "has_value": 6
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 2
        }
      }
    ]
  }
}

application/json

{
  "data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "has_property_structure_built_year": {
          "has_value": 2020
        },
        "has_gross_living_area_square_feet_number": {
          "has_value": 120
        },
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "with_inspection": [
          "01FMM41S2R86Q33TC28H9RC191",
          "01FMM41S2R86Q33TC28H9RC192"
        ]
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "inspections": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC191",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "home_inspection"
        }
      },
      {
        "@id": "01FMM41S2R86Q33TC28H9RC192",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "pest"
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 800000
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 3
        },
        "has_page_number_last": {
          "has_value": 6
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 2
        }
      }
    ]
  }
}

Response

application/json

Collection created successfully

{
  "transaction_id": "01F0KHK7DN3H5JZ4QJKMYAM6GB",
  "collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN",
  "metadata": {
    "created_at": "2021-09-14T03:08:00.284090-04:00",
    "validation": false
  },
  "data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_inspection": [
          "01FMM41S2R86Q33TC28H9RC191",
          "01FMM41S2R86Q33TC28H9RC192"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "has_property_structure_built_year": {
          "has_value": 2020
        },
        "has_gross_living_area_square_feet_number": {
          "has_value": 120
        },
        "has_planned_unit_development_pud_indicator": {
          "has_value": true
        },
        "has_project_type": {
          "has_value": "condominium"
        },
        "has_construction_method_type": {
          "has_value": "manufactured"
        }
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "has_mers_mortgage_identification_number": {
          "has_value": "id123"
        },
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_balloon_indicator": {
          "has_value": true
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "inspections": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC191",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "home_inspection"
        }
      },
      {
        "@id": "01FMM41S2R86Q33TC28H9RC192",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "pest"
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 800000
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 14
        },
        "has_page_number_last": {
          "has_value": 16
        }
      },
      {
        "@id": "01FMM23S2R86Q22TC28K9RC191",
        "@type": "conveyance_deed_bargain_and_sale_deed",
        "has_page_number_first": {
          "has_value": 17
        },
        "has_page_number_last": {
          "has_value": 20
        }
      },
      {
        "@id": "01FMM24S2R86Q33TC28T9RC191",
        "@type": "conveyance_deed_quit_claim_deed",
        "has_page_number_first": {
          "has_value": 21
        },
        "has_page_number_last": {
          "has_value": 24
        }
      },
      {
        "@id": "01FMM25S2R86Q44TC28X9RC191",
        "@type": "conveyance_deed_warranty_deed",
        "has_page_number_first": {
          "has_value": 25
        },
        "has_page_number_last": {
          "has_value": 30
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 13
        }
      }
    ]
  }
}

application/json

403 invalid error

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

application/json

Internal server error

{
  "message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	—	Environment API Key.
`transaction_id` required	`string (ulid)` path	`01F0KHK7DN3H5JZ4QJKMYAM6GB`	Staircase Transaction Identifier

Request body`application/json`

1 fields

Field	Type	Description
`data`	`object`	The data that is needed for invocation. It should follow the request schema
`properties`required	`object[]`	Add the Property related with the Loan in this container
`@id`required	`string`	—
`@type`required	`string`	`subject_property`
`with_address`required	`string[]`	—
`with_sales_contract`required	`string[]`	—
`with_value`	`string[]`	—
`with_inspection`	`string[]`	—
`with_property_title`	`string[]`	—
`with_legal_description`	`string[]`	—
`has_property_structure_built_year`	`object`	—
`has_value`required	`integer`	—
`has_gross_living_area_square_feet_number`	`object`	—
`has_value`required	`number`	—
`has_planned_unit_development_pud_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_project_type`	`object`	—
`has_value`required	`string`	`common_interest_apartmentcondominiumcooperativeother`
`has_number_of_units_type`	`object`	—
`has_value`required	`string`	`fouronethreetwotwo_to_four`
`has_property_current_occupancy_type`	`object`	—
`has_value`required	`string`	`abandonedadverse_occupiedoccupied_by_unknownowner_occupiedpartially_vacanttenant_occupiedunknownvacant`
`has_construction_method_type`	`object`	—
`has_value`required	`string`	`manufacturedmobile_homemodularon_frame_modularothersite_built`
`has_land_use_type`	`object`	—
`has_value`required	`string`	`manufacturedmobile_homemodularon_frame_modularothersite_built`
`addresses`required	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	—
`has_state_code`required	`object`	—
`has_value`required	`string`	—
`has_county_name`required	`object`	—
`has_value`required	`string`	—
`has_city_name`required	`object`	—
`has_value`required	`string`	—
`has_postal_code`required	`object`	—
`has_value`required	`string`	—
`has_address_line_1_text`	`object`	—
`has_value`required	`string`	—
`sales_contracts`required	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`sales_contract`
`has_sales_contract_amount`required	`object`	Deed Taxes & Fees are calculated according to this parameter
`has_value`required	`number`	—
`loans`required	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`loan`
`with_loan_terms`required	`string[]`	—
`with_borrower`	`string[]`	—
`with_modification_information`	`string[]`	—
`with_closing_cost_fee_information`	`string[]`	—
`funded_by`	`string[]`	—
`has_mers_mortgage_identification_number`	`object`	—
`has_value`required	`string`	—
`has_loan_closing_date`	`object`	—
`has_value`required	`string`	—
`has_current_unpaid_principal_balance_upb_amount`	`object`	Old loans unpaid principal balance
`has_value`required	`number`	—
`loan_terms`required	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`loan_term`
`has_note_amount`required	`object`	Mortgage Taxes & Fees are calculated according to this parameter
`has_value`required	`number`	—
`has_loan_amortization_type`	`object`	Title Insurance: When provided endorsements are updated accordingly
`has_value`required	`string`	`adjustable_ratefixed_ratehome_equity_line_of_creditpayment_option_adjustable_rate`
`has_balloon_indicator`	`object`	Title Insurance: When provided an additional endorsement for Balloon Mortgage is returned
`has_value`required	`boolean`	—
`has_loan_purpose_type`	`object`	—
`has_value`required	`string`	`otherpurchaserefinance`
`has_loan_maturity_due_date`	`object`	—
`has_value`required	`string`	—
`documents`required	`object[]`	Documents: Mortgage and Deed recording fees are calculated based on these documents page count.
`@id`required	`string`	—
`@type`required	`string`	`conveyance_deedconveyance_deed_bargain_and_sale_deedconveyance_deed_quit_claim_deedconveyance_deed_warranty_deednote`
`has_page_number_first`required	`object`	—
`has_value`required	`integer`	—
`has_page_number_last`required	`object`	—
`has_value`required	`integer`	—
`people`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`borrower`
`owes_liability`	`string[]`	—
`has_birth_date`required	`object`	—
`has_value`required	`string`	—
`inspections`	`object[]`	Inspections: When provided inspection fees are returned accordingly.
`@id`required	`string`	—
`@type`required	`string`	`inspection`
`has_property_inspection_purpose_type`required	`object`	—
`has_value`required	`string`	`home_inspectionpest`
`organizations`	`object[]`	Includes organizations such as lenders.
`@id`required	`string`	—
`@type`required	`string`	`lender`
`has_organization_name`required	`object`	—
`has_value`required	`string`	—
`has_credit_union_indicator`	`object`	Indicates whether this organization (only applies to lenders) is a Federal or state-accredited credit union or not.
`has_value`required	`boolean`	—
`declarations`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`declaration`
`has_intent_to_occupy_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_borrower_first_time_home_buyer_indicator`	`object`	—
`has_value`required	`boolean`	—
`current_owner_is_senior_citizen_blind_or_disabled_person_indicator`	`object`	—
`has_value`required	`boolean`	—
`property_valuations`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`property_valuation`
`has_property_valuation_amount`required	`object`	—
`has_value`required	`number`	—
`modification_information`	`object[]`	Connects Loan object with Modification object
`@id`required	`string`	—
`@type`required	`string`	`modification_information`
`with_modification`required	`string[]`	—
`modifications`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`modification_information`
`with_modification_aspect`required	`string[]`	—
`modification_aspects`	`object[]`	Includes information about what is being changed in a loan
`@id`required	`string`	—
`@type`required	`string`	`modification_aspect`
`has_loan_modification_type`required	`object`	—
`has_value`required	`string`	`amortization_methodinterest_ratematurity_dateotherpayment_amountpayment_frequencyprincipal_amount`
`liabilities`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`liability`
`has_liability_type`required	`object`	—
`has_value`required	`string`	`heloc`
`property_titles`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`property_title`
`legal_descriptions`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`legal_description`
`with_parsed_legal_description`required	`string[]`	—
`with_parcel_identification`required	`string[]`	—
`parcel_identifications`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`platted_land`
`parsed_legal_descriptions`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`parsed_legal_description`
`with_platted_land`required	`string[]`	—
`with_unplatted_land`required	`string[]`	—
`platted_lands`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`platted_land`
`unplatted_lands`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`unplatted_land`
`closing_cost_fee_information`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`closing_cost_fee_information`
`has_closing_cost_fee_al_modification_time_to_pay_extended_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_al_modification_loan_amount_increasing_from_original_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ca_all_recording_exempt_from_additional_real_estate_fraud_prosecution_trust_fund_fee_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ca_deed_taxable_quit_claim_deed_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ca_release_multicaption_document_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ca_release_captions_number`	`object`	—
`has_value`required	`integer`	—
`has_closing_cost_fee_ca_release_any_document_has_assignment_of_mortgage_or_rent_as_second_title_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_deed_mortgage_and_deed_recorded_at_same_time_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_fl_modification_exempt_from_intangible_tax_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ga_modification_lender_and_borrower_unchanged_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_il_all_recorded_documents_exempt_from_mail_handling_fee_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ma_deed_municipal_lien_certificate_being_recorded_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_md_modification_lender_assumed_previous_debt_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_md_refinance_original_purchase_money_mortgage_older_than_12_months_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_fee_ny_modification_number_of_colsolidation_references`	`object`	—
`has_value`required	`integer`	—
`has_closing_cost_fee_ny_modification_references_to_assignment_number`	`object`	—
`has_value`required	`integer`	—
`has_closing_cost_fee_ny_modification_cema_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ny_deed_residential_real_property_ratio`	`object`	—
`has_value`required	`number`	—
`has_closing_cost_fee_ny_refinance_previous_mortgage_in_past_12_months_amount`	`object`	—
`has_value`required	`number`	—
`has_closing_cost_fee_pa_deed_executory_construction_contract_prior_to_or_during_title_transfer_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_va_modification_existing_debt_certified_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_wa_release_second_title_type`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_wa_release_captions_or_titles_number`	`object`	—
`has_value`required	`integer`	—

Response `201application/json`

4 fields

Collection created successfully

Field	Type	Description
`transaction_id`	`string (ulid)`	Transaction ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF`
`collection_id`	`string (ulid)`	Collection ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF`
`data`	`object`	Data in Staircase language schema.
`metadata`	`object`	Metadata about collection, f.e version of used Staircase schema.

Response `400application/json`

1 fields

Error

Field	Type	Description
`message`	`one of`	Either message object with more properties.

Response `403application/json`

2 fields

403 invalid error

Field	Type	Description
`message`	`string`	Error message.
`url`	`string`	Error additional URL.

Response `404application/json`

1 fields

Resource not found

Field	Type	Description
`message`	`string`	Message

Response `500application/json`

1 fields

Internal server error

Field	Type	Description
`message`	`string`	Error message.

Other responses

405

GET /transactions/{transaction_id}/collections/{collection_id}

Retrieve Collection

retrieveCollection

Retrieve Collection returns the content of a given collection_id associated with a transaction_id.

Response

application/json

403 invalid error

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

application/json

Internal server error

{
  "message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	—	Environment API Key.
`transaction_id` required	`string (ulid)` path	`01F0KHK7DN3H5JZ4QJKMYAM6GB`	Staircase Transaction Identifier
`collection_id` required	`string (ulid)` path	`01F0KHKADN0HRFXMCQQXPA6AFZ`	Staircase collection_id

Response `200application/json`

4 fields

Successfully Retrieved Collection

Field	Type	Description
`transaction_id`required	`string`	—
`collection_id`required	`string`	—
`metadata`required	`object`	—
`created_at`required	`string`	—
`validation`required	`boolean`	—
`data`required	`object`	—

Response `403application/json`

2 fields

403 invalid error

Field	Type	Description
`message`	`string`	Error message.
`url`	`string`	Error additional URL.

Response `404application/json`

1 fields

Resource not found

Field	Type	Description
`message`	`string`	Message

Response `500application/json`

1 fields

Internal server error

Field	Type	Description
`message`	`string`	Error message.

Other responses

400

GET /transactions/{transaction_id}/collections

Retrieve Transaction Collections

RetrieveTransactionCollections

Retrieve Transaction Collections returns the content of a given collection_id associated with a specific transaction_id.

Response

application/json

Transaction collection retrieved successfully

{
  "metadata": {
    "created_at": "2021-09-14T03:08:00.284090-04:00",
    "validation": false
  },
  "transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
  "collection_id": "01FFHJ4JCWGHV38SC1NJ8TVNFY",
  "data": {}
}

application/json

403 invalid error

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

application/json

Internal server error

{
  "message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	—	Environment API Key.
`transaction_id` required	`string (ulid)` path	`01F0KHK7DN3H5JZ4QJKMYAM6GB`	Staircase Transaction Identifier

Response `200application/json`

4 fields

Transaction collection retrieved successfully

Field	Type	Description
`transaction_id`	`string (ulid)`	Transaction ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF`
`collection_id`	`string (ulid)`	Collection ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF`
`data`	`object`	Data in Staircase language schema.
`metadata`	`object`	Metadata about collection, f.e version of used Staircase schema.

Response `400application/json`

1 fields

Error

Field	Type	Description
`message`	`one of`	Either message object with more properties.

Response `403application/json`

2 fields

403 invalid error

Field	Type	Description
`message`	`string`	Error message.
`url`	`string`	Error additional URL.

Response `404application/json`

1 fields

Resource not found

Field	Type	Description
`message`	`string`	Message

Response `500application/json`

1 fields

Internal server error

Field	Type	Description
`message`	`string`	Error message.

PUT /transactions/{transaction_id}/collections/{collection_id}

Update Collection

updateCollection

Update Collection allows you to update the content of a given collection_id associated with a transaction_id.

Request

application/json

{
  "data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_inspection": [
          "01FMM41S2R86Q33TC28H9RC191",
          "01FMM41S2R86Q33TC28H9RC192"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "has_property_structure_built_year": {
          "has_value": 2020
        },
        "has_gross_living_area_square_feet_number": {
          "has_value": 120
        },
        "has_planned_unit_development_pud_indicator": {
          "has_value": true
        },
        "has_project_type": {
          "has_value": "condominium"
        },
        "has_construction_method_type": {
          "has_value": "manufactured"
        }
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "has_mers_mortgage_identification_number": {
          "has_value": "id123"
        },
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_balloon_indicator": {
          "has_value": true
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "inspections": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC191",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "home_inspection"
        }
      },
      {
        "@id": "01FMM41S2R86Q33TC28H9RC192",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "pest"
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 800000
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 14
        },
        "has_page_number_last": {
          "has_value": 16
        }
      },
      {
        "@id": "01FMM23S2R86Q22TC28K9RC191",
        "@type": "conveyance_deed_bargain_and_sale_deed",
        "has_page_number_first": {
          "has_value": 17
        },
        "has_page_number_last": {
          "has_value": 20
        }
      },
      {
        "@id": "01FMM24S2R86Q33TC28T9RC191",
        "@type": "conveyance_deed_quit_claim_deed",
        "has_page_number_first": {
          "has_value": 21
        },
        "has_page_number_last": {
          "has_value": 24
        }
      },
      {
        "@id": "01FMM25S2R86Q44TC28X9RC191",
        "@type": "conveyance_deed_warranty_deed",
        "has_page_number_first": {
          "has_value": 25
        },
        "has_page_number_last": {
          "has_value": 30
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 13
        }
      }
    ]
  }
}

application/json

{
  "data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "has_property_current_occupancy_type": {
          "has_value": "owner_occupied"
        },
        "has_project_type": {
          "has_value": "condominium"
        },
        "has_number_of_units_type": {
          "has_value": "one"
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 500000
        }
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5A"
        ],
        "with_borrower": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "funded_by": [
          "01FMM41S2RE99T8XGQJCMTE8E"
        ],
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        },
        "has_mers_mortgage_identification_number": {
          "has_value": "id123"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5A",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_balloon_indicator": {
          "has_value": true
        },
        "has_loan_maturity_due_date": {
          "has_value": "2021-10-22"
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 4
        },
        "has_page_number_last": {
          "has_value": 5
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 3
        }
      }
    ],
    "organizations": [
      {
        "@id": "01FMM41S2RE99T8XGQJCMTE8E",
        "@type": "lender",
        "has_organization_name": {
          "has_value": "lender_organization"
        },
        "has_credit_union_indicator": {
          "has_value": true
        }
      }
    ],
    "declarations": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCKUHDF5J",
        "@type": "declaration",
        "has_intent_to_occupy_indicator": {
          "has_value": true
        },
        "has_borrower_first_time_home_buyer_indicator": {
          "has_value": true
        }
      }
    ],
    "people": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "borrower",
        "has_birth_date": {
          "has_value": "1950-10-10"
        }
      }
    ]
  }
}

application/json

{
  "data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "has_planned_unit_development_pud_indicator": {
          "has_value": true
        },
        "has_project_type": {
          "has_value": "condominium"
        },
        "has_construction_method_type": {
          "has_value": "manufactured"
        }
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "has_mers_mortgage_identification_number": {
          "has_value": "id123"
        },
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_balloon_indicator": {
          "has_value": true
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 800000
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 3
        },
        "has_page_number_last": {
          "has_value": 6
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 2
        }
      }
    ]
  }
}

application/json

{
  "data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "has_property_structure_built_year": {
          "has_value": 2020
        },
        "has_gross_living_area_square_feet_number": {
          "has_value": 120
        },
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "with_inspection": [
          "01FMM41S2R86Q33TC28H9RC191",
          "01FMM41S2R86Q33TC28H9RC192"
        ]
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "inspections": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC191",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "home_inspection"
        }
      },
      {
        "@id": "01FMM41S2R86Q33TC28H9RC192",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "pest"
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 800000
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 3
        },
        "has_page_number_last": {
          "has_value": 6
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 2
        }
      }
    ]
  }
}

Response

application/json

Collection updated successfully

{
  "transaction_id": "01F0KHK7DN3H5JZ4QJKMYAM6GB",
  "collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN",
  "metadata": {
    "created_at": "2021-09-14T03:08:00.284090-04:00",
    "validation": false
  },
  "data": {
    "properties": [
      {
        "@id": "01FMM41S2RE99T8XGQJC2MTE8E",
        "@type": "subject_property",
        "with_address": [
          "01FMM41S2R86Q33TC28H9RC197"
        ],
        "with_sales_contract": [
          "01FDTQ5PJTJLYZ444RCH7TDF5J"
        ],
        "with_inspection": [
          "01FMM41S2R86Q33TC28H9RC191",
          "01FMM41S2R86Q33TC28H9RC192"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ],
        "has_property_structure_built_year": {
          "has_value": 2020
        },
        "has_gross_living_area_square_feet_number": {
          "has_value": 120
        },
        "has_planned_unit_development_pud_indicator": {
          "has_value": true
        },
        "has_project_type": {
          "has_value": "condominium"
        },
        "has_construction_method_type": {
          "has_value": "manufactured"
        }
      }
    ],
    "addresses": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC197",
        "@type": "residential_address",
        "has_county_name": {
          "has_value": "Suffolk"
        },
        "has_state_code": {
          "has_value": "NY"
        },
        "has_city_name": {
          "has_value": "Riverhead"
        },
        "has_postal_code": {
          "has_value": "77069"
        },
        "has_address_line_1_text": {
          "has_value": "5118 Westerham Pl"
        }
      }
    ],
    "loans": [
      {
        "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
        "@type": "loan",
        "with_loan_terms": [
          "01FDTQ5PJTJBJZ777RCH7TDF5J"
        ],
        "has_mers_mortgage_identification_number": {
          "has_value": "id123"
        },
        "has_loan_closing_date": {
          "has_value": "2021-12-25"
        }
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "has_note_amount": {
          "has_value": 800000
        },
        "has_loan_amortization_type": {
          "has_value": "adjustable_rate"
        },
        "has_loan_purpose_type": {
          "has_value": "purchase"
        },
        "has_balloon_indicator": {
          "has_value": true
        }
      }
    ],
    "sales_contracts": [
      {
        "@id": "01FDTQ5PJTJLYZ444RCH7TDF5J",
        "@type": "sales_contract",
        "has_sales_contract_amount": {
          "has_value": 1100000
        }
      }
    ],
    "inspections": [
      {
        "@id": "01FMM41S2R86Q33TC28H9RC191",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "home_inspection"
        }
      },
      {
        "@id": "01FMM41S2R86Q33TC28H9RC192",
        "@type": "inspection",
        "has_property_inspection_purpose_type": {
          "has_value": "pest"
        }
      }
    ],
    "property_valuations": [
      {
        "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
        "@type": "property_valuation",
        "has_property_valuation_amount": {
          "has_value": 800000
        }
      }
    ],
    "documents": [
      {
        "@id": "01FMM22S2R86Q77TC28H9RC191",
        "@type": "conveyance_deed",
        "has_page_number_first": {
          "has_value": 14
        },
        "has_page_number_last": {
          "has_value": 16
        }
      },
      {
        "@id": "01FMM23S2R86Q22TC28K9RC191",
        "@type": "conveyance_deed_bargain_and_sale_deed",
        "has_page_number_first": {
          "has_value": 17
        },
        "has_page_number_last": {
          "has_value": 20
        }
      },
      {
        "@id": "01FMM24S2R86Q33TC28T9RC191",
        "@type": "conveyance_deed_quit_claim_deed",
        "has_page_number_first": {
          "has_value": 21
        },
        "has_page_number_last": {
          "has_value": 24
        }
      },
      {
        "@id": "01FMM25S2R86Q44TC28X9RC191",
        "@type": "conveyance_deed_warranty_deed",
        "has_page_number_first": {
          "has_value": 25
        },
        "has_page_number_last": {
          "has_value": 30
        }
      },
      {
        "@id": "01FMM26S2R86Q99TC28R9RC191",
        "@type": "note",
        "has_page_number_first": {
          "has_value": 1
        },
        "has_page_number_last": {
          "has_value": 13
        }
      }
    ]
  }
}

application/json

403 invalid error

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

application/json

Internal server error

{
  "message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	—	Environment API Key.
`transaction_id` required	`string (ulid)` path	`01F0KHK7DN3H5JZ4QJKMYAM6GB`	Staircase Transaction Identifier
`collection_id` required	`string (ulid)` path	`01F0KHKADN0HRFXMCQQXPA6AFZ`	Staircase collection_id

Request body`application/json`

1 fields

Field	Type	Description
`data`	`object`	The data that is needed for invocation. It should follow the request schema
`properties`required	`object[]`	Add the Property related with the Loan in this container
`@id`required	`string`	—
`@type`required	`string`	`subject_property`
`with_address`required	`string[]`	—
`with_sales_contract`required	`string[]`	—
`with_value`	`string[]`	—
`with_inspection`	`string[]`	—
`with_property_title`	`string[]`	—
`with_legal_description`	`string[]`	—
`has_property_structure_built_year`	`object`	—
`has_value`required	`integer`	—
`has_gross_living_area_square_feet_number`	`object`	—
`has_value`required	`number`	—
`has_planned_unit_development_pud_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_project_type`	`object`	—
`has_value`required	`string`	`common_interest_apartmentcondominiumcooperativeother`
`has_number_of_units_type`	`object`	—
`has_value`required	`string`	`fouronethreetwotwo_to_four`
`has_property_current_occupancy_type`	`object`	—
`has_value`required	`string`	`abandonedadverse_occupiedoccupied_by_unknownowner_occupiedpartially_vacanttenant_occupiedunknownvacant`
`has_construction_method_type`	`object`	—
`has_value`required	`string`	`manufacturedmobile_homemodularon_frame_modularothersite_built`
`has_land_use_type`	`object`	—
`has_value`required	`string`	`manufacturedmobile_homemodularon_frame_modularothersite_built`
`addresses`required	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	—
`has_state_code`required	`object`	—
`has_value`required	`string`	—
`has_county_name`required	`object`	—
`has_value`required	`string`	—
`has_city_name`required	`object`	—
`has_value`required	`string`	—
`has_postal_code`required	`object`	—
`has_value`required	`string`	—
`has_address_line_1_text`	`object`	—
`has_value`required	`string`	—
`sales_contracts`required	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`sales_contract`
`has_sales_contract_amount`required	`object`	Deed Taxes & Fees are calculated according to this parameter
`has_value`required	`number`	—
`loans`required	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`loan`
`with_loan_terms`required	`string[]`	—
`with_borrower`	`string[]`	—
`with_modification_information`	`string[]`	—
`with_closing_cost_fee_information`	`string[]`	—
`funded_by`	`string[]`	—
`has_mers_mortgage_identification_number`	`object`	—
`has_value`required	`string`	—
`has_loan_closing_date`	`object`	—
`has_value`required	`string`	—
`has_current_unpaid_principal_balance_upb_amount`	`object`	Old loans unpaid principal balance
`has_value`required	`number`	—
`loan_terms`required	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`loan_term`
`has_note_amount`required	`object`	Mortgage Taxes & Fees are calculated according to this parameter
`has_value`required	`number`	—
`has_loan_amortization_type`	`object`	Title Insurance: When provided endorsements are updated accordingly
`has_value`required	`string`	`adjustable_ratefixed_ratehome_equity_line_of_creditpayment_option_adjustable_rate`
`has_balloon_indicator`	`object`	Title Insurance: When provided an additional endorsement for Balloon Mortgage is returned
`has_value`required	`boolean`	—
`has_loan_purpose_type`	`object`	—
`has_value`required	`string`	`otherpurchaserefinance`
`has_loan_maturity_due_date`	`object`	—
`has_value`required	`string`	—
`documents`required	`object[]`	Documents: Mortgage and Deed recording fees are calculated based on these documents page count.
`@id`required	`string`	—
`@type`required	`string`	`conveyance_deedconveyance_deed_bargain_and_sale_deedconveyance_deed_quit_claim_deedconveyance_deed_warranty_deednote`
`has_page_number_first`required	`object`	—
`has_value`required	`integer`	—
`has_page_number_last`required	`object`	—
`has_value`required	`integer`	—
`people`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`borrower`
`owes_liability`	`string[]`	—
`has_birth_date`required	`object`	—
`has_value`required	`string`	—
`inspections`	`object[]`	Inspections: When provided inspection fees are returned accordingly.
`@id`required	`string`	—
`@type`required	`string`	`inspection`
`has_property_inspection_purpose_type`required	`object`	—
`has_value`required	`string`	`home_inspectionpest`
`organizations`	`object[]`	Includes organizations such as lenders.
`@id`required	`string`	—
`@type`required	`string`	`lender`
`has_organization_name`required	`object`	—
`has_value`required	`string`	—
`has_credit_union_indicator`	`object`	Indicates whether this organization (only applies to lenders) is a Federal or state-accredited credit union or not.
`has_value`required	`boolean`	—
`declarations`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`declaration`
`has_intent_to_occupy_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_borrower_first_time_home_buyer_indicator`	`object`	—
`has_value`required	`boolean`	—
`current_owner_is_senior_citizen_blind_or_disabled_person_indicator`	`object`	—
`has_value`required	`boolean`	—
`property_valuations`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`property_valuation`
`has_property_valuation_amount`required	`object`	—
`has_value`required	`number`	—
`modification_information`	`object[]`	Connects Loan object with Modification object
`@id`required	`string`	—
`@type`required	`string`	`modification_information`
`with_modification`required	`string[]`	—
`modifications`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`modification_information`
`with_modification_aspect`required	`string[]`	—
`modification_aspects`	`object[]`	Includes information about what is being changed in a loan
`@id`required	`string`	—
`@type`required	`string`	`modification_aspect`
`has_loan_modification_type`required	`object`	—
`has_value`required	`string`	`amortization_methodinterest_ratematurity_dateotherpayment_amountpayment_frequencyprincipal_amount`
`liabilities`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`liability`
`has_liability_type`required	`object`	—
`has_value`required	`string`	`heloc`
`property_titles`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`property_title`
`legal_descriptions`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`legal_description`
`with_parsed_legal_description`required	`string[]`	—
`with_parcel_identification`required	`string[]`	—
`parcel_identifications`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`platted_land`
`parsed_legal_descriptions`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`parsed_legal_description`
`with_platted_land`required	`string[]`	—
`with_unplatted_land`required	`string[]`	—
`platted_lands`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`platted_land`
`unplatted_lands`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`unplatted_land`
`closing_cost_fee_information`	`object[]`	—
`@id`required	`string`	—
`@type`required	`string`	`closing_cost_fee_information`
`has_closing_cost_fee_al_modification_time_to_pay_extended_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_al_modification_loan_amount_increasing_from_original_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ca_all_recording_exempt_from_additional_real_estate_fraud_prosecution_trust_fund_fee_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ca_deed_taxable_quit_claim_deed_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ca_release_multicaption_document_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ca_release_captions_number`	`object`	—
`has_value`required	`integer`	—
`has_closing_cost_fee_ca_release_any_document_has_assignment_of_mortgage_or_rent_as_second_title_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_deed_mortgage_and_deed_recorded_at_same_time_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_fl_modification_exempt_from_intangible_tax_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ga_modification_lender_and_borrower_unchanged_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_il_all_recorded_documents_exempt_from_mail_handling_fee_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ma_deed_municipal_lien_certificate_being_recorded_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_md_modification_lender_assumed_previous_debt_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_md_refinance_original_purchase_money_mortgage_older_than_12_months_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_fee_ny_modification_number_of_colsolidation_references`	`object`	—
`has_value`required	`integer`	—
`has_closing_cost_fee_ny_modification_references_to_assignment_number`	`object`	—
`has_value`required	`integer`	—
`has_closing_cost_fee_ny_modification_cema_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_ny_deed_residential_real_property_ratio`	`object`	—
`has_value`required	`number`	—
`has_closing_cost_fee_ny_refinance_previous_mortgage_in_past_12_months_amount`	`object`	—
`has_value`required	`number`	—
`has_closing_cost_fee_pa_deed_executory_construction_contract_prior_to_or_during_title_transfer_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_va_modification_existing_debt_certified_indicator`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_wa_release_second_title_type`	`object`	—
`has_value`required	`boolean`	—
`has_closing_cost_fee_wa_release_captions_or_titles_number`	`object`	—
`has_value`required	`integer`	—

Response `200application/json`

4 fields

Collection updated successfully

Field	Type	Description
`transaction_id`	`string (ulid)`	Transaction ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF`
`collection_id`	`string (ulid)`	Collection ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF`
`data`	`object`	Data in Staircase language schema.
`metadata`	`object`	Metadata about collection, f.e version of used Staircase schema.

Response `400application/json`

1 fields

Error

Field	Type	Description
`message`	`one of`	Either message object with more properties.

Response `403application/json`

2 fields

403 invalid error

Field	Type	Description
`message`	`string`	Error message.
`url`	`string`	Error additional URL.

Response `404application/json`

1 fields

Resource not found

Field	Type	Description
`message`	`string`	Message

Response `500application/json`

1 fields

Internal server error

Field	Type	Description
`message`	`string`	Error message.

Other responses

405

Operations

POST /fees

Create Fees

post-fees

Create Fees creates views of fees and closing data costs for settlement, escrow, and other charges that emerge during the loan decisioning process .

Request

application/json

{
  "transaction_id": "uhz6t54e-9d74-g17e-99ca-a36b30vdfd35",
  "collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
  "partner_name": "PartnerName"
}

Response

application/json

Fees Report request created successfully.

{
  "collection_id": "e4502ed2-8df8-4b8f-84bd-a1097e999a77",
  "message": "When ready, data will be available under the following collection_id. Use this new collection_id to get the execution status."
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`	Authorization key

Request body`application/json`

3 fields

Field	Type	Description
`transaction_id`required	`string`	Transaction ID
`collection_id`required	`string`	Collection ID
`partner_name`required	`string`	—

Response `200application/json`

2 fields

Fees Report request created successfully.

Field	Type	Description
`collection_id`	`string`	Collection ID
`message`	`string`	Message

Errors

400403404405422500

How it works

Operations

Setup

Get Ernst Credentials

Response

Parameters

Response 200application/json

Response 400application/json

Response 403application/json

Response 404application/json

Response 500application/json

Set Ernst Credentials

Usage

Request

Response

Parameters

Request bodyapplication/json

Response 200application/json

Response 400application/json

Response 403application/json

Response 404application/json

Response 422application/json

Response 500application/json

Fees

Fees Info

Response

Response 200application/json

Response 400application/json

Response 403application/json

Response 422application/json

Response 500application/json

Other responses

Workflow

Invoke Product Flow

Usage

Retrieving the Invocation Result

Request Collection Description

Mortgage & Deed Recording Taxes & Fees

Purchase, Refinancing, Modification Purposes

Refinancing, Modification Purposes

Modification Purpose

Title Insurance Fees

Title Insurance Fees Providers

Endorsement Fees

Inspection Fees

Request

Response

Parameters

Response 201application/json

Response 400application/json

Response 403application/json

Response 404application/json

Response 500application/json

Retrieve Invocation Status

Response

Parameters

Response 200application/json

Response 400application/json

Response 403application/json

Response 404application/json

Response 500application/json

Retrieve Request Schema

Response

Parameters

Response 200application/json

Response 400application/json

Response 403application/json

Response 404application/json

Response 500application/json

Retrieve Response Schema

Response

Parameters

Response 200application/json

Response 400application/json

Response 403application/json

Response 404application/json

Response 500application/json

Platform

Create Transaction

Response

Response `200application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `500application/json`

Request body`application/json`

Response `200application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `422application/json`

Response `500application/json`

Response `200application/json`

Response `400application/json`

Response `403application/json`

Response `422application/json`

Response `500application/json`

Response `201application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `500application/json`

Response `200application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `500application/json`

Response `200application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `500application/json`

Response `200application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `500application/json`

Response `201application/json`

Response `403application/json`

Response `500application/json`

Request body`application/json`

Response `201application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `500application/json`

Response `200application/json`

Response `403application/json`

Response `404application/json`

Response `500application/json`

Response `200application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `500application/json`

Request body`application/json`

Response `200application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `500application/json`

Request body`application/json`

Response `200application/json`