Skip to content
Staircase

Price

Best-execution rate and price selection: the eligible-product search across amortisation terms, and the candidate closest to par.

A caller sends the loan characteristics and the borrower's credit profile. The product runs the eligible-product search against the pricing engine and returns the selected product with its rate, price, investor and identifier.

The search runs three times, once per amortisation term — thirty-year fixed, fifteen-year fixed, and thirty-year adjustable — so a caller sees the choice across terms rather than a single quote.

How it works

Selection rule, as recorded: for each term, take the product closest to par whose price is above par. That is a stated rule rather than a scoring model, which is what makes a quote reproducible from the inputs.

Several inputs the engine needs are derived rather than asked for. Debt-to-income is computed from the liability and income totals already on the file, and state and county are derived from the postal code through a lookup rather than collected again.

Operations

Pricing

POST /bestexsearch

Best Execution Search

InvokePricingFlow

Invoke Best Pricing Flow

The Best Execution API facilitates the retrieval of pricing details for the best execution product offered by lenders based on provided borrower and loan information. Additionally, it provides the ability to calculate monthly payments for various buydown options.

API Input

In order to run Best Execution below data is required in the request payload:

  • partner_name, supported partners:

    Show the rest

  • optimalBlue

  • request_data: You need to provide people, properties, loans, incomes, credits classes in your request collection, in addition each of these should have a relationship defined in the relationships list. Below is detailed explaination for the request_data attributes.

    • People
    • first_name - (string) - The person's first name.
    • last_name - (string) - The person's last name.
    • us_citizenship_status - (boolean) - Whether the person is a US citizen.
    • first_time_home_owner - (boolean) - Whether the person is a first time homeowner. Optional - Default: True
    • person_identifier - (string) - The identifier for the person class.
    Properties
    • purchase_price - (string) - The property purchase price.
    • property_type - (string) - The property type. - Possible enum values ["SingleFamily", "Condo", "ManufacturedDoubleWide", "Condotel", "Modular", "PUD", "Timesharer", "ManufacturedSingleWide", "Coop", "NonWarrantableCondo", "Townhouse", "DetachedCondo"] - Optional. Default: SingleFamily
    • property_identifier - (string) - The identifier for the property class.
    • full_address_txt - (string) - The property full address.
    • county_name - (string) - The property county.
    • state_name - (string) - The property state.
    • postal_code - (string) - The postal code.
    • property_identifier - (string) - The identifier for the property class.
    • lien_type - (string) - The property lien type. Optional - Default: "first"
    • numberOfUnits - (string) - The number of units. Optional - Default: OneUnit
    • numberOfStories - (integer) - The number of stories. Optional - Default: 1
    Loans
    • downpayment_amount - (string) - The loan down payment amount.
    • downpayment_percentage - (string) - The loan down payment percentage.
    • monthly_payment - (integer) - The loan monthly payment value
    • buydown_type - (string) - The loan buydown method - Possible enum values ["ThreeTwoOne", "TwoOne", "OneZero", "None"]
    • loan_role_type - (string) - The loan role type.
    • loan_identifier - (string) - The identifier for the loan class.
    • loan_type - (string) - The loan type. Optional Default: conventional
    • loan_purpose - (string) - The loan purpose. Optional Default: purchase
    • interest_only - (boolean) - Whether it's interest only. Optional Default: True
    • prepayment_penalty - (string) - The prepayment penalty. Optional Default: None
    • borrower_paid_mi - (boolean) - Whether the borrower paid the mortgage insurance. Optional Default: False
    • amortization_type - (string) - The loan amortization type. Optional Default: Fixed
    • loan_terms - (string) - The terms of the loan. Optional Default: ThirtyYear
    Incomes
    • annual_income - (integer) - The annual income value for a person.
    • income_identifier - (string) - The identifier for the income class.
    Credits
    • credit_score - (integer) - The credit score for a person.
    • credit_identifier - (string) - The identifier for the credit class.
    Lease
    • lease_identifier - (string) - The identifier for the lease class.
    • monthly_rate - (number) - The monthly rate of the lease.
    Rents
    • rent_identifier - (string) - The identifier for the rent class.
    • monthly_rate - (number) - The monthly rate of the rent.
    Automobiles
    • automobile_identifier - (string) - The identifier for the automobile class.
    • automobile_type - (string) - The automobile type.
    Relationships
    • @type - (string) - The identifier of the relationship class. Possible enum ["finance_relation", "person_credit", "person_income"]
    • Attributes required will vary according to @type. If @type is finance_relation, below are the attributes required:
    • has_person - (string) - The identifier for the people class.
    • has_loan - (string) - The identifier for the loans class.
    • has_property - (string) - The identifier for the properties class.
    • has_rent - (string) - The identifier for the rents class.
    • has_lease - (string) - The identifier for the lease class.
    • has_automobile - (string) - The identifier for the automobiles class.
    • main_applicant - (boolean) - Whether the person is the main applicant.
    • If @type is person_income, below are the attributes required:
    • has_income - (string) - The identifier for the incomes class.
    • has_person - (string) - The identifier for the people class.
    • If @type is person_credit, below are the attributes required:
    • has_credit - (string) - The identifier for the credit class.
    • has_person - (string) - The identifier for the person class.
    • callback_url: If you don't want to continuously poll the result, you can provide a callback_url in request body. Once the invocation is completed, response content will be posted to this endpoint.

    Note: All relationships between classes need to be defined and present in the relationships list. If this is not the case the API may encounter issues getting the correct price.

    In case of invalid request data, you will receive 400 status code with information about missing fields.

    Running Best Execution API

    API can run in two modes:

    • Real Call: In the case of a Real Partner Call, an actual call will be made to the partner. Prior to making this call, it is necessary to call Setup Partner Configurations API through this link. Please note that Staircase and Partners may apply charges for this service.

    • Mock Call: The API will return a mock partner response without making a real call in the case of a mock scenario. To return the corresponding response for each scenario, the API will use the

    People[*].ssn field. However, if any other SSN values are used in the call, the API will switch to Real Partner Call Mode.

    Mock Scenarios Examples

    If you want to test the system and see possible pricing results without invoking partners you can do mock request instead. Create payload as described in Request Payload section above but add ssn field to the person with following values:

    SSN Buydown Type Mock Scenario
    000000001 ThreeTwoOne ThreeTwoOne Buydown Response
    000000001 TwoOne TwoOne Buydown Response
    000000001 OneZero OneZero Buydown Response
    000000001 None All three buydown options Response
    999000011 None Error Scenario

    API Response

    • Once Best Execution results are available, the results will be returned on the Webhook URL with the status and response_data, below are the details of the response_data from the best_execution API
    Pricing Schemas
    • pricing_schema_identifier - (string) - The pricing schema class identifier.
    • apr - (number) - The pricing schemas annual percentage rate.
    • rebate - (number) - The pricing schemas rebate.
    • discount - (number) - The pricing schemas discount.
    • closing_cost - (number) - The pricing schemas closing cost.
    • monthly_insurance - (number) - The pricing schemas monthly insurance value.
    • total_monthly_payment - (number) - The pricing schemas total monthly payment amount.
    • rate - (number) - The pricing schemas rate.
    • price - (number) - The pricing schemas price.
    • principal_and_interest - (number) - The pricing schemas principal and interest amount.
    • first_year_monthly_payment - (number) - The pricing schemas first year monthly payment amount. Calculated based on the buy down option provided in the request.
    • second_year_monthly_payment - (number) - The pricing schemas second year monthly payment amount. Calculated based on the buy down option provided in the request.
    • third_year_monthly_payment - (number) - The pricing schemas third year monthly payment amount. Calculated based on the buy down option provided in the request.
    • piti - (number) - The pricing schemas principal, interest, taxes and insurance amount. Calculated based on the values in the response.
    Loans
    • loan_identifier - (string) - The loan class identifier.
    • buydown_type - (string) - The loan buy down option. One of ['ThreeTwoOne', 'TwoOne', 'OneZero' or 'None'].
    • ltv_value - (number) - The loan to value ratio.
    • dti_value - (number) - The loan debt to income ratio.
    Mortgage Plans
    • plan_identifier - (string) - The mortgage plan class identifier.
    • amortization_term - (string) - The mortgage plan amortization term in years.
    • name - (string) - The mortgage plan name.
    • code - (string) - The mortgage plan code.
    Relationships
    • has_pricing_schema - (string) - The pricing schema class identifier.
    • has_loan - (string) - The loan class identifier.
    • has_mortgage_plan - (string) - The mortgage plan class identifier.

    Moreover, the system provides an API to get the status, you can use it using this link to get the data at any time.

    Request
    application/json 
    {
  "partner_name": "optimalBlue",
  "callback_url": "callback.url",
  "request_data": {
    "people": [
      {
        "first_name": "John",
        "last_name": "Smith",
        "ssn": "000000001",
        "us_citizenship_status": true,
        "person_identifier": "person_1",
        "first_time_home_owner": true
      }
    ],
    "properties": [
      {
        "purchase_price": 10000000,
        "property_type": "PrimaryResidence",
        "property_identifier": "property_1",
        "full_address_txt": "123 Main Street",
        "county_name": "FAIRFAX",
        "state_name": "VA",
        "postal_code": "20191"
      }
    ],
    "loans": [
      {
        "loan_identifier": "loan_1",
        "downpayment_amount": 200000,
        "downpayment_percentage": 10,
        "buydown_type": "ThreeTwoOne"
      }
    ],
    "incomes": [
      {
        "annual_income": 120000,
        "monthly_rent": 800,
        "monthly_debt_payment": 400,
        "monthly_car_payment": 200,
        "income_identifier": "income_1"
      }
    ],
    "credits": [
      {
        "credit_score": 700,
        "credit_identifier": "credit_1"
      }
    ],
    "relationships": [
      {
        "@type": "finance_relation",
        "has_person": "person_1",
        "has_loan": "loan_1",
        "has_property": "property_1",
        "main_applicant": true
      },
      {
        "@type": "person_income",
        "has_income": "income_1",
        "has_person": "person_1"
      },
      {
        "@type": "person_credit",
        "has_credit": "credit_1",
        "has_person": "person_1"
      }
    ]
  }
}
    Response
    application/json

    Successfully started flow invocation.

    {
  "response_id": "01F6NAQ4894HPMCBGB4P0G78HG"
}
    Parameters
    1
    ParameterTypeExampleDescription
    x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Environment API Key.
    Request bodyapplication/json
    3 fields
    FieldTypeDescription
    partner_namerequiredstringPartner name.Example optimalBlue
    callback_urlstringCallback urlExample callback.url
    request_datarequiredobjectRequest data for Pricing.
    peoplerequiredobject[]List of persons.
    first_namerequiredstringPersons first name.
    last_namerequiredstringPersons last name.
    ssnstringPersons taxpayer number identifier.
    us_citizenship_statusrequiredbooleanWhether person is US citizen.
    person_identifierrequiredstringPerson class identifier.
    first_time_home_ownerrequiredbooleanWhether person is a first time homeowner.
    propertiesrequiredobject[]List of properties.
    purchase_pricerequiredintegerProperty purchase price.
    property_typerequiredstringProperty type.
    property_identifierrequiredstringProperty class identifier.
    full_address_txtrequiredstringProperty full address.
    county_namerequiredstringProperty county name.
    state_namerequiredstringProperty state name.
    postal_coderequiredstringProperty state code.
    lien_typestringProperty lien type.
    loansrequiredobject[]List of loans.
    loan_identifierrequiredstringLoan class identifier.
    downpayment_amountrequiredintegerLoan down payment amount.
    downpayment_percentagerequiredintegerLoan down payment percentage.
    buydown_typerequiredstringLoan buydown.
    amortization_typestringLoan amortization type.
    borrower_paid_mibooleanWhether the borrower paid mortgage insurance.
    buydown_amountintegerLoan buydown amount.
    loan_amountintegerLoan amount.
    loan_purposestringLoan purpose.
    loan_typestringLoan type.
    monthly_paymentnumberLoan monthly payment.
    incomesrequiredobject[]List of incomes.
    annual_incomerequiredintegerAnnual Income amount.
    income_identifierrequiredstringIncome class identifier.
    creditsrequiredobject[]List of credits.
    credit_scorerequiredintegerCredit score value.
    credit_identifierrequiredstringCredit class identifier.
    leaseobject[]List of leases.
    lease_identifierrequiredstringLease class identifier.
    monthly_raterequirednumberThe monthly rate of the lease.
    automobilesobject[]List of automobiles
    automobile_identifierrequiredstringAutomobile class identifier.
    automobile_typestringAutomobile type.
    rentsobject[]List of rents
    rent_identifierrequiredstringRent class identifier.
    monthly_raterequirednumberMonthly rate of the rent.
    relationshipsrequiredobject[]List of financial relations.
    @typestringThe relationship types. Can be one of finance_relation, person_income, person_credit.
    has_incomestringIncome class identifier.
    has_personstringPerson class identifier.
    has_creditstringCredit class identifier.
    has_loanstringLoan class identifier.
    has_propertystringProperty class identifier.
    has_rentstringRent class identifier
    has_leasestringLease class identifier
    has_automobilestringAutomobile class identifier
    has_mortgagestringMortgage class identifier
    main_applicantbooleanWhether the person is the main applicant.
    Response 201application/json
    1 fields

    Successfully started flow invocation.

    FieldTypeDescription
    response_idrequiredstringResponse collection ID.
    Response 400application/json
    1 fields

    Request data failed validation

    FieldTypeDescription
    messageone ofMessage
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 404application/json
    1 fields

    Resource not found

    FieldTypeDescription
    messagestringMessage
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError message.
    GET /bestexsearch/{id}

    Retrieve Status

    RetrievePricingFlowStatus

    Retrieve Pricing Status

    Retrieves the result of running Pricing process.

    The status of the process can be found in metadata invocation_status once the status is COMPLETED the Pricing data will be stored in the data object.

    If something fails an error message with further details will be stored in the data object.

    Response Payload

    This endpoint returns the following response object:

    Show the rest
    Pricing Schemas
    • pricing_schema_identifier - (string) - The pricing schema class identifier.
    • apr - (number) - The pricing schemas annual percentage rate.
    • rebate - (number) - The pricing schemas rebate.
    • discount - (number) - The pricing schemas discount.
    • closing_cost - (number) - The pricing schemas closing cost.
    • monthly_insurance - (number) - The pricing schemas monthly insurance value.
    • total_monthly_payment - (number) - The pricing schemas total monthly payment amount.
    • rate - (number) - The pricing schemas rate.
    • price - (number) - The pricing schemas price.
    • principal_and_interest - (number) - The pricing schemas principal and interest amount.
    • first_year_monthly_payment - (number) - The pricing schemas first year monthly payment amount. Calculated based on the buy down option provided in the request.
    • second_year_monthly_payment - (number) - The pricing schemas second year monthly payment amount. Calculated based on the buy down option provided in the request.
    • third_year_monthly_payment - (number) - The pricing schemas third year monthly payment amount. Calculated based on the buy down option provided in the request.
    • piti - (number) - The pricing schemas principal, interest, taxes and insurance amount. Calculated based on the values in the response.
    Loans
    • loan_identifier - (string) - The loan class identifier.
    • buydown_type - (string) - The loan buy down option. One of 'ThreeTwoOne', 'TwoOne' or 'OneZero'.
    • ltv_value - (number) - The loan to value ratio.
    • dti_value - (number) - The loan debt to income ratio.
    Mortgage Plans
    • plan_identifier - (string) - The mortgage plan class identifier.
    • amortization_term - (string) - The mortgage plan amortization term in years.
    • name - (string) - The mortgage plan name.
    • code - (string) - The mortgage plan code.
    Relationships
    • has_pricing_schema - (string) - The pricing schema class identifier.
    • has_loan - (string) - The loan class identifier.
    • has_mortgage_plan - (string) - The mortgage plan class identifier.

    Any warning, errors or unwanted behavior will be shown in the error objects:

    Errors
    • error_id - (string) - The error class identifier.
    • error_message - (string) - The error message.
    • error_timestamp - (string) - The error timestamp.
    • error_type - (string) - The error type. Enum ["AuthenticationError" , "AuthorizationError" , "ConfigurationError" , "DependencyError" , "LogicError" , "NetworkError" , "ResourceError" , "RuntimeError" , "SyntaxError" , "TimeoutError" , "ValidationError"]
    • severity_level - (string) - The error severity level. Enum ["Critical", "High", "Low", "Medium", "Warning"]
    Response
    application/json

    Successfully returned result of the Asset Verification.

    {
  "transaction_id": "01GT91JJRFRV60T4TTEMXFZMWE",
  "collection_id": "01GT91JJZRZ5ZNP7Y6V63527T7",
  "metadata": {
    "validation": false,
    "serialise_to_graph": false,
    "created_at": "2023-03-27T11:14:48.118327-04:00",
    "invocation_status": "COMPLETED",
    "last_updated_at": "2023-03-27T11:14:51.943421-04:00",
    "partner_name": "optimalBlue",
    "product_invocation_id": "01GWHT5PNPJA3JE0BT1DY3H24H",
    "product_name": "Price"
  },
  "data": {
    "relationships": [
      {
        "@id": "mortgage_application_1",
        "@type": "mortgage_application",
        "has_pricing_schema": "pricing_schema_1",
        "has_loan": "loan_1",
        "has_mortgage_plan": "plan_1"
      }
    ],
    "mortgage_plans": [
      {
        "@id": "mortgage_plan_1",
        "@type": "mortgage_plan",
        "code": "53040066",
        "name": "Fixed 30 years",
        "plan_identifier": "plan_1",
        "amortization_term": "30"
      }
    ],
    "loans": [
      {
        "@id": "loan_1",
        "@type": "loan",
        "loan_identifier": "loan_1",
        "ltv_value": 80,
        "dti_value": 54
      }
    ],
    "pricing_schemas": [
      {
        "@id": "pricing_schema_1",
        "@type": "pricing_schema",
        "rebate": 0,
        "discount": 0,
        "first_year_monthly_payment": 1104.93,
        "second_year_monthly_payment": 1029.61,
        "third_year_monthly_payment": 957.59,
        "closing_cost": 0,
        "monthly_insurance": 0,
        "total_monthly_payment": 1719.37,
        "rate": 10,
        "price": 100,
        "principal_and_interest": 1719,
        "piti": 1430.22,
        "apr": 10.24,
        "pricing_schema_identifier": "pricing_schema_1"
      }
    ]
  }
}
    Parameters
    2
    ParameterTypeExampleDescription
    x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Environment API Key.
    id required string (Staircase Response Collection Identifier) path 01FFMHWSS346W9V6HZVGSEZPQ Pricing ID
    Response 200application/json
    4 fields

    Successfully returned result of the Asset Verification.

    FieldTypeDescription
    transaction_idstring (ulid)Transaction ID.Example 01EZQ32PJQGKRA6HR8D72Q9FFF
    collection_idstring (ulid)Collection ID.Example 01EZQ32PJQGKRA6HR8D72Q9FFF
    dataobjectPricing Data in Staircase lexicon schema.
    metadataobjectMetadata about collection, f.e version of used Staircase schema.
    product_namestringProduct nameExample asset
    partner_namestringPartner nameExample equifax
    created_atstringTime of creation
    last_updated_atstringTime of last update
    invocation_statusstringStatus of the Asset Verification.COMPLETEDFAILEDRUNNINGSTARTED
    Response 400application/json
    1 fields

    Request data failed validation

    FieldTypeDescription
    messageone ofMessage
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 404application/json
    1 fields

    Resource not found

    FieldTypeDescription
    messagestringMessage
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError message.

    Workflow

    POST /products/pricing/invocations

    Invoke Product Flow

    InvokeSpecificProductFlow

    This product receives all detailed pricing information for a product. The response will return all price, rate, lock period combinations for the requested product.

    Note: Pricing product has a dependency to the Options Product. You need to invoke Options to search for possible loan options and then using the mortgage_products and one of the loan_products fields returned by the Options, you can retrieve pricing details of a Loan Product.

    Note: If you're using OptimalBlue as Partner, and invoke Pricing without invoking Options, you will not be able to retrieve has_amortization_term_months_count and has_loan_amortization_type fields. This is due to a limitation in the OptimalBlue API.

    Request
    application/json 
    {
  "product_flow_name": "OptimalBlue",
  "transaction_id": "01F6NAMXWN2XVBD1YJ92A6S6R4",
  "request_collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN"
}
    Response
    application/json

    Successfully started flow invocation.

    {
  "product_flow_name": "OptimalBlue",
  "metadata": {},
  "request_collection_id": "01FFHJ4JCWGHV38SC1NJ8TVNFY",
  "invocation_id": "08f0f7bd-0158-4ab8-845c-f94eafa3859c",
  "invocation_status": "STARTED",
  "transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD"
}
    Parameters
    1
    ParameterTypeDescription
    x-api-key required string header Environment API Key.
    Request bodyapplication/json
    6 fields
    FieldTypeDescription
    product_flow_namestringProduct flow name. If it is not specified, the default product flow will be invoked. If the product has no default product flow, the first created flow will be invoked. Cannot be specified together with vendor_name.OptimalBlueOptimalBlue-BestSearchOptimalBlue-ProductDetails
    vendor_namestringVendor name. Cannot be specified together with product_flow_name.optimalBlue
    transaction_idstringTransaction ID used for invocation.
    response_collection_idstringResponse Collection ID.
    callback_urlstring (uri)Callback URL.
    request_dataone of—
    Response 201application/json
    7 fields

    Successfully started flow invocation.

    FieldTypeDescription
    invocation_idrequiredstringInvocation ID.
    invocation_statusrequiredstringThe status of the invocation.STARTED
    transaction_idrequiredstringTransaction ID.
    product_flow_namestringProduct flow name.OptimalBlueOptimalBlue-BestSearchOptimalBlue-ProductDetails
    metadataobjectThe metadata of the invoked product flow.
    callback_urlstringCallback URL.
    request_dataobjectThe data for the request collection.
    Response 400application/json
    1 fields

    Request data failed validation

    FieldTypeDescription
    messagestringMessage
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 404application/json
    1 fields

    Resource not found

    FieldTypeDescription
    messagestringMessage
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError message.
    GET /products/pricing/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": "OptimalBlue",
  "request_collection": {
    "metadata": {
      "created_at": "2021-09-14T03:08:00.284090-04:00",
      "validation": false
    },
    "transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
    "collection_id": "01FFHJ4JCWGHV38SC1NJ8TVNFY",
    "data": {
      "vendor_name": "optimalBlue",
      "request_data": {
        "people": [
          {
            "@id": "01FDTQ5PJSKC94HHZGYZDSTXCT",
            "@type": "borrower",
            "has_first_name": {
              "has_value": "test"
            },
            "has_last_name": {
              "has_value": "test1"
            },
            "has_debt_expense_to_income_dti_ratio": {
              "has_value": 15
            },
            "employed_as": [
              "01FDTQ5PGZWEG4M8PSR5T6TSYH"
            ],
            "with_declaration": [
              "01FDTQ5PH0KQ21KE0DR3FV16SW"
            ],
            "with_credit_information": [
              "01G0F456KV2YVD0N168SD8QTGD"
            ]
          }
        ],
        "credit_information": [
          {
            "@id": "01G0F456KV2YVD0N168SD8QTGD",
            "@type": "credit_information",
            "has_credit_rating_code_type": {
              "has_value": "experian"
            },
            "has_credit_report_action_type": {
              "has_value": "submit"
            },
            "has_credit_report_first_issued_date": {
              "has_value": "2022-04-12"
            },
            "has_credit_report_identifier": {
              "has_value": "DF6VM5"
            },
            "has_credit_report_last_updated_date": {
              "has_value": "2022-04-12"
            },
            "has_credit_report_merge_type": {
              "has_value": "blend"
            },
            "has_credit_report_type": {
              "has_value": "merge"
            },
            "has_credit_request_type": {
              "has_value": "individual"
            },
            "with_credit_score_information": [
              "01FDTQ5PH1J05ESN8F3M8X03MD"
            ]
          }
        ],
        "employment": [
          {
            "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
            "@type": "employment",
            "has_self_employment_indicator": {
              "has_value": true
            }
          }
        ],
        "declarations": [
          {
            "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
            "@type": "declaration",
            "has_citizenship_residency_type": {
              "has_value": "us_citizen"
            },
            "has_borrower_first_time_homebuyer_indicator": {
              "has_value": false
            },
            "has_bankruptcy_indicator": {
              "has_value": false
            },
            "has_age_of_bankruptcy_years_count": {
              "has_value": 0
            },
            "has_prior_property_foreclosure_completed_indicator": {
              "has_value": false
            },
            "has_age_of_prior_property_foreclosure_years_count": {
              "has_value": 0
            }
          }
        ],
        "credit_score_information": [
          {
            "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
            "@type": "credit_score_information",
            "has_credit_score": {
              "has_value": "850"
            }
          }
        ],
        "loans": [
          {
            "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
            "@type": "loan",
            "has_relocation_loan_indicator": {
              "has_value": false
            },
            "has_heloc_indicator": {
              "has_value": false
            },
            "with_borrower": [
              "01FDTQ5PJSKC94HHZGYZDSTXCT"
            ],
            "with_loan_terms": [
              "01FDTQ5PJTJBJZ777RCH7TDF5J"
            ],
            "with_documentation": [
              "01FDTQ5PJTMCWMQW9WYKSDT3FE"
            ],
            "with_summary": [
              "01FDTQ5PJVWPHV0MBGEMS6QHZZ"
            ],
            "with_payment_information": [
              "01FDTQ5PJXBVSW37ZTESFQWN4Y"
            ],
            "with_arm_adjustment": [
              "01FDTQ5PJXSBQYT5X7EAS4H31S"
            ],
            "with_insurance": [
              "01FDTQ5PJYNRA67MQEVTBZCRZ7"
            ],
            "with_project": [
              "01FKTQ5PKC2ZFKXBEH170VG0BJ"
            ],
            "serviced_by": [
              "01FDTQ5PKA5DVQ7F39HZK84H2R"
            ],
            "with_buydown": [
              "01FDTQ5PKBF5JHM46TQQEE3SAE"
            ],
            "with_quote_request": [
              "01FDTQ5PKBHV90N3GJ0PEK9TWD"
            ],
            "secured_by_property": [
              "01FDTQ5PKC4ZFKXBET140VG0BJ"
            ]
          }
        ],
        "loan_terms": [
          {
            "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
            "@type": "loan_terms",
            "has_mortgage_type": {
              "has_value": "conventional"
            },
            "has_pledged_assets_indicator": {
              "has_value": false
            },
            "has_escrow_required_indicator": {
              "has_value": true
            },
            "has_loan_purpose_type": {
              "has_value": "purchase"
            },
            "has_refinance_type": {
              "has_value": "no_cash_out"
            },
            "has_lien_position_type": {
              "has_value": "first_lien"
            },
            "has_base_loan_amount": {
              "has_value": 150000
            },
            "has_interest_only_indicator": {
              "has_value": false
            },
            "has_prepayment_penalty_indicator": {
              "has_value": false
            },
            "has_prepayment_penalty_term_months_count": {
              "has_value": 0
            },
            "has_construction_loan_indicator": {
              "has_value": false
            },
            "has_buydown_indicator": {
              "has_value": true
            }
          }
        ],
        "arm_adjustments": [
          {
            "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
            "@type": "arm_adjustment",
            "has_first_rate_adjustment_months_count": {
              "has_value": 60
            }
          }
        ],
        "buydowns": [
          {
            "@id": "01FDTQ5PKBF5JHM46TQQEE3SAE",
            "@type": "buydown",
            "has_buydown_type": {
              "has_value": "one_one"
            }
          }
        ],
        "insurance": [
          {
            "@id": "01FDTQ5PJYNRA67MQEVTBZCRZ7",
            "@type": "mortgage_insurance",
            "has_mortgage_insurance_premium_source_type": {
              "has_value": "borrower"
            }
          }
        ],
        "loan_documentation": [
          {
            "@id": "01FDTQ5PJTMCWMQW9WYKSDT3FE",
            "@type": "loan_documentation",
            "has_asset_documentation_level_type": {
              "has_value": "stated_and_verified"
            },
            "has_employment_documentation_level_type": {
              "has_value": "stated_and_verified"
            },
            "has_income_documentation_level_type": {
              "has_value": "stated_and_verified"
            }
          }
        ],
        "loan_summaries": [
          {
            "@id": "01FDTQ5PJVWPHV0MBGEMS6QHZZ",
            "@type": "loan_summary",
            "has_total_debt_expense_to_income_dti_ratio": {
              "has_value": 18
            },
            "has_total_monthly_income_amount": {
              "has_value": 0
            },
            "has_projected_reserves_amount": {
              "has_value": 24
            },
            "has_representative_credit_score": {
              "has_value": 850
            }
          }
        ],
        "loan_payment_information": [
          {
            "@id": "01FDTQ5PJXBVSW37ZTESFQWN4Y",
            "@type": "loan_payment_information",
            "has_number_of_payments_30_days_late_count": {
              "has_value": 0
            },
            "has_number_of_payments_60_days_late_count": {
              "has_value": 0
            },
            "has_number_of_payments_90_days_late_count": {
              "has_value": 0
            },
            "has_number_of_payments_120_days_late_count": {
              "has_value": 0
            },
            "has_number_of_payments_rolling_12_months_late_count": {
              "has_value": 0
            }
          }
        ],
        "organizations": [
          {
            "@id": "01FDTQ5PKA5DVQ7F39HZK84H2R",
            "@type": "servicer"
          }
        ],
        "quote_requests": [
          {
            "@id": "01FDTQ5PKBHV90N3GJ0PEK9TWD",
            "@type": "loan_price_quote_request",
            "has_loan_officer_compensation_type": {
              "has_value": "yes_lender_paid"
            },
            "has_calculate_borrower_requested_loan_amount_indicator": {
              "has_value": true
            },
            "has_include_fixed_rate_amortization_loans_indicator": {
              "has_value": true
            },
            "has_include_adjustable_rate_amortization_loans_indicator": {
              "has_value": false
            },
            "has_include_payment_option_adjustable_rate_amortization_loans_indicator": {
              "has_value": false
            },
            "has_discount_points_percent": {
              "has_value": 0
            },
            "has_include_balloon_loans_indicator": {
              "has_value": false
            },
            "has_cash_out_amount": {
              "has_value": 0
            },
            "include_loans_with_amortization_term": [
              "01FDTQGB8WJHJC9YT32CQ1ESCC"
            ]
          }
        ],
        "quote_amortization_terms": [
          {
            "@id": "01FDTQGB8WJHJC9YT32CQ1ESCC",
            "@type": "quote_amortization_term",
            "has_amortization_term_months_count": {
              "has_value": 360
            }
          }
        ],
        "properties": [
          {
            "@id": "01FDTQ5PKC4ZFKXBET140VG0BJ",
            "@type": "subject_property",
            "has_property_usage_type": {
              "has_value": "primary_residence"
            },
            "has_number_of_units_type": {
              "has_value": "one"
            },
            "has_project_design_type": {
              "has_value": "midrise_project"
            },
            "has_manufactured_home_indicator": {
              "has_value": false
            },
            "has_planned_unit_development_pud_indicator": {
              "has_value": false
            },
            "has_manufactured_home_width_type": {
              "has_value": "single_wide"
            },
            "has_project_usage_type": {
              "has_value": "string"
            },
            "has_financed_unit_count": {
              "has_value": 1
            },
            "has_non_warrantable_project_indicator": {
              "has_value": false
            },
            "has_stories_count": {
              "has_value": 1
            },
            "has_construction_method_type": {
              "has_value": "site_built"
            },
            "with_address": [
              "01FDTQGB9EV6FKWGZ2CY35971G"
            ],
            "with_sales_contract": [
              "01FDTQGB9EPKV6EJXZMTW0CGV0"
            ],
            "with_value": [
              "01FDTQGB9FVMF9YTFBTX95D2KH"
            ]
          }
        ],
        "projects": [
          {
            "@id": "01FKTQ5PKC2ZFKXBEH170VG0BJ",
            "@type": "project",
            "has_project_legal_structure_type": {
              "has_value": "condominium"
            }
          }
        ],
        "addresses": [
          {
            "@id": "01FDTQGB9EV6FKWGZ2CY35971G",
            "@type": "residential_address",
            "has_address_line_1_text": {
              "has_value": "string"
            },
            "has_county_name": {
              "has_value": "Collin"
            },
            "has_state_code": {
              "has_value": "TX"
            },
            "has_postal_code": {
              "has_value": "75024"
            }
          }
        ],
        "sales_contracts": [
          {
            "@id": "01FDTQGB9EPKV6EJXZMTW0CGV0",
            "@type": "property_sales_contract",
            "has_sales_contract_amount": {
              "has_value": 225000
            }
          }
        ],
        "property_valuations": [
          {
            "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
            "@type": "property_valuation",
            "has_property_valuation_amount": {
              "has_value": 225000
            }
          }
        ]
      }
    }
  },
  "response_collection": {
    "metadata": {
      "created_at": "2021-09-14T03:36:45.193268-04:00",
      "validation": false
    },
    "transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
    "collection_id": "01FFHKS6W9J0JDTGTQJB9Y2RWB",
    "data": {
      "loans": [
        {
          "@id": "01FT3Z7W06MJTDW8RY2ZKT48RY",
          "@type": "loan",
          "has_conforming_loan_indicator": {
            "has_value": true
          },
          "has_borrower_requested_loan_amount": {
            "has_value": 150000
          },
          "has_loan_to_value_ltv_ratio_percent": {
            "has_value": 66.67
          },
          "has_combined_loan_to_value_cltv_ratio_percent": {
            "has_value": 0
          },
          "has_home_equity_combined_loan_to_value_hcltv_ratio_percent": {
            "has_value": 0
          },
          "with_closing_information": [
            "01FT3Z7W84Z4G2P5XV66YT608A"
          ],
          "with_housing_expenses_deprecated": [
            "01FT3Z7W9C9M8HXJ3Y7GZN71Y1"
          ],
          "with_fees": [
            "01FT3Z7WAKRDFH04ZYH5VQY1NR"
          ],
          "with_arm_adjustment": [
            "01FT3Z7WBAGCKPPS5ZDQFMVN69"
          ],
          "with_loan_terms": [
            "01FT3Z7WCKCERY65RVCZGM9M02"
          ],
          "with_quote": [
            "01FT3Z7WD9VSBBV7DVPPA8TEYK"
          ],
          "with_product": [
            "01FT3Z7WEBGKEHFGB9S0JZTV30"
          ],
          "with_loan_product": [
            "01FT3Z7WEBGKEHFGB9S0JZTV30"
          ]
        },
        {
          "@id": "01FT3Z7W06421XRYA43QVBDYY9",
          "@type": "loan",
          "has_conforming_loan_indicator": {
            "has_value": true
          },
          "has_borrower_requested_loan_amount": {
            "has_value": 150000
          },
          "has_loan_to_value_ltv_ratio_percent": {
            "has_value": 66.67
          },
          "has_combined_loan_to_value_cltv_ratio_percent": {
            "has_value": 0
          },
          "has_home_equity_combined_loan_to_value_hcltv_ratio_percent": {
            "has_value": 0
          },
          "with_closing_information": [
            "01FT3Z7W843F0PCKCH1B51HWKX"
          ],
          "with_housing_expenses_deprecated": [
            "01FT3Z7W9CF9G7FHZ3VM2CFYBQ"
          ],
          "with_fees": [
            "01FT3Z7WAK4HRSPR7FPCX4Z2TG"
          ],
          "with_arm_adjustment": [
            "01FT3Z7WBAR92NAQ6X929CHV5E"
          ],
          "with_loan_terms": [
            "01FT3Z7WCKSFD5FEVY4SF2T1AE"
          ],
          "with_quote": [
            "01FT3Z7WDACNHY76KECAXZ7J50"
          ],
          "with_product": [
            "01FT3Z7WEBGKEHFGB9S0JZTV30"
          ],
          "with_loan_product": [
            "01FT3Z7WEBGKEHFGB9S0JZTV30"
          ]
        }
      ],
      "closing_information": [
        {
          "@id": "01FT3Z7W84Z4G2P5XV66YT608A",
          "@type": "closing_information",
          "has_total_closing_costs_amount": {
            "has_value": 14340
          }
        },
        {
          "@id": "01FT3Z7W843F0PCKCH1B51HWKX",
          "@type": "closing_information",
          "has_total_closing_costs_amount": {
            "has_value": 12840
          }
        }
      ],
      "housing_expenses_deprecated": [
        {
          "@id": "01FT3Z7W9C9M8HXJ3Y7GZN71Y1",
          "@type": "housing_expenses_deprecated",
          "has_proposed_first_mortgage_principal_and_interest_monthly_amount": {
            "has_value": 536
          },
          "has_proposed_mortgage_insurance_monthly_amount": {
            "has_value": 0
          },
          "has_proposed_first_mortgage_principal_interest_taxes_and_insurance_piti_monthly_amount": {
            "has_value": 535.87
          }
        },
        {
          "@id": "01FT3Z7W9CF9G7FHZ3VM2CFYBQ",
          "@type": "housing_expenses_deprecated",
          "has_proposed_first_mortgage_principal_and_interest_monthly_amount": {
            "has_value": 545
          },
          "has_proposed_mortgage_insurance_monthly_amount": {
            "has_value": 0
          },
          "has_proposed_first_mortgage_principal_interest_taxes_and_insurance_piti_monthly_amount": {
            "has_value": 545.1
          }
        }
      ],
      "arm_adjustments": [
        {
          "@id": "01FT3Z7WBAGCKPPS5ZDQFMVN69",
          "@type": "arm_adjustment",
          "has_margin_rate_percent": {
            "has_value": 0
          }
        },
        {
          "@id": "01FT3Z7WBAR92NAQ6X929CHV5E",
          "@type": "arm_adjustment",
          "has_margin_rate_percent": {
            "has_value": 0
          }
        }
      ],
      "loan_terms": [
        {
          "@id": "01FT3Z7WCKCERY65RVCZGM9M02",
          "@type": "loan_terms",
          "has_note_rate_percent": {
            "has_value": 1.75
          },
          "has_loan_amortization_term_type": {
            "has_value": "monthly"
          },
          "has_loan_amortization_type": {
            "has_value": "fixed_rate"
          }
        },
        {
          "@id": "01FT3Z7WCKSFD5FEVY4SF2T1AE",
          "@type": "loan_terms",
          "has_note_rate_percent": {
            "has_value": 1.875
          },
          "has_loan_amortization_term_type": {
            "has_value": "monthly"
          },
          "has_loan_amortization_type": {
            "has_value": "fixed_rate"
          }
        }
      ],
      "quotes": [
        {
          "@id": "01FT3Z7WD9VSBBV7DVPPA8TEYK",
          "@type": "loan_price_quote",
          "has_loan_price_lock_duration_days_count": {
            "has_value": 30
          },
          "has_loan_price_lock_expiration_date": {
            "has_value": "2022-02-22 00:00:00"
          },
          "has_loan_price_percent": {
            "has_value": 91.625
          },
          "has_discount_points_amount": {
            "has_value": 12563
          },
          "has_discount_points_percent": {
            "has_value": 8.375
          },
          "has_rebate_amount": {
            "has_value": 0
          },
          "has_rebate_percent": {
            "has_value": 0
          },
          "has_total_credit_amount": {
            "has_value": 0
          }
        },
        {
          "@id": "01FT3Z7WDACNHY76KECAXZ7J50",
          "@type": "loan_price_quote",
          "has_loan_price_lock_duration_days_count": {
            "has_value": 30
          },
          "has_loan_price_lock_expiration_date": {
            "has_value": "2022-02-22 00:00:00"
          },
          "has_loan_price_percent": {
            "has_value": 92.625
          },
          "has_discount_points_amount": {
            "has_value": 11063
          },
          "has_discount_points_percent": {
            "has_value": 7.375
          },
          "has_rebate_amount": {
            "has_value": 0
          },
          "has_rebate_percent": {
            "has_value": 0
          },
          "has_total_credit_amount": {
            "has_value": 0
          }
        }
      ],
      "loan_products": [
        {
          "@id": "01FT3Z7WEBGKEHFGB9S0JZTV30",
          "@type": "loan_product",
          "has_product_identifier": {
            "has_value": "20290727"
          },
          "has_product_name": {
            "has_value": "NEW - 30 Year Fixed Conventional"
          },
          "has_total_loan_price_adjustment_percent": {
            "has_value": -0.25
          },
          "has_total_rate_adjustment_percent": {
            "has_value": 0
          },
          "has_total_margin_adjustment_percent": {
            "has_value": 0
          },
          "has_total_service_release_premium_srp_adjustment_percent": {
            "has_value": 3.72
          },
          "offered_by": [
            "01FT3Z7XNTTFNMKYCW2A67DW32"
          ],
          "with_adjustment": [
            "01FT3Z7XNWGT8N92SNKVNRF5ZH",
            "01FT3Z7XNWT625ENNXE4NVMM1V"
          ],
          "with_notes": [
            "01FT3Z7XNYBNBPVQWZJG2X0F5E",
            "01FT3Z7XNYYNSK04SMVAWVCQK9",
            "01FT3Z7XNZMPHWEDYB2RSP987X"
          ],
          "with_price": [
            "01FT3Z7XPEBMPC0MREMP90QMNV",
            "01FT3Z7XPE63BT5HJAN81FY51P",
            "01FT3Z7XPEBQ9WF9Q34EQMBVJY",
            "01FT3Z7XPEYHJR07CRKNZ0HK8E"
          ]
        }
      ],
      "organizations": [
        {
          "@id": "01FT3Z7XNTTFNMKYCW2A67DW32",
          "@type": "investor",
          "has_organization_identifier": {
            "has_value": "43946"
          },
          "has_organization_name": {
            "has_value": "Homeside Financial - "
          }
        }
      ],
      "price_adjustments": [
        {
          "@id": "01FT3Z7XNWGT8N92SNKVNRF5ZH",
          "@type": "loan_product_price_adjustment",
          "has_loan_price_adjustment_percent": {
            "has_value": -0.25
          },
          "has_loan_adjustment_reason_text": {
            "has_value": "LTV is 60.01 - 70%, And FICO is >=740"
          },
          "has_loan_adjustment_type": {
            "has_value": "Adjust Price"
          }
        },
        {
          "@id": "01FT3Z7XNWT625ENNXE4NVMM1V",
          "@type": "loan_product_price_adjustment",
          "has_loan_price_adjustment_percent": {
            "has_value": 3.72
          },
          "has_loan_adjustment_reason_text": {
            "has_value": "State is TX, And 1st Mtg Loan Amt (Total) is 110000.01-150000.00"
          },
          "has_loan_adjustment_type": {
            "has_value": "Adjust SRP"
          }
        }
      ],
      "notes": [
        {
          "@id": "01FT3Z7XNYBNBPVQWZJG2X0F5E",
          "@type": "notes",
          "has_notes_comment": {
            "has_value": "The borrower's credit history related to bankruptcy and derogatory housing events, including mortgage late payments, has not been evaluated to determine eligibility for this program. Contact the Lender for related requirements."
          }
        },
        {
          "@id": "01FT3Z7XNYYNSK04SMVAWVCQK9",
          "@type": "notes",
          "has_notes_comment": {
            "has_value": "Please note that you must complete the \"Self Employed\" field as \"Yes\" if self-employment income for any borrower is used to qualify as this may impact eligibility and/or pricing. "
          }
        },
        {
          "@id": "01FT3Z7XNZMPHWEDYB2RSP987X",
          "@type": "notes",
          "has_notes_comment": {
            "has_value": "Please note that you must complete the \"First-Time Home Buyer\" field as \"Yes\" if any borrower is a first-time home buyer, as this may impact eligibility and/or pricing. "
          }
        }
      ],
      "prices": [
        {
          "@id": "01FT3Z7XPEBMPC0MREMP90QMNV",
          "@type": "loan_price_at_par",
          "has_loan_price_at_par_percent": {
            "has_value": 100.5
          },
          "has_note_rate_at_par_percent": {
            "has_value": 3.125
          },
          "has_loan_price_lock_duration_days_at_par_count": {
            "has_value": 15
          }
        },
        {
          "@id": "01FT3Z7XPE63BT5HJAN81FY51P",
          "@type": "loan_price_at_par",
          "has_loan_price_at_par_percent": {
            "has_value": 100.25
          },
          "has_note_rate_at_par_percent": {
            "has_value": 3.125
          },
          "has_loan_price_lock_duration_days_at_par_count": {
            "has_value": 30
          }
        },
        {
          "@id": "01FT3Z7XPEBQ9WF9Q34EQMBVJY",
          "@type": "loan_price_at_par",
          "has_loan_price_at_par_percent": {
            "has_value": 100.25
          },
          "has_note_rate_at_par_percent": {
            "has_value": 3.125
          },
          "has_loan_price_lock_duration_days_at_par_count": {
            "has_value": 45
          }
        },
        {
          "@id": "01FT3Z7XPEYHJR07CRKNZ0HK8E",
          "@type": "loan_price_at_par",
          "has_loan_price_at_par_percent": {
            "has_value": 100.125
          },
          "has_note_rate_at_par_percent": {
            "has_value": 3.125
          },
          "has_loan_price_lock_duration_days_at_par_count": {
            "has_value": 60
          }
        }
      ]
    }
  }
}
    Parameters
    2
    ParameterTypeExampleDescription
    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.

    FieldTypeDescription
    invocation_statusrequiredstringInvocation Status.ACTION_REQUIREDCOMPLETEDFAILEDRUNNINGSTARTED
    transaction_idrequiredstringTransaction ID used for invocation.
    request_collection_idstringRequest Collection ID.
    request_collectionobjectCollection.
    transaction_idstring (ulid)Transaction ID.Example 01EZQ32PJQGKRA6HR8D72Q9FFF
    collection_idstring (ulid)Collection ID.Example 01EZQ32PJQGKRA6HR8D72Q9FFF
    dataobjectData in Staircase language schema.
    metadataobjectMetadata about collection, f.e version of used Staircase schema.
    response_collection_idstringResponse Collection ID.
    response_collectionobjectCollection.
    transaction_idstring (ulid)Transaction ID.Example 01EZQ32PJQGKRA6HR8D72Q9FFF
    collection_idstring (ulid)Collection ID.Example 01EZQ32PJQGKRA6HR8D72Q9FFF
    dataobject—
    loansobject[]—
    @idstring—
    @typestring—
    has_conforming_loan_indicatorobject—
    has_loan_to_value_ltv_ratio_percentobject—
    has_combined_loan_to_value_cltv_ratio_percentobject—
    has_home_equity_combined_loan_to_value_hcltv_ratio_percentobject—
    with_closing_informationstring[]—
    with_housing_expenses_deprecatedstring[]—
    with_feesstring[]—
    with_arm_adjustmentstring[]—
    with_loan_termsstring[]—
    with_quotestring[]—
    with_productstring[]—
    with_load_productstring[]—
    closing_informationobject[]—
    @idstring—
    @typestring—
    has_total_closing_costs_amountobject—
    housing_expenses_deprecatedobject[]—
    @idstring—
    @typestring—
    has_proposed_first_mortgage_principal_and_interest_monthly_amountobject—
    has_proposed_mortgage_insurance_monthly_amountobject—
    has_proposed_first_mortgage_principal_interest_taxes_and_insurance_piti_monthly_amountobject—
    arm_adjustmentsobject[]—
    @idstring—
    @typestring—
    has_margin_rate_percentobject—
    loan_termsobject[]—
    @idstring—
    @typestring—
    has_margin_rate_percentobject—
    has_loan_amortization_term_typeobject—
    has_loan_amortization_typeobject—
    quotesobject[]—
    @idstring—
    @typestring—
    has_loan_price_lock_duration_days_countobject—
    has_loan_price_lock_expiration_dateobject—
    has_loan_price_percentobject—
    has_discount_points_amountobject—
    has_discount_points_percentobject—
    has_rebate_amountobject—
    has_rebate_percentobject—
    has_total_credit_amountobject—
    loan_productsobject[]—
    @idstring—
    @typestring—
    has_product_identifierobject—
    has_product_nameobject—
    has_total_loan_price_adjustment_percentobject—
    has_total_rate_adjustment_percentobject—
    has_total_service_release_premium_srp_adjustment_percentobject—
    offered_bystring[]—
    with_adjustmentstring[]—
    with_notesstring[]—
    with_pricestring[]—
    organizationsobject[]—
    @idstring—
    @typestring—
    has_organization_identifierobject—
    price_adjustmentsobject[]—
    @idstring—
    @typestring—
    has_loan_price_adjustment_percentobject—
    has_loan_adjustment_reason_textobject—
    has_loan_adjustment_typeobject—
    notesobject[]—
    @idstring—
    @typestring—
    has_notes_commentobject—
    pricesobject[]—
    @idstring—
    @typestring—
    has_loan_price_at_par_percentobject—
    has_note_rate_at_par_percentobject—
    has_loan_price_lock_duration_days_at_par_countobject—
    metadataobjectMetadata about collection, f.e version of used Staircase schema.
    callback_urlstringURL that was specified in flow invocation and will be used to send the callback when flow invocation will be finished.
    widget_urlstring (uri)URL of the widget.
    metadataobjectResponse Collection ID.
    Response 400application/json
    1 fields

    Request data failed validation

    FieldTypeDescription
    messagestringMessage
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 404application/json
    1 fields

    Resource not found

    FieldTypeDescription
    messagestringMessage
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError message.
    GET /products/pricing/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": {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "loan_products": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "@type": {
                  "type": "string"
                },
                "has_product_identifier": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "has_value": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "has_value"
                  ]
                }
              },
              "required": [
                "has_product_identifier"
              ]
            }
          },
          "mortgage_products": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "has_partner_transaction_identifier": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "has_value": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "has_value"
                  ]
                },
                "@type": {
                  "type": "string"
                }
              },
              "required": [
                "has_partner_transaction_identifier"
              ]
            }
          }
        },
        "required": [
          "loan_products",
          "mortgage_products"
        ]
      },
      {
        "type": "object",
        "properties": {
          "addresses": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_county_name",
                "has_state_code"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_county_name": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string"
                    }
                  }
                },
                "has_state_code": {
                  "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"
                    }
                  }
                }
              }
            }
          },
          "people": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_first_name",
                "has_last_name",
                "has_debt_expense_to_income_dti_ratio"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_first_name": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string"
                    }
                  }
                },
                "has_last_name": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string"
                    }
                  }
                },
                "has_debt_expense_to_income_dti_ratio": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "number"
                    }
                  }
                }
              }
            }
          },
          "loan_terms": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_loan_purpose_type",
                "has_refinance_type",
                "has_lien_position_type",
                "has_base_loan_amount",
                "has_interest_only_indicator",
                "has_prepayment_penalty_indicator",
                "has_prepayment_penalty_term_months_count",
                "has_buydown_indicator"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_pledged_assets_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                },
                "has_escrow_required_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                },
                "has_loan_purpose_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "other",
                        "purchase",
                        "refinance"
                      ]
                    }
                  }
                },
                "has_refinance_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "cash_out",
                        "limited_cash_out",
                        "no_cash_out"
                      ]
                    }
                  }
                },
                "has_lien_position_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "first_lien",
                        "second_lien",
                        "subordinate_lien"
                      ]
                    }
                  }
                },
                "has_base_loan_amount": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "number"
                    }
                  }
                },
                "has_interest_only_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                },
                "has_prepayment_penalty_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                },
                "has_prepayment_penalty_term_months_count": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "integer"
                    }
                  }
                },
                "has_construction_loan_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                },
                "has_buydown_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          },
          "loans": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_mortgage_type",
                "has_relocation_loan_indicator"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_mortgage_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "conventional",
                        "fha",
                        "local_agency",
                        "other",
                        "public_and_indian_housing",
                        "state_agency",
                        "usda-rd",
                        "va"
                      ]
                    }
                  }
                },
                "has_relocation_loan_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          },
          "properties": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_property_usage_type",
                "has_number_of_units_type",
                "has_project_type",
                "has_project_design_type",
                "has_planned_unit_development_pud_indicator",
                "has_manufactured_home_indicator",
                "has_manufactured_home_width_type",
                "has_project_usage_type",
                "has_stories_count"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_property_usage_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "investment",
                        "other",
                        "primary_residence",
                        "second_home"
                      ]
                    }
                  }
                },
                "has_number_of_units_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "four",
                        "one",
                        "three",
                        "two",
                        "two_to_four"
                      ]
                    }
                  }
                },
                "has_project_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "common_interest_apartment",
                        "condominium",
                        "cooperative",
                        "other"
                      ]
                    }
                  }
                },
                "has_project_design_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "highrise",
                        "midrise",
                        "townhouse"
                      ]
                    }
                  }
                },
                "has_planned_unit_development_pud_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                },
                "has_manufactured_home_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                },
                "has_manufactured_home_width_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string"
                    }
                  }
                },
                "has_project_usage_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string"
                    }
                  }
                },
                "has_stories_count": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          },
          "loan_payment_information": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_number_of_payments_30_days_late_count": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "integer"
                    }
                  }
                },
                "has_number_of_payments_60_days_late_count": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "integer"
                    }
                  }
                },
                "has_number_of_payments_90_days_late_count": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "integer"
                    }
                  }
                },
                "has_number_of_payments_120_days_late_count": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "integer"
                    }
                  }
                },
                "has_number_of_payments_rolling_12_months_late_count": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          },
          "loan_documentation": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_asset_documentation_level_type",
                "has_employment_documentation_level_type",
                "has_income_documentation_level_type"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_asset_documentation_level_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "neither_stated_nor_verified",
                        "not_required",
                        "stated_and_verified",
                        "stated_only"
                      ]
                    }
                  }
                },
                "has_employment_documentation_level_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "neither_stated_nor_verified",
                        "not_required",
                        "stated_and_verified",
                        "stated_only"
                      ]
                    }
                  }
                },
                "has_income_documentation_level_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "neither_stated_nor_verified",
                        "not_required",
                        "stated_and_verified",
                        "stated_only"
                      ]
                    }
                  }
                }
              }
            }
          },
          "loan_summaries": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_total_debt_expense_to_income_dti_ratio",
                "has_representative_credit_score"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_total_debt_expense_to_income_dti_ratio": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "number"
                    }
                  }
                },
                "has_total_monthly_income_amount": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "number"
                    }
                  }
                },
                "has_projected_reserves_amount": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "number"
                    }
                  }
                },
                "has_representative_credit_score": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          },
          "declarations": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_citizenship_residency_type"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_citizenship_residency_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "non_permanent_resident_alien",
                        "non_resident_alien",
                        "permanent_resident_alien",
                        "us_citizen"
                      ]
                    }
                  }
                },
                "has_borrower_first_time_homebuyer_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                },
                "has_age_of_bankruptcy_years_count": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "integer"
                    }
                  }
                },
                "has_age_of_prior_property_foreclosure_years_count": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          },
          "quote_requests": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_loan_officer_compensation_type",
                "has_calculate_borrower_requested_loan_amount_indicator",
                "has_include_fixed_rate_amortization_loans_indicator",
                "has_include_adjustable_rate_amortization_loans_indicator",
                "has_include_payment_option_adjustable_rate_amortization_loans_indicator"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_loan_officer_compensation_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "no_buyer_paid",
                        "no_lender_paid",
                        "yes_lender_paid"
                      ]
                    }
                  }
                },
                "has_calculate_borrower_requested_loan_amount_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                },
                "has_include_fixed_rate_amortization_loans_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                },
                "has_include_adjustable_rate_amortization_loans_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                },
                "has_include_payment_option_adjustable_rate_amortization_loans_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                },
                "has_include_balloon_loans_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          },
          "employment": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_self_employment_indicator"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_self_employment_indicator": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          },
          "credit_score_information": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_credit_score"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_credit_score": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "arm_adjustments": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_first_rate_adjustment_months_count"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_first_rate_adjustment_months_count": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          },
          "automated_underwriting": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_desktop_underwriter_recommendation_type"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_desktop_underwriter_recommendation_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "approve_eligible",
                        "approve_ineligible",
                        "error",
                        "expanded_approval_1_eligible",
                        "expanded_approval_1_ineligible",
                        "expanded_approval_2_eligible",
                        "expanded_approval_2_ineligible",
                        "expanded_approval_3_eligible",
                        "expanded_approval_3_ineligible",
                        "out_of_scope",
                        "refer_eligible",
                        "refer_ineligible",
                        "refer_with_caution",
                        "unknown"
                      ]
                    }
                  }
                }
              }
            }
          },
          "insurance": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_mortgage_insurance_premium_source_type"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_mortgage_insurance_premium_source_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "borrower",
                        "lender"
                      ]
                    }
                  }
                }
              }
            }
          },
          "organizations": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_organization_name": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "quote_amortization_terms": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_amortization_term_months_count"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_amortization_term_months_count": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          },
          "sales_contracts": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_sales_contract_amount"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_sales_contract_amount": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "number"
                    }
                  }
                }
              }
            }
          },
          "property_valuations": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_property_valuation_amount"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_property_valuation_amount": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "number"
                    }
                  }
                }
              }
            }
          },
          "buydowns": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "@type",
                "@id",
                "has_buydown_type"
              ],
              "properties": {
                "@type": {
                  "type": "string"
                },
                "@id": {
                  "type": "string"
                },
                "has_buydown_type": {
                  "type": "object",
                  "required": [
                    "has_value"
                  ],
                  "properties": {
                    "has_value": {
                      "type": "string",
                      "enum": [
                        "one_one",
                        "one_zero",
                        "three",
                        "two_one"
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "required": [
          "addresses",
          "loan_terms",
          "loans",
          "properties",
          "loan_documentation",
          "loan_summaries",
          "declarations",
          "quote_requests",
          "automated_underwriting",
          "insurance",
          "quote_amortization_terms",
          "sales_contracts",
          "property_valuations",
          "buydowns"
        ]
      }
    ]
  }
}
    Parameters
    2
    ParameterTypeDescription
    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.

    FieldTypeDescription
    schemarequiredobjectSchema for the Request Collection
    examplesobjectEach item in the dictionary corresponds to the name of the example and dictionary content is the sample response.
    Response 400application/json
    1 fields

    Error

    FieldTypeDescription
    messagestringMessage
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 404application/json
    1 fields

    Resource not found

    FieldTypeDescription
    messagestringError Message.
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError message.
    GET /products/pricing/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": {}
}
    Parameters
    2
    ParameterTypeDescription
    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.

    FieldTypeDescription
    schemarequiredobjectJSON-Schema as a single object
    examplesobjectA 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

    FieldTypeDescription
    messagestringMessage
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 404application/json
    1 fields

    Resource not found

    FieldTypeDescription
    messagestringError Message.
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError message.

    Partners

    GET /products/pricing/partners

    Retrieve Product Partners

    getVendors

    Retrieve Partners retrieves:

    -All the Partners (vendors) configured in the Product Flows configurations.

    -The Order of the partner in the Product Waterfall Settings or default order in Product Flows if Product Waterfall was not configured.

    -The status of the partners as active/upcoming according to the configurations of the product flows of these partners (partner will be active if at least one flow is active).'

    Response
    application/json

    Successfully retrieved product partners.

    [
  {
    "Partner": "partner_name",
    "order": 1,
    "active": true,
    "status": "active",
    "verification_type": "borrower",
    "byoc": true
  }
]
    Parameters
    2
    ParameterTypeExampleDescription
    x-api-key required string header — Environment API Key.
    active boolean query false Include vendors with active product flows
    Response 200application/json
    6 fields

    Successfully retrieved product partners.

    FieldTypeDescription
    partnerstringPartner name
    ordernumberOrder of the product flows associated with this partner
    activebooleanPartner has active flows
    statusstringStatus of the partner
    verification_typestringType of verification
    byocbooleanSpecify whether customer should add its own partner credentials or not
    Response 400application/json
    1 fields

    Request data failed validation

    FieldTypeDescription
    messagestringMessage
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 404application/json
    1 fields

    Resource not found

    FieldTypeDescription
    messagestringError Message.
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError message.
    PATCH /products/pricing/partners/{partner}/status

    Update Partner Status

    updatePartnerStatus

    Update Partner Status updates the active value of a specific partner to value true or false. This shall activate or deactivate the flows configured for this partner in Product Flows.

    Request
    application/json 
    {
  "active": true,
  "verification_type": "borrower",
  "byoc": true,
  "status": "active"
}
    Response
    application/json

    Successfully updated active parameter for the partner.

    {
  "message": "Partner status updated."
}
    Parameters
    2
    ParameterTypeExampleDescription
    x-api-key required string header — Environment API Key.
    partner required string path partner_name Name of the partner for which we wan't to update status.
    Request bodyapplication/json
    4 fields
    FieldTypeDescription
    activerequiredbooleanExample true
    byocbooleanSpecify whether customer should add its own partner credentials or not
    statusstringStatus of the vendor
    verification_typestringType of verification
    Response 200application/json
    1 fields

    Successfully updated active parameter for the partner.

    FieldTypeDescription
    messagestringPartner status updated.
    Response 400application/json
    1 fields

    Failed to update the partner from one of the reasons.

    FieldTypeDescription
    messagestringPartner doesn't exist in database.
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 404application/json
    1 fields

    Resource not found

    FieldTypeDescription
    messagestringError Message.
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError message.

    Setup

    POST /setup/optimalBlue/credentials

    Set OptimalBlue Credentials

    setOptimalBlueCredentials

    By using Set OptimalBlue Credentials API we allow our customers to configure OptimalBlue in customer environment. If you want to use your own OptimalBlue contract for Price operations, run Set OptimalBlue Credentials API. You can check the partner status by calling the Retrieve Partners endpoint

    Request
    application/json 
    {
  "client_id": "--------",
  "client_secret": "<redacted>",
  "originator_id": "--------",
  "business_channel_id": "-------",
  "environment": "staging"
}
    Response
    application/json

    Setup API Triggered Successfully

    {
  "message": "Credentials are saved and verified"
}
    Parameters
    1
    ParameterTypeExampleDescription
    x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Environment API Key.
    Request bodyapplication/json
    5 fields
    FieldTypeDescription
    client_idrequiredstringOptimalBlue client ID
    client_secretrequiredstringOptimalBlue client secret
    originator_idstringOptimalBlue originator id
    business_channel_idstringOptimalBlue business channel id
    environmentstringOptimalBlue environment selectionproductionstaging
    Response 200application/json
    1 fields

    Setup API Triggered Successfully

    FieldTypeDescription
    messagestringMessage
    Response 400application/json
    1 fields

    Request data failed validation

    FieldTypeDescription
    errorobjectUnprocessed entity error.
    coderequiredstringError name.
    messagerequiredstringError description.
    Response 403application/json
    2 fields

    Invalid key for service

    FieldTypeDescription
    messagestring—
    urlstring—
    Response 404application/json
    2 fields

    Invalid key for service

    FieldTypeDescription
    messagestring—
    urlstring—
    Response 422application/json
    1 fields

    Unprocessed Entity

    FieldTypeDescription
    errorobjectUnprocessed entity error.
    coderequiredstringError name.
    messagerequiredstringError description.
    Response 500application/json
    1 fields

    The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

    FieldTypeDescription
    messagestring—
    POST /setup/polly/credentials

    Set polly Credentials

    setPollyCredentials

    Set Polly Credentials

    By using Set Polly Credentials API we allow our customers to configure Poly in customer environment. If you want to use your own Polly contract for Price operations, run Set Polly Credentials API. You can check the partner status by calling the Retrieve Partners endpoint

    Request
    application/json 
    {
  "user_name": "--------",
  "password": "<redacted>",
  "domain": "https://api.stage.polly.io/",
  "client_id": "",
  "client_secret": "",
  "audienceId": ""
}
    Response
    application/json

    Setup API Triggered Successfully

    {
  "message": "Credentials are saved and verified"
}
    Parameters
    1
    ParameterTypeExampleDescription
    x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Environment API Key.
    Request bodyapplication/json
    6 fields
    FieldTypeDescription
    user_namerequiredstringPolly username
    passwordrequiredstringPolly password
    domainrequiredstringPolly API domain
    client_idrequiredstringPolly client ID
    client_secretrequiredstringPolly API client secret
    audienceIdrequiredstringPolly audience ID
    Response 200application/json
    1 fields

    Setup API Triggered Successfully

    FieldTypeDescription
    messagestringMessage
    Response 400application/json
    1 fields

    Request data failed validation

    FieldTypeDescription
    errorobjectUnprocessed entity error.
    coderequiredstringError name.
    messagerequiredstringError description.
    Response 403application/json
    2 fields

    Invalid key for service

    FieldTypeDescription
    messagestring—
    urlstring—
    Response 404application/json
    2 fields

    Invalid key for service

    FieldTypeDescription
    messagestring—
    urlstring—
    Response 422application/json
    1 fields

    Unprocessed Entity

    FieldTypeDescription
    errorobjectUnprocessed entity error.
    coderequiredstringError name.
    messagerequiredstringError description.
    Response 500application/json
    1 fields

    The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

    FieldTypeDescription
    messagestring—
    GET /setup/{partner_name}/credentials

    Retrieve Partner Credentials Schema

    getCredentials

    Get Credentials Schema

    Get credentials schema for specific partner. You can use retrieved schema for updating the partner credentials.

    Response
    application/json

    Request data failed validation

    {
  "code": 400,
  "message": "Bad Request"
}
    Parameters
    2
    ParameterTypeExampleDescription
    x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Environment API Key.
    partner_name required string path optimalblue Partner name
    Response 200application/json
    2 fields

    Create Adapter API Triggered Successfully

    FieldTypeDescription
    codenumberStatus code
    messageobjectMessage
    Response 400application/json
    1 fields

    Request data failed validation

    FieldTypeDescription
    errorobjectUnprocessed entity error.
    coderequiredstringError name.
    messagerequiredstringError description.
    Response 403application/json
    2 fields

    Invalid key for service

    FieldTypeDescription
    messagestring—
    urlstring—
    Response 404application/json
    2 fields

    Invalid key for service

    FieldTypeDescription
    messagestring—
    urlstring—
    Response 422application/json
    1 fields

    Unprocessed Entity

    FieldTypeDescription
    errorobjectUnprocessed entity error.
    coderequiredstringError name.
    messagerequiredstringError description.
    Response 500application/json
    1 fields

    The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

    FieldTypeDescription
    messagestring—

    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"
}
    Parameters
    1
    ParameterTypeDescription
    x-api-key required string header Environment API Key.
    Response 201application/json
    2 fields

    Transaction created successfully

    FieldTypeDescription
    transaction_idstring (ulid)Staircase Transaction IdentifierExample 01F0KHK7DN3H5JZ4QJKMYAM6GB
    created_atstringStaircase time string.Example 03/03/2021, 8:24:04 AM EST
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError 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/pricing/invocations

    Request
    application/json 
    {
  "data": {
    "vendor_name": "optimalBlue",
    "request_data": {
      "people": [
        {
          "@id": "01FDTQ5PJSKC94HHZGYZDSTXCT",
          "@type": "borrower",
          "has_first_name": {
            "has_value": "test"
          },
          "has_last_name": {
            "has_value": "test1"
          },
          "has_debt_expense_to_income_dti_ratio": {
            "has_value": 15
          },
          "employed_as": [
            "01FDTQ5PGZWEG4M8PSR5T6TSYH"
          ],
          "with_declaration": [
            "01FDTQ5PH0KQ21KE0DR3FV16SW"
          ],
          "with_credit_information": [
            "01G0F456KV2YVD0N168SD8QTGD"
          ]
        }
      ],
      "credit_information": [
        {
          "@id": "01G0F456KV2YVD0N168SD8QTGD",
          "@type": "credit_information",
          "has_credit_rating_code_type": {
            "has_value": "experian"
          },
          "has_credit_report_action_type": {
            "has_value": "submit"
          },
          "has_credit_report_first_issued_date": {
            "has_value": "2022-04-12"
          },
          "has_credit_report_identifier": {
            "has_value": "DF6VM5"
          },
          "has_credit_report_last_updated_date": {
            "has_value": "2022-04-12"
          },
          "has_credit_report_merge_type": {
            "has_value": "blend"
          },
          "has_credit_report_type": {
            "has_value": "merge"
          },
          "has_credit_request_type": {
            "has_value": "individual"
          },
          "with_credit_score_information": [
            "01FDTQ5PH1J05ESN8F3M8X03MD"
          ]
        }
      ],
      "employment": [
        {
          "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
          "@type": "employment",
          "has_self_employment_indicator": {
            "has_value": true
          }
        }
      ],
      "declarations": [
        {
          "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
          "@type": "declaration",
          "has_citizenship_residency_type": {
            "has_value": "us_citizen"
          },
          "has_borrower_first_time_homebuyer_indicator": {
            "has_value": false
          },
          "has_bankruptcy_indicator": {
            "has_value": false
          },
          "has_age_of_bankruptcy_years_count": {
            "has_value": 0
          },
          "has_prior_property_foreclosure_completed_indicator": {
            "has_value": false
          },
          "has_age_of_prior_property_foreclosure_years_count": {
            "has_value": 0
          }
        }
      ],
      "credit_score_information": [
        {
          "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
          "@type": "credit_score_information",
          "has_credit_score": {
            "has_value": "850"
          }
        }
      ],
      "loans": [
        {
          "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
          "@type": "loan",
          "has_relocation_loan_indicator": {
            "has_value": false
          },
          "has_heloc_indicator": {
            "has_value": false
          },
          "with_borrower": [
            "01FDTQ5PJSKC94HHZGYZDSTXCT"
          ],
          "with_loan_terms": [
            "01FDTQ5PJTJBJZ777RCH7TDF5J"
          ],
          "with_documentation": [
            "01FDTQ5PJTMCWMQW9WYKSDT3FE"
          ],
          "with_summary": [
            "01FDTQ5PJVWPHV0MBGEMS6QHZZ"
          ],
          "with_payment_information": [
            "01FDTQ5PJXBVSW37ZTESFQWN4Y"
          ],
          "with_arm_adjustment": [
            "01FDTQ5PJXSBQYT5X7EAS4H31S"
          ],
          "with_insurance": [
            "01FDTQ5PJYNRA67MQEVTBZCRZ7"
          ],
          "with_project": [
            "01FKTQ5PKC2ZFKXBEH170VG0BJ"
          ],
          "serviced_by": [
            "01FDTQ5PKA5DVQ7F39HZK84H2R"
          ],
          "with_buydown": [
            "01FDTQ5PKBF5JHM46TQQEE3SAE"
          ],
          "with_quote_request": [
            "01FDTQ5PKBHV90N3GJ0PEK9TWD"
          ],
          "secured_by_property": [
            "01FDTQ5PKC4ZFKXBET140VG0BJ"
          ]
        }
      ],
      "loan_terms": [
        {
          "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
          "@type": "loan_terms",
          "has_mortgage_type": {
            "has_value": "conventional"
          },
          "has_pledged_assets_indicator": {
            "has_value": false
          },
          "has_escrow_required_indicator": {
            "has_value": true
          },
          "has_loan_purpose_type": {
            "has_value": "purchase"
          },
          "has_refinance_type": {
            "has_value": "no_cash_out"
          },
          "has_lien_position_type": {
            "has_value": "first_lien"
          },
          "has_base_loan_amount": {
            "has_value": 150000
          },
          "has_interest_only_indicator": {
            "has_value": false
          },
          "has_prepayment_penalty_indicator": {
            "has_value": false
          },
          "has_prepayment_penalty_term_months_count": {
            "has_value": 0
          },
          "has_construction_loan_indicator": {
            "has_value": false
          },
          "has_buydown_indicator": {
            "has_value": true
          }
        }
      ],
      "arm_adjustments": [
        {
          "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
          "@type": "arm_adjustment",
          "has_first_rate_adjustment_months_count": {
            "has_value": 60
          }
        }
      ],
      "buydowns": [
        {
          "@id": "01FDTQ5PKBF5JHM46TQQEE3SAE",
          "@type": "buydown",
          "has_buydown_type": {
            "has_value": "one_one"
          }
        }
      ],
      "insurance": [
        {
          "@id": "01FDTQ5PJYNRA67MQEVTBZCRZ7",
          "@type": "mortgage_insurance",
          "has_mortgage_insurance_premium_source_type": {
            "has_value": "borrower"
          }
        }
      ],
      "loan_documentation": [
        {
          "@id": "01FDTQ5PJTMCWMQW9WYKSDT3FE",
          "@type": "loan_documentation",
          "has_asset_documentation_level_type": {
            "has_value": "stated_and_verified"
          },
          "has_employment_documentation_level_type": {
            "has_value": "stated_and_verified"
          },
          "has_income_documentation_level_type": {
            "has_value": "stated_and_verified"
          }
        }
      ],
      "loan_summaries": [
        {
          "@id": "01FDTQ5PJVWPHV0MBGEMS6QHZZ",
          "@type": "loan_summary",
          "has_total_debt_expense_to_income_dti_ratio": {
            "has_value": 18
          },
          "has_total_monthly_income_amount": {
            "has_value": 0
          },
          "has_projected_reserves_amount": {
            "has_value": 24
          },
          "has_representative_credit_score": {
            "has_value": 850
          }
        }
      ],
      "loan_payment_information": [
        {
          "@id": "01FDTQ5PJXBVSW37ZTESFQWN4Y",
          "@type": "loan_payment_information",
          "has_number_of_payments_30_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_60_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_90_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_120_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_rolling_12_months_late_count": {
            "has_value": 0
          }
        }
      ],
      "organizations": [
        {
          "@id": "01FDTQ5PKA5DVQ7F39HZK84H2R",
          "@type": "servicer"
        }
      ],
      "quote_requests": [
        {
          "@id": "01FDTQ5PKBHV90N3GJ0PEK9TWD",
          "@type": "loan_price_quote_request",
          "has_loan_officer_compensation_type": {
            "has_value": "yes_lender_paid"
          },
          "has_calculate_borrower_requested_loan_amount_indicator": {
            "has_value": true
          },
          "has_include_fixed_rate_amortization_loans_indicator": {
            "has_value": true
          },
          "has_include_adjustable_rate_amortization_loans_indicator": {
            "has_value": false
          },
          "has_include_payment_option_adjustable_rate_amortization_loans_indicator": {
            "has_value": false
          },
          "has_discount_points_percent": {
            "has_value": 0
          },
          "has_include_balloon_loans_indicator": {
            "has_value": false
          },
          "has_cash_out_amount": {
            "has_value": 0
          },
          "include_loans_with_amortization_term": [
            "01FDTQGB8WJHJC9YT32CQ1ESCC"
          ]
        }
      ],
      "quote_amortization_terms": [
        {
          "@id": "01FDTQGB8WJHJC9YT32CQ1ESCC",
          "@type": "quote_amortization_term",
          "has_amortization_term_months_count": {
            "has_value": 360
          }
        }
      ],
      "properties": [
        {
          "@id": "01FDTQ5PKC4ZFKXBET140VG0BJ",
          "@type": "subject_property",
          "has_property_usage_type": {
            "has_value": "primary_residence"
          },
          "has_number_of_units_type": {
            "has_value": "one"
          },
          "has_project_design_type": {
            "has_value": "midrise_project"
          },
          "has_manufactured_home_indicator": {
            "has_value": false
          },
          "has_planned_unit_development_pud_indicator": {
            "has_value": false
          },
          "has_manufactured_home_width_type": {
            "has_value": "single_wide"
          },
          "has_project_usage_type": {
            "has_value": "string"
          },
          "has_financed_unit_count": {
            "has_value": 1
          },
          "has_non_warrantable_project_indicator": {
            "has_value": false
          },
          "has_stories_count": {
            "has_value": 1
          },
          "has_construction_method_type": {
            "has_value": "site_built"
          },
          "with_address": [
            "01FDTQGB9EV6FKWGZ2CY35971G"
          ],
          "with_sales_contract": [
            "01FDTQGB9EPKV6EJXZMTW0CGV0"
          ],
          "with_value": [
            "01FDTQGB9FVMF9YTFBTX95D2KH"
          ]
        }
      ],
      "projects": [
        {
          "@id": "01FKTQ5PKC2ZFKXBEH170VG0BJ",
          "@type": "project",
          "has_project_legal_structure_type": {
            "has_value": "condominium"
          }
        }
      ],
      "addresses": [
        {
          "@id": "01FDTQGB9EV6FKWGZ2CY35971G",
          "@type": "residential_address",
          "has_address_line_1_text": {
            "has_value": "string"
          },
          "has_county_name": {
            "has_value": "Collin"
          },
          "has_state_code": {
            "has_value": "TX"
          },
          "has_postal_code": {
            "has_value": "75024"
          }
        }
      ],
      "sales_contracts": [
        {
          "@id": "01FDTQGB9EPKV6EJXZMTW0CGV0",
          "@type": "property_sales_contract",
          "has_sales_contract_amount": {
            "has_value": 225000
          }
        }
      ],
      "property_valuations": [
        {
          "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
          "@type": "property_valuation",
          "has_property_valuation_amount": {
            "has_value": 225000
          }
        }
      ]
    }
  }
}
    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": {
    "vendor_name": "optimalBlue",
    "request_data": {
      "people": [
        {
          "@id": "01FDTQ5PJSKC94HHZGYZDSTXCT",
          "@type": "borrower",
          "has_first_name": {
            "has_value": "test"
          },
          "has_last_name": {
            "has_value": "test1"
          },
          "has_debt_expense_to_income_dti_ratio": {
            "has_value": 15
          },
          "employed_as": [
            "01FDTQ5PGZWEG4M8PSR5T6TSYH"
          ],
          "with_declaration": [
            "01FDTQ5PH0KQ21KE0DR3FV16SW"
          ],
          "with_credit_information": [
            "01G0F456KV2YVD0N168SD8QTGD"
          ]
        }
      ],
      "credit_information": [
        {
          "@id": "01G0F456KV2YVD0N168SD8QTGD",
          "@type": "credit_information",
          "has_credit_rating_code_type": {
            "has_value": "experian"
          },
          "has_credit_report_action_type": {
            "has_value": "submit"
          },
          "has_credit_report_first_issued_date": {
            "has_value": "2022-04-12"
          },
          "has_credit_report_identifier": {
            "has_value": "DF6VM5"
          },
          "has_credit_report_last_updated_date": {
            "has_value": "2022-04-12"
          },
          "has_credit_report_merge_type": {
            "has_value": "blend"
          },
          "has_credit_report_type": {
            "has_value": "merge"
          },
          "has_credit_request_type": {
            "has_value": "individual"
          },
          "with_credit_score_information": [
            "01FDTQ5PH1J05ESN8F3M8X03MD"
          ]
        }
      ],
      "employment": [
        {
          "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
          "@type": "employment",
          "has_self_employment_indicator": {
            "has_value": true
          }
        }
      ],
      "declarations": [
        {
          "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
          "@type": "declaration",
          "has_citizenship_residency_type": {
            "has_value": "us_citizen"
          },
          "has_borrower_first_time_homebuyer_indicator": {
            "has_value": false
          },
          "has_bankruptcy_indicator": {
            "has_value": false
          },
          "has_age_of_bankruptcy_years_count": {
            "has_value": 0
          },
          "has_prior_property_foreclosure_completed_indicator": {
            "has_value": false
          },
          "has_age_of_prior_property_foreclosure_years_count": {
            "has_value": 0
          }
        }
      ],
      "credit_score_information": [
        {
          "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
          "@type": "credit_score_information",
          "has_credit_score": {
            "has_value": "850"
          }
        }
      ],
      "loans": [
        {
          "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
          "@type": "loan",
          "has_relocation_loan_indicator": {
            "has_value": false
          },
          "has_heloc_indicator": {
            "has_value": false
          },
          "with_borrower": [
            "01FDTQ5PJSKC94HHZGYZDSTXCT"
          ],
          "with_loan_terms": [
            "01FDTQ5PJTJBJZ777RCH7TDF5J"
          ],
          "with_documentation": [
            "01FDTQ5PJTMCWMQW9WYKSDT3FE"
          ],
          "with_summary": [
            "01FDTQ5PJVWPHV0MBGEMS6QHZZ"
          ],
          "with_payment_information": [
            "01FDTQ5PJXBVSW37ZTESFQWN4Y"
          ],
          "with_arm_adjustment": [
            "01FDTQ5PJXSBQYT5X7EAS4H31S"
          ],
          "with_insurance": [
            "01FDTQ5PJYNRA67MQEVTBZCRZ7"
          ],
          "with_project": [
            "01FKTQ5PKC2ZFKXBEH170VG0BJ"
          ],
          "serviced_by": [
            "01FDTQ5PKA5DVQ7F39HZK84H2R"
          ],
          "with_buydown": [
            "01FDTQ5PKBF5JHM46TQQEE3SAE"
          ],
          "with_quote_request": [
            "01FDTQ5PKBHV90N3GJ0PEK9TWD"
          ],
          "secured_by_property": [
            "01FDTQ5PKC4ZFKXBET140VG0BJ"
          ]
        }
      ],
      "loan_terms": [
        {
          "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
          "@type": "loan_terms",
          "has_mortgage_type": {
            "has_value": "conventional"
          },
          "has_pledged_assets_indicator": {
            "has_value": false
          },
          "has_escrow_required_indicator": {
            "has_value": true
          },
          "has_loan_purpose_type": {
            "has_value": "purchase"
          },
          "has_refinance_type": {
            "has_value": "no_cash_out"
          },
          "has_lien_position_type": {
            "has_value": "first_lien"
          },
          "has_base_loan_amount": {
            "has_value": 150000
          },
          "has_interest_only_indicator": {
            "has_value": false
          },
          "has_prepayment_penalty_indicator": {
            "has_value": false
          },
          "has_prepayment_penalty_term_months_count": {
            "has_value": 0
          },
          "has_construction_loan_indicator": {
            "has_value": false
          },
          "has_buydown_indicator": {
            "has_value": true
          }
        }
      ],
      "arm_adjustments": [
        {
          "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
          "@type": "arm_adjustment",
          "has_first_rate_adjustment_months_count": {
            "has_value": 60
          }
        }
      ],
      "buydowns": [
        {
          "@id": "01FDTQ5PKBF5JHM46TQQEE3SAE",
          "@type": "buydown",
          "has_buydown_type": {
            "has_value": "one_one"
          }
        }
      ],
      "insurance": [
        {
          "@id": "01FDTQ5PJYNRA67MQEVTBZCRZ7",
          "@type": "mortgage_insurance",
          "has_mortgage_insurance_premium_source_type": {
            "has_value": "borrower"
          }
        }
      ],
      "loan_documentation": [
        {
          "@id": "01FDTQ5PJTMCWMQW9WYKSDT3FE",
          "@type": "loan_documentation",
          "has_asset_documentation_level_type": {
            "has_value": "stated_and_verified"
          },
          "has_employment_documentation_level_type": {
            "has_value": "stated_and_verified"
          },
          "has_income_documentation_level_type": {
            "has_value": "stated_and_verified"
          }
        }
      ],
      "loan_summaries": [
        {
          "@id": "01FDTQ5PJVWPHV0MBGEMS6QHZZ",
          "@type": "loan_summary",
          "has_total_debt_expense_to_income_dti_ratio": {
            "has_value": 18
          },
          "has_total_monthly_income_amount": {
            "has_value": 0
          },
          "has_projected_reserves_amount": {
            "has_value": 24
          },
          "has_representative_credit_score": {
            "has_value": 850
          }
        }
      ],
      "loan_payment_information": [
        {
          "@id": "01FDTQ5PJXBVSW37ZTESFQWN4Y",
          "@type": "loan_payment_information",
          "has_number_of_payments_30_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_60_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_90_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_120_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_rolling_12_months_late_count": {
            "has_value": 0
          }
        }
      ],
      "organizations": [
        {
          "@id": "01FDTQ5PKA5DVQ7F39HZK84H2R",
          "@type": "servicer"
        }
      ],
      "quote_requests": [
        {
          "@id": "01FDTQ5PKBHV90N3GJ0PEK9TWD",
          "@type": "loan_price_quote_request",
          "has_loan_officer_compensation_type": {
            "has_value": "yes_lender_paid"
          },
          "has_calculate_borrower_requested_loan_amount_indicator": {
            "has_value": true
          },
          "has_include_fixed_rate_amortization_loans_indicator": {
            "has_value": true
          },
          "has_include_adjustable_rate_amortization_loans_indicator": {
            "has_value": false
          },
          "has_include_payment_option_adjustable_rate_amortization_loans_indicator": {
            "has_value": false
          },
          "has_discount_points_percent": {
            "has_value": 0
          },
          "has_include_balloon_loans_indicator": {
            "has_value": false
          },
          "has_cash_out_amount": {
            "has_value": 0
          },
          "include_loans_with_amortization_term": [
            "01FDTQGB8WJHJC9YT32CQ1ESCC"
          ]
        }
      ],
      "quote_amortization_terms": [
        {
          "@id": "01FDTQGB8WJHJC9YT32CQ1ESCC",
          "@type": "quote_amortization_term",
          "has_amortization_term_months_count": {
            "has_value": 360
          }
        }
      ],
      "properties": [
        {
          "@id": "01FDTQ5PKC4ZFKXBET140VG0BJ",
          "@type": "subject_property",
          "has_property_usage_type": {
            "has_value": "primary_residence"
          },
          "has_number_of_units_type": {
            "has_value": "one"
          },
          "has_project_design_type": {
            "has_value": "midrise_project"
          },
          "has_manufactured_home_indicator": {
            "has_value": false
          },
          "has_planned_unit_development_pud_indicator": {
            "has_value": false
          },
          "has_manufactured_home_width_type": {
            "has_value": "single_wide"
          },
          "has_project_usage_type": {
            "has_value": "string"
          },
          "has_financed_unit_count": {
            "has_value": 1
          },
          "has_non_warrantable_project_indicator": {
            "has_value": false
          },
          "has_stories_count": {
            "has_value": 1
          },
          "has_construction_method_type": {
            "has_value": "site_built"
          },
          "with_address": [
            "01FDTQGB9EV6FKWGZ2CY35971G"
          ],
          "with_sales_contract": [
            "01FDTQGB9EPKV6EJXZMTW0CGV0"
          ],
          "with_value": [
            "01FDTQGB9FVMF9YTFBTX95D2KH"
          ]
        }
      ],
      "projects": [
        {
          "@id": "01FKTQ5PKC2ZFKXBEH170VG0BJ",
          "@type": "project",
          "has_project_legal_structure_type": {
            "has_value": "condominium"
          }
        }
      ],
      "addresses": [
        {
          "@id": "01FDTQGB9EV6FKWGZ2CY35971G",
          "@type": "residential_address",
          "has_address_line_1_text": {
            "has_value": "string"
          },
          "has_county_name": {
            "has_value": "Collin"
          },
          "has_state_code": {
            "has_value": "TX"
          },
          "has_postal_code": {
            "has_value": "75024"
          }
        }
      ],
      "sales_contracts": [
        {
          "@id": "01FDTQGB9EPKV6EJXZMTW0CGV0",
          "@type": "property_sales_contract",
          "has_sales_contract_amount": {
            "has_value": 225000
          }
        }
      ],
      "property_valuations": [
        {
          "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
          "@type": "property_valuation",
          "has_property_valuation_amount": {
            "has_value": 225000
          }
        }
      ]
    }
  }
}
    Parameters
    2
    ParameterTypeExampleDescription
    x-api-key required string header — Environment API Key.
    transaction_id required string (ulid) path 01F0KHK7DN3H5JZ4QJKMYAM6GB Staircase Transaction Identifier
    Request bodyapplication/json
    1 fields
    FieldTypeDescription
    dataobjectThe data that is needed for invocation. It should follow the request schema
    peopleobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_first_namerequiredobject—
    has_valuerequiredstring—
    has_last_namerequiredobject—
    has_valuerequiredstring—
    has_debt_expense_to_income_dti_ratiorequiredobject—
    has_valuerequirednumber—
    employed_asrequiredstring[]—
    with_declarationrequiredstring[]—
    with_credit_informationrequiredstring[]—
    employmentobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_self_employment_indicatorrequiredobject—
    has_valuerequiredboolean—
    declarationsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_citizenship_residency_typerequiredobject—
    has_valuerequiredstringnon_permanent_resident_aliennon_resident_alienpermanent_resident_alienus_citizen
    has_borrower_first_time_homebuyer_indicatorobject—
    has_valuerequiredboolean—
    has_bankruptcy_indicatorobject—
    has_valuerequiredboolean—
    has_age_of_bankruptcy_years_countobject—
    has_valuerequiredinteger—
    has_prior_property_foreclosure_completed_indicatorobject—
    has_valuerequiredboolean—
    has_age_of_prior_property_foreclosure_years_countobject—
    has_valuerequiredinteger—
    credit_score_informationobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_credit_scorerequiredobject—
    has_valuerequiredstring—
    loansrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_relocation_loan_indicatorrequiredobject—
    has_valuerequiredboolean—
    with_borrowerrequiredstring[]—
    with_loan_termsrequiredstring[]—
    with_documentationrequiredstring[]—
    with_summaryrequiredstring[]—
    with_payment_informationrequiredstring[]—
    with_arm_adjustmentrequiredstring[]—
    with_insurancerequiredstring[]—
    with_projectrequiredstring[]—
    serviced_byrequiredstring[]—
    with_buydownrequiredstring[]—
    with_quote_requestrequiredstring[]—
    secured_by_propertyrequiredstring[]—
    has_heloc_indicatorrequiredobject—
    has_valuerequiredboolean—
    loan_termsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_pledged_assets_indicatorobject—
    has_valuerequiredboolean—
    has_mortgage_typerequiredobject—
    has_valuerequiredstringconventionalfhalocal_agencyotherpublic_and_indian_housingstate_agencyusda-rdva
    has_escrow_required_indicatorobject—
    has_valuerequiredboolean—
    has_loan_purpose_typerequiredobject—
    has_valuerequiredstringotherpurchaserefinance
    has_refinance_typerequiredobject—
    has_valuerequiredstringcash_outlimited_cash_outno_cash_out
    has_lien_position_typerequiredobject—
    has_valuerequiredstringfirst_liensecond_liensubordinate_lien
    has_base_loan_amountrequiredobject—
    has_valuerequirednumber—
    has_interest_only_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_prepayment_penalty_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_prepayment_penalty_term_months_countrequiredobject—
    has_valuerequiredinteger—
    has_construction_loan_indicatorobject—
    has_valuerequiredboolean—
    has_buydown_indicatorrequiredobject—
    has_valuerequiredboolean—
    arm_adjustmentsobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_first_rate_adjustment_months_countrequiredobject—
    has_valuerequiredinteger—
    buydownsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_buydown_typerequiredobject—
    has_valuerequiredstringone_oneone_zerothreetwo_one
    insurancerequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_mortgage_insurance_premium_source_typerequiredobject—
    has_valuerequiredstringborrowerlender
    loan_documentationrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_asset_documentation_level_typerequiredobject—
    has_valuerequiredstringneither_stated_nor_verifiednot_requiredstated_and_verifiedstated_only
    has_employment_documentation_level_typerequiredobject—
    has_valuerequiredstringneither_stated_nor_verifiednot_requiredstated_and_verifiedstated_only
    has_income_documentation_level_typerequiredobject—
    has_valuerequiredstringneither_stated_nor_verifiednot_requiredstated_and_verifiedstated_only
    loan_summariesrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_total_debt_expense_to_income_dti_ratiorequiredobject—
    has_valuerequirednumber—
    has_total_monthly_income_amountobject—
    has_valuerequirednumber—
    has_projected_reserves_amountobject—
    has_valuerequirednumber—
    has_representative_credit_scorerequiredobject—
    has_valuerequiredinteger—
    loan_payment_informationobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_number_of_payments_30_days_late_countobject—
    has_valuerequiredinteger—
    has_number_of_payments_60_days_late_countobject—
    has_valuerequiredinteger—
    has_number_of_payments_90_days_late_countobject—
    has_valuerequiredinteger—
    has_number_of_payments_120_days_late_countobject—
    has_valuerequiredinteger—
    has_number_of_payments_rolling_12_months_late_countobject—
    has_valuerequiredinteger—
    organizationsobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_organization_nameobject—
    has_valuerequiredstring—
    quote_requestsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_loan_officer_compensation_typerequiredobject—
    has_valuerequiredstringno_buyer_paidno_lender_paidyes_lender_paid
    has_calculate_borrower_requested_loan_amount_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_include_fixed_rate_amortization_loans_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_include_adjustable_rate_amortization_loans_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_include_payment_option_adjustable_rate_amortization_loans_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_discount_points_percentobject—
    has_valuerequirednumber—
    has_include_balloon_loans_indicatorobject—
    has_valuerequiredboolean—
    has_cash_out_amountobject—
    has_valuerequirednumber—
    include_loans_with_amortization_termstring[]—
    quote_amortization_termsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_amortization_term_months_countrequiredobject—
    has_valuerequiredinteger—
    propertiesrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_property_usage_typerequiredobject—
    has_valuerequiredstringinvestmentotherprimary_residencesecond_home
    has_number_of_units_typerequiredobject—
    has_valuerequiredstringfouronethreetwotwo_to_four
    has_project_design_typerequiredobject—
    has_valuerequiredstringgarden_projecthighrise_projectmidrise_projectothertownhouse_rowhouse
    has_planned_unit_development_pud_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_manufactured_home_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_manufactured_home_width_typerequiredobject—
    has_valuerequiredstring—
    has_project_usage_typerequiredobject—
    has_valuerequiredstring—
    has_stories_countrequiredobject—
    has_valuerequiredinteger—
    has_construction_method_typerequiredobject—
    has_valuerequiredstringmanufacturedmobile_homemodularon_frame_modularothersite_built
    has_financed_unit_countrequiredobject—
    has_valuerequiredinteger—
    has_non_warrantable_project_indicatorrequiredobject—
    has_valuerequiredboolean—
    with_addressrequiredstring[]—
    with_sales_contractrequiredstring[]—
    with_valuerequiredstring[]—
    projectsobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_project_legal_structure_typerequiredobject—
    has_valuerequiredstringcommon_interest_apartmentcondominiumcooperativeunknown
    addressesrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_county_nameobjectRequired if the address is for the subject property
    has_valuerequiredstring—
    has_state_coderequiredobject—
    has_valuerequiredstring—
    has_city_nameobject—
    has_valuerequiredstring—
    has_postal_codeobject—
    has_valuerequiredstring—
    has_address_line_1_textobject—
    has_valuerequiredstring—
    sales_contractsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_sales_contract_amountrequiredobject—
    has_valuerequirednumber—
    property_valuationsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_property_valuation_amountrequiredobject—
    has_valuerequirednumber—
    Response 201application/json
    4 fields

    Collection created successfully

    FieldTypeDescription
    transaction_idstring (ulid)Transaction ID.Example 01EZQ32PJQGKRA6HR8D72Q9FFF
    collection_idstring (ulid)Collection ID.Example 01EZQ32PJQGKRA6HR8D72Q9FFF
    dataobjectData in Staircase language schema.
    metadataobjectMetadata about collection, f.e version of used Staircase schema.
    Response 400application/json
    1 fields

    Error

    FieldTypeDescription
    messageone ofEither message object with more properties.
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 404application/json
    1 fields

    Resource not found

    FieldTypeDescription
    messagestringMessage
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError 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"
}
    Parameters
    3
    ParameterTypeExampleDescription
    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

    FieldTypeDescription
    transaction_idrequiredstring—
    collection_idrequiredstring—
    metadatarequiredobject—
    created_atrequiredstring—
    validationrequiredboolean—
    datarequiredobject—
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 404application/json
    1 fields

    Resource not found

    FieldTypeDescription
    messagestringMessage
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError 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": {}
}
    Parameters
    2
    ParameterTypeExampleDescription
    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

    FieldTypeDescription
    transaction_idstring (ulid)Transaction ID.Example 01EZQ32PJQGKRA6HR8D72Q9FFF
    collection_idstring (ulid)Collection ID.Example 01EZQ32PJQGKRA6HR8D72Q9FFF
    dataobjectData in Staircase language schema.
    metadataobjectMetadata about collection, f.e version of used Staircase schema.
    Response 400application/json
    1 fields

    Error

    FieldTypeDescription
    messageone ofEither message object with more properties.
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 404application/json
    1 fields

    Resource not found

    FieldTypeDescription
    messagestringMessage
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError 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": {
    "vendor_name": "optimalBlue",
    "request_data": {
      "people": [
        {
          "@id": "01FDTQ5PJSKC94HHZGYZDSTXCT",
          "@type": "borrower",
          "has_first_name": {
            "has_value": "test"
          },
          "has_last_name": {
            "has_value": "test1"
          },
          "has_debt_expense_to_income_dti_ratio": {
            "has_value": 15
          },
          "employed_as": [
            "01FDTQ5PGZWEG4M8PSR5T6TSYH"
          ],
          "with_declaration": [
            "01FDTQ5PH0KQ21KE0DR3FV16SW"
          ],
          "with_credit_information": [
            "01G0F456KV2YVD0N168SD8QTGD"
          ]
        }
      ],
      "credit_information": [
        {
          "@id": "01G0F456KV2YVD0N168SD8QTGD",
          "@type": "credit_information",
          "has_credit_rating_code_type": {
            "has_value": "experian"
          },
          "has_credit_report_action_type": {
            "has_value": "submit"
          },
          "has_credit_report_first_issued_date": {
            "has_value": "2022-04-12"
          },
          "has_credit_report_identifier": {
            "has_value": "DF6VM5"
          },
          "has_credit_report_last_updated_date": {
            "has_value": "2022-04-12"
          },
          "has_credit_report_merge_type": {
            "has_value": "blend"
          },
          "has_credit_report_type": {
            "has_value": "merge"
          },
          "has_credit_request_type": {
            "has_value": "individual"
          },
          "with_credit_score_information": [
            "01FDTQ5PH1J05ESN8F3M8X03MD"
          ]
        }
      ],
      "employment": [
        {
          "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
          "@type": "employment",
          "has_self_employment_indicator": {
            "has_value": true
          }
        }
      ],
      "declarations": [
        {
          "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
          "@type": "declaration",
          "has_citizenship_residency_type": {
            "has_value": "us_citizen"
          },
          "has_borrower_first_time_homebuyer_indicator": {
            "has_value": false
          },
          "has_bankruptcy_indicator": {
            "has_value": false
          },
          "has_age_of_bankruptcy_years_count": {
            "has_value": 0
          },
          "has_prior_property_foreclosure_completed_indicator": {
            "has_value": false
          },
          "has_age_of_prior_property_foreclosure_years_count": {
            "has_value": 0
          }
        }
      ],
      "credit_score_information": [
        {
          "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
          "@type": "credit_score_information",
          "has_credit_score": {
            "has_value": "850"
          }
        }
      ],
      "loans": [
        {
          "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
          "@type": "loan",
          "has_relocation_loan_indicator": {
            "has_value": false
          },
          "has_heloc_indicator": {
            "has_value": false
          },
          "with_borrower": [
            "01FDTQ5PJSKC94HHZGYZDSTXCT"
          ],
          "with_loan_terms": [
            "01FDTQ5PJTJBJZ777RCH7TDF5J"
          ],
          "with_documentation": [
            "01FDTQ5PJTMCWMQW9WYKSDT3FE"
          ],
          "with_summary": [
            "01FDTQ5PJVWPHV0MBGEMS6QHZZ"
          ],
          "with_payment_information": [
            "01FDTQ5PJXBVSW37ZTESFQWN4Y"
          ],
          "with_arm_adjustment": [
            "01FDTQ5PJXSBQYT5X7EAS4H31S"
          ],
          "with_insurance": [
            "01FDTQ5PJYNRA67MQEVTBZCRZ7"
          ],
          "with_project": [
            "01FKTQ5PKC2ZFKXBEH170VG0BJ"
          ],
          "serviced_by": [
            "01FDTQ5PKA5DVQ7F39HZK84H2R"
          ],
          "with_buydown": [
            "01FDTQ5PKBF5JHM46TQQEE3SAE"
          ],
          "with_quote_request": [
            "01FDTQ5PKBHV90N3GJ0PEK9TWD"
          ],
          "secured_by_property": [
            "01FDTQ5PKC4ZFKXBET140VG0BJ"
          ]
        }
      ],
      "loan_terms": [
        {
          "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
          "@type": "loan_terms",
          "has_mortgage_type": {
            "has_value": "conventional"
          },
          "has_pledged_assets_indicator": {
            "has_value": false
          },
          "has_escrow_required_indicator": {
            "has_value": true
          },
          "has_loan_purpose_type": {
            "has_value": "purchase"
          },
          "has_refinance_type": {
            "has_value": "no_cash_out"
          },
          "has_lien_position_type": {
            "has_value": "first_lien"
          },
          "has_base_loan_amount": {
            "has_value": 150000
          },
          "has_interest_only_indicator": {
            "has_value": false
          },
          "has_prepayment_penalty_indicator": {
            "has_value": false
          },
          "has_prepayment_penalty_term_months_count": {
            "has_value": 0
          },
          "has_construction_loan_indicator": {
            "has_value": false
          },
          "has_buydown_indicator": {
            "has_value": true
          }
        }
      ],
      "arm_adjustments": [
        {
          "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
          "@type": "arm_adjustment",
          "has_first_rate_adjustment_months_count": {
            "has_value": 60
          }
        }
      ],
      "buydowns": [
        {
          "@id": "01FDTQ5PKBF5JHM46TQQEE3SAE",
          "@type": "buydown",
          "has_buydown_type": {
            "has_value": "one_one"
          }
        }
      ],
      "insurance": [
        {
          "@id": "01FDTQ5PJYNRA67MQEVTBZCRZ7",
          "@type": "mortgage_insurance",
          "has_mortgage_insurance_premium_source_type": {
            "has_value": "borrower"
          }
        }
      ],
      "loan_documentation": [
        {
          "@id": "01FDTQ5PJTMCWMQW9WYKSDT3FE",
          "@type": "loan_documentation",
          "has_asset_documentation_level_type": {
            "has_value": "stated_and_verified"
          },
          "has_employment_documentation_level_type": {
            "has_value": "stated_and_verified"
          },
          "has_income_documentation_level_type": {
            "has_value": "stated_and_verified"
          }
        }
      ],
      "loan_summaries": [
        {
          "@id": "01FDTQ5PJVWPHV0MBGEMS6QHZZ",
          "@type": "loan_summary",
          "has_total_debt_expense_to_income_dti_ratio": {
            "has_value": 18
          },
          "has_total_monthly_income_amount": {
            "has_value": 0
          },
          "has_projected_reserves_amount": {
            "has_value": 24
          },
          "has_representative_credit_score": {
            "has_value": 850
          }
        }
      ],
      "loan_payment_information": [
        {
          "@id": "01FDTQ5PJXBVSW37ZTESFQWN4Y",
          "@type": "loan_payment_information",
          "has_number_of_payments_30_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_60_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_90_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_120_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_rolling_12_months_late_count": {
            "has_value": 0
          }
        }
      ],
      "organizations": [
        {
          "@id": "01FDTQ5PKA5DVQ7F39HZK84H2R",
          "@type": "servicer"
        }
      ],
      "quote_requests": [
        {
          "@id": "01FDTQ5PKBHV90N3GJ0PEK9TWD",
          "@type": "loan_price_quote_request",
          "has_loan_officer_compensation_type": {
            "has_value": "yes_lender_paid"
          },
          "has_calculate_borrower_requested_loan_amount_indicator": {
            "has_value": true
          },
          "has_include_fixed_rate_amortization_loans_indicator": {
            "has_value": true
          },
          "has_include_adjustable_rate_amortization_loans_indicator": {
            "has_value": false
          },
          "has_include_payment_option_adjustable_rate_amortization_loans_indicator": {
            "has_value": false
          },
          "has_discount_points_percent": {
            "has_value": 0
          },
          "has_include_balloon_loans_indicator": {
            "has_value": false
          },
          "has_cash_out_amount": {
            "has_value": 0
          },
          "include_loans_with_amortization_term": [
            "01FDTQGB8WJHJC9YT32CQ1ESCC"
          ]
        }
      ],
      "quote_amortization_terms": [
        {
          "@id": "01FDTQGB8WJHJC9YT32CQ1ESCC",
          "@type": "quote_amortization_term",
          "has_amortization_term_months_count": {
            "has_value": 360
          }
        }
      ],
      "properties": [
        {
          "@id": "01FDTQ5PKC4ZFKXBET140VG0BJ",
          "@type": "subject_property",
          "has_property_usage_type": {
            "has_value": "primary_residence"
          },
          "has_number_of_units_type": {
            "has_value": "one"
          },
          "has_project_design_type": {
            "has_value": "midrise_project"
          },
          "has_manufactured_home_indicator": {
            "has_value": false
          },
          "has_planned_unit_development_pud_indicator": {
            "has_value": false
          },
          "has_manufactured_home_width_type": {
            "has_value": "single_wide"
          },
          "has_project_usage_type": {
            "has_value": "string"
          },
          "has_financed_unit_count": {
            "has_value": 1
          },
          "has_non_warrantable_project_indicator": {
            "has_value": false
          },
          "has_stories_count": {
            "has_value": 1
          },
          "has_construction_method_type": {
            "has_value": "site_built"
          },
          "with_address": [
            "01FDTQGB9EV6FKWGZ2CY35971G"
          ],
          "with_sales_contract": [
            "01FDTQGB9EPKV6EJXZMTW0CGV0"
          ],
          "with_value": [
            "01FDTQGB9FVMF9YTFBTX95D2KH"
          ]
        }
      ],
      "projects": [
        {
          "@id": "01FKTQ5PKC2ZFKXBEH170VG0BJ",
          "@type": "project",
          "has_project_legal_structure_type": {
            "has_value": "condominium"
          }
        }
      ],
      "addresses": [
        {
          "@id": "01FDTQGB9EV6FKWGZ2CY35971G",
          "@type": "residential_address",
          "has_address_line_1_text": {
            "has_value": "string"
          },
          "has_county_name": {
            "has_value": "Collin"
          },
          "has_state_code": {
            "has_value": "TX"
          },
          "has_postal_code": {
            "has_value": "75024"
          }
        }
      ],
      "sales_contracts": [
        {
          "@id": "01FDTQGB9EPKV6EJXZMTW0CGV0",
          "@type": "property_sales_contract",
          "has_sales_contract_amount": {
            "has_value": 225000
          }
        }
      ],
      "property_valuations": [
        {
          "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
          "@type": "property_valuation",
          "has_property_valuation_amount": {
            "has_value": 225000
          }
        }
      ]
    }
  }
}
    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": {
    "vendor_name": "optimalBlue",
    "request_data": {
      "people": [
        {
          "@id": "01FDTQ5PJSKC94HHZGYZDSTXCT",
          "@type": "borrower",
          "has_first_name": {
            "has_value": "test"
          },
          "has_last_name": {
            "has_value": "test1"
          },
          "has_debt_expense_to_income_dti_ratio": {
            "has_value": 15
          },
          "employed_as": [
            "01FDTQ5PGZWEG4M8PSR5T6TSYH"
          ],
          "with_declaration": [
            "01FDTQ5PH0KQ21KE0DR3FV16SW"
          ],
          "with_credit_information": [
            "01G0F456KV2YVD0N168SD8QTGD"
          ]
        }
      ],
      "credit_information": [
        {
          "@id": "01G0F456KV2YVD0N168SD8QTGD",
          "@type": "credit_information",
          "has_credit_rating_code_type": {
            "has_value": "experian"
          },
          "has_credit_report_action_type": {
            "has_value": "submit"
          },
          "has_credit_report_first_issued_date": {
            "has_value": "2022-04-12"
          },
          "has_credit_report_identifier": {
            "has_value": "DF6VM5"
          },
          "has_credit_report_last_updated_date": {
            "has_value": "2022-04-12"
          },
          "has_credit_report_merge_type": {
            "has_value": "blend"
          },
          "has_credit_report_type": {
            "has_value": "merge"
          },
          "has_credit_request_type": {
            "has_value": "individual"
          },
          "with_credit_score_information": [
            "01FDTQ5PH1J05ESN8F3M8X03MD"
          ]
        }
      ],
      "employment": [
        {
          "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
          "@type": "employment",
          "has_self_employment_indicator": {
            "has_value": true
          }
        }
      ],
      "declarations": [
        {
          "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
          "@type": "declaration",
          "has_citizenship_residency_type": {
            "has_value": "us_citizen"
          },
          "has_borrower_first_time_homebuyer_indicator": {
            "has_value": false
          },
          "has_bankruptcy_indicator": {
            "has_value": false
          },
          "has_age_of_bankruptcy_years_count": {
            "has_value": 0
          },
          "has_prior_property_foreclosure_completed_indicator": {
            "has_value": false
          },
          "has_age_of_prior_property_foreclosure_years_count": {
            "has_value": 0
          }
        }
      ],
      "credit_score_information": [
        {
          "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
          "@type": "credit_score_information",
          "has_credit_score": {
            "has_value": "850"
          }
        }
      ],
      "loans": [
        {
          "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
          "@type": "loan",
          "has_relocation_loan_indicator": {
            "has_value": false
          },
          "has_heloc_indicator": {
            "has_value": false
          },
          "with_borrower": [
            "01FDTQ5PJSKC94HHZGYZDSTXCT"
          ],
          "with_loan_terms": [
            "01FDTQ5PJTJBJZ777RCH7TDF5J"
          ],
          "with_documentation": [
            "01FDTQ5PJTMCWMQW9WYKSDT3FE"
          ],
          "with_summary": [
            "01FDTQ5PJVWPHV0MBGEMS6QHZZ"
          ],
          "with_payment_information": [
            "01FDTQ5PJXBVSW37ZTESFQWN4Y"
          ],
          "with_arm_adjustment": [
            "01FDTQ5PJXSBQYT5X7EAS4H31S"
          ],
          "with_insurance": [
            "01FDTQ5PJYNRA67MQEVTBZCRZ7"
          ],
          "with_project": [
            "01FKTQ5PKC2ZFKXBEH170VG0BJ"
          ],
          "serviced_by": [
            "01FDTQ5PKA5DVQ7F39HZK84H2R"
          ],
          "with_buydown": [
            "01FDTQ5PKBF5JHM46TQQEE3SAE"
          ],
          "with_quote_request": [
            "01FDTQ5PKBHV90N3GJ0PEK9TWD"
          ],
          "secured_by_property": [
            "01FDTQ5PKC4ZFKXBET140VG0BJ"
          ]
        }
      ],
      "loan_terms": [
        {
          "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
          "@type": "loan_terms",
          "has_mortgage_type": {
            "has_value": "conventional"
          },
          "has_pledged_assets_indicator": {
            "has_value": false
          },
          "has_escrow_required_indicator": {
            "has_value": true
          },
          "has_loan_purpose_type": {
            "has_value": "purchase"
          },
          "has_refinance_type": {
            "has_value": "no_cash_out"
          },
          "has_lien_position_type": {
            "has_value": "first_lien"
          },
          "has_base_loan_amount": {
            "has_value": 150000
          },
          "has_interest_only_indicator": {
            "has_value": false
          },
          "has_prepayment_penalty_indicator": {
            "has_value": false
          },
          "has_prepayment_penalty_term_months_count": {
            "has_value": 0
          },
          "has_construction_loan_indicator": {
            "has_value": false
          },
          "has_buydown_indicator": {
            "has_value": true
          }
        }
      ],
      "arm_adjustments": [
        {
          "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
          "@type": "arm_adjustment",
          "has_first_rate_adjustment_months_count": {
            "has_value": 60
          }
        }
      ],
      "buydowns": [
        {
          "@id": "01FDTQ5PKBF5JHM46TQQEE3SAE",
          "@type": "buydown",
          "has_buydown_type": {
            "has_value": "one_one"
          }
        }
      ],
      "insurance": [
        {
          "@id": "01FDTQ5PJYNRA67MQEVTBZCRZ7",
          "@type": "mortgage_insurance",
          "has_mortgage_insurance_premium_source_type": {
            "has_value": "borrower"
          }
        }
      ],
      "loan_documentation": [
        {
          "@id": "01FDTQ5PJTMCWMQW9WYKSDT3FE",
          "@type": "loan_documentation",
          "has_asset_documentation_level_type": {
            "has_value": "stated_and_verified"
          },
          "has_employment_documentation_level_type": {
            "has_value": "stated_and_verified"
          },
          "has_income_documentation_level_type": {
            "has_value": "stated_and_verified"
          }
        }
      ],
      "loan_summaries": [
        {
          "@id": "01FDTQ5PJVWPHV0MBGEMS6QHZZ",
          "@type": "loan_summary",
          "has_total_debt_expense_to_income_dti_ratio": {
            "has_value": 18
          },
          "has_total_monthly_income_amount": {
            "has_value": 0
          },
          "has_projected_reserves_amount": {
            "has_value": 24
          },
          "has_representative_credit_score": {
            "has_value": 850
          }
        }
      ],
      "loan_payment_information": [
        {
          "@id": "01FDTQ5PJXBVSW37ZTESFQWN4Y",
          "@type": "loan_payment_information",
          "has_number_of_payments_30_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_60_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_90_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_120_days_late_count": {
            "has_value": 0
          },
          "has_number_of_payments_rolling_12_months_late_count": {
            "has_value": 0
          }
        }
      ],
      "organizations": [
        {
          "@id": "01FDTQ5PKA5DVQ7F39HZK84H2R",
          "@type": "servicer"
        }
      ],
      "quote_requests": [
        {
          "@id": "01FDTQ5PKBHV90N3GJ0PEK9TWD",
          "@type": "loan_price_quote_request",
          "has_loan_officer_compensation_type": {
            "has_value": "yes_lender_paid"
          },
          "has_calculate_borrower_requested_loan_amount_indicator": {
            "has_value": true
          },
          "has_include_fixed_rate_amortization_loans_indicator": {
            "has_value": true
          },
          "has_include_adjustable_rate_amortization_loans_indicator": {
            "has_value": false
          },
          "has_include_payment_option_adjustable_rate_amortization_loans_indicator": {
            "has_value": false
          },
          "has_discount_points_percent": {
            "has_value": 0
          },
          "has_include_balloon_loans_indicator": {
            "has_value": false
          },
          "has_cash_out_amount": {
            "has_value": 0
          },
          "include_loans_with_amortization_term": [
            "01FDTQGB8WJHJC9YT32CQ1ESCC"
          ]
        }
      ],
      "quote_amortization_terms": [
        {
          "@id": "01FDTQGB8WJHJC9YT32CQ1ESCC",
          "@type": "quote_amortization_term",
          "has_amortization_term_months_count": {
            "has_value": 360
          }
        }
      ],
      "properties": [
        {
          "@id": "01FDTQ5PKC4ZFKXBET140VG0BJ",
          "@type": "subject_property",
          "has_property_usage_type": {
            "has_value": "primary_residence"
          },
          "has_number_of_units_type": {
            "has_value": "one"
          },
          "has_project_design_type": {
            "has_value": "midrise_project"
          },
          "has_manufactured_home_indicator": {
            "has_value": false
          },
          "has_planned_unit_development_pud_indicator": {
            "has_value": false
          },
          "has_manufactured_home_width_type": {
            "has_value": "single_wide"
          },
          "has_project_usage_type": {
            "has_value": "string"
          },
          "has_financed_unit_count": {
            "has_value": 1
          },
          "has_non_warrantable_project_indicator": {
            "has_value": false
          },
          "has_stories_count": {
            "has_value": 1
          },
          "has_construction_method_type": {
            "has_value": "site_built"
          },
          "with_address": [
            "01FDTQGB9EV6FKWGZ2CY35971G"
          ],
          "with_sales_contract": [
            "01FDTQGB9EPKV6EJXZMTW0CGV0"
          ],
          "with_value": [
            "01FDTQGB9FVMF9YTFBTX95D2KH"
          ]
        }
      ],
      "projects": [
        {
          "@id": "01FKTQ5PKC2ZFKXBEH170VG0BJ",
          "@type": "project",
          "has_project_legal_structure_type": {
            "has_value": "condominium"
          }
        }
      ],
      "addresses": [
        {
          "@id": "01FDTQGB9EV6FKWGZ2CY35971G",
          "@type": "residential_address",
          "has_address_line_1_text": {
            "has_value": "string"
          },
          "has_county_name": {
            "has_value": "Collin"
          },
          "has_state_code": {
            "has_value": "TX"
          },
          "has_postal_code": {
            "has_value": "75024"
          }
        }
      ],
      "sales_contracts": [
        {
          "@id": "01FDTQGB9EPKV6EJXZMTW0CGV0",
          "@type": "property_sales_contract",
          "has_sales_contract_amount": {
            "has_value": 225000
          }
        }
      ],
      "property_valuations": [
        {
          "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
          "@type": "property_valuation",
          "has_property_valuation_amount": {
            "has_value": 225000
          }
        }
      ]
    }
  }
}
    Parameters
    3
    ParameterTypeExampleDescription
    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 bodyapplication/json
    1 fields
    FieldTypeDescription
    dataobjectThe data that is needed for invocation. It should follow the request schema
    peopleobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_first_namerequiredobject—
    has_valuerequiredstring—
    has_last_namerequiredobject—
    has_valuerequiredstring—
    has_debt_expense_to_income_dti_ratiorequiredobject—
    has_valuerequirednumber—
    employed_asrequiredstring[]—
    with_declarationrequiredstring[]—
    with_credit_informationrequiredstring[]—
    employmentobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_self_employment_indicatorrequiredobject—
    has_valuerequiredboolean—
    declarationsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_citizenship_residency_typerequiredobject—
    has_valuerequiredstringnon_permanent_resident_aliennon_resident_alienpermanent_resident_alienus_citizen
    has_borrower_first_time_homebuyer_indicatorobject—
    has_valuerequiredboolean—
    has_bankruptcy_indicatorobject—
    has_valuerequiredboolean—
    has_age_of_bankruptcy_years_countobject—
    has_valuerequiredinteger—
    has_prior_property_foreclosure_completed_indicatorobject—
    has_valuerequiredboolean—
    has_age_of_prior_property_foreclosure_years_countobject—
    has_valuerequiredinteger—
    credit_score_informationobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_credit_scorerequiredobject—
    has_valuerequiredstring—
    loansrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_relocation_loan_indicatorrequiredobject—
    has_valuerequiredboolean—
    with_borrowerrequiredstring[]—
    with_loan_termsrequiredstring[]—
    with_documentationrequiredstring[]—
    with_summaryrequiredstring[]—
    with_payment_informationrequiredstring[]—
    with_arm_adjustmentrequiredstring[]—
    with_insurancerequiredstring[]—
    with_projectrequiredstring[]—
    serviced_byrequiredstring[]—
    with_buydownrequiredstring[]—
    with_quote_requestrequiredstring[]—
    secured_by_propertyrequiredstring[]—
    has_heloc_indicatorrequiredobject—
    has_valuerequiredboolean—
    loan_termsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_pledged_assets_indicatorobject—
    has_valuerequiredboolean—
    has_mortgage_typerequiredobject—
    has_valuerequiredstringconventionalfhalocal_agencyotherpublic_and_indian_housingstate_agencyusda-rdva
    has_escrow_required_indicatorobject—
    has_valuerequiredboolean—
    has_loan_purpose_typerequiredobject—
    has_valuerequiredstringotherpurchaserefinance
    has_refinance_typerequiredobject—
    has_valuerequiredstringcash_outlimited_cash_outno_cash_out
    has_lien_position_typerequiredobject—
    has_valuerequiredstringfirst_liensecond_liensubordinate_lien
    has_base_loan_amountrequiredobject—
    has_valuerequirednumber—
    has_interest_only_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_prepayment_penalty_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_prepayment_penalty_term_months_countrequiredobject—
    has_valuerequiredinteger—
    has_construction_loan_indicatorobject—
    has_valuerequiredboolean—
    has_buydown_indicatorrequiredobject—
    has_valuerequiredboolean—
    arm_adjustmentsobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_first_rate_adjustment_months_countrequiredobject—
    has_valuerequiredinteger—
    buydownsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_buydown_typerequiredobject—
    has_valuerequiredstringone_oneone_zerothreetwo_one
    insurancerequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_mortgage_insurance_premium_source_typerequiredobject—
    has_valuerequiredstringborrowerlender
    loan_documentationrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_asset_documentation_level_typerequiredobject—
    has_valuerequiredstringneither_stated_nor_verifiednot_requiredstated_and_verifiedstated_only
    has_employment_documentation_level_typerequiredobject—
    has_valuerequiredstringneither_stated_nor_verifiednot_requiredstated_and_verifiedstated_only
    has_income_documentation_level_typerequiredobject—
    has_valuerequiredstringneither_stated_nor_verifiednot_requiredstated_and_verifiedstated_only
    loan_summariesrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_total_debt_expense_to_income_dti_ratiorequiredobject—
    has_valuerequirednumber—
    has_total_monthly_income_amountobject—
    has_valuerequirednumber—
    has_projected_reserves_amountobject—
    has_valuerequirednumber—
    has_representative_credit_scorerequiredobject—
    has_valuerequiredinteger—
    loan_payment_informationobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_number_of_payments_30_days_late_countobject—
    has_valuerequiredinteger—
    has_number_of_payments_60_days_late_countobject—
    has_valuerequiredinteger—
    has_number_of_payments_90_days_late_countobject—
    has_valuerequiredinteger—
    has_number_of_payments_120_days_late_countobject—
    has_valuerequiredinteger—
    has_number_of_payments_rolling_12_months_late_countobject—
    has_valuerequiredinteger—
    organizationsobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_organization_nameobject—
    has_valuerequiredstring—
    quote_requestsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_loan_officer_compensation_typerequiredobject—
    has_valuerequiredstringno_buyer_paidno_lender_paidyes_lender_paid
    has_calculate_borrower_requested_loan_amount_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_include_fixed_rate_amortization_loans_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_include_adjustable_rate_amortization_loans_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_include_payment_option_adjustable_rate_amortization_loans_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_discount_points_percentobject—
    has_valuerequirednumber—
    has_include_balloon_loans_indicatorobject—
    has_valuerequiredboolean—
    has_cash_out_amountobject—
    has_valuerequirednumber—
    include_loans_with_amortization_termstring[]—
    quote_amortization_termsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_amortization_term_months_countrequiredobject—
    has_valuerequiredinteger—
    propertiesrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_property_usage_typerequiredobject—
    has_valuerequiredstringinvestmentotherprimary_residencesecond_home
    has_number_of_units_typerequiredobject—
    has_valuerequiredstringfouronethreetwotwo_to_four
    has_project_design_typerequiredobject—
    has_valuerequiredstringgarden_projecthighrise_projectmidrise_projectothertownhouse_rowhouse
    has_planned_unit_development_pud_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_manufactured_home_indicatorrequiredobject—
    has_valuerequiredboolean—
    has_manufactured_home_width_typerequiredobject—
    has_valuerequiredstring—
    has_project_usage_typerequiredobject—
    has_valuerequiredstring—
    has_stories_countrequiredobject—
    has_valuerequiredinteger—
    has_construction_method_typerequiredobject—
    has_valuerequiredstringmanufacturedmobile_homemodularon_frame_modularothersite_built
    has_financed_unit_countrequiredobject—
    has_valuerequiredinteger—
    has_non_warrantable_project_indicatorrequiredobject—
    has_valuerequiredboolean—
    with_addressrequiredstring[]—
    with_sales_contractrequiredstring[]—
    with_valuerequiredstring[]—
    projectsobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_project_legal_structure_typerequiredobject—
    has_valuerequiredstringcommon_interest_apartmentcondominiumcooperativeunknown
    addressesrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_county_nameobjectRequired if the address is for the subject property
    has_valuerequiredstring—
    has_state_coderequiredobject—
    has_valuerequiredstring—
    has_city_nameobject—
    has_valuerequiredstring—
    has_postal_codeobject—
    has_valuerequiredstring—
    has_address_line_1_textobject—
    has_valuerequiredstring—
    sales_contractsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_sales_contract_amountrequiredobject—
    has_valuerequirednumber—
    property_valuationsrequiredobject[]—
    @idrequiredstring—
    @typerequiredstring—
    has_property_valuation_amountrequiredobject—
    has_valuerequirednumber—
    Response 200application/json
    4 fields

    Collection updated successfully

    FieldTypeDescription
    transaction_idstring (ulid)Transaction ID.Example 01EZQ32PJQGKRA6HR8D72Q9FFF
    collection_idstring (ulid)Collection ID.Example 01EZQ32PJQGKRA6HR8D72Q9FFF
    dataobjectData in Staircase language schema.
    metadataobjectMetadata about collection, f.e version of used Staircase schema.
    Response 400application/json
    1 fields

    Error

    FieldTypeDescription
    messageone ofEither message object with more properties.
    Response 403application/json
    2 fields

    403 invalid error

    FieldTypeDescription
    messagestringError message.
    urlstringError additional URL.
    Response 404application/json
    1 fields

    Resource not found

    FieldTypeDescription
    messagestringMessage
    Response 500application/json
    1 fields

    Internal server error

    FieldTypeDescription
    messagestringError message.
    Other responses

    405

    Operations

    POST /pricing

    Create Pricing

    post-pricing

    Create Pricing creates views of scenario-specific pricing, best pricing alternatives, and side-by-side price comparisons from various products and partners.

    Request
    application/json 
    {
  "transaction_id": "uhz6t54e-9d74-g17e-99ca-a36b30vdfd35",
  "collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
  "partner_name": "PartnerName"
}
    Response
    application/json

    Pricing 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
    1
    ParameterTypeExampleDescription
    x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
    Request bodyapplication/json
    3 fields
    FieldTypeDescription
    transaction_idrequiredstringTransaction ID
    collection_idrequiredstringCollection ID
    partner_namerequiredstring—
    Response 200application/json
    2 fields

    Pricing request created successfully.

    FieldTypeDescription
    collection_idstringCollection ID
    messagestringMessage

    Providers

    Errors

    400403404405422500

    Type to search.