Skip to content
Staircase

Government

One request that reaches both government-sponsored underwriting engines, with one canonical response and one error vocabulary.

A caller sends a loan file once. The product fans it out to Fannie Mae's Desktop Underwriter and Freddie Mac's Loan Product Advisor, and returns a canonical underwriting response — recommendation, eligibility, and the findings behind it.

The catalogue records twelve separate product APIs behind it, one per combination of purpose, agency programme and amortisation type: purchase and refinance, across conventional, FHA and VA, each fixed and adjustable.

How it works

The two agencies model the same loan differently, and the gap is measured rather than estimated: 378 elements on one side, 437 on the other, 258 in common. Everything outside that intersection is why a single canonical request needs a real translation layer rather than a field-rename table.

Validation rules are generated from the two agencies' own schemas rather than written by hand, and enumerations are taken as the intersection of both — so a value the canonical request accepts is a value both engines accept. Generating the rules is what keeps them correct when either agency revises its schema.

Errors are unified twice. Two agency error codes meaning the same thing are mapped to one code, and that code is then rendered against the caller's own field paths. A caller working in its own dialect receives a validation error naming its own fields, with no work on its side.

Findings come back as numbered messages. A separate service turns them into plain language and answers questions against them, which is the difference between handing an underwriter a list of codes and handing them a readable account of what the engine decided.

Operations

Verify

POST /products/eligibility-verify/invocations

Invoke Verification Flow

InvokeVerifyProductFlow

Invoke Product Flow

Starts a background job that validates the IDs retrieved from Third Party Service verification services, through GSEs.

Usage

Sending the Request

You can send a request in two different ways:

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

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

Show the rest

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

Request
application/json 
{
  "vendor_name": "freddiemac",
  "transaction_id": "01F6NAMXWN2XVBD1YJ92A6S6R4",
  "request_collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN"
}
Response
application/json

Successfully started flow invocation.

{
  "product_flow_name": "freddiemac",
  "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.
Response 201application/json
7 fields

Successfully started flow invocation.

FieldTypeDescription
invocation_idstringInvocation ID.
invocation_statusstringThe status of the invocation.STARTED
transaction_idstringTransaction ID.
product_flow_namestringProduct flow name.freddiemac
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/eligibility-verify/invocations/{invocation_id}

Retrieve Invocation Status

RetrieveVerifyFlowInvocationStatus

Retrieve status of the Invocation

Retrieves the status of running flow invocation.

Response
application/json

Successfully returned status of the 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": "freddiemac",
  "request_collection": {
    "metadata": {
      "created_at": "2021-09-14T03:08:00.284090-04:00",
      "validation": false
    },
    "transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
    "collection_id": "01FFHJ4JCWGHV38SC1NJ8TVNFY",
    "data": {
      "people": [
        {
          "@id": "8a0a2eef-cdbd-49cb-bc89-79817644d2cd",
          "has_first_name": {
            "has_value": "John"
          },
          "has_last_name": {
            "has_value": "Freddie"
          },
          "has_taxpayer_identifier_value": {
            "has_value": "666991238"
          },
          "@type": "borrower",
          "has_taxpayer_identifier_type": {
            "has_value": "social_security_number"
          },
          "owns_asset": [
            "01FYK7W3S8E6FEEHRRX4Y7E3AG",
            "01FYK7W3S8VTGDVZWWJT1QXDXC",
            "01FYK7W3S8D0NP0BQJEHBB5SZF"
          ],
          "contact_at": [
            "01FYK7W3SSFGZPVVERRTB1KQWH"
          ],
          "with_declaration": [
            "01FYK7W3SWEMY9JDBDX5HWXXK9"
          ],
          "employed_as": [
            "01FYK7W3SX2AN44NF1BMGSWHFR",
            "01FYK7W3T0RJC5EHSKXYZXYYJZ"
          ],
          "earns": [
            "01FYK7W3TBQ00RZ0N4E849YQYM"
          ],
          "works_for": [
            "01FYK7W3TD1ZX6HG4FRXNJHT5Y"
          ],
          "lives_at": [
            "01FYK7W3TXTZBQADRXRQF8JHHF"
          ]
        }
      ],
      "assets": [
        {
          "has_asset_cash_or_market_value_amount": {
            "has_value": 57844
          },
          "has_asset_type": {
            "has_value": " savings_account"
          },
          "@id": "01FYK7W3S8E6FEEHRRX4Y7E3AG",
          "@type": " savings_account"
        },
        {
          "has_asset_cash_or_market_value_amount": {
            "has_value": 5000
          },
          "has_asset_type": {
            "has_value": " gifts_total"
          },
          "@id": "01FYK7W3S8VTGDVZWWJT1QXDXC",
          "@type": " gifts_total"
        },
        {
          "has_asset_cash_or_market_value_amount": {
            "has_value": 15000
          },
          "has_asset_type": {
            "has_value": "checking_account"
          },
          "@id": "01FYK7W3S8D0NP0BQJEHBB5SZF",
          "@type": "checking_account"
        }
      ],
      "contact_information": [
        {
          "has_email_address": {
            "has_value": "happy.traveler998@gmail.com"
          },
          "has_phone_number": {
            "has_value": "999-00-0000"
          },
          "@id": "01FYK7W3SSFGZPVVERRTB1KQWH",
          "@type": "contact_information"
        }
      ],
      "employment": [
        {
          "has_self_employment_indicator": {
            "has_value": false
          },
          "has_current_employment_indicator": {
            "has_value": true
          },
          "has_employment_monthly_income_amount": {
            "has_value": 2100
          },
          "@id": "01FYK7W3SX2AN44NF1BMGSWHFR",
          "@type": "employment",
          "has_employment_start_date": {
            "has_value": "2021-01-01"
          }
        },
        {
          "@id": "01FYK7W3T0RJC5EHSKXYZXYYJZ",
          "@type": "employment",
          "has_employment_start_date": {
            "has_value": "2019-09-09"
          },
          "has_employment_end_date": {
            "has_value": "2020-12-31"
          }
        }
      ],
      "income": [
        {
          "@id": "01FYK7W3TBQ00RZ0N4E849YQYM",
          "@type": "rental_income",
          "has_income_amount": {
            "has_value": 300
          }
        }
      ],
      "organizations": [
        {
          "has_organization_name": {
            "has_value": "Freddiemac"
          },
          "@id": "01FYK7W3TD1ZX6HG4FRXNJHT5Y",
          "@type": "organization"
        }
      ],
      "addresses": [
        {
          "has_address_line_1_text": {
            "has_value": "455001 Nowhere Dr"
          },
          "has_city_name": {
            "has_value": "McLean"
          },
          "has_postal_code": {
            "has_value": 22101
          },
          "has_state_code": {
            "has_value": "VA"
          },
          "@id": "01FYK7W3TZY2BEM7J25QYX37ER",
          "@type": "residential_address"
        }
      ],
      "services": [
        {
          "has_service_identifier": {
            "has_value": "dyjwvzd8wtuj"
          },
          "@id": "01FYK7W3V14AP5VG66TEKWV4HB",
          "@type": "service",
          "has_service_type": {
            "has_value": "verification_of_deposit"
          },
          "has_service_vendor_type": {
            "has_value": "finicity"
          }
        }
      ],
      "residences": [
        {
          "@id": "01FYK7W3TXTZBQADRXRQF8JHHF",
          "@type": "residence",
          "with_address": [
            "01FYK7W3TZY2BEM7J25QYX37ER"
          ]
        }
      ]
    }
  },
  "response_collection": {
    "metadata": {
      "created_at": "2021-09-14T03:36:45.193268-04:00",
      "validation": false
    },
    "transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
    "collection_id": "01FFHKS6W9J0JDTGTQJB9Y2RWB",
    "data": {
      "people": [
        {
          "@id": "01FYP4AE63K5AR49Y2FAHRPWT1",
          "@type": "borrower",
          "has_full_name": {
            "has_value": "John Freddie"
          },
          "employed_as": [
            "01FYP4AE6MVWHEB00W6DDWPGJ5"
          ],
          "owns_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        }
      ],
      "employment": [
        {
          "@id": "01FYP4AE6MVWHEB00W6DDWPGJ5",
          "@type": "employment",
          "has_current_employment_indicator": {
            "has_value": true
          },
          "earns": [
            "01FYP4AE8FQB73EZSR4AZEHYYD",
            "01FYP4AE8F28WM69QEG8MAH4ZB"
          ],
          "provided_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ]
        }
      ],
      "organizations": [
        {
          "@id": "01FYP4AE8J8ZZ35A1Y7ESGV336",
          "@type": "organization",
          "has_organization_name": {
            "has_value": "Freddiemac"
          }
        }
      ],
      "income": [
        {
          "@type": "employment_income",
          "@id": "01FYP4AE8FQB73EZSR4AZEHYYD",
          "has_income_pay_frequency_type": {
            "has_value": "monthly"
          },
          "has_income_amount": {
            "has_value": 2100
          }
        },
        {
          "@type": "other_income",
          "@id": "01FYP4AE8F28WM69QEG8MAH4ZB",
          "has_income_pay_frequency_type": {
            "has_value": "monthly"
          },
          "has_income_amount": {
            "has_value": 551.2
          }
        }
      ],
      "foreign_objects": [
        {
          "@id": "01FYP4AE9Q4AE9J9X8HAMPGVFS",
          "has_mime_type_identifier": {
            "has_value": "application/pdf"
          },
          "has_staircase_blob_id": {
            "has_value": "01FYP2F8QHRNXXSQCPXCKCVVV7"
          },
          "@type": "foreign_object"
        }
      ],
      "assets": [
        {
          "@id": "01FYP4AE7BZDH4WPY3CGSNP8CF",
          "@type": "asset",
          "has_asset_account_identifier": {
            "has_value": "9073"
          },
          "has_asset_type": {
            "has_value": "checking"
          },
          "has_asset_cash_or_market_value_amount": {
            "has_value": 40000
          },
          "has_asset_net_value_amount": {
            "has_value": 31665.16
          },
          "with_transaction": [
            "01FYP4AEB1APQC7PGJX8AC78P8",
            "01FYP4AEB1Q5JV6AJ8Q1SAYNDJ",
            "01FYP4AEB1E6ZPRRZPSJRR1YBR",
            "01FYP4AEB1ANKFVWGG8PX48MHR",
            "01FYP4AEB1Q3J9WQYB8F682RXN",
            "01FYP4AEB1JQX3CQE73TBHGDTF",
            "01FYP4AEB1PPQHXJMVYTFB3PK4",
            "01FYP4AEB18T7V4X5B19G99S76",
            "01FYP4AEB1QDMCJWMNBKDTSR4T",
            "01FYP4AEB1JSS22WWTYSHA4X2R",
            "01FYP4AEB1RG40NSXG12VWN19F",
            "01FYP4AEB1XVZ321FR8YXG0WJ5",
            "01FYP4AEB18559TM7NPA8QQD8Q",
            "01FYP4AEB1EZTJ4QM321XDNP0S",
            "01FYP4AEB1Z5WZ0PE02K2NFCXA",
            "01FYP4AEB1FN6FSNJF08AY1FJX",
            "01FYP4AEB2Z3442ZN9XA40TFN4",
            "01FYP4AEB2NDRXKYTZW5VZDXTA",
            "01FYP4AEB2GQW4MPFZA1S1RKWW",
            "01FYP4AEB2KSQJVDC5X6KVFCR2",
            "01FYP4AEB2WY4J3CFW4WXPJFNM",
            "01FYP4AEB2FWCT92ZTVDS5T1VZ",
            "01FYP4AEB267YNTZGD5K74KETG",
            "01FYP4AEB271H0AZBQH75J87MA"
          ]
        }
      ],
      "asset_transaction": [
        {
          "@id": "01FYP4AEB1APQC7PGJX8AC78P8",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2022-01-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1Q5JV6AJ8Q1SAYNDJ",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 7500.98
          },
          "has_transaction_date": {
            "has_value": "2021-12-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1E6ZPRRZPSJRR1YBR",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2021-11-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1ANKFVWGG8PX48MHR",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2021-10-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1Q3J9WQYB8F682RXN",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2021-09-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1JQX3CQE73TBHGDTF",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2021-08-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1PPQHXJMVYTFB3PK4",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2021-07-13"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB18T7V4X5B19G99S76",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 9500.98
          },
          "has_transaction_date": {
            "has_value": "2021-06-16"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1QDMCJWMNBKDTSR4T",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2021-05-12"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1JSS22WWTYSHA4X2R",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2021-04-12"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1RG40NSXG12VWN19F",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2021-03-12"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1XVZ321FR8YXG0WJ5",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2021-02-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB18559TM7NPA8QQD8Q",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2021-01-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1EZTJ4QM321XDNP0S",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 8000.98
          },
          "has_transaction_date": {
            "has_value": "2020-12-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1Z5WZ0PE02K2NFCXA",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2020-11-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB1FN6FSNJF08AY1FJX",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2020-10-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB2Z3442ZN9XA40TFN4",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2020-09-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB2NDRXKYTZW5VZDXTA",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2020-08-10"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB2GQW4MPFZA1S1RKWW",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2020-07-13"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB2KSQJVDC5X6KVFCR2",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 10000.98
          },
          "has_transaction_date": {
            "has_value": "2020-06-12"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB2WY4J3CFW4WXPJFNM",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2020-05-12"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB2FWCT92ZTVDS5T1VZ",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2020-04-12"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB267YNTZGD5K74KETG",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2020-03-12"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        },
        {
          "@id": "01FYP4AEB271H0AZBQH75J87MA",
          "@type": "asset_transaction",
          "with_transaction_paid_by": [
            "01FYP4AE8J8ZZ35A1Y7ESGV336"
          ],
          "with_financial_institution": [
            "01FYP4AEE4F3TEHWDGWXTYCQW6"
          ],
          "has_income_source_identified_indicator": {
            "has_value": true
          },
          "has_transaction_description": {
            "has_value": "JOHN FREDDIE PAYROLL"
          },
          "has_transaction_amount": {
            "has_value": 5833.86
          },
          "has_transaction_date": {
            "has_value": "2020-02-11"
          },
          "with_asset": [
            "01FYP4AE7BZDH4WPY3CGSNP8CF"
          ]
        }
      ],
      "services": [
        {
          "@type": "service",
          "@id": "01FYP4AEMKJ8N1DCT3CD2ZTV63",
          "with_foreign_objects": [
            "01FYP4AE9Q4AE9J9X8HAMPGVFS"
          ],
          "has_service_name": {
            "has_value": "AIM Check"
          },
          "has_vendor_name": {
            "has_value": "FreddieMac"
          },
          "with_error": [
            "01FYP4AEN87TR9396Y45436Y5X"
          ]
        }
      ],
      "error_messages": [
        {
          "@id": "01FYP4AEMZSB3NWP1X1YYJ0R6P",
          "@type": "error_message",
          "has_error_message_code": {
            "has_value": "AIM811"
          },
          "has_error_message_text": {
            "has_value": "Missing Employment Status for Employment EMPLOYER_1. AIM Check API has defaulted Employment Status to current."
          }
        }
      ],
      "error_message_information": [
        {
          "@type": "error_message_information",
          "with_error_message": [
            "01FYP4AEMZSB3NWP1X1YYJ0R6P"
          ],
          "@id": "01FYP4AEN6R0C2QTNBMPPXFX47"
        }
      ],
      "errors": [
        {
          "@type": "error",
          "with_error_message_information": [
            "01FYP4AEN6R0C2QTNBMPPXFX47"
          ],
          "@id": "01FYP4AEN87TR9396Y45436Y5X"
        }
      ]
    }
  }
}
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 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—
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/eligibility-verify/request-schema

Retrieve Request Schema

retrieveRequestSchema

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

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

Response
application/json

Request schema (possibly with examples) is successfully returned.

{
  "schema": {
    "type": "object",
    "required": [
      "people",
      "residences",
      "addresses",
      "services",
      "employment",
      "organizations"
    ],
    "properties": {
      "people": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_first_name",
            "has_last_name",
            "lives_at",
            "employed_as",
            "works_for"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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_taxpayer_identifier_value": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_taxpayer_identifier_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "owns_asset": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "contact_at": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_declaration": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "employed_as": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "earns": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "works_for": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "lives_at": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "residences": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "with_address": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "addresses": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_address_line_1_text",
            "has_city_name",
            "has_postal_code",
            "has_state_code"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_address_line_1_text": {
              "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": "integer"
                }
              }
            },
            "has_state_code": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "services": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_service_identifier",
            "has_service_type",
            "has_service_vendor_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_service_identifier": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_service_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_service_vendor_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "assets": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_asset_cash_or_market_value_amount",
            "has_asset_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_asset_cash_or_market_value_amount": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "has_asset_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "contact_information": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_email_address": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_phone_number": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "employment": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_self_employment_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_current_employment_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_employment_monthly_income_amount": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            },
            "has_employment_start_date": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            },
            "has_employment_end_date": {
              "type": "object",
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "income": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_income_amount"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_income_amount": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            }
          }
        }
      },
      "organizations": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_organization_name"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_organization_name": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "description": "The data that is needed for invocation. It should follow the request 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

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/eligibility-verify/response-schema

Retrieve Response Schema

retrieveResponseSchema

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

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

Response
application/json

Response schema (possibly with examples) is successfully returned.

{
  "schema": {
    "type": "object"
  }
}
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.

Eligibility

POST /products/loan-eligibility/invocations

Invoke Eligibility Flow

InvokeSpecificProductFlow

This endpoint retrieves a person's eligibility for a mortgage

Request
application/json 
{
  "vendor_name": "optimalBlue",
  "transaction_id": "01F6NAMXWN2XVBD1YJ92A6S6R4",
  "request_collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN"
}
Response
application/json

Successfully started flow invocation.

{
  "product_flow_name": "OptimalBlue-Eligibility",
  "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.
Response 201application/json
7 fields

Successfully started flow invocation.

FieldTypeDescription
invocation_idstringInvocation ID.
invocation_statusstringThe status of the invocation.STARTED
transaction_idstringTransaction ID.
product_flow_namestringProduct flow name.OptimalBlue-Eligibility
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/loan-eligibility/invocations/{invocation_id}

Retrieve Invocation Status

RetrieveProductFlowInvocationStatus

Retrieve status of Eligibility Flow Invocation

Retrieves the status of running Eligibility flow invocation.

Response
application/json

Successfully returned status of the Eligibility 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-Eligibility",
  "request_collection": {
    "metadata": {
      "created_at": "2021-09-14T03:08:00.284090-04:00",
      "validation": false
    },
    "transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
    "collection_id": "01FFHJ4JCWGHV38SC1NJ8TVNFY",
    "data": {
      "people": [
        {
          "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
          "@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_declarations": [
            "01FDTQ5PH0KQ21KE0DR3FV16SW"
          ],
          "with_credit_risk": [
            "01FDTQ5PH1J05ESN8F3M8X03MD"
          ]
        }
      ],
      "employment": [
        {
          "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
          "@type": "employment",
          "has_self_employment_indicator": {
            "has_value": true
          }
        }
      ],
      "declarations": [
        {
          "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
          "@type": "declarations",
          "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_mortgage_type": {
            "has_value": "conventional"
          },
          "has_relocation_loan_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_automated_underwriting": [
            "01FDTQ5PJYAP2V6RT2ZJND1KC4"
          ],
          "with_insurance": [
            "01FDTQ5PJYNRA67MQEVTBZCRZ7"
          ],
          "serviced_by": [
            "01FDTQ5PKA5DVQ7F39HZK84H2R"
          ],
          "with_buydown": [
            "01FDTQ5PKBF5JHM46TQQEE3SAE"
          ],
          "with_quote_request": [
            "01FDTQ5PKBHV90N3GJ0PEK9TWD"
          ],
          "secured_by_property": [
            "01FDTQ5PKC4ZFKXBET140VG0BJ"
          ]
        }
      ],
      "loan_terms": [
        {
          "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
          "@type": "loan_term",
          "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_note_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
          }
        }
      ],
      "automated_underwriting": [
        {
          "@id": "01FDTQ5PJYAP2V6RT2ZJND1KC4",
          "@type": "NotSpecified",
          "has_desktop_underwriter_recommendation_type": {
            "has_value": "out_of_scope"
          }
        }
      ],
      "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_type": {
            "has_value": "condominium"
          },
          "has_project_design_type": {
            "has_value": "midrise"
          },
          "has_manufactured_home_indicator": {
            "has_value": false
          },
          "has_planned_unit_development_pud_indicator": {
            "has_value": false
          },
          "has_manufactured_home_width_type": {
            "has_value": "string"
          },
          "has_project_usage_type": {
            "has_value": "string"
          },
          "has_stories_count": {
            "has_value": 1
          },
          "with_address": [
            "01FDTQGB9EV6FKWGZ2CY35971G"
          ],
          "with_sales_contract": [
            "01FDTQGB9EPKV6EJXZMTW0CGV0"
          ],
          "with_value": [
            "01FDTQGB9FVMF9YTFBTX95D2KH"
          ]
        }
      ],
      "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": "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": {
      "automated_underwriting": {
        "automated_underwriting_system_result_value": {
          "has_value": "approve_eligible"
        }
      }
    }
  }
}
Parameters
2
ParameterTypeExampleDescription
x-api-key required string header — Environment API Key.
invocation_id required string (ulid) path 01F0KHKADN0HRFXMCQQXPA6AFZ Eligibility flow invocation identifier
Response 200application/json
9 fields

Successfully returned status of the Eligibility 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—
automated_underwritingrequiredobject—
automated_underwriting_system_result_valueobject—
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/loan-eligibility/request-schema

Retrieve Request Schema

retrieveRequestSchema

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

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

Response
application/json

Request schema (possibly with examples) is successfully returned.

{
  "schema": {
    "type": "object",
    "properties": {
      "people": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@type",
            "@id",
            "has_first_name",
            "has_last_name",
            "has_debt_expense_to_income_dti_ratio"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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"
                }
              }
            },
            "employed_as": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_declarations": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_credit_risk": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "employment": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_self_employment_indicator"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_self_employment_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "declarations": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_citizenship_residency_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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_bankruptcy_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_prior_property_foreclosure_completed_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_age_of_prior_property_foreclosure_years_count": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            }
          }
        }
      },
      "credit_score_information": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_credit_score"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_credit_score": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "loans": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_mortgage_type",
            "has_relocation_loan_indicator",
            "with_borrower",
            "with_loan_terms",
            "with_documentation",
            "with_summary",
            "with_payment_information",
            "with_arm_adjustment",
            "with_automated_underwriting",
            "with_insurance",
            "serviced_by",
            "with_buydown",
            "with_quote_request",
            "secured_by_property"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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"
                }
              }
            },
            "with_borrower": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_loan_terms": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_documentation": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_summary": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_payment_information": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_arm_adjustment": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_automated_underwriting": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_insurance": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "serviced_by": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_buydown": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_quote_request": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "secured_by_property": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "loan_terms": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@type",
            "@id",
            "has_loan_purpose_type",
            "has_refinance_type",
            "has_lien_position_type",
            "has_note_amount",
            "has_interest_only_indicator",
            "has_prepayment_penalty_indicator",
            "has_prepayment_penalty_term_months_count",
            "has_buydown_indicator"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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_note_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"
                }
              }
            }
          }
        }
      },
      "arm_adjustments": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_first_rate_adjustment_months_count"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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": [
            "@id",
            "@type",
            "has_desktop_underwriter_recommendation_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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"
                  ]
                }
              }
            }
          }
        }
      },
      "buydowns": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_buydown_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_buydown_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "one_one",
                    "one_zero",
                    "three",
                    "two_one"
                  ]
                }
              }
            }
          }
        }
      },
      "insurance": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_mortgage_insurance_premium_source_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_mortgage_insurance_premium_source_type": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string",
                  "enum": [
                    "borrower",
                    "lender"
                  ]
                }
              }
            }
          }
        }
      },
      "loan_documentation": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_asset_documentation_level_type",
            "has_employment_documentation_level_type",
            "has_income_documentation_level_type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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": [
            "@id",
            "@type",
            "has_total_debt_expense_to_income_dti_ratio",
            "has_representative_credit_score"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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"
                }
              }
            }
          }
        }
      },
      "loan_payment_information": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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"
                }
              }
            }
          }
        }
      },
      "organizations": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_organization_name": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "quote_requests": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "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": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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_discount_points_percent": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "has_include_balloon_loans_indicator": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "boolean"
                }
              }
            },
            "has_cash_out_amount": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            },
            "include_loans_with_amortization_term": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "quote_amortization_terms": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_amortization_term_months_count"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_amortization_term_months_count": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "integer"
                }
              }
            }
          }
        }
      },
      "properties": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "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",
            "with_address",
            "with_sales_contract",
            "with_value"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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"
                }
              }
            },
            "with_address": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_sales_contract": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "with_value": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "addresses": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_county_name",
            "has_state_code"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "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"
                }
              }
            }
          }
        }
      },
      "sales_contracts": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_sales_contract_amount"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_sales_contract_amount": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            }
          }
        }
      },
      "property_valuations": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "@id",
            "@type",
            "has_property_valuation_amount"
          ],
          "properties": {
            "@id": {
              "type": "string"
            },
            "@type": {
              "type": "string"
            },
            "has_property_valuation_amount": {
              "type": "object",
              "required": [
                "has_value"
              ],
              "properties": {
                "has_value": {
                  "type": "number"
                }
              }
            }
          }
        }
      }
    },
    "required": [
      "addresses",
      "loan_terms",
      "loans",
      "properties",
      "loan_documentation",
      "loan_summaries",
      "declarations",
      "quote_requests",
      "automated_underwriting",
      "insurance",
      "quote_amortization_terms",
      "sales_contracts",
      "property_valuations",
      "buydowns"
    ],
    "description": "The data that is needed for invocation. It should follow the request 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

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/loan-eligibility/response-schema

Retrieve Response Schema

retrieveResponseSchema

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

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

Response
application/json

Response schema (possibly with examples) is successfully returned.

{
  "schema": {
    "type": "object",
    "properties": {
      "automated_underwriting": {
        "type": "object",
        "properties": {
          "automated_underwriting_system_result_value": {
            "type": "object",
            "required": [
              "has_value"
            ],
            "properties": {
              "has_value": {
                "type": "string",
                "enum": [
                  "approve_eligible",
                  "approve_ineligible"
                ]
              }
            }
          }
        }
      }
    },
    "required": [
      "automated_underwriting"
    ]
  }
}
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.

Workflow

POST /transactions

Create Transaction

post-decision-transaction

Create Transaction creates a transaction in Staircase. A transaction is supposed to hold all data containers (collections) related to a given mortgage loan. You will be billed on the basis of transaction_ids, so it is important to associate each loan on your end with a transaction_id on our end.

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.

Response
application/json

Transaction created successfully

{
  "transaction_id": "6b19feeb-7433-448e-b285-b758d19a4fe6"
}
Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Environment API Key.
Response 201application/json
1 fields

Transaction created successfully

FieldTypeDescription
transaction_idstringNew transaction identifier
Response 400application/json
1 fields

Transaction creation unsuccessful

FieldTypeDescription
messagestring—
Response 403application/json
2 fields

Invalid key for service

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

The user has sent too many requests in a given amount of time ("rate limiting")

FieldTypeDescription
messagestringMessage
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/{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/loan-eligibility/invocations

Request
application/json 
{
  "data": {
    "people": [
      {
        "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
        "@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_declarations": [
          "01FDTQ5PH0KQ21KE0DR3FV16SW"
        ],
        "with_credit_risk": [
          "01FDTQ5PH1J05ESN8F3M8X03MD"
        ]
      }
    ],
    "employment": [
      {
        "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
        "@type": "employment",
        "has_self_employment_indicator": {
          "has_value": true
        }
      }
    ],
    "declarations": [
      {
        "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
        "@type": "declarations",
        "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_mortgage_type": {
          "has_value": "conventional"
        },
        "has_relocation_loan_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_automated_underwriting": [
          "01FDTQ5PJYAP2V6RT2ZJND1KC4"
        ],
        "with_insurance": [
          "01FDTQ5PJYNRA67MQEVTBZCRZ7"
        ],
        "serviced_by": [
          "01FDTQ5PKA5DVQ7F39HZK84H2R"
        ],
        "with_buydown": [
          "01FDTQ5PKBF5JHM46TQQEE3SAE"
        ],
        "with_quote_request": [
          "01FDTQ5PKBHV90N3GJ0PEK9TWD"
        ],
        "secured_by_property": [
          "01FDTQ5PKC4ZFKXBET140VG0BJ"
        ]
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "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_note_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
        }
      }
    ],
    "automated_underwriting": [
      {
        "@id": "01FDTQ5PJYAP2V6RT2ZJND1KC4",
        "@type": "NotSpecified",
        "has_desktop_underwriter_recommendation_type": {
          "has_value": "out_of_scope"
        }
      }
    ],
    "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_type": {
          "has_value": "condominium"
        },
        "has_project_design_type": {
          "has_value": "midrise"
        },
        "has_manufactured_home_indicator": {
          "has_value": false
        },
        "has_planned_unit_development_pud_indicator": {
          "has_value": false
        },
        "has_manufactured_home_width_type": {
          "has_value": "string"
        },
        "has_project_usage_type": {
          "has_value": "string"
        },
        "has_stories_count": {
          "has_value": 1
        },
        "with_address": [
          "01FDTQGB9EV6FKWGZ2CY35971G"
        ],
        "with_sales_contract": [
          "01FDTQGB9EPKV6EJXZMTW0CGV0"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ]
      }
    ],
    "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": "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": {
    "people": [
      {
        "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
        "@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_declarations": [
          "01FDTQ5PH0KQ21KE0DR3FV16SW"
        ],
        "with_credit_risk": [
          "01FDTQ5PH1J05ESN8F3M8X03MD"
        ]
      }
    ],
    "employment": [
      {
        "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
        "@type": "employment",
        "has_self_employment_indicator": {
          "has_value": true
        }
      }
    ],
    "declarations": [
      {
        "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
        "@type": "declarations",
        "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_mortgage_type": {
          "has_value": "conventional"
        },
        "has_relocation_loan_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_automated_underwriting": [
          "01FDTQ5PJYAP2V6RT2ZJND1KC4"
        ],
        "with_insurance": [
          "01FDTQ5PJYNRA67MQEVTBZCRZ7"
        ],
        "serviced_by": [
          "01FDTQ5PKA5DVQ7F39HZK84H2R"
        ],
        "with_buydown": [
          "01FDTQ5PKBF5JHM46TQQEE3SAE"
        ],
        "with_quote_request": [
          "01FDTQ5PKBHV90N3GJ0PEK9TWD"
        ],
        "secured_by_property": [
          "01FDTQ5PKC4ZFKXBET140VG0BJ"
        ]
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "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_note_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
        }
      }
    ],
    "automated_underwriting": [
      {
        "@id": "01FDTQ5PJYAP2V6RT2ZJND1KC4",
        "@type": "NotSpecified",
        "has_desktop_underwriter_recommendation_type": {
          "has_value": "out_of_scope"
        }
      }
    ],
    "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_type": {
          "has_value": "condominium"
        },
        "has_project_design_type": {
          "has_value": "midrise"
        },
        "has_manufactured_home_indicator": {
          "has_value": false
        },
        "has_planned_unit_development_pud_indicator": {
          "has_value": false
        },
        "has_manufactured_home_width_type": {
          "has_value": "string"
        },
        "has_project_usage_type": {
          "has_value": "string"
        },
        "has_stories_count": {
          "has_value": 1
        },
        "with_address": [
          "01FDTQGB9EV6FKWGZ2CY35971G"
        ],
        "with_sales_contract": [
          "01FDTQGB9EPKV6EJXZMTW0CGV0"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ]
      }
    ],
    "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": "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_asstring[]—
with_declarationsstring[]—
with_credit_riskstring[]—
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_mortgage_typerequiredobject—
has_valuerequiredstringconventionalfhalocal_agencyotherpublic_and_indian_housingstate_agencyusda-rdva
has_relocation_loan_indicatorrequiredobject—
has_valuerequiredboolean—
with_borrowerrequiredstring[]—
with_loan_termsrequiredstring[]—
with_documentationrequiredstring[]—
with_summaryrequiredstring[]—
with_payment_informationrequiredstring[]—
with_arm_adjustmentrequiredstring[]—
with_automated_underwritingrequiredstring[]—
with_insurancerequiredstring[]—
serviced_byrequiredstring[]—
with_buydownrequiredstring[]—
with_quote_requestrequiredstring[]—
secured_by_propertyrequiredstring[]—
loan_termsrequiredobject[]—
@idrequiredstring—
@typerequiredstring—
has_pledged_assets_indicatorobject—
has_valuerequiredboolean—
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_note_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—
automated_underwritingrequiredobject[]—
@idrequiredstring—
@typerequiredstring—
has_desktop_underwriter_recommendation_typerequiredobject—
has_valuerequiredstringapprove_eligibleapprove_ineligibleerrorexpanded_approval_1_eligibleexpanded_approval_1_ineligibleexpanded_approval_2_eligibleexpanded_approval_2_ineligibleexpanded_approval_3_eligibleexpanded_approval_3_ineligibleout_of_scoperefer_eligiblerefer_ineligiblerefer_with_cautionunknown
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_typerequiredobject—
has_valuerequiredstringcommon_interest_apartmentcondominiumcooperativeother
has_project_design_typerequiredobject—
has_valuerequiredstringhighrisemidrisetownhouse
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—
with_addressrequiredstring[]—
with_sales_contractrequiredstring[]—
with_valuerequiredstring[]—
addressesrequiredobject[]—
@idrequiredstring—
@typerequiredstring—
has_county_namerequiredobject—
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": {
    "people": [
      {
        "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
        "@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_declarations": [
          "01FDTQ5PH0KQ21KE0DR3FV16SW"
        ],
        "with_credit_risk": [
          "01FDTQ5PH1J05ESN8F3M8X03MD"
        ]
      }
    ],
    "employment": [
      {
        "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
        "@type": "employment",
        "has_self_employment_indicator": {
          "has_value": true
        }
      }
    ],
    "declarations": [
      {
        "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
        "@type": "declarations",
        "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_mortgage_type": {
          "has_value": "conventional"
        },
        "has_relocation_loan_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_automated_underwriting": [
          "01FDTQ5PJYAP2V6RT2ZJND1KC4"
        ],
        "with_insurance": [
          "01FDTQ5PJYNRA67MQEVTBZCRZ7"
        ],
        "serviced_by": [
          "01FDTQ5PKA5DVQ7F39HZK84H2R"
        ],
        "with_buydown": [
          "01FDTQ5PKBF5JHM46TQQEE3SAE"
        ],
        "with_quote_request": [
          "01FDTQ5PKBHV90N3GJ0PEK9TWD"
        ],
        "secured_by_property": [
          "01FDTQ5PKC4ZFKXBET140VG0BJ"
        ]
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "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_note_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
        }
      }
    ],
    "automated_underwriting": [
      {
        "@id": "01FDTQ5PJYAP2V6RT2ZJND1KC4",
        "@type": "NotSpecified",
        "has_desktop_underwriter_recommendation_type": {
          "has_value": "out_of_scope"
        }
      }
    ],
    "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_type": {
          "has_value": "condominium"
        },
        "has_project_design_type": {
          "has_value": "midrise"
        },
        "has_manufactured_home_indicator": {
          "has_value": false
        },
        "has_planned_unit_development_pud_indicator": {
          "has_value": false
        },
        "has_manufactured_home_width_type": {
          "has_value": "string"
        },
        "has_project_usage_type": {
          "has_value": "string"
        },
        "has_stories_count": {
          "has_value": 1
        },
        "with_address": [
          "01FDTQGB9EV6FKWGZ2CY35971G"
        ],
        "with_sales_contract": [
          "01FDTQGB9EPKV6EJXZMTW0CGV0"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ]
      }
    ],
    "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": "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": {
    "people": [
      {
        "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
        "@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_declarations": [
          "01FDTQ5PH0KQ21KE0DR3FV16SW"
        ],
        "with_credit_risk": [
          "01FDTQ5PH1J05ESN8F3M8X03MD"
        ]
      }
    ],
    "employment": [
      {
        "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
        "@type": "employment",
        "has_self_employment_indicator": {
          "has_value": true
        }
      }
    ],
    "declarations": [
      {
        "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
        "@type": "declarations",
        "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_mortgage_type": {
          "has_value": "conventional"
        },
        "has_relocation_loan_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_automated_underwriting": [
          "01FDTQ5PJYAP2V6RT2ZJND1KC4"
        ],
        "with_insurance": [
          "01FDTQ5PJYNRA67MQEVTBZCRZ7"
        ],
        "serviced_by": [
          "01FDTQ5PKA5DVQ7F39HZK84H2R"
        ],
        "with_buydown": [
          "01FDTQ5PKBF5JHM46TQQEE3SAE"
        ],
        "with_quote_request": [
          "01FDTQ5PKBHV90N3GJ0PEK9TWD"
        ],
        "secured_by_property": [
          "01FDTQ5PKC4ZFKXBET140VG0BJ"
        ]
      }
    ],
    "loan_terms": [
      {
        "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
        "@type": "loan_term",
        "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_note_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
        }
      }
    ],
    "automated_underwriting": [
      {
        "@id": "01FDTQ5PJYAP2V6RT2ZJND1KC4",
        "@type": "NotSpecified",
        "has_desktop_underwriter_recommendation_type": {
          "has_value": "out_of_scope"
        }
      }
    ],
    "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_type": {
          "has_value": "condominium"
        },
        "has_project_design_type": {
          "has_value": "midrise"
        },
        "has_manufactured_home_indicator": {
          "has_value": false
        },
        "has_planned_unit_development_pud_indicator": {
          "has_value": false
        },
        "has_manufactured_home_width_type": {
          "has_value": "string"
        },
        "has_project_usage_type": {
          "has_value": "string"
        },
        "has_stories_count": {
          "has_value": 1
        },
        "with_address": [
          "01FDTQGB9EV6FKWGZ2CY35971G"
        ],
        "with_sales_contract": [
          "01FDTQGB9EPKV6EJXZMTW0CGV0"
        ],
        "with_value": [
          "01FDTQGB9FVMF9YTFBTX95D2KH"
        ]
      }
    ],
    "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": "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_asstring[]—
with_declarationsstring[]—
with_credit_riskstring[]—
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_mortgage_typerequiredobject—
has_valuerequiredstringconventionalfhalocal_agencyotherpublic_and_indian_housingstate_agencyusda-rdva
has_relocation_loan_indicatorrequiredobject—
has_valuerequiredboolean—
with_borrowerrequiredstring[]—
with_loan_termsrequiredstring[]—
with_documentationrequiredstring[]—
with_summaryrequiredstring[]—
with_payment_informationrequiredstring[]—
with_arm_adjustmentrequiredstring[]—
with_automated_underwritingrequiredstring[]—
with_insurancerequiredstring[]—
serviced_byrequiredstring[]—
with_buydownrequiredstring[]—
with_quote_requestrequiredstring[]—
secured_by_propertyrequiredstring[]—
loan_termsrequiredobject[]—
@idrequiredstring—
@typerequiredstring—
has_pledged_assets_indicatorobject—
has_valuerequiredboolean—
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_note_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—
automated_underwritingrequiredobject[]—
@idrequiredstring—
@typerequiredstring—
has_desktop_underwriter_recommendation_typerequiredobject—
has_valuerequiredstringapprove_eligibleapprove_ineligibleerrorexpanded_approval_1_eligibleexpanded_approval_1_ineligibleexpanded_approval_2_eligibleexpanded_approval_2_ineligibleexpanded_approval_3_eligibleexpanded_approval_3_ineligibleout_of_scoperefer_eligiblerefer_ineligiblerefer_with_cautionunknown
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_typerequiredobject—
has_valuerequiredstringcommon_interest_apartmentcondominiumcooperativeother
has_project_design_typerequiredobject—
has_valuerequiredstringhighrisemidrisetownhouse
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—
with_addressrequiredstring[]—
with_sales_contractrequiredstring[]—
with_valuerequiredstring[]—
addressesrequiredobject[]—
@idrequiredstring—
@typerequiredstring—
has_county_namerequiredobject—
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

Providers

Errors

400403404405429500

Type to search.