<!-- https://staircase.co/products/contract/price -->
# Price

# Price

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

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

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

## How it works

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

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

## Operations

<!--source:api-specifications-->

### Pricing
<!--/source-->

`POST` `/bestexsearch`

<!--source:api-specifications-->

#### Best Execution Search
<!--/source-->

`InvokePricingFlow`

<!--source:api-specifications-->
Invoke Best Pricing Flow
<!--/source-->

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

#### API Input

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

- `partner_name`, supported partners:

Show the rest
- optimalBlue

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

People
- `first_name` - (string) - The person's first name.
- `last_name` - (string) - The person's last name.
- `us_citizenship_status` - (boolean) - Whether the person is a US citizen.
- `first_time_home_owner` - (boolean) - Whether the person is a first time homeowner. `Optional` - Default: True
- `person_identifier` - (string) - The identifier for the person class.

Properties
- `purchase_price` - (string) - The property purchase price.
- `property_type` - (string) - The property type. - Possible enum values `["SingleFamily", "Condo", "ManufacturedDoubleWide", "Condotel", "Modular", "PUD", "Timesharer", "ManufacturedSingleWide", "Coop", "NonWarrantableCondo", "Townhouse", "DetachedCondo"]` - `Optional`. Default: SingleFamily
- `property_identifier` - (string) - The identifier for the property class.
- `full_address_txt` - (string) - The property full address.
- `county_name` - (string) - The property county.
- `state_name` - (string) - The property state.
- `postal_code` - (string) - The postal code.
- `property_identifier` - (string) - The identifier for the property class.
- `lien_type` - (string) - The property lien type. `Optional` - Default: "first"
- `numberOfUnits` - (string) - The number of units. `Optional` - Default: OneUnit
- `numberOfStories` - (integer) - The number of stories. `Optional` - Default: 1

Loans
- `downpayment_amount` - (string) - The loan down payment amount.
- `downpayment_percentage` - (string) - The loan down payment percentage.
- `monthly_payment` - (integer) - The loan monthly payment value
- `buydown_type` - (string) - The loan buydown method - Possible enum values `["ThreeTwoOne", "TwoOne", "OneZero", "None"]`
- `loan_role_type` - (string) - The loan role type.
- `loan_identifier` - (string) - The identifier for the loan class.
- `loan_type` - (string) - The loan type. `Optional` Default: conventional
- `loan_purpose` - (string) - The loan purpose. `Optional` Default: purchase
- `interest_only` - (boolean) - Whether it's interest only. `Optional` Default: True
- `prepayment_penalty` - (string) - The prepayment penalty. `Optional` Default: None
- `borrower_paid_mi` - (boolean) - Whether the borrower paid the mortgage insurance. `Optional` Default: False
- `amortization_type` - (string) - The loan amortization type. `Optional` Default: Fixed
- `loan_terms` - (string) - The terms of the loan. `Optional` Default: ThirtyYear

Incomes
- `annual_income` - (integer) - The annual income value for a person.
- `income_identifier` - (string) - The identifier for the income class.

Credits
- `credit_score` - (integer) - The credit score for a person.
- `credit_identifier` - (string) - The identifier for the credit class.

Lease
- `lease_identifier` - (string) - The identifier for the lease class.
- `monthly_rate` - (number) - The monthly rate of the lease.

Rents
- `rent_identifier` - (string) - The identifier for the rent class.
- `monthly_rate` - (number) - The monthly rate of the rent.

Automobiles
- `automobile_identifier` - (string) - The identifier for the automobile class.
- `automobile_type` - (string) - The automobile type.

Relationships
- `@type` - (string) - The identifier of the relationship class. Possible enum `["finance_relation", "person_credit", "person_income"]`
- Attributes required will vary according to `@type`. If `@type` is `finance_relation`, below are the attributes required:
- `has_person` - (string) - The identifier for the people class.
- `has_loan` - (string) - The identifier for the loans class.
- `has_property` - (string) - The identifier for the properties class.
- `has_rent` - (string) - The identifier for the rents class.
- `has_lease` - (string) - The identifier for the lease class.
- `has_automobile` - (string) - The identifier for the automobiles class.
- `main_applicant` - (boolean) - Whether the person is the main applicant.
- If `@type` is `person_income`, below are the attributes required:
- `has_income` - (string) - The identifier for the incomes class.
- `has_person` - (string) - The identifier for the people class.
- If `@type` is `person_credit`, below are the attributes required:
- `has_credit` - (string) - The identifier for the credit class.
- `has_person` - (string) - The identifier for the person class.

- `callback_url`: If you don't want to continuously poll the result, you can provide a callback_url in request body. Once the invocation is completed, response content will be posted to this endpoint.

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

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

#### Running Best Execution API

API can run in two modes:

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

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

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

###### Mock Scenarios Examples

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

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

#### API Response

- Once `Best Execution` results are available, the results will be returned on the Webhook URL with the status and response_data, below are the details of the `response_data` from the `best_execution` API

Pricing Schemas
- `pricing_schema_identifier` - (string) - The pricing schema class identifier.
- `apr` - (number) - The pricing schemas annual percentage rate.
- `rebate` - (number) - The pricing schemas rebate.
- `discount` - (number) - The pricing schemas discount.
- `closing_cost` - (number) - The pricing schemas closing cost.
- `monthly_insurance` - (number) - The pricing schemas monthly insurance value.
- `total_monthly_payment` - (number) - The pricing schemas total monthly payment amount.
- `rate` - (number) - The pricing schemas rate.
- `price` - (number) - The pricing schemas price.
- `principal_and_interest` - (number) - The pricing schemas principal and interest amount.
- `first_year_monthly_payment` - (number) - The pricing schemas first year monthly payment amount. Calculated based on the buy down option provided in the request.
- `second_year_monthly_payment` - (number) - The pricing schemas second year monthly payment amount. Calculated based on the buy down option provided in the request.
- `third_year_monthly_payment` - (number) - The pricing schemas third year monthly payment amount. Calculated based on the buy down option provided in the request.
- `piti` - (number) - The pricing schemas principal, interest, taxes and insurance amount. Calculated based on the values in the response.

Loans
- `loan_identifier` - (string) - The loan class identifier.
- `buydown_type` - (string) - The loan buy down option. One of `['ThreeTwoOne', 'TwoOne', 'OneZero' or 'None']`.
- `ltv_value` - (number) - The loan to value ratio.
- `dti_value` - (number) - The loan debt to income ratio.

Mortgage Plans
- `plan_identifier` - (string) - The mortgage plan class identifier.
- `amortization_term` - (string) - The mortgage plan amortization term in years.
- `name` - (string) - The mortgage plan name.
- `code` - (string) - The mortgage plan code.

Relationships
- `has_pricing_schema` - (string) - The pricing schema class identifier.
- `has_loan` - (string) - The loan class identifier.
- `has_mortgage_plan` - (string) - The mortgage plan class identifier.

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

<!--/source-->

##### Request

<!--source:api-specifications-->
Mock Request ThreeTwoOneMock Request TwoOneMock Request OneZeroMock Request Three BuydownsMock Request Error ScenarioPrice Request Single ApplicantPrice Request Multiple ApplicantsPrice Request With `Optional` FieldsPrice Request With callback URL
<!--/source-->

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

<!--/source-->

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

<!--/source-->

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

<!--/source-->

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

<!--/source-->

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "partner_name": "partner_name",
 "request_data": {
 "people": [
 {
 "first_name": "Andy",
 "last_name": "America",
 "us_citizenship_status": true,
 "person_identifier": "person_1",
 "first_time_home_owner": true
 }
 ],
 "properties": [
 {
 "purchase_price": 150000,
 "property_type": "PrimaryResidence",
 "property_identifier": "property_1",
 "full_address_txt": "123 Made Up Street",
 "county_name": "FAIRFAX",
 "state_name": "VA",
 "postal_code": "12345"
 }
 ],
 "loans": [
 {
 "loan_identifier": "loan_1",
 "downpayment_amount": 20000,
 "downpayment_percentage": 14,
 "buydown_type": "ThreeTwoOne",
 "loan_role_type": "subject_loan"
 }
 ],
 "incomes": [
 {
 "annual_income": 75000,
 "income_identifier": "income_1"
 }
 ],
 "credits": [
 {
 "credit_score": 750,
 "credit_identifier": "credit_1"
 }
 ],
 "rents": [
 {
 "rent_identifier": "rent_1",
 "monthly_rate": 1000
 }
 ],
 "relationships": [
 {
 "@type": "finance_relation",
 "has_person": "person_1",
 "has_loan": "loan_1",
 "has_property": "property_1",
 "main_applicant": true
 },
 {
 "@type": "person_income",
 "has_person": "person_1",
 "has_income": "income_1"
 },
 {
 "@type": "person_credit",
 "has_credit": "credit_1",
 "has_person": "person_1"
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "partner_name": "partner_name",
 "request_data": {
 "people": [
 {
 "first_name": "Andy",
 "last_name": "America",
 "us_citizenship_status": true,
 "person_identifier": "person_1",
 "first_time_home_owner": true
 },
 {
 "first_name": "Amy",
 "last_name": "America",
 "person_identifier": "person_2"
 }
 ],
 "properties": [
 {
 "purchase_price": 250000,
 "property_type": "PrimaryResidence",
 "property_identifier": "property_1",
 "full_address_txt": "123 Made Up Street",
 "county_name": "FAIRFAX",
 "state_name": "VA",
 "postal_code": "12345"
 }
 ],
 "loans": [
 {
 "loan_identifier": "loan_1",
 "downpayment_amount": 20000,
 "downpayment_percentage": 8,
 "buydown_type": "OneZero",
 "loan_role_type": "subject_loan"
 }
 ],
 "incomes": [
 {
 "annual_income": 150000,
 "income_identifier": "income_1"
 },
 {
 "annual_income": 75000,
 "income_identifier": "income_2"
 }
 ],
 "credits": [
 {
 "credit_score": 750,
 "credit_identifier": "credit_1"
 },
 {
 "credit_score": 625,
 "credit_identifier": "credit_2"
 }
 ],
 "lease": [
 {
 "monthly_rate": 7500,
 "lease_identifier": "lease_1"
 }
 ],
 "automobile": [
 {
 "automobile_identifier": "automobile_1"
 }
 ],
 "rent": [
 {
 "monthly_rate": 2500,
 "rent_identifier": "rent_1"
 }
 ],
 "relationships": [
 {
 "@type": "finance_relation",
 "has_person": "person_1",
 "has_loan": "loan_1",
 "has_property": "property_1",
 "main_applicant": true
 },
 {
 "@type": "finance_relation",
 "has_person": "person_2",
 "has_loan": "loan_1",
 "has_property": "property_1",
 "main_applicant": false
 },
 {
 "@type": "finance_relation",
 "has_person": "person_1",
 "has_leas": "lease_1",
 "has_property": "automobile_1"
 },
 {
 "@type": "person_income",
 "has_person": "person_1",
 "has_income": "income_1"
 },
 {
 "@type": "person_income",
 "has_person": "person_2",
 "has_income": "income_2"
 },
 {
 "@type": "person_credit",
 "has_credit": "credit_1",
 "has_person": "person_1"
 },
 {
 "@type": "person_credit",
 "has_credit": "credit_2",
 "has_person": "person_2"
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "partner_name": "partner_name",
 "request_data": {
 "people": [
 {
 "first_name": "Andy",
 "last_name": "America",
 "us_citizenship_status": true,
 "person_identifier": "person_1",
 "first_time_home_owner": true
 }
 ],
 "properties": [
 {
 "purchase_price": 150000,
 "property_type": "PrimaryResidence",
 "property_identifier": "property_1",
 "full_address_txt": "123 Made Up Street",
 "county_name": "FAIRFAX",
 "state_name": "VA",
 "postal_code": "12345",
 "lien_type": "First",
 "numberOfUnits": "OneUnit",
 "numberOfStories": 1,
 "propertyType": "SingleFamily"
 }
 ],
 "loans": [
 {
 "loan_identifier": "loan_1",
 "downpayment_amount": 20000,
 "downpayment_percentage": 14,
 "buydown_type": "ThreeTwoOne",
 "loan_role_type": "subject_loan",
 "loan_type": "Conventional",
 "loan_purpose": "Purchase",
 "interest_only": false,
 "prepayment_penalty": "None",
 "borrower_paid_mi": true,
 "amortization_type": "Fixed",
 "loan_terms": "FifteenYear"
 }
 ],
 "incomes": [
 {
 "annual_income": 75000,
 "income_identifier": "income_1"
 }
 ],
 "credits": [
 {
 "credit_score": 750,
 "credit_identifier": "credit_1"
 }
 ],
 "relationships": [
 {
 "@type": "finance_relation",
 "has_person": "person_1",
 "has_loan": "loan_1",
 "has_property": "property_1",
 "main_applicant": true
 },
 {
 "@type": "person_income",
 "has_person": "person_1",
 "has_income": "income_1"
 },
 {
 "@type": "person_credit",
 "has_credit": "credit_1",
 "has_person": "person_1"
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "partner_name": "partner_name",
 "callback_url": "callback.url",
 "request_data": {
 "people": [
 {
 "first_name": "Andy",
 "last_name": "America",
 "us_citizenship_status": true,
 "person_identifier": "person_1",
 "first_time_home_owner": true
 }
 ],
 "properties": [
 {
 "purchase_price": 150000,
 "property_type": "PrimaryResidence",
 "property_identifier": "property_1",
 "full_address_txt": "123 Made Up Street",
 "county_name": "FAIRFAX",
 "state_name": "VA",
 "postal_code": "12345"
 }
 ],
 "loans": [
 {
 "loan_identifier": "loan_1",
 "downpayment_amount": 20000,
 "downpayment_percentage": 14,
 "buydown_type": "ThreeTwoOne",
 "loan_role_type": "subject_loan"
 }
 ],
 "incomes": [
 {
 "annual_income": 75000,
 "income_identifier": "income_1"
 }
 ],
 "credits": [
 {
 "credit_score": 750,
 "credit_identifier": "credit_1"
 }
 ],
 "rents": [
 {
 "rent_identifier": "rent_1",
 "monthly_rate": 1000
 }
 ],
 "relationships": [
 {
 "@type": "finance_relation",
 "has_person": "person_1",
 "has_loan": "loan_1",
 "has_property": "property_1",
 "main_applicant": true
 },
 {
 "@type": "person_income",
 "has_person": "person_1",
 "has_income": "income_1"
 },
 {
 "@type": "person_credit",
 "has_credit": "credit_1",
 "has_person": "person_1"
 }
 ]
 }
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201400403404500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully started flow invocation.

```
{
 "response_id": "01F6NAQ4894HPMCBGB4P0G78HG"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

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

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |

##### Request body`application/json`

<!--source:api-specifications-->
3 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `partner_name`required | `string` | <!--source:api-specifications-->Partner name.<!--/source-->Example `optimalBlue` |
| `callback_url` | `string` | <!--source:api-specifications-->Callback url<!--/source-->Example `callback.url` |
| `request_data`required | `object` | <!--source:api-specifications-->Request data for Pricing.<!--/source--> |
| `people`required | `object[]` | <!--source:api-specifications-->List of persons.<!--/source--> |
| `first_name`required | `string` | <!--source:api-specifications-->Persons first name.<!--/source--> |
| `last_name`required | `string` | <!--source:api-specifications-->Persons last name.<!--/source--> |
| `ssn` | `string` | <!--source:api-specifications-->Persons taxpayer number identifier.<!--/source--> |
| `us_citizenship_status`required | `boolean` | <!--source:api-specifications-->Whether person is US citizen.<!--/source--> |
| `person_identifier`required | `string` | <!--source:api-specifications-->Person class identifier.<!--/source--> |
| `first_time_home_owner`required | `boolean` | <!--source:api-specifications-->Whether person is a first time homeowner.<!--/source--> |
| `properties`required | `object[]` | <!--source:api-specifications-->List of properties.<!--/source--> |
| `purchase_price`required | `integer` | <!--source:api-specifications-->Property purchase price.<!--/source--> |
| `property_type`required | `string` | <!--source:api-specifications-->Property type.<!--/source--> |
| `property_identifier`required | `string` | <!--source:api-specifications-->Property class identifier.<!--/source--> |
| `full_address_txt`required | `string` | <!--source:api-specifications-->Property full address.<!--/source--> |
| `county_name`required | `string` | <!--source:api-specifications-->Property county name.<!--/source--> |
| `state_name`required | `string` | <!--source:api-specifications-->Property state name.<!--/source--> |
| `postal_code`required | `string` | <!--source:api-specifications-->Property state code.<!--/source--> |
| `lien_type` | `string` | <!--source:api-specifications-->Property lien type.<!--/source--> |
| `loans`required | `object[]` | <!--source:api-specifications-->List of loans.<!--/source--> |
| `loan_identifier`required | `string` | <!--source:api-specifications-->Loan class identifier.<!--/source--> |
| `downpayment_amount`required | `integer` | <!--source:api-specifications-->Loan down payment amount.<!--/source--> |
| `downpayment_percentage`required | `integer` | <!--source:api-specifications-->Loan down payment percentage.<!--/source--> |
| `buydown_type`required | `string` | <!--source:api-specifications-->Loan buydown.<!--/source--> |
| `amortization_type` | `string` | <!--source:api-specifications-->Loan amortization type.<!--/source--> |
| `borrower_paid_mi` | `boolean` | <!--source:api-specifications-->Whether the borrower paid mortgage insurance.<!--/source--> |
| `buydown_amount` | `integer` | <!--source:api-specifications-->Loan buydown amount.<!--/source--> |
| `loan_amount` | `integer` | <!--source:api-specifications-->Loan amount.<!--/source--> |
| `loan_purpose` | `string` | <!--source:api-specifications-->Loan purpose.<!--/source--> |
| `loan_type` | `string` | <!--source:api-specifications-->Loan type.<!--/source--> |
| `monthly_payment` | `number` | <!--source:api-specifications-->Loan monthly payment.<!--/source--> |
| `incomes`required | `object[]` | <!--source:api-specifications-->List of incomes.<!--/source--> |
| `annual_income`required | `integer` | <!--source:api-specifications-->Annual Income amount.<!--/source--> |
| `income_identifier`required | `string` | <!--source:api-specifications-->Income class identifier.<!--/source--> |
| `credits`required | `object[]` | <!--source:api-specifications-->List of credits.<!--/source--> |
| `credit_score`required | `integer` | <!--source:api-specifications-->Credit score value.<!--/source--> |
| `credit_identifier`required | `string` | <!--source:api-specifications-->Credit class identifier.<!--/source--> |
| `lease` | `object[]` | <!--source:api-specifications-->List of leases.<!--/source--> |
| `lease_identifier`required | `string` | <!--source:api-specifications-->Lease class identifier.<!--/source--> |
| `monthly_rate`required | `number` | <!--source:api-specifications-->The monthly rate of the lease.<!--/source--> |
| `automobiles` | `object[]` | <!--source:api-specifications-->List of automobiles<!--/source--> |
| `automobile_identifier`required | `string` | <!--source:api-specifications-->Automobile class identifier.<!--/source--> |
| `automobile_type` | `string` | <!--source:api-specifications-->Automobile type.<!--/source--> |
| `rents` | `object[]` | <!--source:api-specifications-->List of rents<!--/source--> |
| `rent_identifier`required | `string` | <!--source:api-specifications-->Rent class identifier.<!--/source--> |
| `monthly_rate`required | `number` | <!--source:api-specifications-->Monthly rate of the rent.<!--/source--> |
| `relationships`required | `object[]` | <!--source:api-specifications-->List of financial relations.<!--/source--> |
| `@type` | `string` | <!--source:api-specifications-->The relationship types. Can be one of finance_relation, person_income, person_credit.<!--/source--> |
| `has_income` | `string` | <!--source:api-specifications-->Income class identifier.<!--/source--> |
| `has_person` | `string` | <!--source:api-specifications-->Person class identifier.<!--/source--> |
| `has_credit` | `string` | <!--source:api-specifications-->Credit class identifier.<!--/source--> |
| `has_loan` | `string` | <!--source:api-specifications-->Loan class identifier.<!--/source--> |
| `has_property` | `string` | <!--source:api-specifications-->Property class identifier.<!--/source--> |
| `has_rent` | `string` | <!--source:api-specifications-->Rent class identifier<!--/source--> |
| `has_lease` | `string` | <!--source:api-specifications-->Lease class identifier<!--/source--> |
| `has_automobile` | `string` | <!--source:api-specifications-->Automobile class identifier<!--/source--> |
| `has_mortgage` | `string` | <!--source:api-specifications-->Mortgage class identifier<!--/source--> |
| `main_applicant` | `boolean` | <!--source:api-specifications-->Whether the person is the main applicant.<!--/source--> |

##### Response `201``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Successfully started flow invocation.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `response_id`required | `string` | <!--source:api-specifications-->Response collection ID.<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

`GET` `/bestexsearch/{id}`

<!--source:api-specifications-->

#### Retrieve Status
<!--/source-->

`RetrievePricingFlowStatus`

<!--source:api-specifications-->
Retrieve Pricing Status
<!--/source-->

<!--source:api-specifications-->
Retrieves the result of running Pricing process.

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

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

#### Response Payload

This endpoint returns the following response object:

Show the rest Pricing Schemas
- `pricing_schema_identifier` - (string) - The pricing schema class identifier.
- `apr` - (number) - The pricing schemas annual percentage rate.
- `rebate` - (number) - The pricing schemas rebate.
- `discount` - (number) - The pricing schemas discount.
- `closing_cost` - (number) - The pricing schemas closing cost.
- `monthly_insurance` - (number) - The pricing schemas monthly insurance value.
- `total_monthly_payment` - (number) - The pricing schemas total monthly payment amount.
- `rate` - (number) - The pricing schemas rate.
- `price` - (number) - The pricing schemas price.
- `principal_and_interest` - (number) - The pricing schemas principal and interest amount.
- `first_year_monthly_payment` - (number) - The pricing schemas first year monthly payment amount. Calculated based on the buy down option provided in the request.
- `second_year_monthly_payment` - (number) - The pricing schemas second year monthly payment amount. Calculated based on the buy down option provided in the request.
- `third_year_monthly_payment` - (number) - The pricing schemas third year monthly payment amount. Calculated based on the buy down option provided in the request.
- `piti` - (number) - The pricing schemas principal, interest, taxes and insurance amount. Calculated based on the values in the response.

Loans
- `loan_identifier` - (string) - The loan class identifier.
- `buydown_type` - (string) - The loan buy down option. One of 'ThreeTwoOne', 'TwoOne' or 'OneZero'.
- `ltv_value` - (number) - The loan to value ratio.
- `dti_value` - (number) - The loan debt to income ratio.

Mortgage Plans
- `plan_identifier` - (string) - The mortgage plan class identifier.
- `amortization_term` - (string) - The mortgage plan amortization term in years.
- `name` - (string) - The mortgage plan name.
- `code` - (string) - The mortgage plan code.

Relationships
- `has_pricing_schema` - (string) - The pricing schema class identifier.
- `has_loan` - (string) - The loan class identifier.
- `has_mortgage_plan` - (string) - The mortgage plan class identifier.

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

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

<!--/source-->

##### Response

<!--source:api-specifications-->
200 Success Status Example200 Error Status Example200 Failed Status Examlpe400403404500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully returned result of the Asset Verification.

```
{
 "transaction_id": "01GT91JJRFRV60T4TTEMXFZMWE",
 "collection_id": "01GT91JJZRZ5ZNP7Y6V63527T7",
 "metadata": {
 "validation": false,
 "serialise_to_graph": false,
 "created_at": "2023-03-27T11:14:48.118327-04:00",
 "invocation_status": "COMPLETED",
 "last_updated_at": "2023-03-27T11:14:51.943421-04:00",
 "partner_name": "optimalBlue",
 "product_invocation_id": "01GWHT5PNPJA3JE0BT1DY3H24H",
 "product_name": "Price"
 },
 "data": {
 "relationships": [
 {
 "@id": "mortgage_application_1",
 "@type": "mortgage_application",
 "has_pricing_schema": "pricing_schema_1",
 "has_loan": "loan_1",
 "has_mortgage_plan": "plan_1"
 }
 ],
 "mortgage_plans": [
 {
 "@id": "mortgage_plan_1",
 "@type": "mortgage_plan",
 "code": "53040066",
 "name": "Fixed 30 years",
 "plan_identifier": "plan_1",
 "amortization_term": "30"
 }
 ],
 "loans": [
 {
 "@id": "loan_1",
 "@type": "loan",
 "loan_identifier": "loan_1",
 "ltv_value": 80,
 "dti_value": 54
 }
 ],
 "pricing_schemas": [
 {
 "@id": "pricing_schema_1",
 "@type": "pricing_schema",
 "rebate": 0,
 "discount": 0,
 "first_year_monthly_payment": 1104.93,
 "second_year_monthly_payment": 1029.61,
 "third_year_monthly_payment": 957.59,
 "closing_cost": 0,
 "monthly_insurance": 0,
 "total_monthly_payment": 1719.37,
 "rate": 10,
 "price": 100,
 "principal_and_interest": 1719,
 "piti": 1430.22,
 "apr": 10.24,
 "pricing_schema_identifier": "pricing_schema_1"
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully returned result of the Asset Verification.

```
{
 "transaction_id": "01GT91JJRFRV60T4TTEMXFZMWE",
 "collection_id": "01GT91JJZRZ5ZNP7Y6V63527T7",
 "metadata": {
 "validation": false,
 "serialise_to_graph": false,
 "created_at": "2023-03-27T11:14:48.118327-04:00",
 "invocation_status": "COMPLETED",
 "last_updated_at": "2023-03-27T11:14:51.943421-04:00",
 "partner_name": "optimalBlue",
 "product_invocation_id": "01GWHT5PNPJA3JE0BT1DY3H24H",
 "product_name": "Price"
 },
 "data": {
 "errors": [
 {
 "@id": "error_1",
 "@type": "error",
 "error_id": "error_1",
 "error_message": "Error message",
 "error_timestamp": "2023-03-30T11:57:17.670361-04:00",
 "error_type": "ValidationError",
 "severity_level": "Warning"
 },
 {
 "@id": "error_2",
 "@type": "error",
 "error_id": "error_2",
 "error_message": "Error message",
 "error_timestamp": "2023-03-30T11:57:17.670361-04:00",
 "error_type": "ValidationError",
 "severity_level": "Warning"
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully returned result of the Asset Verification.

```
{
 "transaction_id": "01GT91JJRFRV60T4TTEMXFZMWE",
 "collection_id": "01GT91JJZRZ5ZNP7Y6V63527T7",
 "metadata": {
 "validation": false,
 "serialise_to_graph": false,
 "created_at": "2023-03-27T11:14:48.118327-04:00",
 "invocation_status": "FAILED",
 "last_updated_at": "2023-03-27T11:14:51.943421-04:00",
 "partner_name": "optimalBlue",
 "product_invocation_id": "01GWHT5PNPJA3JE0BT1DY3H24H",
 "product_name": "Price"
 },
 "data": {
 "errors": [
 {
 "@id": "error_1",
 "@type": "error",
 "error_id": "error_1",
 "error_message": "Something went wrong!",
 "error_timestamp": "2023-03-30T11:57:17.670361-04:00",
 "error_type": "ProducError",
 "severity_level": "Critical"
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

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

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
2
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `id` required | `string (Staircase Response Collection Identifier)` path | `01FFMHWSS346W9V6HZVGSEZPQ` | <!--source:api-specifications-->Pricing ID<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
4 fields
<!--/source-->
<!--source:api-specifications-->
Successfully returned result of the Asset Verification.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string (ulid)` | <!--source:api-specifications-->Transaction ID.<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `collection_id` | `string (ulid)` | <!--source:api-specifications-->Collection ID.<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `object` | <!--source:api-specifications-->Pricing Data in Staircase lexicon schema.<!--/source--> |
| `metadata` | `object` | <!--source:api-specifications-->Metadata about collection, f.e version of used Staircase schema.<!--/source--> |
| `product_name` | `string` | <!--source:api-specifications-->Product name<!--/source-->Example `asset` |
| `partner_name` | `string` | <!--source:api-specifications-->Partner name<!--/source-->Example `equifax` |
| `created_at` | `string` | <!--source:api-specifications-->Time of creation<!--/source--> |
| `last_updated_at` | `string` | <!--source:api-specifications-->Time of last update<!--/source--> |
| `invocation_status` | `string` | <!--source:api-specifications-->Status of the Asset Verification.<!--/source-->`COMPLETED``FAILED``RUNNING``STARTED` |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

<!--source:api-specifications-->

### Workflow
<!--/source-->

`POST` `/products/pricing/invocations`

<!--source:api-specifications-->

#### Invoke Product Flow
<!--/source-->

`InvokeSpecificProductFlow`

<!--source:api-specifications-->
This product receives all detailed pricing information for a product. The response will return all price, rate, lock period combinations for the requested product.

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

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

<!--/source-->

##### Request

<!--source:api-specifications-->
Flow Invocation with Collection IDPricing Details ExamplePricing Search ExamplePricing Search With Cash Out FilterPricing Search With Term FilterPricing Search With Discount Point Filter
<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "OptimalBlue",
 "transaction_id": "01F6NAMXWN2XVBD1YJ92A6S6R4",
 "request_collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "OptimalBlue",
 "request_data": {
 "loan_products": [
 {
 "@type": "loan_product",
 "has_product_name": {
 "has_value": "NEW - 30 Year Fixed Conventional"
 },
 "has_product_description_text": {
 "has_value": ""
 },
 "has_product_identifier": {
 "has_value": "20290727"
 }
 }
 ],
 "mortgage_products": [
 {
 "has_partner_product_name": {
 "has_value": "Product Detail"
 },
 "has_partner_transaction_identifier": {
 "has_value": null
 },
 "has_service_response_date": {
 "has_value": "2021-09-14T07:07:38.1847142Z"
 },
 "has_partner_name": {
 "has_value": "Optimal Blue"
 },
 "@type": "pricing"
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "OptimalBlue-BestSearch",
 "request_data": {
 "people": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
 "@type": "borrower",
 "has_first_name": {
 "has_value": "test"
 },
 "has_last_name": {
 "has_value": "test1"
 },
 "employed_as": [
 "01FDTQ5PGZWEG4M8PSR5T6TSYH"
 ],
 "with_declarations": [
 "01FDTQ5PH0KQ21KE0DR3FV16SW"
 ],
 "with_credit_risk": [
 "01FDTQ5PH1J05ESN8F3M8X03MD"
 ],
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 15
 }
 }
 ],
 "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": false
 },
 "has_loan_purpose_type": {
 "has_value": "purchase"
 },
 "has_refinance_type": {
 "has_value": "no_cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 150000
 },
 "has_interest_only_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_term_months_count": {
 "has_value": 0
 },
 "has_construction_loan_indicator": {
 "has_value": false
 },
 "has_buydown_indicator": {
 "has_value": true
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "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_include_ballon_loans_indicator": {
 "has_value": false
 },
 "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
 }
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "OptimalBlue-BestSearch",
 "request_data": {
 "people": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
 "@type": "borrower",
 "has_first_name": {
 "has_value": "test"
 },
 "has_last_name": {
 "has_value": "test1"
 },
 "employed_as": [
 "01FDTQ5PGZWEG4M8PSR5T6TSYH"
 ],
 "with_declarations": [
 "01FDTQ5PH0KQ21KE0DR3FV16SW"
 ],
 "with_credit_risk": [
 "01FDTQ5PH1J05ESN8F3M8X03MD"
 ],
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 15
 }
 }
 ],
 "employment": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
 "@type": "employment",
 "has_self_employment_indicator": {
 "has_value": true
 }
 }
 ],
 "declarations": [
 {
 "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
 "@type": "declaration",
 "has_citizenship_residency_type": {
 "has_value": "us_citizen"
 },
 "has_borrower_first_time_homebuyer_indicator": {
 "has_value": false
 },
 "has_bankruptcy_indicator": {
 "has_value": false
 },
 "has_age_of_bankruptcy_years_count": {
 "has_value": 0
 },
 "has_prior_property_foreclosure_completed_indicator": {
 "has_value": false
 },
 "has_age_of_prior_property_foreclosure_years_count": {
 "has_value": 0
 }
 }
 ],
 "credit_score_information": [
 {
 "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
 "@type": "credit_score_information",
 "has_credit_score": {
 "has_value": "850"
 }
 }
 ],
 "loans": [
 {
 "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
 "@type": "loan",
 "has_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": false
 },
 "has_loan_purpose_type": {
 "has_value": "refinance"
 },
 "has_refinance_type": {
 "has_value": "cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 150000
 },
 "has_interest_only_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_term_months_count": {
 "has_value": 0
 },
 "has_construction_loan_indicator": {
 "has_value": false
 },
 "has_buydown_indicator": {
 "has_value": true
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "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": 15
 },
 "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_rice_quote_request",
 "has_discount_points_percent": {
 "has_value": 0
 },
 "has_cash_out_amount": {
 "has_value": 10000
 },
 "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_include_balloon_loans_indicator": {
 "has_value": false
 },
 "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": "false"
 },
 "has_project_usage_type": {
 "has_value": "false"
 },
 "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": "subject_property",
 "has_sales_contract_amount": {
 "has_value": 225000
 }
 }
 ],
 "property_valuations": [
 {
 "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
 "@type": "property_valuation",
 "has_property_valuation_amount": {
 "has_value": 225000
 }
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "OptimalBlue-BestSearch",
 "request_data": {
 "people": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
 "@type": "borrower",
 "has_first_name": {
 "has_value": "test"
 },
 "has_last_name": {
 "has_value": "test1"
 },
 "employed_as": [
 "01FDTQ5PGZWEG4M8PSR5T6TSYH"
 ],
 "with_declarations": [
 "01FDTQ5PH0KQ21KE0DR3FV16SW"
 ],
 "with_credit_risk": [
 "01FDTQ5PH1J05ESN8F3M8X03MD"
 ],
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 15
 }
 }
 ],
 "employment": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
 "@type": "employment",
 "has_self_employment_indicator": {
 "has_value": true
 }
 }
 ],
 "declarations": [
 {
 "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
 "@type": "declaration",
 "has_citizenship_residency_type": {
 "has_value": "us_citizen"
 },
 "has_borrower_first_time_homebuyer_indicator": {
 "has_value": false
 },
 "has_bankruptcy_indicator": {
 "has_value": false
 },
 "has_age_of_bankruptcy_years_count": {
 "has_value": 0
 },
 "has_prior_property_foreclosure_completed_indicator": {
 "has_value": false
 },
 "has_age_of_prior_property_foreclosure_years_count": {
 "has_value": 0
 }
 }
 ],
 "credit_score_information": [
 {
 "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
 "@type": "credit_score_information",
 "has_credit_score": {
 "has_value": "850"
 }
 }
 ],
 "loans": [
 {
 "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
 "@type": "loan",
 "has_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": false
 },
 "has_loan_purpose_type": {
 "has_value": "purchase"
 },
 "has_refinance_type": {
 "has_value": "no_cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 150000
 },
 "has_interest_only_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_term_months_count": {
 "has_value": 0
 },
 "has_construction_loan_indicator": {
 "has_value": false
 },
 "has_buydown_indicator": {
 "has_value": true
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "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": 15
 },
 "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_rice_quote_request",
 "has_discount_points_percent": {
 "has_value": 0
 },
 "has_cash_out_amount": {
 "has_value": 0
 },
 "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_include_balloon_loans_indicator": {
 "has_value": false
 },
 "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": "false"
 },
 "has_project_usage_type": {
 "has_value": "false"
 },
 "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": "subject_property",
 "has_sales_contract_amount": {
 "has_value": 225000
 }
 }
 ],
 "property_valuations": [
 {
 "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
 "@type": "property_valuation",
 "has_property_valuation_amount": {
 "has_value": 225000
 }
 }
 ],
 "mortgage_products": [
 {
 "@id": "01FDTQGB9JWTYPBP9NNEDC7F9M",
 "@type": "Options",
 "has_partner_name": {
 "has_value": "Optimal Blue"
 }
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "OptimalBlue-BestSearch",
 "request_data": {
 "people": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
 "@type": "borrower",
 "has_first_name": {
 "has_value": "test"
 },
 "has_last_name": {
 "has_value": "test1"
 },
 "employed_as": [
 "01FDTQ5PGZWEG4M8PSR5T6TSYH"
 ],
 "with_declarations": [
 "01FDTQ5PH0KQ21KE0DR3FV16SW"
 ],
 "with_credit_risk": [
 "01FDTQ5PH1J05ESN8F3M8X03MD"
 ],
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 15
 }
 }
 ],
 "employment": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
 "@type": "employment",
 "has_self_employment_indicator": {
 "has_value": true
 }
 }
 ],
 "declarations": [
 {
 "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
 "@type": "declaration",
 "has_citizenship_residency_type": {
 "has_value": "us_citizen"
 },
 "has_borrower_first_time_homebuyer_indicator": {
 "has_value": false
 },
 "has_bankruptcy_indicator": {
 "has_value": false
 },
 "has_age_of_bankruptcy_years_count": {
 "has_value": 0
 },
 "has_prior_property_foreclosure_completed_indicator": {
 "has_value": false
 },
 "has_age_of_prior_property_foreclosure_years_count": {
 "has_value": 0
 }
 }
 ],
 "credit_score_information": [
 {
 "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
 "@type": "credit_score_information",
 "has_credit_score": {
 "has_value": "850"
 }
 }
 ],
 "loans": [
 {
 "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
 "@type": "loan",
 "has_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": false
 },
 "has_loan_purpose_type": {
 "has_value": "purchase"
 },
 "has_refinance_type": {
 "has_value": "no_cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 150000
 },
 "has_interest_only_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_term_months_count": {
 "has_value": 0
 },
 "has_construction_loan_indicator": {
 "has_value": false
 },
 "has_buydown_indicator": {
 "has_value": true
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "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": 15
 },
 "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_rice_quote_request",
 "has_discount_points_percent": {
 "has_value": 1
 },
 "has_cash_out_amount": {
 "has_value": 0
 },
 "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_include_balloon_loans_indicator": {
 "has_value": false
 },
 "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": "false"
 },
 "has_project_usage_type": {
 "has_value": "false"
 },
 "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": "subject_property",
 "has_sales_contract_amount": {
 "has_value": 225000
 }
 }
 ],
 "property_valuations": [
 {
 "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
 "@type": "property_valuation",
 "has_property_valuation_amount": {
 "has_value": 225000
 }
 }
 ],
 "mortgage_products": [
 {
 "@id": "01FDTQGB9JWTYPBP9NNEDC7F9M",
 "@type": "Options",
 "has_partner_name": {
 "has_value": "Optimal Blue"
 }
 }
 ]
 }
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201400403404500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully started flow invocation.

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Description |
| --- | --- | --- |
| `x-api-key` required | `string` header | <!--source:api-specifications-->Environment API Key.<!--/source--> |

##### Request body`application/json`

<!--source:api-specifications-->
6 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `product_flow_name` | `string` | <!--source:api-specifications-->Product flow name. If it is not specified, the default product flow will be invoked. If the product has no default product flow, the first created flow will be invoked. Cannot be specified together with vendor_name.<!--/source-->`OptimalBlue``OptimalBlue-BestSearch``OptimalBlue-ProductDetails` |
| `vendor_name` | `string` | <!--source:api-specifications-->Vendor name. Cannot be specified together with product_flow_name.<!--/source-->`optimalBlue` |
| `transaction_id` | `string` | <!--source:api-specifications-->Transaction ID used for invocation.<!--/source--> |
| `response_collection_id` | `string` | <!--source:api-specifications-->Response Collection ID.<!--/source--> |
| `callback_url` | `string (uri)` | <!--source:api-specifications-->Callback URL.<!--/source--> |
| `request_data` | `one of` | — |

##### Response `201``application/json`

<!--source:api-specifications-->
7 fields
<!--/source-->
<!--source:api-specifications-->
Successfully started flow invocation.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `invocation_id`required | `string` | <!--source:api-specifications-->Invocation ID.<!--/source--> |
| `invocation_status`required | `string` | <!--source:api-specifications-->The status of the invocation.<!--/source-->`STARTED` |
| `transaction_id`required | `string` | <!--source:api-specifications-->Transaction ID.<!--/source--> |
| `product_flow_name` | `string` | <!--source:api-specifications-->Product flow name.<!--/source-->`OptimalBlue``OptimalBlue-BestSearch``OptimalBlue-ProductDetails` |
| `metadata` | `object` | <!--source:api-specifications-->The metadata of the invoked product flow.<!--/source--> |
| `callback_url` | `string` | <!--source:api-specifications-->Callback URL.<!--/source--> |
| `request_data` | `object` | <!--source:api-specifications-->The data for the request collection.<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

`GET` `/products/pricing/invocations/{invocation_id}`

<!--source:api-specifications-->

#### Retrieve Invocation Status
<!--/source-->

`RetrieveProductFlowInvocationStatus`

<!--source:api-specifications-->
Retrieve status of a Product Flow Invocation
<!--/source-->

<!--source:api-specifications-->
Retrieves the status of running Product flow invocation.

<!--/source-->

##### Response

<!--source:api-specifications-->
200400403404500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully returned status of the Product flow Invocation.

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
2
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `invocation_id` required | `string (ulid)` path | `01F0KHKADN0HRFXMCQQXPA6AFZ` | <!--source:api-specifications-->Product flow invocation identifier<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
9 fields
<!--/source-->
<!--source:api-specifications-->
Successfully returned status of the Product flow Invocation.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `invocation_status`required | `string` | <!--source:api-specifications-->Invocation Status.<!--/source-->`ACTION_REQUIRED``COMPLETED``FAILED``RUNNING``STARTED` |
| `transaction_id`required | `string` | <!--source:api-specifications-->Transaction ID used for invocation.<!--/source--> |
| `request_collection_id` | `string` | <!--source:api-specifications-->Request Collection ID.<!--/source--> |
| `request_collection` | `object` | <!--source:api-specifications-->Collection.<!--/source--> |
| `transaction_id` | `string (ulid)` | <!--source:api-specifications-->Transaction ID.<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `collection_id` | `string (ulid)` | <!--source:api-specifications-->Collection ID.<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `object` | <!--source:api-specifications-->Data in Staircase language schema.<!--/source--> |
| `metadata` | `object` | <!--source:api-specifications-->Metadata about collection, f.e version of used Staircase schema.<!--/source--> |
| `response_collection_id` | `string` | <!--source:api-specifications-->Response Collection ID.<!--/source--> |
| `response_collection` | `object` | <!--source:api-specifications-->Collection.<!--/source--> |
| `transaction_id` | `string (ulid)` | <!--source:api-specifications-->Transaction ID.<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `collection_id` | `string (ulid)` | <!--source:api-specifications-->Collection ID.<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `object` | — |
| `loans` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_conforming_loan_indicator` | `object` | — |
| `has_loan_to_value_ltv_ratio_percent` | `object` | — |
| `has_combined_loan_to_value_cltv_ratio_percent` | `object` | — |
| `has_home_equity_combined_loan_to_value_hcltv_ratio_percent` | `object` | — |
| `with_closing_information` | `string[]` | — |
| `with_housing_expenses_deprecated` | `string[]` | — |
| `with_fees` | `string[]` | — |
| `with_arm_adjustment` | `string[]` | — |
| `with_loan_terms` | `string[]` | — |
| `with_quote` | `string[]` | — |
| `with_product` | `string[]` | — |
| `with_load_product` | `string[]` | — |
| `closing_information` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_total_closing_costs_amount` | `object` | — |
| `housing_expenses_deprecated` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_proposed_first_mortgage_principal_and_interest_monthly_amount` | `object` | — |
| `has_proposed_mortgage_insurance_monthly_amount` | `object` | — |
| `has_proposed_first_mortgage_principal_interest_taxes_and_insurance_piti_monthly_amount` | `object` | — |
| `arm_adjustments` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_margin_rate_percent` | `object` | — |
| `loan_terms` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_margin_rate_percent` | `object` | — |
| `has_loan_amortization_term_type` | `object` | — |
| `has_loan_amortization_type` | `object` | — |
| `quotes` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_loan_price_lock_duration_days_count` | `object` | — |
| `has_loan_price_lock_expiration_date` | `object` | — |
| `has_loan_price_percent` | `object` | — |
| `has_discount_points_amount` | `object` | — |
| `has_discount_points_percent` | `object` | — |
| `has_rebate_amount` | `object` | — |
| `has_rebate_percent` | `object` | — |
| `has_total_credit_amount` | `object` | — |
| `loan_products` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_product_identifier` | `object` | — |
| `has_product_name` | `object` | — |
| `has_total_loan_price_adjustment_percent` | `object` | — |
| `has_total_rate_adjustment_percent` | `object` | — |
| `has_total_service_release_premium_srp_adjustment_percent` | `object` | — |
| `offered_by` | `string[]` | — |
| `with_adjustment` | `string[]` | — |
| `with_notes` | `string[]` | — |
| `with_price` | `string[]` | — |
| `organizations` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_organization_identifier` | `object` | — |
| `price_adjustments` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_loan_price_adjustment_percent` | `object` | — |
| `has_loan_adjustment_reason_text` | `object` | — |
| `has_loan_adjustment_type` | `object` | — |
| `notes` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_notes_comment` | `object` | — |
| `prices` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_loan_price_at_par_percent` | `object` | — |
| `has_note_rate_at_par_percent` | `object` | — |
| `has_loan_price_lock_duration_days_at_par_count` | `object` | — |
| `metadata` | `object` | <!--source:api-specifications-->Metadata about collection, f.e version of used Staircase schema.<!--/source--> |
| `callback_url` | `string` | <!--source:api-specifications-->URL that was specified in flow invocation and will be used to send the callback when flow invocation will be finished.<!--/source--> |
| `widget_url` | `string (uri)` | <!--source:api-specifications-->URL of the widget.<!--/source--> |
| `metadata` | `object` | <!--source:api-specifications-->Response Collection ID.<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

`GET` `/products/pricing/request-schema`

<!--source:api-specifications-->

#### Retrieve Request Schema
<!--/source-->

`retrieveRequestSchema`

<!--source:api-specifications-->
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.

<!--/source-->

##### Response

<!--source:api-specifications-->
200 Schema200 Schema with Examples400 InvalidReturnExamplesValue400 text/html403404 GetProduct404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Request schema (possibly with examples) is successfully returned.

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request schema (possibly with examples) is successfully returned.

```
{
 "schema": {
 "oneOf": [
 {
 "type": "object",
 "properties": {
 "loan_products": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "@type": {
 "type": "string"
 },
 "has_product_identifier": {
 "type": "object",
 "additionalProperties": false,
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "required": [
 "has_value"
 ]
 }
 },
 "required": [
 "has_product_identifier"
 ]
 }
 },
 "mortgage_products": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "has_partner_transaction_identifier": {
 "type": "object",
 "additionalProperties": false,
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "required": [
 "has_value"
 ]
 },
 "@type": {
 "type": "string"
 }
 },
 "required": [
 "has_partner_transaction_identifier"
 ]
 }
 }
 },
 "required": [
 "loan_products",
 "mortgage_products"
 ]
 },
 {
 "type": "object",
 "properties": {
 "addresses": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_county_name",
 "has_state_code"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_county_name": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string"
 }
 }
 },
 "has_state_code": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string"
 }
 }
 },
 "has_city_name": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string"
 }
 }
 },
 "has_postal_code": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string"
 }
 }
 },
 "has_address_line_1_text": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string"
 }
 }
 }
 }
 }
 },
 "people": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_first_name",
 "has_last_name",
 "has_debt_expense_to_income_dti_ratio"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_first_name": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string"
 }
 }
 },
 "has_last_name": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string"
 }
 }
 },
 "has_debt_expense_to_income_dti_ratio": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "number"
 }
 }
 }
 }
 }
 },
 "loan_terms": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_loan_purpose_type",
 "has_refinance_type",
 "has_lien_position_type",
 "has_base_loan_amount",
 "has_interest_only_indicator",
 "has_prepayment_penalty_indicator",
 "has_prepayment_penalty_term_months_count",
 "has_buydown_indicator"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_pledged_assets_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 },
 "has_escrow_required_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 },
 "has_loan_purpose_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "other",
 "purchase",
 "refinance"
 ]
 }
 }
 },
 "has_refinance_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "cash_out",
 "limited_cash_out",
 "no_cash_out"
 ]
 }
 }
 },
 "has_lien_position_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "first_lien",
 "second_lien",
 "subordinate_lien"
 ]
 }
 }
 },
 "has_base_loan_amount": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "number"
 }
 }
 },
 "has_interest_only_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 },
 "has_prepayment_penalty_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 },
 "has_prepayment_penalty_term_months_count": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "integer"
 }
 }
 },
 "has_construction_loan_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 },
 "has_buydown_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 }
 }
 }
 },
 "loans": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_mortgage_type",
 "has_relocation_loan_indicator"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_mortgage_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "conventional",
 "fha",
 "local_agency",
 "other",
 "public_and_indian_housing",
 "state_agency",
 "usda-rd",
 "va"
 ]
 }
 }
 },
 "has_relocation_loan_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 }
 }
 }
 },
 "properties": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_property_usage_type",
 "has_number_of_units_type",
 "has_project_type",
 "has_project_design_type",
 "has_planned_unit_development_pud_indicator",
 "has_manufactured_home_indicator",
 "has_manufactured_home_width_type",
 "has_project_usage_type",
 "has_stories_count"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_property_usage_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "investment",
 "other",
 "primary_residence",
 "second_home"
 ]
 }
 }
 },
 "has_number_of_units_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "four",
 "one",
 "three",
 "two",
 "two_to_four"
 ]
 }
 }
 },
 "has_project_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "common_interest_apartment",
 "condominium",
 "cooperative",
 "other"
 ]
 }
 }
 },
 "has_project_design_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "highrise",
 "midrise",
 "townhouse"
 ]
 }
 }
 },
 "has_planned_unit_development_pud_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 },
 "has_manufactured_home_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 },
 "has_manufactured_home_width_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string"
 }
 }
 },
 "has_project_usage_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string"
 }
 }
 },
 "has_stories_count": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "integer"
 }
 }
 }
 }
 }
 },
 "loan_payment_information": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_number_of_payments_30_days_late_count": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "integer"
 }
 }
 },
 "has_number_of_payments_60_days_late_count": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "integer"
 }
 }
 },
 "has_number_of_payments_90_days_late_count": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "integer"
 }
 }
 },
 "has_number_of_payments_120_days_late_count": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "integer"
 }
 }
 },
 "has_number_of_payments_rolling_12_months_late_count": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "integer"
 }
 }
 }
 }
 }
 },
 "loan_documentation": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_asset_documentation_level_type",
 "has_employment_documentation_level_type",
 "has_income_documentation_level_type"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_asset_documentation_level_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "neither_stated_nor_verified",
 "not_required",
 "stated_and_verified",
 "stated_only"
 ]
 }
 }
 },
 "has_employment_documentation_level_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "neither_stated_nor_verified",
 "not_required",
 "stated_and_verified",
 "stated_only"
 ]
 }
 }
 },
 "has_income_documentation_level_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "neither_stated_nor_verified",
 "not_required",
 "stated_and_verified",
 "stated_only"
 ]
 }
 }
 }
 }
 }
 },
 "loan_summaries": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_total_debt_expense_to_income_dti_ratio",
 "has_representative_credit_score"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_total_debt_expense_to_income_dti_ratio": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "number"
 }
 }
 },
 "has_total_monthly_income_amount": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "number"
 }
 }
 },
 "has_projected_reserves_amount": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "number"
 }
 }
 },
 "has_representative_credit_score": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "integer"
 }
 }
 }
 }
 }
 },
 "declarations": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_citizenship_residency_type"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_citizenship_residency_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "non_permanent_resident_alien",
 "non_resident_alien",
 "permanent_resident_alien",
 "us_citizen"
 ]
 }
 }
 },
 "has_borrower_first_time_homebuyer_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 },
 "has_age_of_bankruptcy_years_count": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "integer"
 }
 }
 },
 "has_age_of_prior_property_foreclosure_years_count": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "integer"
 }
 }
 }
 }
 }
 },
 "quote_requests": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_loan_officer_compensation_type",
 "has_calculate_borrower_requested_loan_amount_indicator",
 "has_include_fixed_rate_amortization_loans_indicator",
 "has_include_adjustable_rate_amortization_loans_indicator",
 "has_include_payment_option_adjustable_rate_amortization_loans_indicator"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_loan_officer_compensation_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "no_buyer_paid",
 "no_lender_paid",
 "yes_lender_paid"
 ]
 }
 }
 },
 "has_calculate_borrower_requested_loan_amount_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 },
 "has_include_fixed_rate_amortization_loans_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 },
 "has_include_adjustable_rate_amortization_loans_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 },
 "has_include_payment_option_adjustable_rate_amortization_loans_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 },
 "has_include_balloon_loans_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 }
 }
 }
 },
 "employment": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_self_employment_indicator"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_self_employment_indicator": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "boolean"
 }
 }
 }
 }
 }
 },
 "credit_score_information": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_credit_score"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_credit_score": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string"
 }
 }
 }
 }
 }
 },
 "arm_adjustments": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_first_rate_adjustment_months_count"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_first_rate_adjustment_months_count": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "integer"
 }
 }
 }
 }
 }
 },
 "automated_underwriting": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_desktop_underwriter_recommendation_type"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_desktop_underwriter_recommendation_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "approve_eligible",
 "approve_ineligible",
 "error",
 "expanded_approval_1_eligible",
 "expanded_approval_1_ineligible",
 "expanded_approval_2_eligible",
 "expanded_approval_2_ineligible",
 "expanded_approval_3_eligible",
 "expanded_approval_3_ineligible",
 "out_of_scope",
 "refer_eligible",
 "refer_ineligible",
 "refer_with_caution",
 "unknown"
 ]
 }
 }
 }
 }
 }
 },
 "insurance": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_mortgage_insurance_premium_source_type"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_mortgage_insurance_premium_source_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "borrower",
 "lender"
 ]
 }
 }
 }
 }
 }
 },
 "organizations": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_organization_name": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string"
 }
 }
 }
 }
 }
 },
 "quote_amortization_terms": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_amortization_term_months_count"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_amortization_term_months_count": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "integer"
 }
 }
 }
 }
 }
 },
 "sales_contracts": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_sales_contract_amount"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_sales_contract_amount": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "number"
 }
 }
 }
 }
 }
 },
 "property_valuations": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_property_valuation_amount"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_property_valuation_amount": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "number"
 }
 }
 }
 }
 }
 },
 "buydowns": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "@type",
 "@id",
 "has_buydown_type"
 ],
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_buydown_type": {
 "type": "object",
 "required": [
 "has_value"
 ],
 "properties": {
 "has_value": {
 "type": "string",
 "enum": [
 "one_one",
 "one_zero",
 "three",
 "two_one"
 ]
 }
 }
 }
 }
 }
 }
 },
 "required": [
 "addresses",
 "loan_terms",
 "loans",
 "properties",
 "loan_documentation",
 "loan_summaries",
 "declarations",
 "quote_requests",
 "automated_underwriting",
 "insurance",
 "quote_amortization_terms",
 "sales_contracts",
 "property_valuations",
 "buydowns"
 ]
 }
 ]
 },
 "examples": [
 {
 "loan_products": [
 {
 "@type": "loan_product",
 "has_product_name": {
 "has_value": "NEW - 30 Year Fixed Conventional"
 },
 "has_product_description_text": {
 "has_value": ""
 },
 "has_product_identifier": {
 "has_value": "20290727"
 }
 }
 ],
 "mortgage_products": [
 {
 "has_partner_product_name": {
 "has_value": "Product Detail"
 },
 "has_partner_transaction_identifier": {
 "has_value": null
 },
 "has_service_response_date": {
 "has_value": "2021-09-14T07:07:38.1847142Z"
 },
 "has_partner_name": {
 "has_value": "Optimal Blue"
 },
 "@type": "pricing"
 }
 ]
 },
 {
 "people": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
 "@type": "borrower",
 "has_first_name": {
 "has_value": "test"
 },
 "has_last_name": {
 "has_value": "test1"
 },
 "employed_as": [
 "01FDTQ5PGZWEG4M8PSR5T6TSYH"
 ],
 "with_declarations": [
 "01FDTQ5PH0KQ21KE0DR3FV16SW"
 ],
 "with_credit_risk": [
 "01FDTQ5PH1J05ESN8F3M8X03MD"
 ],
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 15
 }
 }
 ],
 "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": false
 },
 "has_loan_purpose_type": {
 "has_value": "purchase"
 },
 "has_refinance_type": {
 "has_value": "no_cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 150000
 },
 "has_interest_only_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_term_months_count": {
 "has_value": 0
 },
 "has_construction_loan_indicator": {
 "has_value": false
 },
 "has_buydown_indicator": {
 "has_value": true
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "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_include_ballon_loans_indicator": {
 "has_value": false
 },
 "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
 }
 }
 ]
 },
 {
 "people": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
 "@type": "borrower",
 "has_first_name": {
 "has_value": "test"
 },
 "has_last_name": {
 "has_value": "test1"
 },
 "employed_as": [
 "01FDTQ5PGZWEG4M8PSR5T6TSYH"
 ],
 "with_declarations": [
 "01FDTQ5PH0KQ21KE0DR3FV16SW"
 ],
 "with_credit_risk": [
 "01FDTQ5PH1J05ESN8F3M8X03MD"
 ],
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 15
 }
 }
 ],
 "employment": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
 "@type": "employment",
 "has_self_employment_indicator": {
 "has_value": true
 }
 }
 ],
 "declarations": [
 {
 "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
 "@type": "declaration",
 "has_citizenship_residency_type": {
 "has_value": "us_citizen"
 },
 "has_borrower_first_time_homebuyer_indicator": {
 "has_value": false
 },
 "has_bankruptcy_indicator": {
 "has_value": false
 },
 "has_age_of_bankruptcy_years_count": {
 "has_value": 0
 },
 "has_prior_property_foreclosure_completed_indicator": {
 "has_value": false
 },
 "has_age_of_prior_property_foreclosure_years_count": {
 "has_value": 0
 }
 }
 ],
 "credit_score_information": [
 {
 "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
 "@type": "credit_score_information",
 "has_credit_score": {
 "has_value": "850"
 }
 }
 ],
 "loans": [
 {
 "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
 "@type": "loan",
 "has_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": false
 },
 "has_loan_purpose_type": {
 "has_value": "refinance"
 },
 "has_refinance_type": {
 "has_value": "cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 150000
 },
 "has_interest_only_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_term_months_count": {
 "has_value": 0
 },
 "has_construction_loan_indicator": {
 "has_value": false
 },
 "has_buydown_indicator": {
 "has_value": true
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "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": 15
 },
 "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_rice_quote_request",
 "has_discount_points_percent": {
 "has_value": 0
 },
 "has_cash_out_amount": {
 "has_value": 10000
 },
 "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_include_balloon_loans_indicator": {
 "has_value": false
 },
 "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": "false"
 },
 "has_project_usage_type": {
 "has_value": "false"
 },
 "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": "subject_property",
 "has_sales_contract_amount": {
 "has_value": 225000
 }
 }
 ],
 "property_valuations": [
 {
 "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
 "@type": "property_valuation",
 "has_property_valuation_amount": {
 "has_value": 225000
 }
 }
 ]
 },
 {
 "people": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
 "@type": "borrower",
 "has_first_name": {
 "has_value": "test"
 },
 "has_last_name": {
 "has_value": "test1"
 },
 "employed_as": [
 "01FDTQ5PGZWEG4M8PSR5T6TSYH"
 ],
 "with_declarations": [
 "01FDTQ5PH0KQ21KE0DR3FV16SW"
 ],
 "with_credit_risk": [
 "01FDTQ5PH1J05ESN8F3M8X03MD"
 ],
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 15
 }
 }
 ],
 "employment": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
 "@type": "employment",
 "has_self_employment_indicator": {
 "has_value": true
 }
 }
 ],
 "declarations": [
 {
 "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
 "@type": "declaration",
 "has_citizenship_residency_type": {
 "has_value": "us_citizen"
 },
 "has_borrower_first_time_homebuyer_indicator": {
 "has_value": false
 },
 "has_bankruptcy_indicator": {
 "has_value": false
 },
 "has_age_of_bankruptcy_years_count": {
 "has_value": 0
 },
 "has_prior_property_foreclosure_completed_indicator": {
 "has_value": false
 },
 "has_age_of_prior_property_foreclosure_years_count": {
 "has_value": 0
 }
 }
 ],
 "credit_score_information": [
 {
 "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
 "@type": "credit_score_information",
 "has_credit_score": {
 "has_value": "850"
 }
 }
 ],
 "loans": [
 {
 "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
 "@type": "loan",
 "has_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": false
 },
 "has_loan_purpose_type": {
 "has_value": "purchase"
 },
 "has_refinance_type": {
 "has_value": "no_cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 150000
 },
 "has_interest_only_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_term_months_count": {
 "has_value": 0
 },
 "has_construction_loan_indicator": {
 "has_value": false
 },
 "has_buydown_indicator": {
 "has_value": true
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "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": 15
 },
 "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_rice_quote_request",
 "has_discount_points_percent": {
 "has_value": 0
 },
 "has_cash_out_amount": {
 "has_value": 0
 },
 "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_include_balloon_loans_indicator": {
 "has_value": false
 },
 "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": "false"
 },
 "has_project_usage_type": {
 "has_value": "false"
 },
 "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": "subject_property",
 "has_sales_contract_amount": {
 "has_value": 225000
 }
 }
 ],
 "property_valuations": [
 {
 "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
 "@type": "property_valuation",
 "has_property_valuation_amount": {
 "has_value": 225000
 }
 }
 ],
 "mortgage_products": [
 {
 "@id": "01FDTQGB9JWTYPBP9NNEDC7F9M",
 "@type": "Options",
 "has_partner_name": {
 "has_value": "Optimal Blue"
 }
 }
 ]
 },
 {
 "people": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYQ",
 "@type": "borrower",
 "has_first_name": {
 "has_value": "test"
 },
 "has_last_name": {
 "has_value": "test1"
 },
 "employed_as": [
 "01FDTQ5PGZWEG4M8PSR5T6TSYH"
 ],
 "with_declarations": [
 "01FDTQ5PH0KQ21KE0DR3FV16SW"
 ],
 "with_credit_risk": [
 "01FDTQ5PH1J05ESN8F3M8X03MD"
 ],
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 15
 }
 }
 ],
 "employment": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
 "@type": "employment",
 "has_self_employment_indicator": {
 "has_value": true
 }
 }
 ],
 "declarations": [
 {
 "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
 "@type": "declaration",
 "has_citizenship_residency_type": {
 "has_value": "us_citizen"
 },
 "has_borrower_first_time_homebuyer_indicator": {
 "has_value": false
 },
 "has_bankruptcy_indicator": {
 "has_value": false
 },
 "has_age_of_bankruptcy_years_count": {
 "has_value": 0
 },
 "has_prior_property_foreclosure_completed_indicator": {
 "has_value": false
 },
 "has_age_of_prior_property_foreclosure_years_count": {
 "has_value": 0
 }
 }
 ],
 "credit_score_information": [
 {
 "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
 "@type": "credit_score_information",
 "has_credit_score": {
 "has_value": "850"
 }
 }
 ],
 "loans": [
 {
 "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
 "@type": "loan",
 "has_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": false
 },
 "has_loan_purpose_type": {
 "has_value": "purchase"
 },
 "has_refinance_type": {
 "has_value": "no_cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 150000
 },
 "has_interest_only_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_term_months_count": {
 "has_value": 0
 },
 "has_construction_loan_indicator": {
 "has_value": false
 },
 "has_buydown_indicator": {
 "has_value": true
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "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": 15
 },
 "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_rice_quote_request",
 "has_discount_points_percent": {
 "has_value": 1
 },
 "has_cash_out_amount": {
 "has_value": 0
 },
 "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_include_balloon_loans_indicator": {
 "has_value": false
 },
 "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": "false"
 },
 "has_project_usage_type": {
 "has_value": "false"
 },
 "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": "subject_property",
 "has_sales_contract_amount": {
 "has_value": 225000
 }
 }
 ],
 "property_valuations": [
 {
 "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
 "@type": "property_valuation",
 "has_property_valuation_amount": {
 "has_value": 225000
 }
 }
 ],
 "mortgage_products": [
 {
 "@id": "01FDTQGB9JWTYPBP9NNEDC7F9M",
 "@type": "Options",
 "has_partner_name": {
 "has_value": "Optimal Blue"
 }
 }
 ]
 }
 ]
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Error

```
{
 "message": "Please provide one of valid return examples values:\ntrue, false"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Error

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "type": "string",
 "description": "Error Message."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
2
<!--/source-->

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

##### Response `200``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Request schema (possibly with examples) is successfully returned.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `schema`required | `object` | <!--source:api-specifications-->Schema for the Request Collection<!--/source--> |
| `examples` | `object` | <!--source:api-specifications-->Each item in the dictionary corresponds to the name of the example and dictionary content is the sample response.<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message.<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

`GET` `/products/pricing/response-schema`

<!--source:api-specifications-->

#### Retrieve Response Schema
<!--/source-->

`retrieveResponseSchema`

<!--source:api-specifications-->
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.

<!--/source-->

##### Response

<!--source:api-specifications-->
200 Schema200 Schema with Examples Response400 InvalidReturnExamplesValue400 text/html403404 GetProduct404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Response schema (possibly with examples) is successfully returned.

```
{
 "schema": {}
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Response schema (possibly with examples) is successfully returned.

```
{
 "schema": {},
 "examples": [
 {}
 ]
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Error

```
{
 "message": "Please provide one of valid return examples values:\ntrue, false"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Error

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "type": "string",
 "description": "Error Message."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
2
<!--/source-->

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

##### Response `200``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Response schema (possibly with examples) is successfully returned.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `schema`required | `object` | <!--source:api-specifications-->JSON-Schema as a single object<!--/source--> |
| `examples` | `object` | <!--source:api-specifications-->A key-value pair for the examples. Keys are the example names, while values correspond to the example values for the response collections you can retrieve.<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message.<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

<!--source:api-specifications-->

### Partners
<!--/source-->

`GET` `/products/pricing/partners`

<!--source:api-specifications-->

#### Retrieve Product Partners
<!--/source-->

`getVendors`

<!--source:api-specifications-->
Retrieve Partners retrieves:

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

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

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

<!--/source-->

##### Response

<!--source:api-specifications-->
200 Example1200 Example2400403404 GetProduct404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully retrieved product partners.

```
[
 {
 "Partner": "partner_name",
 "order": 1,
 "active": true,
 "status": "active",
 "verification_type": "borrower",
 "byoc": true
 }
]
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully retrieved product partners.

```
[
 {
 "Partner": "partner_name",
 "order": 1,
 "active": false,
 "status": "upcoming",
 "verification_type": "borrower",
 "byoc": true
 }
]
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "type": "string",
 "description": "Error Message."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
2
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `active` | `boolean` query | `false` | <!--source:api-specifications-->Include vendors with active product flows<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
6 fields
<!--/source-->
<!--source:api-specifications-->
Successfully retrieved product partners.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `partner` | `string` | <!--source:api-specifications-->Partner name<!--/source--> |
| `order` | `number` | <!--source:api-specifications-->Order of the product flows associated with this partner<!--/source--> |
| `active` | `boolean` | <!--source:api-specifications-->Partner has active flows<!--/source--> |
| `status` | `string` | <!--source:api-specifications-->Status of the partner<!--/source--> |
| `verification_type` | `string` | <!--source:api-specifications-->Type of verification<!--/source--> |
| `byoc` | `boolean` | <!--source:api-specifications-->Specify whether customer should add its own partner credentials or not<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message.<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

`PATCH` `/products/pricing/partners/{partner}/status`

<!--source:api-specifications-->

#### Update Partner Status
<!--/source-->

`updatePartnerStatus`

<!--source:api-specifications-->
Update Partner Status updates the active value of a specific partner to value true or false. This shall activate or deactivate the flows configured for this partner in Product Flows.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "active": true,
 "verification_type": "borrower",
 "byoc": true,
 "status": "active"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
200400 application/json400 text/html403404 GetProduct404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully updated active parameter for the partner.

```
{
 "message": "Partner status updated."
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Failed to update the partner from one of the reasons.

```
{
 "message": "Partner doesn't exist in database."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Failed to update the partner from one of the reasons.

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "type": "string",
 "description": "Error Message."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
2
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `partner` required | `string` path | `partner_name` | <!--source:api-specifications-->Name of the partner for which we wan't to update status.<!--/source--> |

##### Request body`application/json`

<!--source:api-specifications-->
4 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `active`required | `boolean` | Example `true` |
| `byoc` | `boolean` | <!--source:api-specifications-->Specify whether customer should add its own partner credentials or not<!--/source--> |
| `status` | `string` | <!--source:api-specifications-->Status of the vendor<!--/source--> |
| `verification_type` | `string` | <!--source:api-specifications-->Type of verification<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Successfully updated active parameter for the partner.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Partner status updated.<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Failed to update the partner from one of the reasons.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Partner doesn't exist in database.<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message.<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

<!--source:api-specifications-->

### Setup
<!--/source-->

`POST` `/setup/optimalBlue/credentials`

<!--source:api-specifications-->

#### Set OptimalBlue Credentials
<!--/source-->

`setOptimalBlueCredentials`

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

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "client_id": "--------",
 "client_secret": "<redacted>",
 "originator_id": "--------",
 "business_channel_id": "-------",
 "environment": "staging"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
200400403404422500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Setup API Triggered Successfully

```
{
 "message": "Credentials are saved and verified"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "code": 400,
 "message": "Bad Request"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Invalid key for service

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Invalid key for service

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Unprocessed Entity

```
{
 "code": 422,
 "message": "Unprocessed Entity."
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |

##### Request body`application/json`

<!--source:api-specifications-->
5 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `client_id`required | `string` | <!--source:api-specifications-->OptimalBlue client ID<!--/source--> |
| `client_secret`required | `string` | <!--source:api-specifications-->OptimalBlue client secret<!--/source--> |
| `originator_id` | `string` | <!--source:api-specifications-->OptimalBlue originator id<!--/source--> |
| `business_channel_id` | `string` | <!--source:api-specifications-->OptimalBlue business channel id<!--/source--> |
| `environment` | `string` | <!--source:api-specifications-->OptimalBlue environment selection<!--/source-->`production``staging` |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Setup API Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `404``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `422``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Unprocessed Entity
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |

`POST` `/setup/polly/credentials`

<!--source:api-specifications-->

#### Set polly Credentials
<!--/source-->

`setPollyCredentials`

<!--source:api-specifications-->
Set Polly Credentials
<!--/source-->

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

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "user_name": "--------",
 "password": "<redacted>",
 "domain": "https://api.stage.polly.io/",
 "client_id": "",
 "client_secret": "",
 "audienceId": ""
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
200400403404422500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Setup API Triggered Successfully

```
{
 "message": "Credentials are saved and verified"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "code": 400,
 "message": "Bad Request"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Invalid key for service

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Invalid key for service

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Unprocessed Entity

```
{
 "code": 422,
 "message": "Unprocessed Entity."
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |

##### Request body`application/json`

<!--source:api-specifications-->
6 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `user_name`required | `string` | <!--source:api-specifications-->Polly username<!--/source--> |
| `password`required | `string` | <!--source:api-specifications-->Polly password<!--/source--> |
| `domain`required | `string` | <!--source:api-specifications-->Polly API domain<!--/source--> |
| `client_id`required | `string` | <!--source:api-specifications-->Polly client ID<!--/source--> |
| `client_secret`required | `string` | <!--source:api-specifications-->Polly API client secret<!--/source--> |
| `audienceId`required | `string` | <!--source:api-specifications-->Polly audience ID<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Setup API Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `404``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `422``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Unprocessed Entity
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |

`GET` `/setup/{partner_name}/credentials`

<!--source:api-specifications-->

#### Retrieve Partner Credentials Schema
<!--/source-->

`getCredentials`

<!--source:api-specifications-->
Get Credentials Schema
<!--/source-->

<!--source:api-specifications-->
Get credentials schema for specific partner. You can use retrieved schema for updating the partner credentials.

<!--/source-->

##### Response

<!--source:api-specifications-->
400403404422500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "code": 400,
 "message": "Bad Request"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Invalid key for service

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Invalid key for service

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Unprocessed Entity

```
{
 "code": 422,
 "message": "Unprocessed Entity."
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
2
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `partner_name` required | `string` path | `optimalblue` | <!--source:api-specifications-->Partner name<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Create Adapter API Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `code` | `number` | <!--source:api-specifications-->Status code<!--/source--> |
| `message` | `object` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `404``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `422``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Unprocessed Entity
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |

<!--source:api-specifications-->

### Platform
<!--/source-->

`POST` `/transactions`

<!--source:api-specifications-->

#### Create Transaction
<!--/source-->

`createTransaction`

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

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

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

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Transaction created successfully

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Description |
| --- | --- | --- |
| `x-api-key` required | `string` header | <!--source:api-specifications-->Environment API Key.<!--/source--> |

##### Response `201``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Transaction created successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string (ulid)` | <!--source:api-specifications-->Staircase Transaction Identifier<!--/source-->Example `01F0KHK7DN3H5JZ4QJKMYAM6GB` |
| `created_at` | `string` | <!--source:api-specifications-->Staircase time string.<!--/source-->Example `03/03/2021, 8:24:04 AM EST` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

##### Other responses

`400`

`POST` `/transactions/{transaction_id}/collections`

<!--source:api-specifications-->

#### Create Collection
<!--/source-->

`createCollection`

<!--source:api-specifications-->
Create Collection creates a collection of data points required for product invocation. A collection contains a digital representation of the input or output data for the product and is identified by `collection_id`.

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

<!--/source-->

##### Request

<!--source:api-specifications-->
Request ExamplePreapproval Example
<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "data": {
 "vendor_name": "optimalBlue",
 "request_data": {
 "people": [
 {
 "@id": "01FDTQ5PJSKC94HHZGYZDSTXCT",
 "@type": "borrower",
 "has_first_name": {
 "has_value": "test"
 },
 "has_last_name": {
 "has_value": "test1"
 },
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 15
 },
 "employed_as": [
 "01FDTQ5PGZWEG4M8PSR5T6TSYH"
 ],
 "with_declaration": [
 "01FDTQ5PH0KQ21KE0DR3FV16SW"
 ],
 "with_credit_information": [
 "01G0F456KV2YVD0N168SD8QTGD"
 ]
 }
 ],
 "credit_information": [
 {
 "@id": "01G0F456KV2YVD0N168SD8QTGD",
 "@type": "credit_information",
 "has_credit_rating_code_type": {
 "has_value": "experian"
 },
 "has_credit_report_action_type": {
 "has_value": "submit"
 },
 "has_credit_report_first_issued_date": {
 "has_value": "2022-04-12"
 },
 "has_credit_report_identifier": {
 "has_value": "DF6VM5"
 },
 "has_credit_report_last_updated_date": {
 "has_value": "2022-04-12"
 },
 "has_credit_report_merge_type": {
 "has_value": "blend"
 },
 "has_credit_report_type": {
 "has_value": "merge"
 },
 "has_credit_request_type": {
 "has_value": "individual"
 },
 "with_credit_score_information": [
 "01FDTQ5PH1J05ESN8F3M8X03MD"
 ]
 }
 ],
 "employment": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
 "@type": "employment",
 "has_self_employment_indicator": {
 "has_value": true
 }
 }
 ],
 "declarations": [
 {
 "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
 "@type": "declaration",
 "has_citizenship_residency_type": {
 "has_value": "us_citizen"
 },
 "has_borrower_first_time_homebuyer_indicator": {
 "has_value": false
 },
 "has_bankruptcy_indicator": {
 "has_value": false
 },
 "has_age_of_bankruptcy_years_count": {
 "has_value": 0
 },
 "has_prior_property_foreclosure_completed_indicator": {
 "has_value": false
 },
 "has_age_of_prior_property_foreclosure_years_count": {
 "has_value": 0
 }
 }
 ],
 "credit_score_information": [
 {
 "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
 "@type": "credit_score_information",
 "has_credit_score": {
 "has_value": "850"
 }
 }
 ],
 "loans": [
 {
 "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
 "@type": "loan",
 "has_relocation_loan_indicator": {
 "has_value": false
 },
 "has_heloc_indicator": {
 "has_value": false
 },
 "with_borrower": [
 "01FDTQ5PJSKC94HHZGYZDSTXCT"
 ],
 "with_loan_terms": [
 "01FDTQ5PJTJBJZ777RCH7TDF5J"
 ],
 "with_documentation": [
 "01FDTQ5PJTMCWMQW9WYKSDT3FE"
 ],
 "with_summary": [
 "01FDTQ5PJVWPHV0MBGEMS6QHZZ"
 ],
 "with_payment_information": [
 "01FDTQ5PJXBVSW37ZTESFQWN4Y"
 ],
 "with_arm_adjustment": [
 "01FDTQ5PJXSBQYT5X7EAS4H31S"
 ],
 "with_insurance": [
 "01FDTQ5PJYNRA67MQEVTBZCRZ7"
 ],
 "with_project": [
 "01FKTQ5PKC2ZFKXBEH170VG0BJ"
 ],
 "serviced_by": [
 "01FDTQ5PKA5DVQ7F39HZK84H2R"
 ],
 "with_buydown": [
 "01FDTQ5PKBF5JHM46TQQEE3SAE"
 ],
 "with_quote_request": [
 "01FDTQ5PKBHV90N3GJ0PEK9TWD"
 ],
 "secured_by_property": [
 "01FDTQ5PKC4ZFKXBET140VG0BJ"
 ]
 }
 ],
 "loan_terms": [
 {
 "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
 "@type": "loan_terms",
 "has_mortgage_type": {
 "has_value": "conventional"
 },
 "has_pledged_assets_indicator": {
 "has_value": false
 },
 "has_escrow_required_indicator": {
 "has_value": true
 },
 "has_loan_purpose_type": {
 "has_value": "purchase"
 },
 "has_refinance_type": {
 "has_value": "no_cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 150000
 },
 "has_interest_only_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_term_months_count": {
 "has_value": 0
 },
 "has_construction_loan_indicator": {
 "has_value": false
 },
 "has_buydown_indicator": {
 "has_value": true
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "buydowns": [
 {
 "@id": "01FDTQ5PKBF5JHM46TQQEE3SAE",
 "@type": "buydown",
 "has_buydown_type": {
 "has_value": "one_one"
 }
 }
 ],
 "insurance": [
 {
 "@id": "01FDTQ5PJYNRA67MQEVTBZCRZ7",
 "@type": "mortgage_insurance",
 "has_mortgage_insurance_premium_source_type": {
 "has_value": "borrower"
 }
 }
 ],
 "loan_documentation": [
 {
 "@id": "01FDTQ5PJTMCWMQW9WYKSDT3FE",
 "@type": "loan_documentation",
 "has_asset_documentation_level_type": {
 "has_value": "stated_and_verified"
 },
 "has_employment_documentation_level_type": {
 "has_value": "stated_and_verified"
 },
 "has_income_documentation_level_type": {
 "has_value": "stated_and_verified"
 }
 }
 ],
 "loan_summaries": [
 {
 "@id": "01FDTQ5PJVWPHV0MBGEMS6QHZZ",
 "@type": "loan_summary",
 "has_total_debt_expense_to_income_dti_ratio": {
 "has_value": 18
 },
 "has_total_monthly_income_amount": {
 "has_value": 0
 },
 "has_projected_reserves_amount": {
 "has_value": 24
 },
 "has_representative_credit_score": {
 "has_value": 850
 }
 }
 ],
 "loan_payment_information": [
 {
 "@id": "01FDTQ5PJXBVSW37ZTESFQWN4Y",
 "@type": "loan_payment_information",
 "has_number_of_payments_30_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_60_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_90_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_120_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_rolling_12_months_late_count": {
 "has_value": 0
 }
 }
 ],
 "organizations": [
 {
 "@id": "01FDTQ5PKA5DVQ7F39HZK84H2R",
 "@type": "servicer"
 }
 ],
 "quote_requests": [
 {
 "@id": "01FDTQ5PKBHV90N3GJ0PEK9TWD",
 "@type": "loan_price_quote_request",
 "has_loan_officer_compensation_type": {
 "has_value": "yes_lender_paid"
 },
 "has_calculate_borrower_requested_loan_amount_indicator": {
 "has_value": true
 },
 "has_include_fixed_rate_amortization_loans_indicator": {
 "has_value": true
 },
 "has_include_adjustable_rate_amortization_loans_indicator": {
 "has_value": false
 },
 "has_include_payment_option_adjustable_rate_amortization_loans_indicator": {
 "has_value": false
 },
 "has_discount_points_percent": {
 "has_value": 0
 },
 "has_include_balloon_loans_indicator": {
 "has_value": false
 },
 "has_cash_out_amount": {
 "has_value": 0
 },
 "include_loans_with_amortization_term": [
 "01FDTQGB8WJHJC9YT32CQ1ESCC"
 ]
 }
 ],
 "quote_amortization_terms": [
 {
 "@id": "01FDTQGB8WJHJC9YT32CQ1ESCC",
 "@type": "quote_amortization_term",
 "has_amortization_term_months_count": {
 "has_value": 360
 }
 }
 ],
 "properties": [
 {
 "@id": "01FDTQ5PKC4ZFKXBET140VG0BJ",
 "@type": "subject_property",
 "has_property_usage_type": {
 "has_value": "primary_residence"
 },
 "has_number_of_units_type": {
 "has_value": "one"
 },
 "has_project_design_type": {
 "has_value": "midrise_project"
 },
 "has_manufactured_home_indicator": {
 "has_value": false
 },
 "has_planned_unit_development_pud_indicator": {
 "has_value": false
 },
 "has_manufactured_home_width_type": {
 "has_value": "single_wide"
 },
 "has_project_usage_type": {
 "has_value": "string"
 },
 "has_financed_unit_count": {
 "has_value": 1
 },
 "has_non_warrantable_project_indicator": {
 "has_value": false
 },
 "has_stories_count": {
 "has_value": 1
 },
 "has_construction_method_type": {
 "has_value": "site_built"
 },
 "with_address": [
 "01FDTQGB9EV6FKWGZ2CY35971G"
 ],
 "with_sales_contract": [
 "01FDTQGB9EPKV6EJXZMTW0CGV0"
 ],
 "with_value": [
 "01FDTQGB9FVMF9YTFBTX95D2KH"
 ]
 }
 ],
 "projects": [
 {
 "@id": "01FKTQ5PKC2ZFKXBEH170VG0BJ",
 "@type": "project",
 "has_project_legal_structure_type": {
 "has_value": "condominium"
 }
 }
 ],
 "addresses": [
 {
 "@id": "01FDTQGB9EV6FKWGZ2CY35971G",
 "@type": "residential_address",
 "has_address_line_1_text": {
 "has_value": "string"
 },
 "has_county_name": {
 "has_value": "Collin"
 },
 "has_state_code": {
 "has_value": "TX"
 },
 "has_postal_code": {
 "has_value": "75024"
 }
 }
 ],
 "sales_contracts": [
 {
 "@id": "01FDTQGB9EPKV6EJXZMTW0CGV0",
 "@type": "property_sales_contract",
 "has_sales_contract_amount": {
 "has_value": 225000
 }
 }
 ],
 "property_valuations": [
 {
 "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
 "@type": "property_valuation",
 "has_property_valuation_amount": {
 "has_value": 225000
 }
 }
 ]
 }
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "data": {
 "underwritings": [
 {
 "@id": "1",
 "@type": "underwriting",
 "with_automated_underwriting": [
 "01G0F46DMPX9DA9SYW9MD469S1"
 ]
 }
 ],
 "loans": [
 {
 "@id": "01G0F46DMPHNWM8TWMGJQRJW5Y",
 "@type": "loan",
 "has_relocation_loan_indicator": {
 "has_value": false
 },
 "has_heloc_indicator": {
 "has_value": false
 },
 "has_originator_loan_identifier": {
 "has_value": "01G0F436Y4B8Z97ZZCX4PDENMF"
 },
 "with_payment_information": [
 "loan_payment_information"
 ],
 "has_loan_status_type": {
 "has_value": "prequalification"
 },
 "has_loan_role_type": {
 "has_value": "subject_loan"
 },
 "with_underwriting": [
 "1"
 ],
 "with_arm_adjustment": [
 "01G0F46DMPRTYR25HZZCWH0EMX"
 ],
 "with_documentation": [
 "01G0F46DMPWS3BHQZM14C8KFVH"
 ],
 "with_insurance": [
 "01G0F46DMP72CMBWKC10X0PPDC"
 ],
 "with_project": [
 "01FKTQ5PKC2ZFKXBEH170VG0BJ"
 ],
 "with_loan_terms": [
 "01G0F46DMPQ9680F59JE7QETN1"
 ],
 "serviced_by": [
 "01G0F46DMPNP1Z0PD6B98BN92S"
 ],
 "with_summary": [
 "01G0F46DMP778HBQW874FV3RFR"
 ],
 "with_quote_request": [
 "01G0F46DMP1A0WN0T89KDRKF5A"
 ],
 "with_buydown": [
 "01G0F46DMPWPA5VM805MXSH2KG"
 ],
 "secured_by_property": [
 "01G0F46DMPE0NJZ7XGRSZJEPM0"
 ],
 "with_borrower": [
 "01G0F43BRK1SAPR67KC0J1NVQB"
 ]
 }
 ],
 "loan_payment_information": [
 {
 "@id": "loan_payment_information",
 "@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
 }
 }
 ],
 "loan_summaries": [
 {
 "@id": "01G0F46DMP778HBQW874FV3RFR",
 "@type": "loan_summary",
 "has_total_debt_expense_to_income_dti_ratio": {
 "has_value": 27
 },
 "has_total_monthly_income_amount": {
 "has_value": 7500
 },
 "has_projected_reserves_amount": {
 "has_value": 24
 },
 "has_representative_credit_score": {
 "has_value": 743
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01G0F46DMPRTYR25HZZCWH0EMX",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "insurance": [
 {
 "@id": "01G0F46DMP72CMBWKC10X0PPDC",
 "@type": "mortgage_insurance",
 "has_mortgage_insurance_premium_source_type": {
 "has_value": "borrower"
 }
 }
 ],
 "loan_documentation": [
 {
 "@id": "01G0F46DMPWS3BHQZM14C8KFVH",
 "@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"
 }
 }
 ],
 "automated_underwritings": [
 {
 "@id": "01G0F46DMPX9DA9SYW9MD469S1",
 "@type": "automated_underwriting",
 "has_desktop_underwriter_recommendation_type": {
 "has_value": "out_of_scope"
 }
 }
 ],
 "loan_terms": [
 {
 "@id": "01G0F46DMPQ9680F59JE7QETN1",
 "@type": "loan_terms",
 "has_pledged_assets_indicator": {
 "has_value": false
 },
 "has_escrow_required_indicator": {
 "has_value": true
 },
 "has_loan_purpose_type": {
 "has_value": "purchase"
 },
 "has_refinance_type": {
 "has_value": "no_cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 50000
 },
 "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": false
 },
 "has_mortgage_type": {
 "has_value": "conventional"
 }
 }
 ],
 "buydowns": [
 {
 "@id": "01G0F46DMPWPA5VM805MXSH2KG",
 "@type": "buydown",
 "has_buydown_type": {
 "has_value": "one_zero"
 }
 }
 ],
 "mortgage_products": [
 {
 "@id": "01G0F46DMQZZHDGDN4X8GMTKET",
 "@type": "pricing",
 "has_partner_name": {
 "has_value": "Optimal Blue"
 }
 },
 {
 "@id": "01G0F46DMQ6NBC8PC4FPKP5QE7",
 "@type": "automated_underwriting_system",
 "has_credit_report_vendor_identifier": {
 "has_value": ""
 }
 },
 {
 "@id": "01G0F456JR9HV6FFQ38NG63W8T",
 "@type": "credit"
 }
 ],
 "organizations": [
 {
 "@id": "01G0F46DMPNP1Z0PD6B98BN92S",
 "@type": "servicer"
 },
 {
 "@id": "01G0F43BRKFYQ6J0K5GJRYF2JB",
 "@type": "organization",
 "has_organization_name": {
 "has_value": "Amazon"
 }
 },
 {
 "@id": "01G0F43BRK89FAZDRJZDC5DX0K",
 "@type": "customer",
 "has_transaction_identifier": {
 "has_value": "01G0F436Y4B8Z97ZZCX4PDENMF"
 }
 }
 ],
 "quote_requests": [
 {
 "@id": "01G0F46DMP1A0WN0T89KDRKF5A",
 "@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_include_balloon_loans_indicator": {
 "has_value": false
 },
 "include_loans_with_amortization_term": [
 "01G0F46DMQRJJ7VVS4Y038BKNX"
 ]
 }
 ],
 "quote_amortization_terms": [
 {
 "@id": "01G0F46DMQRJJ7VVS4Y038BKNX",
 "@type": "quote_amortization_term",
 "has_amortization_term_months_count": {
 "has_value": 360
 }
 }
 ],
 "properties": [
 {
 "@id": "01G0F46DMPE0NJZ7XGRSZJEPM0",
 "@type": "subject_property",
 "has_construction_method_type": {
 "has_value": "site_built"
 },
 "has_non_warrantable_project_indicator": {
 "has_value": false
 },
 "has_property_usage_type": {
 "has_value": "primary_residence"
 },
 "has_number_of_units_type": {
 "has_value": "one"
 },
 "has_project_design_type": {
 "has_value": "midrise_project"
 },
 "has_manufactured_home_indicator": {
 "has_value": false
 },
 "has_planned_unit_development_pud_indicator": {
 "has_value": false
 },
 "has_manufactured_home_width_type": {
 "has_value": "single_wide"
 },
 "has_project_usage_type": {
 "has_value": "other"
 },
 "has_stories_count": {
 "has_value": 1
 },
 "has_financed_unit_count": {
 "has_value": 1
 },
 "has_property_in_project_indicator": {
 "has_value": false
 },
 "with_address": [
 "01G0F46DMPB9Y8YNQN8BY1AZ1F"
 ],
 "with_sales_contract": [
 "01G0F46DMQYRE9H69KXTEFW8KK"
 ],
 "with_value": [
 "01G0F46DMQ917ABYDMNHH8BR61"
 ]
 }
 ],
 "projects": [
 {
 "@id": "01FKTQ5PKC2ZFKXBEH170VG0BJ",
 "@type": "project",
 "has_project_legal_structure_type": {
 "has_value": "condominium"
 }
 }
 ],
 "addresses": [
 {
 "@id": "01G0F46DMPB9Y8YNQN8BY1AZ1F",
 "@type": "residential_address",
 "has_county_name": {
 "has_value": "Fort Bend"
 },
 "has_state_code": {
 "has_value": "TX"
 }
 },
 {
 "@id": "01G0F43BRJB7S9ZSS0Q4AXN357",
 "@type": "address",
 "has_address_line_1_text": {
 "has_value": "126 4th St"
 },
 "has_address_line_2_text": {
 "has_value": ""
 },
 "has_city_name": {
 "has_value": "Atlanta"
 },
 "has_country_name": {
 "has_value": "US"
 },
 "has_postal_code": {
 "has_value": "30014"
 },
 "has_state_code": {
 "has_value": "GA"
 }
 },
 {
 "@id": "01G0F456PEEXG5XWXDFNW8H5XY",
 "@type": "residential_address",
 "has_address_line_1_text": {
 "has_value": "126 4TH ST"
 },
 "has_city_name": {
 "has_value": "ATLANTA"
 },
 "has_postal_code": {
 "has_value": "30014"
 },
 "has_state_code": {
 "has_value": "GA"
 }
 }
 ],
 "sales_contracts": [
 {
 "@id": "01G0F46DMQYRE9H69KXTEFW8KK",
 "@type": "property_sales_contract",
 "has_sales_contract_amount": {
 "has_value": 500000
 }
 }
 ],
 "property_valuations": [
 {
 "@id": "01G0F46DMQ917ABYDMNHH8BR61",
 "@type": "property_valuation",
 "has_property_valuation_amount": {
 "has_value": 500000
 }
 }
 ],
 "assets": [
 {
 "@id": "01G0F43ERM91FT0DTAQ1J8FME3",
 "@type": "checking_account",
 "has_market_value_amount": {
 "has_value": 10000
 },
 "owned_by": [
 "01G0F43BRK1SAPR67KC0J1NVQB"
 ]
 }
 ],
 "contact_information": [
 {
 "@id": "01G0F43BRKGVC0X90BH7S6E8S0",
 "@type": "contact_information",
 "has_email_address": {
 "has_value": "test@email.com"
 },
 "has_phone_number": {
 "has_value": "1231231232"
 }
 }
 ],
 "credit_information": [
 {
 "@id": "01G0F456KV2YVD0N168SD8QTGD",
 "@type": "credit_information",
 "has_credit_rating_code_type": {
 "has_value": "experian"
 },
 "has_credit_report_action_type": {
 "has_value": "submit"
 },
 "has_credit_report_first_issued_date": {
 "has_value": "2022-04-12"
 },
 "has_credit_report_identifier": {
 "has_value": "DF6VM5"
 },
 "has_credit_report_last_updated_date": {
 "has_value": "2022-04-12"
 },
 "has_credit_report_merge_type": {
 "has_value": "blend"
 },
 "has_credit_report_type": {
 "has_value": "merge"
 },
 "has_credit_request_type": {
 "has_value": "individual"
 },
 "with_credit_score_information": [
 "01G0F456QKHJP096X9CH9H0QAZ"
 ]
 }
 ],
 "credit_score_factors": [
 {
 "@id": "01G0F45MHVRFPK6245AJ68T9MZ",
 "@type": "credit_score_factor",
 "has_credit_score_factor_code": {
 "has_value": "00030"
 },
 "has_credit_score_factor_text": {
 "has_value": "TIME SINCE MOST RECENT ACCOUNT OPENING IS TOO SHORT"
 }
 },
 {
 "@id": "01G0F45MHW2W46K8E0TTE3CC86",
 "@type": "credit_score_factor",
 "has_credit_score_factor_code": {
 "has_value": "00014"
 },
 "has_credit_score_factor_text": {
 "has_value": "LENGTH OF TIME ACCOUNTS HAVE BEEN ESTABLISHED"
 }
 },
 {
 "@id": "01G0F45MHWNRX3YABMXWX8QHE1",
 "@type": "credit_score_factor",
 "has_credit_score_factor_code": {
 "has_value": 8
 },
 "has_credit_score_factor_text": {
 "has_value": "TOO MANY INQUIRIES LAST 12 MONTHS"
 }
 },
 {
 "@id": "01G0F45MHW9J9AR4T56XX2B6HK",
 "@type": "credit_score_factor",
 "has_credit_score_factor_code": {
 "has_value": "00012"
 },
 "has_credit_score_factor_text": {
 "has_value": "LENGTH OF TIME REVOLVING ACCOUNTS HAVE BEEN ESTABLISHED"
 }
 }
 ],
 "credit_score_information": [
 {
 "@id": "01G0F456QKHJP096X9CH9H0QAZ",
 "@type": "credit_score_information",
 "has_credit_report_identifier": {
 "has_value": "DF6VM5"
 },
 "has_credit_score": {
 "has_value": "00743"
 }
 }
 ],
 "declarations": [
 {
 "@id": "01G0F43BRKNQKR7P36ZT59T2YX",
 "@type": "declaration",
 "has_citizenship_residency_type": {
 "has_value": "us_citizen"
 },
 "has_intent_to_occupy_indicator": {
 "has_value": true
 },
 "has_prior_property_foreclosure_completed_indicator": {
 "has_value": false
 }
 }
 ],
 "documents": [
 {
 "@id": "01G0F45MHWAWZKFCZHT7RCFR5B",
 "@type": "credit_report",
 "has_staircase_blob_identifier": {
 "has_value": "01G0F450M9J09JRC2G6CFAVMX8"
 }
 }
 ],
 "employment": [
 {
 "@id": "01G0F43BRMG882TMY5F8S50GY8",
 "@type": "employment",
 "has_self_employment_indicator": {
 "has_value": false
 },
 "provided_by": [
 "01G0F43BRKFYQ6J0K5GJRYF2JB"
 ]
 }
 ],
 "housing_expenses_deprecated": [
 {
 "@id": "01G0F43BRK4Z2GDQPHBJNSZS1M",
 "@type": "housing_expenses_deprecated",
 "has_present_first_mortgage_principal_and_interest_monthly_amount": {
 "has_value": 0
 },
 "has_present_first_mortgage_principal_interest_taxes_and_insurance_piti_monthly_amount": {
 "has_value": 0
 },
 "has_present_flood_insurance_monthly_amount": {
 "has_value": 0
 },
 "has_present_homeowners_association_dues_and_condominium_fees_monthly_amount": {
 "has_value": 0
 },
 "has_present_homeowners_insurance_monthly_amount": {
 "has_value": 0
 },
 "has_present_mortgage_insurance_monthly_amount": {
 "has_value": 0
 },
 "has_present_other_mortgage_loan_principal_and_interest_monthly_amount": {
 "has_value": 0
 },
 "has_present_other_mortgage_loan_principal_interest_taxes_and_insurance_monthly_amount": {
 "has_value": 0
 },
 "has_present_property_tax_monthly_amount": {
 "has_value": 0
 },
 "has_present_supplemental_property_insurance_monthly_amount": {
 "has_value": 0
 },
 "has_present_total_monthly_payment_amount": {
 "has_value": 0
 }
 }
 ],
 "income": [
 {
 "@id": "01G0F43DJT2A15SH870HJ2K5EX",
 "@type": "employment_income",
 "has_income_amount": {
 "has_value": 7500
 },
 "has_income_pay_frequency_type": {
 "has_value": "monthly"
 }
 },
 {
 "@id": "01G0F43DJTH8BHZGVS31GBFSKV",
 "@type": "employment_income",
 "has_income_amount": {
 "has_value": 90000
 },
 "has_income_year": {
 "has_value": "2022"
 }
 }
 ],
 "liabilities": [
 {
 "@id": "01G0F43BRK7WTG1SSEEJG143CF",
 "@type": "liability",
 "has_liability_payment_amount": {
 "has_value": 2000
 },
 "has_liability_unpaid_balance_amount": {
 "has_value": 2000
 }
 }
 ],
 "people": [
 {
 "@id": "01G0F43BRK1SAPR67KC0J1NVQB",
 "@type": "borrower",
 "contact_at": [
 "01G0F43BRKGVC0X90BH7S6E8S0"
 ],
 "earns": [
 "01G0F43DJTH8BHZGVS31GBFSKV",
 "01G0F43DJT2A15SH870HJ2K5EX"
 ],
 "has_birth_date": {
 "has_value": "1958-12-12"
 },
 "has_first_name": {
 "has_value": "DAD"
 },
 "has_last_name": {
 "has_value": "FIRSTIMER"
 },
 "has_marital_status_type": {
 "has_value": "unmarried"
 },
 "has_taxpayer_identifier_type": {
 "has_value": "individual_taxpayer_identification_number"
 },
 "has_taxpayer_identifier_value": {
 "has_value": "000-000-001"
 },
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 25
 },
 "lives_at": [
 "01G0F43BRKGDPCT3N1BHVVXPJ1"
 ],
 "owes_liability": [
 "01G0F43BRK7WTG1SSEEJG143CF"
 ],
 "owns_asset": [
 "01G0F43ERM91FT0DTAQ1J8FME3"
 ],
 "with_address": [
 "01G0F43BRJB7S9ZSS0Q4AXN357"
 ],
 "with_credit_information": [
 "01G0F456KV2YVD0N168SD8QTGD"
 ],
 "with_declaration": [
 "01G0F43BRKNQKR7P36ZT59T2YX"
 ],
 "works_for": [
 "01G0F43BRKFYQ6J0K5GJRYF2JB"
 ],
 "employed_as": [
 "01G0F43BRMG882TMY5F8S50GY8"
 ]
 }
 ],
 "residences": [
 {
 "@id": "01G0F43BRKGDPCT3N1BHVVXPJ1",
 "@type": "residence",
 "has_borrower_residency_type": {
 "has_value": "current"
 },
 "has_residency_basis_type": {
 "has_value": "living_rent_free"
 },
 "has_residency_duration_months_count": {
 "has_value": 30
 },
 "with_address": [
 "01G0F43BRJB7S9ZSS0Q4AXN357"
 ]
 }
 ]
 }
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201400 CreateCollectionError400 text/html403404 CreateCollectionError404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Collection created successfully

```
{
 "transaction_id": "01F0KHK7DN3H5JZ4QJKMYAM6GB",
 "collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN",
 "metadata": {
 "created_at": "2021-09-14T03:08:00.284090-04:00",
 "validation": false
 },
 "data": {
 "vendor_name": "optimalBlue",
 "request_data": {
 "people": [
 {
 "@id": "01FDTQ5PJSKC94HHZGYZDSTXCT",
 "@type": "borrower",
 "has_first_name": {
 "has_value": "test"
 },
 "has_last_name": {
 "has_value": "test1"
 },
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 15
 },
 "employed_as": [
 "01FDTQ5PGZWEG4M8PSR5T6TSYH"
 ],
 "with_declaration": [
 "01FDTQ5PH0KQ21KE0DR3FV16SW"
 ],
 "with_credit_information": [
 "01G0F456KV2YVD0N168SD8QTGD"
 ]
 }
 ],
 "credit_information": [
 {
 "@id": "01G0F456KV2YVD0N168SD8QTGD",
 "@type": "credit_information",
 "has_credit_rating_code_type": {
 "has_value": "experian"
 },
 "has_credit_report_action_type": {
 "has_value": "submit"
 },
 "has_credit_report_first_issued_date": {
 "has_value": "2022-04-12"
 },
 "has_credit_report_identifier": {
 "has_value": "DF6VM5"
 },
 "has_credit_report_last_updated_date": {
 "has_value": "2022-04-12"
 },
 "has_credit_report_merge_type": {
 "has_value": "blend"
 },
 "has_credit_report_type": {
 "has_value": "merge"
 },
 "has_credit_request_type": {
 "has_value": "individual"
 },
 "with_credit_score_information": [
 "01FDTQ5PH1J05ESN8F3M8X03MD"
 ]
 }
 ],
 "employment": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
 "@type": "employment",
 "has_self_employment_indicator": {
 "has_value": true
 }
 }
 ],
 "declarations": [
 {
 "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
 "@type": "declaration",
 "has_citizenship_residency_type": {
 "has_value": "us_citizen"
 },
 "has_borrower_first_time_homebuyer_indicator": {
 "has_value": false
 },
 "has_bankruptcy_indicator": {
 "has_value": false
 },
 "has_age_of_bankruptcy_years_count": {
 "has_value": 0
 },
 "has_prior_property_foreclosure_completed_indicator": {
 "has_value": false
 },
 "has_age_of_prior_property_foreclosure_years_count": {
 "has_value": 0
 }
 }
 ],
 "credit_score_information": [
 {
 "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
 "@type": "credit_score_information",
 "has_credit_score": {
 "has_value": "850"
 }
 }
 ],
 "loans": [
 {
 "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
 "@type": "loan",
 "has_relocation_loan_indicator": {
 "has_value": false
 },
 "has_heloc_indicator": {
 "has_value": false
 },
 "with_borrower": [
 "01FDTQ5PJSKC94HHZGYZDSTXCT"
 ],
 "with_loan_terms": [
 "01FDTQ5PJTJBJZ777RCH7TDF5J"
 ],
 "with_documentation": [
 "01FDTQ5PJTMCWMQW9WYKSDT3FE"
 ],
 "with_summary": [
 "01FDTQ5PJVWPHV0MBGEMS6QHZZ"
 ],
 "with_payment_information": [
 "01FDTQ5PJXBVSW37ZTESFQWN4Y"
 ],
 "with_arm_adjustment": [
 "01FDTQ5PJXSBQYT5X7EAS4H31S"
 ],
 "with_insurance": [
 "01FDTQ5PJYNRA67MQEVTBZCRZ7"
 ],
 "with_project": [
 "01FKTQ5PKC2ZFKXBEH170VG0BJ"
 ],
 "serviced_by": [
 "01FDTQ5PKA5DVQ7F39HZK84H2R"
 ],
 "with_buydown": [
 "01FDTQ5PKBF5JHM46TQQEE3SAE"
 ],
 "with_quote_request": [
 "01FDTQ5PKBHV90N3GJ0PEK9TWD"
 ],
 "secured_by_property": [
 "01FDTQ5PKC4ZFKXBET140VG0BJ"
 ]
 }
 ],
 "loan_terms": [
 {
 "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
 "@type": "loan_terms",
 "has_mortgage_type": {
 "has_value": "conventional"
 },
 "has_pledged_assets_indicator": {
 "has_value": false
 },
 "has_escrow_required_indicator": {
 "has_value": true
 },
 "has_loan_purpose_type": {
 "has_value": "purchase"
 },
 "has_refinance_type": {
 "has_value": "no_cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 150000
 },
 "has_interest_only_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_term_months_count": {
 "has_value": 0
 },
 "has_construction_loan_indicator": {
 "has_value": false
 },
 "has_buydown_indicator": {
 "has_value": true
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "buydowns": [
 {
 "@id": "01FDTQ5PKBF5JHM46TQQEE3SAE",
 "@type": "buydown",
 "has_buydown_type": {
 "has_value": "one_one"
 }
 }
 ],
 "insurance": [
 {
 "@id": "01FDTQ5PJYNRA67MQEVTBZCRZ7",
 "@type": "mortgage_insurance",
 "has_mortgage_insurance_premium_source_type": {
 "has_value": "borrower"
 }
 }
 ],
 "loan_documentation": [
 {
 "@id": "01FDTQ5PJTMCWMQW9WYKSDT3FE",
 "@type": "loan_documentation",
 "has_asset_documentation_level_type": {
 "has_value": "stated_and_verified"
 },
 "has_employment_documentation_level_type": {
 "has_value": "stated_and_verified"
 },
 "has_income_documentation_level_type": {
 "has_value": "stated_and_verified"
 }
 }
 ],
 "loan_summaries": [
 {
 "@id": "01FDTQ5PJVWPHV0MBGEMS6QHZZ",
 "@type": "loan_summary",
 "has_total_debt_expense_to_income_dti_ratio": {
 "has_value": 18
 },
 "has_total_monthly_income_amount": {
 "has_value": 0
 },
 "has_projected_reserves_amount": {
 "has_value": 24
 },
 "has_representative_credit_score": {
 "has_value": 850
 }
 }
 ],
 "loan_payment_information": [
 {
 "@id": "01FDTQ5PJXBVSW37ZTESFQWN4Y",
 "@type": "loan_payment_information",
 "has_number_of_payments_30_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_60_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_90_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_120_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_rolling_12_months_late_count": {
 "has_value": 0
 }
 }
 ],
 "organizations": [
 {
 "@id": "01FDTQ5PKA5DVQ7F39HZK84H2R",
 "@type": "servicer"
 }
 ],
 "quote_requests": [
 {
 "@id": "01FDTQ5PKBHV90N3GJ0PEK9TWD",
 "@type": "loan_price_quote_request",
 "has_loan_officer_compensation_type": {
 "has_value": "yes_lender_paid"
 },
 "has_calculate_borrower_requested_loan_amount_indicator": {
 "has_value": true
 },
 "has_include_fixed_rate_amortization_loans_indicator": {
 "has_value": true
 },
 "has_include_adjustable_rate_amortization_loans_indicator": {
 "has_value": false
 },
 "has_include_payment_option_adjustable_rate_amortization_loans_indicator": {
 "has_value": false
 },
 "has_discount_points_percent": {
 "has_value": 0
 },
 "has_include_balloon_loans_indicator": {
 "has_value": false
 },
 "has_cash_out_amount": {
 "has_value": 0
 },
 "include_loans_with_amortization_term": [
 "01FDTQGB8WJHJC9YT32CQ1ESCC"
 ]
 }
 ],
 "quote_amortization_terms": [
 {
 "@id": "01FDTQGB8WJHJC9YT32CQ1ESCC",
 "@type": "quote_amortization_term",
 "has_amortization_term_months_count": {
 "has_value": 360
 }
 }
 ],
 "properties": [
 {
 "@id": "01FDTQ5PKC4ZFKXBET140VG0BJ",
 "@type": "subject_property",
 "has_property_usage_type": {
 "has_value": "primary_residence"
 },
 "has_number_of_units_type": {
 "has_value": "one"
 },
 "has_project_design_type": {
 "has_value": "midrise_project"
 },
 "has_manufactured_home_indicator": {
 "has_value": false
 },
 "has_planned_unit_development_pud_indicator": {
 "has_value": false
 },
 "has_manufactured_home_width_type": {
 "has_value": "single_wide"
 },
 "has_project_usage_type": {
 "has_value": "string"
 },
 "has_financed_unit_count": {
 "has_value": 1
 },
 "has_non_warrantable_project_indicator": {
 "has_value": false
 },
 "has_stories_count": {
 "has_value": 1
 },
 "has_construction_method_type": {
 "has_value": "site_built"
 },
 "with_address": [
 "01FDTQGB9EV6FKWGZ2CY35971G"
 ],
 "with_sales_contract": [
 "01FDTQGB9EPKV6EJXZMTW0CGV0"
 ],
 "with_value": [
 "01FDTQGB9FVMF9YTFBTX95D2KH"
 ]
 }
 ],
 "projects": [
 {
 "@id": "01FKTQ5PKC2ZFKXBEH170VG0BJ",
 "@type": "project",
 "has_project_legal_structure_type": {
 "has_value": "condominium"
 }
 }
 ],
 "addresses": [
 {
 "@id": "01FDTQGB9EV6FKWGZ2CY35971G",
 "@type": "residential_address",
 "has_address_line_1_text": {
 "has_value": "string"
 },
 "has_county_name": {
 "has_value": "Collin"
 },
 "has_state_code": {
 "has_value": "TX"
 },
 "has_postal_code": {
 "has_value": "75024"
 }
 }
 ],
 "sales_contracts": [
 {
 "@id": "01FDTQGB9EPKV6EJXZMTW0CGV0",
 "@type": "property_sales_contract",
 "has_sales_contract_amount": {
 "has_value": 225000
 }
 }
 ],
 "property_valuations": [
 {
 "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
 "@type": "property_valuation",
 "has_property_valuation_amount": {
 "has_value": 225000
 }
 }
 ]
 }
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Error

```
{
 "message": "Unable to create collection. Please check the collectionchr\ndata"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Error

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "message": "Unable to create collection. Please check the transaction\nID."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
2
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | <!--source:api-specifications-->Staircase Transaction Identifier<!--/source--> |

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | <!--source:api-specifications-->The data that is needed for invocation. It should follow the request schema<!--/source--> |
| `people` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_first_name`required | `object` | — |
| `has_value`required | `string` | — |
| `has_last_name`required | `object` | — |
| `has_value`required | `string` | — |
| `has_debt_expense_to_income_dti_ratio`required | `object` | — |
| `has_value`required | `number` | — |
| `employed_as`required | `string[]` | — |
| `with_declaration`required | `string[]` | — |
| `with_credit_information`required | `string[]` | — |
| `employment` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_self_employment_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `declarations`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_citizenship_residency_type`required | `object` | — |
| `has_value`required | `string` | `non_permanent_resident_alien``non_resident_alien``permanent_resident_alien``us_citizen` |
| `has_borrower_first_time_homebuyer_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_bankruptcy_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_age_of_bankruptcy_years_count` | `object` | — |
| `has_value`required | `integer` | — |
| `has_prior_property_foreclosure_completed_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_age_of_prior_property_foreclosure_years_count` | `object` | — |
| `has_value`required | `integer` | — |
| `credit_score_information` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_credit_score`required | `object` | — |
| `has_value`required | `string` | — |
| `loans`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_relocation_loan_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `with_borrower`required | `string[]` | — |
| `with_loan_terms`required | `string[]` | — |
| `with_documentation`required | `string[]` | — |
| `with_summary`required | `string[]` | — |
| `with_payment_information`required | `string[]` | — |
| `with_arm_adjustment`required | `string[]` | — |
| `with_insurance`required | `string[]` | — |
| `with_project`required | `string[]` | — |
| `serviced_by`required | `string[]` | — |
| `with_buydown`required | `string[]` | — |
| `with_quote_request`required | `string[]` | — |
| `secured_by_property`required | `string[]` | — |
| `has_heloc_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `loan_terms`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_pledged_assets_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_mortgage_type`required | `object` | — |
| `has_value`required | `string` | `conventional``fha``local_agency``other``public_and_indian_housing``state_agency``usda-rd``va` |
| `has_escrow_required_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_loan_purpose_type`required | `object` | — |
| `has_value`required | `string` | `other``purchase``refinance` |
| `has_refinance_type`required | `object` | — |
| `has_value`required | `string` | `cash_out``limited_cash_out``no_cash_out` |
| `has_lien_position_type`required | `object` | — |
| `has_value`required | `string` | `first_lien``second_lien``subordinate_lien` |
| `has_base_loan_amount`required | `object` | — |
| `has_value`required | `number` | — |
| `has_interest_only_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_prepayment_penalty_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_prepayment_penalty_term_months_count`required | `object` | — |
| `has_value`required | `integer` | — |
| `has_construction_loan_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_buydown_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `arm_adjustments` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_first_rate_adjustment_months_count`required | `object` | — |
| `has_value`required | `integer` | — |
| `buydowns`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_buydown_type`required | `object` | — |
| `has_value`required | `string` | `one_one``one_zero``three``two_one` |
| `insurance`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_mortgage_insurance_premium_source_type`required | `object` | — |
| `has_value`required | `string` | `borrower``lender` |
| `loan_documentation`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_asset_documentation_level_type`required | `object` | — |
| `has_value`required | `string` | `neither_stated_nor_verified``not_required``stated_and_verified``stated_only` |
| `has_employment_documentation_level_type`required | `object` | — |
| `has_value`required | `string` | `neither_stated_nor_verified``not_required``stated_and_verified``stated_only` |
| `has_income_documentation_level_type`required | `object` | — |
| `has_value`required | `string` | `neither_stated_nor_verified``not_required``stated_and_verified``stated_only` |
| `loan_summaries`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_total_debt_expense_to_income_dti_ratio`required | `object` | — |
| `has_value`required | `number` | — |
| `has_total_monthly_income_amount` | `object` | — |
| `has_value`required | `number` | — |
| `has_projected_reserves_amount` | `object` | — |
| `has_value`required | `number` | — |
| `has_representative_credit_score`required | `object` | — |
| `has_value`required | `integer` | — |
| `loan_payment_information` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_number_of_payments_30_days_late_count` | `object` | — |
| `has_value`required | `integer` | — |
| `has_number_of_payments_60_days_late_count` | `object` | — |
| `has_value`required | `integer` | — |
| `has_number_of_payments_90_days_late_count` | `object` | — |
| `has_value`required | `integer` | — |
| `has_number_of_payments_120_days_late_count` | `object` | — |
| `has_value`required | `integer` | — |
| `has_number_of_payments_rolling_12_months_late_count` | `object` | — |
| `has_value`required | `integer` | — |
| `organizations` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_organization_name` | `object` | — |
| `has_value`required | `string` | — |
| `quote_requests`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_loan_officer_compensation_type`required | `object` | — |
| `has_value`required | `string` | `no_buyer_paid``no_lender_paid``yes_lender_paid` |
| `has_calculate_borrower_requested_loan_amount_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_include_fixed_rate_amortization_loans_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_include_adjustable_rate_amortization_loans_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_include_payment_option_adjustable_rate_amortization_loans_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_discount_points_percent` | `object` | — |
| `has_value`required | `number` | — |
| `has_include_balloon_loans_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_cash_out_amount` | `object` | — |
| `has_value`required | `number` | — |
| `include_loans_with_amortization_term` | `string[]` | — |
| `quote_amortization_terms`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_amortization_term_months_count`required | `object` | — |
| `has_value`required | `integer` | — |
| `properties`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_property_usage_type`required | `object` | — |
| `has_value`required | `string` | `investment``other``primary_residence``second_home` |
| `has_number_of_units_type`required | `object` | — |
| `has_value`required | `string` | `four``one``three``two``two_to_four` |
| `has_project_design_type`required | `object` | — |
| `has_value`required | `string` | `garden_project``highrise_project``midrise_project``other``townhouse_rowhouse` |
| `has_planned_unit_development_pud_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_manufactured_home_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_manufactured_home_width_type`required | `object` | — |
| `has_value`required | `string` | — |
| `has_project_usage_type`required | `object` | — |
| `has_value`required | `string` | — |
| `has_stories_count`required | `object` | — |
| `has_value`required | `integer` | — |
| `has_construction_method_type`required | `object` | — |
| `has_value`required | `string` | `manufactured``mobile_home``modular``on_frame_modular``other``site_built` |
| `has_financed_unit_count`required | `object` | — |
| `has_value`required | `integer` | — |
| `has_non_warrantable_project_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `with_address`required | `string[]` | — |
| `with_sales_contract`required | `string[]` | — |
| `with_value`required | `string[]` | — |
| `projects` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_project_legal_structure_type`required | `object` | — |
| `has_value`required | `string` | `common_interest_apartment``condominium``cooperative``unknown` |
| `addresses`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_county_name` | `object` | <!--source:api-specifications-->Required if the address is for the subject property<!--/source--> |
| `has_value`required | `string` | — |
| `has_state_code`required | `object` | — |
| `has_value`required | `string` | — |
| `has_city_name` | `object` | — |
| `has_value`required | `string` | — |
| `has_postal_code` | `object` | — |
| `has_value`required | `string` | — |
| `has_address_line_1_text` | `object` | — |
| `has_value`required | `string` | — |
| `sales_contracts`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_sales_contract_amount`required | `object` | — |
| `has_value`required | `number` | — |
| `property_valuations`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_property_valuation_amount`required | `object` | — |
| `has_value`required | `number` | — |

##### Response `201``application/json`

<!--source:api-specifications-->
4 fields
<!--/source-->
<!--source:api-specifications-->
Collection created successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string (ulid)` | <!--source:api-specifications-->Transaction ID.<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `collection_id` | `string (ulid)` | <!--source:api-specifications-->Collection ID.<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `object` | <!--source:api-specifications-->Data in Staircase language schema.<!--/source--> |
| `metadata` | `object` | <!--source:api-specifications-->Metadata about collection, f.e version of used Staircase schema.<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | <!--source:api-specifications-->Either message object with more properties.<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

##### Other responses

`405`

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

<!--source:api-specifications-->

#### Retrieve Collection
<!--/source-->

`retrieveCollection`

<!--source:api-specifications-->
Retrieve Collection returns the content of a given `collection_id` associated with a `transaction_id`.

<!--/source-->

##### Response

<!--source:api-specifications-->
403404 GetCollectionError404 GetCollectionsError500
<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "message": "Unable to get collection. Please check the given ids"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "message": "Unable to get collections of given transaction. Please\ncheck the transaction id"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
3
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | <!--source:api-specifications-->Staircase Transaction Identifier<!--/source--> |
| `collection_id` required | `string (ulid)` path | `01F0KHKADN0HRFXMCQQXPA6AFZ` | <!--source:api-specifications-->Staircase collection_id<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
4 fields
<!--/source-->
<!--source:api-specifications-->
Successfully Retrieved Collection
<!--/source-->

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

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

##### Other responses

`400`

`GET` `/transactions/{transaction_id}/collections`

<!--source:api-specifications-->

#### Retrieve Transaction Collections
<!--/source-->

`RetrieveTransactionCollections`

<!--source:api-specifications-->
Retrieve Transaction Collections returns the content of a given `collection_id` associated with a specific `transaction_id`.

<!--/source-->

##### Response

<!--source:api-specifications-->
200400403404500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Transaction collection retrieved successfully

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

<!--/source-->

<!--source:api-specifications-->
text/html Copy Error

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "message": "Unable to get collections of given transaction. Please\ncheck the transaction id"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
2
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | <!--source:api-specifications-->Staircase Transaction Identifier<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
4 fields
<!--/source-->
<!--source:api-specifications-->
Transaction collection retrieved successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string (ulid)` | <!--source:api-specifications-->Transaction ID.<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `collection_id` | `string (ulid)` | <!--source:api-specifications-->Collection ID.<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `object` | <!--source:api-specifications-->Data in Staircase language schema.<!--/source--> |
| `metadata` | `object` | <!--source:api-specifications-->Metadata about collection, f.e version of used Staircase schema.<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | <!--source:api-specifications-->Either message object with more properties.<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

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

<!--source:api-specifications-->

#### Update Collection
<!--/source-->

`updateCollection`

<!--source:api-specifications-->
Update Collection allows you to update the content of a given `collection_id` associated with a `transaction_id`.

<!--/source-->

##### Request

<!--source:api-specifications-->
Request ExamplePreapproval Example
<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "data": {
 "vendor_name": "optimalBlue",
 "request_data": {
 "people": [
 {
 "@id": "01FDTQ5PJSKC94HHZGYZDSTXCT",
 "@type": "borrower",
 "has_first_name": {
 "has_value": "test"
 },
 "has_last_name": {
 "has_value": "test1"
 },
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 15
 },
 "employed_as": [
 "01FDTQ5PGZWEG4M8PSR5T6TSYH"
 ],
 "with_declaration": [
 "01FDTQ5PH0KQ21KE0DR3FV16SW"
 ],
 "with_credit_information": [
 "01G0F456KV2YVD0N168SD8QTGD"
 ]
 }
 ],
 "credit_information": [
 {
 "@id": "01G0F456KV2YVD0N168SD8QTGD",
 "@type": "credit_information",
 "has_credit_rating_code_type": {
 "has_value": "experian"
 },
 "has_credit_report_action_type": {
 "has_value": "submit"
 },
 "has_credit_report_first_issued_date": {
 "has_value": "2022-04-12"
 },
 "has_credit_report_identifier": {
 "has_value": "DF6VM5"
 },
 "has_credit_report_last_updated_date": {
 "has_value": "2022-04-12"
 },
 "has_credit_report_merge_type": {
 "has_value": "blend"
 },
 "has_credit_report_type": {
 "has_value": "merge"
 },
 "has_credit_request_type": {
 "has_value": "individual"
 },
 "with_credit_score_information": [
 "01FDTQ5PH1J05ESN8F3M8X03MD"
 ]
 }
 ],
 "employment": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
 "@type": "employment",
 "has_self_employment_indicator": {
 "has_value": true
 }
 }
 ],
 "declarations": [
 {
 "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
 "@type": "declaration",
 "has_citizenship_residency_type": {
 "has_value": "us_citizen"
 },
 "has_borrower_first_time_homebuyer_indicator": {
 "has_value": false
 },
 "has_bankruptcy_indicator": {
 "has_value": false
 },
 "has_age_of_bankruptcy_years_count": {
 "has_value": 0
 },
 "has_prior_property_foreclosure_completed_indicator": {
 "has_value": false
 },
 "has_age_of_prior_property_foreclosure_years_count": {
 "has_value": 0
 }
 }
 ],
 "credit_score_information": [
 {
 "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
 "@type": "credit_score_information",
 "has_credit_score": {
 "has_value": "850"
 }
 }
 ],
 "loans": [
 {
 "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
 "@type": "loan",
 "has_relocation_loan_indicator": {
 "has_value": false
 },
 "has_heloc_indicator": {
 "has_value": false
 },
 "with_borrower": [
 "01FDTQ5PJSKC94HHZGYZDSTXCT"
 ],
 "with_loan_terms": [
 "01FDTQ5PJTJBJZ777RCH7TDF5J"
 ],
 "with_documentation": [
 "01FDTQ5PJTMCWMQW9WYKSDT3FE"
 ],
 "with_summary": [
 "01FDTQ5PJVWPHV0MBGEMS6QHZZ"
 ],
 "with_payment_information": [
 "01FDTQ5PJXBVSW37ZTESFQWN4Y"
 ],
 "with_arm_adjustment": [
 "01FDTQ5PJXSBQYT5X7EAS4H31S"
 ],
 "with_insurance": [
 "01FDTQ5PJYNRA67MQEVTBZCRZ7"
 ],
 "with_project": [
 "01FKTQ5PKC2ZFKXBEH170VG0BJ"
 ],
 "serviced_by": [
 "01FDTQ5PKA5DVQ7F39HZK84H2R"
 ],
 "with_buydown": [
 "01FDTQ5PKBF5JHM46TQQEE3SAE"
 ],
 "with_quote_request": [
 "01FDTQ5PKBHV90N3GJ0PEK9TWD"
 ],
 "secured_by_property": [
 "01FDTQ5PKC4ZFKXBET140VG0BJ"
 ]
 }
 ],
 "loan_terms": [
 {
 "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
 "@type": "loan_terms",
 "has_mortgage_type": {
 "has_value": "conventional"
 },
 "has_pledged_assets_indicator": {
 "has_value": false
 },
 "has_escrow_required_indicator": {
 "has_value": true
 },
 "has_loan_purpose_type": {
 "has_value": "purchase"
 },
 "has_refinance_type": {
 "has_value": "no_cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 150000
 },
 "has_interest_only_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_term_months_count": {
 "has_value": 0
 },
 "has_construction_loan_indicator": {
 "has_value": false
 },
 "has_buydown_indicator": {
 "has_value": true
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "buydowns": [
 {
 "@id": "01FDTQ5PKBF5JHM46TQQEE3SAE",
 "@type": "buydown",
 "has_buydown_type": {
 "has_value": "one_one"
 }
 }
 ],
 "insurance": [
 {
 "@id": "01FDTQ5PJYNRA67MQEVTBZCRZ7",
 "@type": "mortgage_insurance",
 "has_mortgage_insurance_premium_source_type": {
 "has_value": "borrower"
 }
 }
 ],
 "loan_documentation": [
 {
 "@id": "01FDTQ5PJTMCWMQW9WYKSDT3FE",
 "@type": "loan_documentation",
 "has_asset_documentation_level_type": {
 "has_value": "stated_and_verified"
 },
 "has_employment_documentation_level_type": {
 "has_value": "stated_and_verified"
 },
 "has_income_documentation_level_type": {
 "has_value": "stated_and_verified"
 }
 }
 ],
 "loan_summaries": [
 {
 "@id": "01FDTQ5PJVWPHV0MBGEMS6QHZZ",
 "@type": "loan_summary",
 "has_total_debt_expense_to_income_dti_ratio": {
 "has_value": 18
 },
 "has_total_monthly_income_amount": {
 "has_value": 0
 },
 "has_projected_reserves_amount": {
 "has_value": 24
 },
 "has_representative_credit_score": {
 "has_value": 850
 }
 }
 ],
 "loan_payment_information": [
 {
 "@id": "01FDTQ5PJXBVSW37ZTESFQWN4Y",
 "@type": "loan_payment_information",
 "has_number_of_payments_30_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_60_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_90_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_120_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_rolling_12_months_late_count": {
 "has_value": 0
 }
 }
 ],
 "organizations": [
 {
 "@id": "01FDTQ5PKA5DVQ7F39HZK84H2R",
 "@type": "servicer"
 }
 ],
 "quote_requests": [
 {
 "@id": "01FDTQ5PKBHV90N3GJ0PEK9TWD",
 "@type": "loan_price_quote_request",
 "has_loan_officer_compensation_type": {
 "has_value": "yes_lender_paid"
 },
 "has_calculate_borrower_requested_loan_amount_indicator": {
 "has_value": true
 },
 "has_include_fixed_rate_amortization_loans_indicator": {
 "has_value": true
 },
 "has_include_adjustable_rate_amortization_loans_indicator": {
 "has_value": false
 },
 "has_include_payment_option_adjustable_rate_amortization_loans_indicator": {
 "has_value": false
 },
 "has_discount_points_percent": {
 "has_value": 0
 },
 "has_include_balloon_loans_indicator": {
 "has_value": false
 },
 "has_cash_out_amount": {
 "has_value": 0
 },
 "include_loans_with_amortization_term": [
 "01FDTQGB8WJHJC9YT32CQ1ESCC"
 ]
 }
 ],
 "quote_amortization_terms": [
 {
 "@id": "01FDTQGB8WJHJC9YT32CQ1ESCC",
 "@type": "quote_amortization_term",
 "has_amortization_term_months_count": {
 "has_value": 360
 }
 }
 ],
 "properties": [
 {
 "@id": "01FDTQ5PKC4ZFKXBET140VG0BJ",
 "@type": "subject_property",
 "has_property_usage_type": {
 "has_value": "primary_residence"
 },
 "has_number_of_units_type": {
 "has_value": "one"
 },
 "has_project_design_type": {
 "has_value": "midrise_project"
 },
 "has_manufactured_home_indicator": {
 "has_value": false
 },
 "has_planned_unit_development_pud_indicator": {
 "has_value": false
 },
 "has_manufactured_home_width_type": {
 "has_value": "single_wide"
 },
 "has_project_usage_type": {
 "has_value": "string"
 },
 "has_financed_unit_count": {
 "has_value": 1
 },
 "has_non_warrantable_project_indicator": {
 "has_value": false
 },
 "has_stories_count": {
 "has_value": 1
 },
 "has_construction_method_type": {
 "has_value": "site_built"
 },
 "with_address": [
 "01FDTQGB9EV6FKWGZ2CY35971G"
 ],
 "with_sales_contract": [
 "01FDTQGB9EPKV6EJXZMTW0CGV0"
 ],
 "with_value": [
 "01FDTQGB9FVMF9YTFBTX95D2KH"
 ]
 }
 ],
 "projects": [
 {
 "@id": "01FKTQ5PKC2ZFKXBEH170VG0BJ",
 "@type": "project",
 "has_project_legal_structure_type": {
 "has_value": "condominium"
 }
 }
 ],
 "addresses": [
 {
 "@id": "01FDTQGB9EV6FKWGZ2CY35971G",
 "@type": "residential_address",
 "has_address_line_1_text": {
 "has_value": "string"
 },
 "has_county_name": {
 "has_value": "Collin"
 },
 "has_state_code": {
 "has_value": "TX"
 },
 "has_postal_code": {
 "has_value": "75024"
 }
 }
 ],
 "sales_contracts": [
 {
 "@id": "01FDTQGB9EPKV6EJXZMTW0CGV0",
 "@type": "property_sales_contract",
 "has_sales_contract_amount": {
 "has_value": 225000
 }
 }
 ],
 "property_valuations": [
 {
 "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
 "@type": "property_valuation",
 "has_property_valuation_amount": {
 "has_value": 225000
 }
 }
 ]
 }
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "data": {
 "underwritings": [
 {
 "@id": "1",
 "@type": "underwriting",
 "with_automated_underwriting": [
 "01G0F46DMPX9DA9SYW9MD469S1"
 ]
 }
 ],
 "loans": [
 {
 "@id": "01G0F46DMPHNWM8TWMGJQRJW5Y",
 "@type": "loan",
 "has_relocation_loan_indicator": {
 "has_value": false
 },
 "has_heloc_indicator": {
 "has_value": false
 },
 "has_originator_loan_identifier": {
 "has_value": "01G0F436Y4B8Z97ZZCX4PDENMF"
 },
 "with_payment_information": [
 "loan_payment_information"
 ],
 "has_loan_status_type": {
 "has_value": "prequalification"
 },
 "has_loan_role_type": {
 "has_value": "subject_loan"
 },
 "with_underwriting": [
 "1"
 ],
 "with_arm_adjustment": [
 "01G0F46DMPRTYR25HZZCWH0EMX"
 ],
 "with_documentation": [
 "01G0F46DMPWS3BHQZM14C8KFVH"
 ],
 "with_insurance": [
 "01G0F46DMP72CMBWKC10X0PPDC"
 ],
 "with_project": [
 "01FKTQ5PKC2ZFKXBEH170VG0BJ"
 ],
 "with_loan_terms": [
 "01G0F46DMPQ9680F59JE7QETN1"
 ],
 "serviced_by": [
 "01G0F46DMPNP1Z0PD6B98BN92S"
 ],
 "with_summary": [
 "01G0F46DMP778HBQW874FV3RFR"
 ],
 "with_quote_request": [
 "01G0F46DMP1A0WN0T89KDRKF5A"
 ],
 "with_buydown": [
 "01G0F46DMPWPA5VM805MXSH2KG"
 ],
 "secured_by_property": [
 "01G0F46DMPE0NJZ7XGRSZJEPM0"
 ],
 "with_borrower": [
 "01G0F43BRK1SAPR67KC0J1NVQB"
 ]
 }
 ],
 "loan_payment_information": [
 {
 "@id": "loan_payment_information",
 "@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
 }
 }
 ],
 "loan_summaries": [
 {
 "@id": "01G0F46DMP778HBQW874FV3RFR",
 "@type": "loan_summary",
 "has_total_debt_expense_to_income_dti_ratio": {
 "has_value": 27
 },
 "has_total_monthly_income_amount": {
 "has_value": 7500
 },
 "has_projected_reserves_amount": {
 "has_value": 24
 },
 "has_representative_credit_score": {
 "has_value": 743
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01G0F46DMPRTYR25HZZCWH0EMX",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "insurance": [
 {
 "@id": "01G0F46DMP72CMBWKC10X0PPDC",
 "@type": "mortgage_insurance",
 "has_mortgage_insurance_premium_source_type": {
 "has_value": "borrower"
 }
 }
 ],
 "loan_documentation": [
 {
 "@id": "01G0F46DMPWS3BHQZM14C8KFVH",
 "@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"
 }
 }
 ],
 "automated_underwritings": [
 {
 "@id": "01G0F46DMPX9DA9SYW9MD469S1",
 "@type": "automated_underwriting",
 "has_desktop_underwriter_recommendation_type": {
 "has_value": "out_of_scope"
 }
 }
 ],
 "loan_terms": [
 {
 "@id": "01G0F46DMPQ9680F59JE7QETN1",
 "@type": "loan_terms",
 "has_pledged_assets_indicator": {
 "has_value": false
 },
 "has_escrow_required_indicator": {
 "has_value": true
 },
 "has_loan_purpose_type": {
 "has_value": "purchase"
 },
 "has_refinance_type": {
 "has_value": "no_cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 50000
 },
 "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": false
 },
 "has_mortgage_type": {
 "has_value": "conventional"
 }
 }
 ],
 "buydowns": [
 {
 "@id": "01G0F46DMPWPA5VM805MXSH2KG",
 "@type": "buydown",
 "has_buydown_type": {
 "has_value": "one_zero"
 }
 }
 ],
 "mortgage_products": [
 {
 "@id": "01G0F46DMQZZHDGDN4X8GMTKET",
 "@type": "pricing",
 "has_partner_name": {
 "has_value": "Optimal Blue"
 }
 },
 {
 "@id": "01G0F46DMQ6NBC8PC4FPKP5QE7",
 "@type": "automated_underwriting_system",
 "has_credit_report_vendor_identifier": {
 "has_value": ""
 }
 },
 {
 "@id": "01G0F456JR9HV6FFQ38NG63W8T",
 "@type": "credit"
 }
 ],
 "organizations": [
 {
 "@id": "01G0F46DMPNP1Z0PD6B98BN92S",
 "@type": "servicer"
 },
 {
 "@id": "01G0F43BRKFYQ6J0K5GJRYF2JB",
 "@type": "organization",
 "has_organization_name": {
 "has_value": "Amazon"
 }
 },
 {
 "@id": "01G0F43BRK89FAZDRJZDC5DX0K",
 "@type": "customer",
 "has_transaction_identifier": {
 "has_value": "01G0F436Y4B8Z97ZZCX4PDENMF"
 }
 }
 ],
 "quote_requests": [
 {
 "@id": "01G0F46DMP1A0WN0T89KDRKF5A",
 "@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_include_balloon_loans_indicator": {
 "has_value": false
 },
 "include_loans_with_amortization_term": [
 "01G0F46DMQRJJ7VVS4Y038BKNX"
 ]
 }
 ],
 "quote_amortization_terms": [
 {
 "@id": "01G0F46DMQRJJ7VVS4Y038BKNX",
 "@type": "quote_amortization_term",
 "has_amortization_term_months_count": {
 "has_value": 360
 }
 }
 ],
 "properties": [
 {
 "@id": "01G0F46DMPE0NJZ7XGRSZJEPM0",
 "@type": "subject_property",
 "has_construction_method_type": {
 "has_value": "site_built"
 },
 "has_non_warrantable_project_indicator": {
 "has_value": false
 },
 "has_property_usage_type": {
 "has_value": "primary_residence"
 },
 "has_number_of_units_type": {
 "has_value": "one"
 },
 "has_project_design_type": {
 "has_value": "midrise_project"
 },
 "has_manufactured_home_indicator": {
 "has_value": false
 },
 "has_planned_unit_development_pud_indicator": {
 "has_value": false
 },
 "has_manufactured_home_width_type": {
 "has_value": "single_wide"
 },
 "has_project_usage_type": {
 "has_value": "other"
 },
 "has_stories_count": {
 "has_value": 1
 },
 "has_financed_unit_count": {
 "has_value": 1
 },
 "has_property_in_project_indicator": {
 "has_value": false
 },
 "with_address": [
 "01G0F46DMPB9Y8YNQN8BY1AZ1F"
 ],
 "with_sales_contract": [
 "01G0F46DMQYRE9H69KXTEFW8KK"
 ],
 "with_value": [
 "01G0F46DMQ917ABYDMNHH8BR61"
 ]
 }
 ],
 "projects": [
 {
 "@id": "01FKTQ5PKC2ZFKXBEH170VG0BJ",
 "@type": "project",
 "has_project_legal_structure_type": {
 "has_value": "condominium"
 }
 }
 ],
 "addresses": [
 {
 "@id": "01G0F46DMPB9Y8YNQN8BY1AZ1F",
 "@type": "residential_address",
 "has_county_name": {
 "has_value": "Fort Bend"
 },
 "has_state_code": {
 "has_value": "TX"
 }
 },
 {
 "@id": "01G0F43BRJB7S9ZSS0Q4AXN357",
 "@type": "address",
 "has_address_line_1_text": {
 "has_value": "126 4th St"
 },
 "has_address_line_2_text": {
 "has_value": ""
 },
 "has_city_name": {
 "has_value": "Atlanta"
 },
 "has_country_name": {
 "has_value": "US"
 },
 "has_postal_code": {
 "has_value": "30014"
 },
 "has_state_code": {
 "has_value": "GA"
 }
 },
 {
 "@id": "01G0F456PEEXG5XWXDFNW8H5XY",
 "@type": "residential_address",
 "has_address_line_1_text": {
 "has_value": "126 4TH ST"
 },
 "has_city_name": {
 "has_value": "ATLANTA"
 },
 "has_postal_code": {
 "has_value": "30014"
 },
 "has_state_code": {
 "has_value": "GA"
 }
 }
 ],
 "sales_contracts": [
 {
 "@id": "01G0F46DMQYRE9H69KXTEFW8KK",
 "@type": "property_sales_contract",
 "has_sales_contract_amount": {
 "has_value": 500000
 }
 }
 ],
 "property_valuations": [
 {
 "@id": "01G0F46DMQ917ABYDMNHH8BR61",
 "@type": "property_valuation",
 "has_property_valuation_amount": {
 "has_value": 500000
 }
 }
 ],
 "assets": [
 {
 "@id": "01G0F43ERM91FT0DTAQ1J8FME3",
 "@type": "checking_account",
 "has_market_value_amount": {
 "has_value": 10000
 },
 "owned_by": [
 "01G0F43BRK1SAPR67KC0J1NVQB"
 ]
 }
 ],
 "contact_information": [
 {
 "@id": "01G0F43BRKGVC0X90BH7S6E8S0",
 "@type": "contact_information",
 "has_email_address": {
 "has_value": "test@email.com"
 },
 "has_phone_number": {
 "has_value": "1231231232"
 }
 }
 ],
 "credit_information": [
 {
 "@id": "01G0F456KV2YVD0N168SD8QTGD",
 "@type": "credit_information",
 "has_credit_rating_code_type": {
 "has_value": "experian"
 },
 "has_credit_report_action_type": {
 "has_value": "submit"
 },
 "has_credit_report_first_issued_date": {
 "has_value": "2022-04-12"
 },
 "has_credit_report_identifier": {
 "has_value": "DF6VM5"
 },
 "has_credit_report_last_updated_date": {
 "has_value": "2022-04-12"
 },
 "has_credit_report_merge_type": {
 "has_value": "blend"
 },
 "has_credit_report_type": {
 "has_value": "merge"
 },
 "has_credit_request_type": {
 "has_value": "individual"
 },
 "with_credit_score_information": [
 "01G0F456QKHJP096X9CH9H0QAZ"
 ]
 }
 ],
 "credit_score_factors": [
 {
 "@id": "01G0F45MHVRFPK6245AJ68T9MZ",
 "@type": "credit_score_factor",
 "has_credit_score_factor_code": {
 "has_value": "00030"
 },
 "has_credit_score_factor_text": {
 "has_value": "TIME SINCE MOST RECENT ACCOUNT OPENING IS TOO SHORT"
 }
 },
 {
 "@id": "01G0F45MHW2W46K8E0TTE3CC86",
 "@type": "credit_score_factor",
 "has_credit_score_factor_code": {
 "has_value": "00014"
 },
 "has_credit_score_factor_text": {
 "has_value": "LENGTH OF TIME ACCOUNTS HAVE BEEN ESTABLISHED"
 }
 },
 {
 "@id": "01G0F45MHWNRX3YABMXWX8QHE1",
 "@type": "credit_score_factor",
 "has_credit_score_factor_code": {
 "has_value": 8
 },
 "has_credit_score_factor_text": {
 "has_value": "TOO MANY INQUIRIES LAST 12 MONTHS"
 }
 },
 {
 "@id": "01G0F45MHW9J9AR4T56XX2B6HK",
 "@type": "credit_score_factor",
 "has_credit_score_factor_code": {
 "has_value": "00012"
 },
 "has_credit_score_factor_text": {
 "has_value": "LENGTH OF TIME REVOLVING ACCOUNTS HAVE BEEN ESTABLISHED"
 }
 }
 ],
 "credit_score_information": [
 {
 "@id": "01G0F456QKHJP096X9CH9H0QAZ",
 "@type": "credit_score_information",
 "has_credit_report_identifier": {
 "has_value": "DF6VM5"
 },
 "has_credit_score": {
 "has_value": "00743"
 }
 }
 ],
 "declarations": [
 {
 "@id": "01G0F43BRKNQKR7P36ZT59T2YX",
 "@type": "declaration",
 "has_citizenship_residency_type": {
 "has_value": "us_citizen"
 },
 "has_intent_to_occupy_indicator": {
 "has_value": true
 },
 "has_prior_property_foreclosure_completed_indicator": {
 "has_value": false
 }
 }
 ],
 "documents": [
 {
 "@id": "01G0F45MHWAWZKFCZHT7RCFR5B",
 "@type": "credit_report",
 "has_staircase_blob_identifier": {
 "has_value": "01G0F450M9J09JRC2G6CFAVMX8"
 }
 }
 ],
 "employment": [
 {
 "@id": "01G0F43BRMG882TMY5F8S50GY8",
 "@type": "employment",
 "has_self_employment_indicator": {
 "has_value": false
 },
 "provided_by": [
 "01G0F43BRKFYQ6J0K5GJRYF2JB"
 ]
 }
 ],
 "housing_expenses_deprecated": [
 {
 "@id": "01G0F43BRK4Z2GDQPHBJNSZS1M",
 "@type": "housing_expenses_deprecated",
 "has_present_first_mortgage_principal_and_interest_monthly_amount": {
 "has_value": 0
 },
 "has_present_first_mortgage_principal_interest_taxes_and_insurance_piti_monthly_amount": {
 "has_value": 0
 },
 "has_present_flood_insurance_monthly_amount": {
 "has_value": 0
 },
 "has_present_homeowners_association_dues_and_condominium_fees_monthly_amount": {
 "has_value": 0
 },
 "has_present_homeowners_insurance_monthly_amount": {
 "has_value": 0
 },
 "has_present_mortgage_insurance_monthly_amount": {
 "has_value": 0
 },
 "has_present_other_mortgage_loan_principal_and_interest_monthly_amount": {
 "has_value": 0
 },
 "has_present_other_mortgage_loan_principal_interest_taxes_and_insurance_monthly_amount": {
 "has_value": 0
 },
 "has_present_property_tax_monthly_amount": {
 "has_value": 0
 },
 "has_present_supplemental_property_insurance_monthly_amount": {
 "has_value": 0
 },
 "has_present_total_monthly_payment_amount": {
 "has_value": 0
 }
 }
 ],
 "income": [
 {
 "@id": "01G0F43DJT2A15SH870HJ2K5EX",
 "@type": "employment_income",
 "has_income_amount": {
 "has_value": 7500
 },
 "has_income_pay_frequency_type": {
 "has_value": "monthly"
 }
 },
 {
 "@id": "01G0F43DJTH8BHZGVS31GBFSKV",
 "@type": "employment_income",
 "has_income_amount": {
 "has_value": 90000
 },
 "has_income_year": {
 "has_value": "2022"
 }
 }
 ],
 "liabilities": [
 {
 "@id": "01G0F43BRK7WTG1SSEEJG143CF",
 "@type": "liability",
 "has_liability_payment_amount": {
 "has_value": 2000
 },
 "has_liability_unpaid_balance_amount": {
 "has_value": 2000
 }
 }
 ],
 "people": [
 {
 "@id": "01G0F43BRK1SAPR67KC0J1NVQB",
 "@type": "borrower",
 "contact_at": [
 "01G0F43BRKGVC0X90BH7S6E8S0"
 ],
 "earns": [
 "01G0F43DJTH8BHZGVS31GBFSKV",
 "01G0F43DJT2A15SH870HJ2K5EX"
 ],
 "has_birth_date": {
 "has_value": "1958-12-12"
 },
 "has_first_name": {
 "has_value": "DAD"
 },
 "has_last_name": {
 "has_value": "FIRSTIMER"
 },
 "has_marital_status_type": {
 "has_value": "unmarried"
 },
 "has_taxpayer_identifier_type": {
 "has_value": "individual_taxpayer_identification_number"
 },
 "has_taxpayer_identifier_value": {
 "has_value": "000-000-001"
 },
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 25
 },
 "lives_at": [
 "01G0F43BRKGDPCT3N1BHVVXPJ1"
 ],
 "owes_liability": [
 "01G0F43BRK7WTG1SSEEJG143CF"
 ],
 "owns_asset": [
 "01G0F43ERM91FT0DTAQ1J8FME3"
 ],
 "with_address": [
 "01G0F43BRJB7S9ZSS0Q4AXN357"
 ],
 "with_credit_information": [
 "01G0F456KV2YVD0N168SD8QTGD"
 ],
 "with_declaration": [
 "01G0F43BRKNQKR7P36ZT59T2YX"
 ],
 "works_for": [
 "01G0F43BRKFYQ6J0K5GJRYF2JB"
 ],
 "employed_as": [
 "01G0F43BRMG882TMY5F8S50GY8"
 ]
 }
 ],
 "residences": [
 {
 "@id": "01G0F43BRKGDPCT3N1BHVVXPJ1",
 "@type": "residence",
 "has_borrower_residency_type": {
 "has_value": "current"
 },
 "has_residency_basis_type": {
 "has_value": "living_rent_free"
 },
 "has_residency_duration_months_count": {
 "has_value": 30
 },
 "with_address": [
 "01G0F43BRJB7S9ZSS0Q4AXN357"
 ]
 }
 ]
 }
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
200400 UpdateCollectionError400 text/html403404 UpdateCollectionError404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Collection updated successfully

```
{
 "transaction_id": "01F0KHK7DN3H5JZ4QJKMYAM6GB",
 "collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN",
 "metadata": {
 "created_at": "2021-09-14T03:08:00.284090-04:00",
 "validation": false
 },
 "data": {
 "vendor_name": "optimalBlue",
 "request_data": {
 "people": [
 {
 "@id": "01FDTQ5PJSKC94HHZGYZDSTXCT",
 "@type": "borrower",
 "has_first_name": {
 "has_value": "test"
 },
 "has_last_name": {
 "has_value": "test1"
 },
 "has_debt_expense_to_income_dti_ratio": {
 "has_value": 15
 },
 "employed_as": [
 "01FDTQ5PGZWEG4M8PSR5T6TSYH"
 ],
 "with_declaration": [
 "01FDTQ5PH0KQ21KE0DR3FV16SW"
 ],
 "with_credit_information": [
 "01G0F456KV2YVD0N168SD8QTGD"
 ]
 }
 ],
 "credit_information": [
 {
 "@id": "01G0F456KV2YVD0N168SD8QTGD",
 "@type": "credit_information",
 "has_credit_rating_code_type": {
 "has_value": "experian"
 },
 "has_credit_report_action_type": {
 "has_value": "submit"
 },
 "has_credit_report_first_issued_date": {
 "has_value": "2022-04-12"
 },
 "has_credit_report_identifier": {
 "has_value": "DF6VM5"
 },
 "has_credit_report_last_updated_date": {
 "has_value": "2022-04-12"
 },
 "has_credit_report_merge_type": {
 "has_value": "blend"
 },
 "has_credit_report_type": {
 "has_value": "merge"
 },
 "has_credit_request_type": {
 "has_value": "individual"
 },
 "with_credit_score_information": [
 "01FDTQ5PH1J05ESN8F3M8X03MD"
 ]
 }
 ],
 "employment": [
 {
 "@id": "01FDTQ5PGZWEG4M8PSR5T6TSYH",
 "@type": "employment",
 "has_self_employment_indicator": {
 "has_value": true
 }
 }
 ],
 "declarations": [
 {
 "@id": "01FDTQ5PH0KQ21KE0DR3FV16SW",
 "@type": "declaration",
 "has_citizenship_residency_type": {
 "has_value": "us_citizen"
 },
 "has_borrower_first_time_homebuyer_indicator": {
 "has_value": false
 },
 "has_bankruptcy_indicator": {
 "has_value": false
 },
 "has_age_of_bankruptcy_years_count": {
 "has_value": 0
 },
 "has_prior_property_foreclosure_completed_indicator": {
 "has_value": false
 },
 "has_age_of_prior_property_foreclosure_years_count": {
 "has_value": 0
 }
 }
 ],
 "credit_score_information": [
 {
 "@id": "01FDTQ5PH1J05ESN8F3M8X03MD",
 "@type": "credit_score_information",
 "has_credit_score": {
 "has_value": "850"
 }
 }
 ],
 "loans": [
 {
 "@id": "01FDTQ5PJQ6XNBSS84F65B3ZNZ",
 "@type": "loan",
 "has_relocation_loan_indicator": {
 "has_value": false
 },
 "has_heloc_indicator": {
 "has_value": false
 },
 "with_borrower": [
 "01FDTQ5PJSKC94HHZGYZDSTXCT"
 ],
 "with_loan_terms": [
 "01FDTQ5PJTJBJZ777RCH7TDF5J"
 ],
 "with_documentation": [
 "01FDTQ5PJTMCWMQW9WYKSDT3FE"
 ],
 "with_summary": [
 "01FDTQ5PJVWPHV0MBGEMS6QHZZ"
 ],
 "with_payment_information": [
 "01FDTQ5PJXBVSW37ZTESFQWN4Y"
 ],
 "with_arm_adjustment": [
 "01FDTQ5PJXSBQYT5X7EAS4H31S"
 ],
 "with_insurance": [
 "01FDTQ5PJYNRA67MQEVTBZCRZ7"
 ],
 "with_project": [
 "01FKTQ5PKC2ZFKXBEH170VG0BJ"
 ],
 "serviced_by": [
 "01FDTQ5PKA5DVQ7F39HZK84H2R"
 ],
 "with_buydown": [
 "01FDTQ5PKBF5JHM46TQQEE3SAE"
 ],
 "with_quote_request": [
 "01FDTQ5PKBHV90N3GJ0PEK9TWD"
 ],
 "secured_by_property": [
 "01FDTQ5PKC4ZFKXBET140VG0BJ"
 ]
 }
 ],
 "loan_terms": [
 {
 "@id": "01FDTQ5PJTJBJZ777RCH7TDF5J",
 "@type": "loan_terms",
 "has_mortgage_type": {
 "has_value": "conventional"
 },
 "has_pledged_assets_indicator": {
 "has_value": false
 },
 "has_escrow_required_indicator": {
 "has_value": true
 },
 "has_loan_purpose_type": {
 "has_value": "purchase"
 },
 "has_refinance_type": {
 "has_value": "no_cash_out"
 },
 "has_lien_position_type": {
 "has_value": "first_lien"
 },
 "has_base_loan_amount": {
 "has_value": 150000
 },
 "has_interest_only_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_indicator": {
 "has_value": false
 },
 "has_prepayment_penalty_term_months_count": {
 "has_value": 0
 },
 "has_construction_loan_indicator": {
 "has_value": false
 },
 "has_buydown_indicator": {
 "has_value": true
 }
 }
 ],
 "arm_adjustments": [
 {
 "@id": "01FDTQ5PJXSBQYT5X7EAS4H31S",
 "@type": "arm_adjustment",
 "has_first_rate_adjustment_months_count": {
 "has_value": 60
 }
 }
 ],
 "buydowns": [
 {
 "@id": "01FDTQ5PKBF5JHM46TQQEE3SAE",
 "@type": "buydown",
 "has_buydown_type": {
 "has_value": "one_one"
 }
 }
 ],
 "insurance": [
 {
 "@id": "01FDTQ5PJYNRA67MQEVTBZCRZ7",
 "@type": "mortgage_insurance",
 "has_mortgage_insurance_premium_source_type": {
 "has_value": "borrower"
 }
 }
 ],
 "loan_documentation": [
 {
 "@id": "01FDTQ5PJTMCWMQW9WYKSDT3FE",
 "@type": "loan_documentation",
 "has_asset_documentation_level_type": {
 "has_value": "stated_and_verified"
 },
 "has_employment_documentation_level_type": {
 "has_value": "stated_and_verified"
 },
 "has_income_documentation_level_type": {
 "has_value": "stated_and_verified"
 }
 }
 ],
 "loan_summaries": [
 {
 "@id": "01FDTQ5PJVWPHV0MBGEMS6QHZZ",
 "@type": "loan_summary",
 "has_total_debt_expense_to_income_dti_ratio": {
 "has_value": 18
 },
 "has_total_monthly_income_amount": {
 "has_value": 0
 },
 "has_projected_reserves_amount": {
 "has_value": 24
 },
 "has_representative_credit_score": {
 "has_value": 850
 }
 }
 ],
 "loan_payment_information": [
 {
 "@id": "01FDTQ5PJXBVSW37ZTESFQWN4Y",
 "@type": "loan_payment_information",
 "has_number_of_payments_30_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_60_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_90_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_120_days_late_count": {
 "has_value": 0
 },
 "has_number_of_payments_rolling_12_months_late_count": {
 "has_value": 0
 }
 }
 ],
 "organizations": [
 {
 "@id": "01FDTQ5PKA5DVQ7F39HZK84H2R",
 "@type": "servicer"
 }
 ],
 "quote_requests": [
 {
 "@id": "01FDTQ5PKBHV90N3GJ0PEK9TWD",
 "@type": "loan_price_quote_request",
 "has_loan_officer_compensation_type": {
 "has_value": "yes_lender_paid"
 },
 "has_calculate_borrower_requested_loan_amount_indicator": {
 "has_value": true
 },
 "has_include_fixed_rate_amortization_loans_indicator": {
 "has_value": true
 },
 "has_include_adjustable_rate_amortization_loans_indicator": {
 "has_value": false
 },
 "has_include_payment_option_adjustable_rate_amortization_loans_indicator": {
 "has_value": false
 },
 "has_discount_points_percent": {
 "has_value": 0
 },
 "has_include_balloon_loans_indicator": {
 "has_value": false
 },
 "has_cash_out_amount": {
 "has_value": 0
 },
 "include_loans_with_amortization_term": [
 "01FDTQGB8WJHJC9YT32CQ1ESCC"
 ]
 }
 ],
 "quote_amortization_terms": [
 {
 "@id": "01FDTQGB8WJHJC9YT32CQ1ESCC",
 "@type": "quote_amortization_term",
 "has_amortization_term_months_count": {
 "has_value": 360
 }
 }
 ],
 "properties": [
 {
 "@id": "01FDTQ5PKC4ZFKXBET140VG0BJ",
 "@type": "subject_property",
 "has_property_usage_type": {
 "has_value": "primary_residence"
 },
 "has_number_of_units_type": {
 "has_value": "one"
 },
 "has_project_design_type": {
 "has_value": "midrise_project"
 },
 "has_manufactured_home_indicator": {
 "has_value": false
 },
 "has_planned_unit_development_pud_indicator": {
 "has_value": false
 },
 "has_manufactured_home_width_type": {
 "has_value": "single_wide"
 },
 "has_project_usage_type": {
 "has_value": "string"
 },
 "has_financed_unit_count": {
 "has_value": 1
 },
 "has_non_warrantable_project_indicator": {
 "has_value": false
 },
 "has_stories_count": {
 "has_value": 1
 },
 "has_construction_method_type": {
 "has_value": "site_built"
 },
 "with_address": [
 "01FDTQGB9EV6FKWGZ2CY35971G"
 ],
 "with_sales_contract": [
 "01FDTQGB9EPKV6EJXZMTW0CGV0"
 ],
 "with_value": [
 "01FDTQGB9FVMF9YTFBTX95D2KH"
 ]
 }
 ],
 "projects": [
 {
 "@id": "01FKTQ5PKC2ZFKXBEH170VG0BJ",
 "@type": "project",
 "has_project_legal_structure_type": {
 "has_value": "condominium"
 }
 }
 ],
 "addresses": [
 {
 "@id": "01FDTQGB9EV6FKWGZ2CY35971G",
 "@type": "residential_address",
 "has_address_line_1_text": {
 "has_value": "string"
 },
 "has_county_name": {
 "has_value": "Collin"
 },
 "has_state_code": {
 "has_value": "TX"
 },
 "has_postal_code": {
 "has_value": "75024"
 }
 }
 ],
 "sales_contracts": [
 {
 "@id": "01FDTQGB9EPKV6EJXZMTW0CGV0",
 "@type": "property_sales_contract",
 "has_sales_contract_amount": {
 "has_value": 225000
 }
 }
 ],
 "property_valuations": [
 {
 "@id": "01FDTQGB9FVMF9YTFBTX95D2KH",
 "@type": "property_valuation",
 "has_property_valuation_amount": {
 "has_value": 225000
 }
 }
 ]
 }
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Error

```
{
 "description": "Error details.",
 "message": "Unable to update collection. Please check the collection\ndata"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Error

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "message": "Unable to update collection. Please check the given ids"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400
Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
3
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | <!--source:api-specifications-->Staircase Transaction Identifier<!--/source--> |
| `collection_id` required | `string (ulid)` path | `01F0KHKADN0HRFXMCQQXPA6AFZ` | <!--source:api-specifications-->Staircase collection_id<!--/source--> |

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | <!--source:api-specifications-->The data that is needed for invocation. It should follow the request schema<!--/source--> |
| `people` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_first_name`required | `object` | — |
| `has_value`required | `string` | — |
| `has_last_name`required | `object` | — |
| `has_value`required | `string` | — |
| `has_debt_expense_to_income_dti_ratio`required | `object` | — |
| `has_value`required | `number` | — |
| `employed_as`required | `string[]` | — |
| `with_declaration`required | `string[]` | — |
| `with_credit_information`required | `string[]` | — |
| `employment` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_self_employment_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `declarations`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_citizenship_residency_type`required | `object` | — |
| `has_value`required | `string` | `non_permanent_resident_alien``non_resident_alien``permanent_resident_alien``us_citizen` |
| `has_borrower_first_time_homebuyer_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_bankruptcy_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_age_of_bankruptcy_years_count` | `object` | — |
| `has_value`required | `integer` | — |
| `has_prior_property_foreclosure_completed_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_age_of_prior_property_foreclosure_years_count` | `object` | — |
| `has_value`required | `integer` | — |
| `credit_score_information` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_credit_score`required | `object` | — |
| `has_value`required | `string` | — |
| `loans`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_relocation_loan_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `with_borrower`required | `string[]` | — |
| `with_loan_terms`required | `string[]` | — |
| `with_documentation`required | `string[]` | — |
| `with_summary`required | `string[]` | — |
| `with_payment_information`required | `string[]` | — |
| `with_arm_adjustment`required | `string[]` | — |
| `with_insurance`required | `string[]` | — |
| `with_project`required | `string[]` | — |
| `serviced_by`required | `string[]` | — |
| `with_buydown`required | `string[]` | — |
| `with_quote_request`required | `string[]` | — |
| `secured_by_property`required | `string[]` | — |
| `has_heloc_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `loan_terms`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_pledged_assets_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_mortgage_type`required | `object` | — |
| `has_value`required | `string` | `conventional``fha``local_agency``other``public_and_indian_housing``state_agency``usda-rd``va` |
| `has_escrow_required_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_loan_purpose_type`required | `object` | — |
| `has_value`required | `string` | `other``purchase``refinance` |
| `has_refinance_type`required | `object` | — |
| `has_value`required | `string` | `cash_out``limited_cash_out``no_cash_out` |
| `has_lien_position_type`required | `object` | — |
| `has_value`required | `string` | `first_lien``second_lien``subordinate_lien` |
| `has_base_loan_amount`required | `object` | — |
| `has_value`required | `number` | — |
| `has_interest_only_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_prepayment_penalty_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_prepayment_penalty_term_months_count`required | `object` | — |
| `has_value`required | `integer` | — |
| `has_construction_loan_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_buydown_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `arm_adjustments` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_first_rate_adjustment_months_count`required | `object` | — |
| `has_value`required | `integer` | — |
| `buydowns`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_buydown_type`required | `object` | — |
| `has_value`required | `string` | `one_one``one_zero``three``two_one` |
| `insurance`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_mortgage_insurance_premium_source_type`required | `object` | — |
| `has_value`required | `string` | `borrower``lender` |
| `loan_documentation`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_asset_documentation_level_type`required | `object` | — |
| `has_value`required | `string` | `neither_stated_nor_verified``not_required``stated_and_verified``stated_only` |
| `has_employment_documentation_level_type`required | `object` | — |
| `has_value`required | `string` | `neither_stated_nor_verified``not_required``stated_and_verified``stated_only` |
| `has_income_documentation_level_type`required | `object` | — |
| `has_value`required | `string` | `neither_stated_nor_verified``not_required``stated_and_verified``stated_only` |
| `loan_summaries`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_total_debt_expense_to_income_dti_ratio`required | `object` | — |
| `has_value`required | `number` | — |
| `has_total_monthly_income_amount` | `object` | — |
| `has_value`required | `number` | — |
| `has_projected_reserves_amount` | `object` | — |
| `has_value`required | `number` | — |
| `has_representative_credit_score`required | `object` | — |
| `has_value`required | `integer` | — |
| `loan_payment_information` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_number_of_payments_30_days_late_count` | `object` | — |
| `has_value`required | `integer` | — |
| `has_number_of_payments_60_days_late_count` | `object` | — |
| `has_value`required | `integer` | — |
| `has_number_of_payments_90_days_late_count` | `object` | — |
| `has_value`required | `integer` | — |
| `has_number_of_payments_120_days_late_count` | `object` | — |
| `has_value`required | `integer` | — |
| `has_number_of_payments_rolling_12_months_late_count` | `object` | — |
| `has_value`required | `integer` | — |
| `organizations` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_organization_name` | `object` | — |
| `has_value`required | `string` | — |
| `quote_requests`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_loan_officer_compensation_type`required | `object` | — |
| `has_value`required | `string` | `no_buyer_paid``no_lender_paid``yes_lender_paid` |
| `has_calculate_borrower_requested_loan_amount_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_include_fixed_rate_amortization_loans_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_include_adjustable_rate_amortization_loans_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_include_payment_option_adjustable_rate_amortization_loans_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_discount_points_percent` | `object` | — |
| `has_value`required | `number` | — |
| `has_include_balloon_loans_indicator` | `object` | — |
| `has_value`required | `boolean` | — |
| `has_cash_out_amount` | `object` | — |
| `has_value`required | `number` | — |
| `include_loans_with_amortization_term` | `string[]` | — |
| `quote_amortization_terms`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_amortization_term_months_count`required | `object` | — |
| `has_value`required | `integer` | — |
| `properties`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_property_usage_type`required | `object` | — |
| `has_value`required | `string` | `investment``other``primary_residence``second_home` |
| `has_number_of_units_type`required | `object` | — |
| `has_value`required | `string` | `four``one``three``two``two_to_four` |
| `has_project_design_type`required | `object` | — |
| `has_value`required | `string` | `garden_project``highrise_project``midrise_project``other``townhouse_rowhouse` |
| `has_planned_unit_development_pud_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_manufactured_home_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `has_manufactured_home_width_type`required | `object` | — |
| `has_value`required | `string` | — |
| `has_project_usage_type`required | `object` | — |
| `has_value`required | `string` | — |
| `has_stories_count`required | `object` | — |
| `has_value`required | `integer` | — |
| `has_construction_method_type`required | `object` | — |
| `has_value`required | `string` | `manufactured``mobile_home``modular``on_frame_modular``other``site_built` |
| `has_financed_unit_count`required | `object` | — |
| `has_value`required | `integer` | — |
| `has_non_warrantable_project_indicator`required | `object` | — |
| `has_value`required | `boolean` | — |
| `with_address`required | `string[]` | — |
| `with_sales_contract`required | `string[]` | — |
| `with_value`required | `string[]` | — |
| `projects` | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_project_legal_structure_type`required | `object` | — |
| `has_value`required | `string` | `common_interest_apartment``condominium``cooperative``unknown` |
| `addresses`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_county_name` | `object` | <!--source:api-specifications-->Required if the address is for the subject property<!--/source--> |
| `has_value`required | `string` | — |
| `has_state_code`required | `object` | — |
| `has_value`required | `string` | — |
| `has_city_name` | `object` | — |
| `has_value`required | `string` | — |
| `has_postal_code` | `object` | — |
| `has_value`required | `string` | — |
| `has_address_line_1_text` | `object` | — |
| `has_value`required | `string` | — |
| `sales_contracts`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_sales_contract_amount`required | `object` | — |
| `has_value`required | `number` | — |
| `property_valuations`required | `object[]` | — |
| `@id`required | `string` | — |
| `@type`required | `string` | — |
| `has_property_valuation_amount`required | `object` | — |
| `has_value`required | `number` | — |

##### Response `200``application/json`

<!--source:api-specifications-->
4 fields
<!--/source-->
<!--source:api-specifications-->
Collection updated successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string (ulid)` | <!--source:api-specifications-->Transaction ID.<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `collection_id` | `string (ulid)` | <!--source:api-specifications-->Collection ID.<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `object` | <!--source:api-specifications-->Data in Staircase language schema.<!--/source--> |
| `metadata` | `object` | <!--source:api-specifications-->Metadata about collection, f.e version of used Staircase schema.<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | <!--source:api-specifications-->Either message object with more properties.<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Error additional URL.<!--/source--> |

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message.<!--/source--> |

##### Other responses

`405`

<!--source:api-specifications-->

### Operations
<!--/source-->

`POST` `/pricing`

<!--source:api-specifications-->

#### Create Pricing
<!--/source-->

`post-pricing`

<!--source:api-specifications-->
Create Pricing creates views of scenario-specific pricing, best pricing alternatives, and side-by-side price comparisons from various products and partners.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "transaction_id": "uhz6t54e-9d74-g17e-99ca-a36b30vdfd35",
 "collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
 "partner_name": "PartnerName"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
application/json Copy Pricing request created successfully.

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Authorization key<!--/source--> |

##### Request body`application/json`

<!--source:api-specifications-->
3 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `transaction_id`required | `string` | <!--source:api-specifications-->Transaction ID<!--/source--> |
| `collection_id`required | `string` | <!--source:api-specifications-->Collection ID<!--/source--> |
| `partner_name`required | `string` | — |

##### Response `200``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Pricing request created successfully.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `collection_id` | `string` | <!--source:api-specifications-->Collection ID<!--/source--> |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

## Providers

- Optimal Blue

## Errors

`400``403``404``405``422``500`

## More in Contract

- Previous product: Notary
- Next product: Signature