Valuation

Successfully returned the partner list

[
  {
    "company_name": "Partner 1",
    "invoke_name": "partner_1",
    "status": "active",
    "description": "Partner 1 does ...."
  },
  {
    "company_name": "Partner 2",
    "invoke_name": "partner_2",
    "status": "upcoming",
    "description": "Use Partner 2 if ...."
  }
]

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"
}

Example for the Valuation Elements object

{
  "$.deal_sets.deal_set[0].deals.deal[0].collaterals.collateral[0].subject_property.property_valuations.property_valuation[0].avms.avm[0].date": "null,",
  "$.deal_sets.deal_set[0].deals.deal[0].collaterals.collateral[0].subject_property.property_valuations.property_valuation[0].avms.avm[0].high_value_range": "null,",
  "$.deal_sets.deal_set[0].deals.deal[0].collaterals.collateral[0].subject_property.property_valuations.property_valuation[0].avms.avm[0].low_value_range": "null,",
  "$.deal_sets.deal_set[0].deals.deal[0].collaterals.collateral[0].subject_property.property_valuations.property_valuation[0].avms.avm[0].value": null
}

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"
}

Successfully returned the list of elements needed for AUS.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "deal_sets": {
      "type": "object",
      "properties": {
        "deal_set": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "deals": {
                  "type": "object",
                  "properties": {
                    "deal": {
                      "type": "array",
                      "items": [
                        {
                          "type": "object",
                          "properties": {
                            "collaterals": {
                              "type": "object",
                              "properties": {
                                "collateral": {
                                  "type": "array",
                                  "items": [
                                    {
                                      "type": "object",
                                      "properties": {
                                        "subject_property": {
                                          "type": "object",
                                          "properties": {
                                            "address": {
                                              "type": "object",
                                              "properties": {
                                                "line_text": {
                                                  "type": "string"
                                                },
                                                "city": {
                                                  "type": "string"
                                                },
                                                "state_code": {
                                                  "type": "string"
                                                },
                                                "postal_code": {
                                                  "type": "string"
                                                }
                                              },
                                              "required": [
                                                "line_text",
                                                "postal_code"
                                              ]
                                            }
                                          },
                                          "required": [
                                            "address"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "subject_property"
                                      ]
                                    }
                                  ]
                                }
                              },
                              "required": [
                                "collateral"
                              ]
                            }
                          },
                          "required": [
                            "collaterals"
                          ]
                        }
                      ]
                    }
                  },
                  "required": [
                    "deal"
                  ]
                }
              },
              "required": [
                "deals"
              ]
            }
          ]
        }
      },
      "required": [
        "deal_set"
      ]
    }
  },
  "required": [
    "deal_sets"
  ]
}

Error

{
  "message": "Please provide one of valid data object values: request, response"
}

Error

{
  "message": "Please provide one of valid version values: v0"
}

Error

{
  "message": "Please make sure your query parameters contains version parameter."
}

Error

{
  "message": "Please provide one of valid return examples values: true, false"
}

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"
}

Successfully Retrieved Collection

[
  {
    "metadata": {
      "created_at": "03/02/2021, 3:19:37 AM EST",
      "last_updated_at": "03/02/2021, 6:06:56 AM EST",
      "validation": false
    },
    "collection_id": "01EZZEJ3W6MHW9W75CYHEC9PAZ",
    "transaction_id": "01EZZEHJY0J6Y2C6R2C26C1V2F",
    "data": {
      "deal_sets": {
        "deal_set": [
          {
            "deals": {
              "deal": [
                {
                  "collaterals": {
                    "collateral": [
                      {
                        "subject_property": {
                          "address": {
                            "city": "Lafayette",
                            "line_text": 1,
                            "postal_code": "705061",
                            "state_code": "LA"
                          }
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  },
  {
    "metadata": {
      "created_at": "03/02/2021, 5:19:37 AM EST",
      "last_updated_at": "03/02/2021, 7:06:56 AM EST",
      "validation": false
    },
    "collection_id": "01EZZEJ3W6MHW9W75CYHEC9PAZ",
    "transaction_id": "01EZZEHJY0J6Y2C6R2C26C1V2F",
    "data": {
      "deal_sets": {
        "deal_set": [
          {
            "deals": {
              "deal": [
                {
                  "collaterals": {
                    "collateral": [
                      {
                        "subject_property": {
                          "address": {
                            "city": "Lafayette",
                            "line_text": 1,
                            "postal_code": "70506",
                            "state_code": "LA"
                          }
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
]

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"
}

Resource not found

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

Error

{
  "message": "Unable to update collection. Please check the collection data"
}

Error

{
  "message": "transaction_id value is missing"
}

Error

{
  "message": "collection_id value is missing"
}

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"
}

Resource not found

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

{
  "data": {
    "deal_sets": {
      "deal_set": [
        {
          "deals": {
            "deal": [
              {
                "collaterals": {
                  "collateral": [
                    {
                      "subject_property": {
                        "address": {
                          "line_text": "110 Ocean Park Blvd Unit 205",
                          "city": "Santa Monica",
                          "postal_code": "90405",
                          "state_code": "CA"
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  },
  "metadata": {}
}

Collection is valid

{
  "message": "Collection is valid."
}

Validation Error

{
  "message": "1 is not of type 'string'. Failed validating 'type' in schema['properties']['deal_sets']['properties']['deal_set']['items']['properties']['deals']['properties']['deal']['items']['properties']['collaterals']['properties']['collateral']['items']['properties']['subject_property']['properties']['address']['properties']['line_text']:"
}

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"
}

Transaction created successfully

{
  "transaction_id": {
    "$ref": "#/components/schemas/TransactionId/example"
  }
}

Transaction creation unsuccessfully

{
  "error": "Response status not OK while creating a new transaction, status_code: [01EZZEHJY0J6Y2C6R2C26C1V2F]",
  "error_code": 4050
}

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"
}

Example for the Valuation Request Elements object

{
  "$.deal_sets.deal_set[0].deals.deal[0].collaterals.collateral[0].subject_property.address.line_text": null,
  "$.deal_sets.deal_set[0].deals.deal[0].collaterals.collateral[0].subject_property.address.city": null,
  "$.deal_sets.deal_set[0].deals.deal[0].collaterals.collateral[0].subject_property.address.postal_code": null,
  "$.deal_sets.deal_set[0].deals.deal[0].collaterals.collateral[0].subject_property.address.state_code": null
}

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"
}

{
  "$.deal_sets.deal_set[0].deals.deal[0].collaterals.collateral[0].subject_property.address.line_text": "112 Southfield Pkwy",
  "$.deal_sets.deal_set[0].deals.deal[0].collaterals.collateral[0].subject_property.address.city": "Lafayette",
  "$.deal_sets.deal_set[0].deals.deal[0].collaterals.collateral[0].subject_property.address.postal_code": "LA",
  "$.deal_sets.deal_set[0].deals.deal[0].collaterals.collateral[0].subject_property.address.state_code": "70506"
}

Valuation Payload.

{
  "deal_sets": {
    "deal_set": [
      {
        "deals": {
          "deal": [
            {
              "collaterals": {
                "collateral": [
                  {
                    "subject_property": {
                      "address": {
                        "line_text": "110 Ocean Park Blvd Unit 205",
                        "city": "Santa Monica",
                        "postal_code": "90405",
                        "state_code": "CA"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

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"
}

{
  "data": {
    "deal_sets": {
      "deal_set": [
        {
          "deals": {
            "deal": [
              {
                "collaterals": {
                  "collateral": [
                    {
                      "subject_property": {
                        "address": {
                          "line_text": "110 Ocean Park Blvd Unit 205",
                          "city": "Santa Monica",
                          "postal_code": "90405",
                          "state_code": "CA"
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  },
  "metadata": {}
}

{
  "data": {
    "deal_sets": {
      "deal_set": [
        {
          "deals": {
            "deal": [
              {
                "collaterals": {
                  "collateral": [
                    {
                      "subject_property": {
                        "address": {
                          "line_text": "902 S 10th St",
                          "city": "Lake City",
                          "postal_code": "55041",
                          "state_code": "MN"
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  },
  "metadata": {}
}

Collection created successfully

{
  "data": {
    "deal_sets": {
      "deal_set": [
        {
          "deals": {
            "deal": [
              {
                "collaterals": {
                  "collateral": [
                    {
                      "subject_property": {
                        "address": {
                          "line_text": "110 Ocean Park Blvd Unit 205",
                          "city": "Santa Monica",
                          "postal_code": "90405",
                          "state_code": "CA"
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  },
  "metadata": {},
  "collection_id": "01EZZEJ3W6MHW9W75CYHEC9PAZ",
  "transaction_id": "01EZZEHJY0J6Y2C6R2C26C1V2F"
}

Error

{
  "message": "Unable to create collection. Please check the collection data"
}

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"
}

Resource not found

{
  "message": "Unable to create collection. Please check the transaction Id"
}

Request for valuation successfully.

{
  "transaction_id": "01EZZEHJY0J6Y2C6R2C26C1V2F",
  "collection_id": "01EZZEJ3W6MHW9W75CYHEC9PAZ"
}

General error

{
  "message": "transaction_id value is missing"
}

General error

{
  "message": "collection_id value is missing"
}

General error

{
  "message": "Please provide a valid partner name. To get available partners, you can use /partners endpoint."
}

General error

{
  "message": "Request body had invalid format. Please provide a valid JSON"
}

Invalid key for service

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

Resource not found

{
  "message": "Unable to get collection. Please check input collection id"
}

Resource not found

{
  "message": "Unable to find city and state for given postal code. Please check the postal code or try by giving city and state code"
}

Error

{
  "message": "transaction_id value is missing"
}

Error

{
  "message": "collection_id value is missing"
}

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"
}

Resource not found

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

Successfully Retrieved Collection

{
  "metadata": {
    "created_at": "03/02/2021, 6:20:55 AM EST",
    "last_updated_at": "03/02/2021, 6:21:12 AM EST",
    "partner_name": "estated",
    "validation": false
  },
  "collection_id": "01EZZEJ3W6MHW9W75CYHEC9PAZ",
  "transaction_id": "01EZZEHJY0J6Y2C6R2C26C1V2F",
  "data": {
    "deal_sets": {
      "deal_set": [
        {
          "deals": {
            "deal": [
              {
                "collaterals": {
                  "collateral": [
                    {
                      "subject_property": {
                        "property_valuations": {
                          "property_valuation": [
                            {
                              "avms": {
                                "avm": [
                                  {
                                    "date": "2020-01-30",
                                    "high_value_range": 118650,
                                    "low_value_range": 91350,
                                    "value": 105000
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

Error

{
  "message": "transaction_id value is missing"
}

Error

{
  "message": "collection_id value is missing"
}

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"
}

Resource not found

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

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

AVM 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."
}

Statuses include: * REQUEST_MADE<p> * REQUEST_ACCEPTED<p> * WAITING_FOR_RESPONSE<p> * COMPLETED

{
  "status": "COMPLETED"
}

Status is unavailable

{
  "error": "Request for specified transaction_id and collection_id was not found!"
}

Transaction successfully created.

{
  "transaction_id": "a34c40a6-3c02-44f9-a696-cd7388f506d3"
}

{
  "sets": {
    "set": [
      {
        "elements": {
          "element": [
            {
              "property_entry": {
                "property_entries": {
                  "datetime": "2020-08-25",
                  "description": "Description of property",
                  "event_type": "TestType"
                }
              },
              "property_class": {
                "property_clases": {
                  "type": "STATEMENT"
                },
                "name": "Test",
                "period_start_date": "2020-07-01",
                "period_end_date": "2020-07-31"
              },
              "content": {
                "foreign_object": "7e62ce76-d93d-4f31-92d3-45c2cb8255ea"
              }
            }
          ]
        }
      }
    ]
  }
}

Collection successfully created.

{
  "collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
  "data": {
    "sets": {
      "set": [
        {
          "elements": {
            "element": [
              {
                "property_entry": {
                  "property_entries": {
                    "datetime": "2020-08-25",
                    "description": "Description of property",
                    "event_type": "TestType"
                  }
                },
                "property_class": {
                  "property_clases": {
                    "type": "STATEMENT"
                  },
                  "name": "Test",
                  "period_start_date": "2020-07-01",
                  "period_end_date": "2020-07-31"
                },
                "content": {
                  "foreign_object": "7e62ce76-d93d-4f31-92d3-45c2cb8255ea"
                }
              }
            ]
          }
        }
      ]
    }
  },
  "metadata": {},
  "transaction_id": "6t5r4wq1-9d74-g17e-99ca-a36b30vdfd35"
}

{
  "sets": {
    "set": [
      {
        "properties": {
          "property": [
            {
              "propety_entry": {
                "propety_entries": {
                  "datetime": "2020-05-05",
                  "description": "Test Description",
                  "event_type": "TestType"
                }
              },
              "propety_class": {
                "propety_classes": {
                  "type": "TestType"
                },
                "name": "TestName",
                "period_start_date": "2019-01-01",
                "period_end_date": "2019-12-31"
              },
              "content": {
                "foreign_object": "7z6t5r4e-d93d-4f31-92d3-45c2cb8255ea"
              }
            }
          ]
        }
      }
    ]
  }
}

Collection successfully updated

{
  "collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
  "data": {
    "sets": {
      "set": [
        {
          "properties": {
            "property": [
              {
                "property_data": {
                  "property_class": {
                    "datetime": "2020-05-05",
                    "description": "Info",
                    "event_type": "TestEvent"
                  }
                },
                "document_classification": {
                  "document_classes": {
                    "type": "TestType"
                  },
                  "name": "TestName",
                  "period_start_date": "2019-01-01",
                  "period_end_date": "2019-12-31"
                },
                "content": {
                  "foreign_object": "7z6t5r4e-d93d-4f31-92d3-45c2cb8255ea"
                }
              }
            ]
          }
        }
      ]
    }
  },
  "metadata": {},
  "transaction_id": "6t5r4wq1-9d74-g17e-99ca-a36b30vdfd35"
}

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

Inspection 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."
}

Statuses include: * REQUEST_MADE<p> * REQUEST_ACCEPTED<p> * WAITING_FOR_RESPONSE<p> * COMPLETED

{
  "status": "COMPLETED"
}

Status is unavailable

{
  "error": "Request for specified transaction_id and collection_id was not found!"
}

Transaction successfully created.

{
  "transaction_id": "a34c40a6-3c02-44f9-a696-cd7388f506d3"
}

{
  "sets": {
    "set": [
      {
        "elements": {
          "element": [
            {
              "property_entry": {
                "property_entries": {
                  "datetime": "2020-08-25",
                  "description": "Description of property",
                  "event_type": "TestType"
                }
              },
              "property_class": {
                "property_clases": {
                  "type": "STATEMENT"
                },
                "name": "Test",
                "period_start_date": "2020-07-01",
                "period_end_date": "2020-07-31"
              },
              "content": {
                "foreign_object": "7e62ce76-d93d-4f31-92d3-45c2cb8255ea"
              }
            }
          ]
        }
      }
    ]
  }
}

Collection successfully created.

{
  "collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
  "data": {
    "sets": {
      "set": [
        {
          "elements": {
            "element": [
              {
                "property_entry": {
                  "property_entries": {
                    "datetime": "2020-08-25",
                    "description": "Description of property",
                    "event_type": "TestType"
                  }
                },
                "property_class": {
                  "property_clases": {
                    "type": "STATEMENT"
                  },
                  "name": "Test",
                  "period_start_date": "2020-07-01",
                  "period_end_date": "2020-07-31"
                },
                "content": {
                  "foreign_object": "7e62ce76-d93d-4f31-92d3-45c2cb8255ea"
                }
              }
            ]
          }
        }
      ]
    }
  },
  "metadata": {},
  "transaction_id": "6t5r4wq1-9d74-g17e-99ca-a36b30vdfd35"
}

{
  "sets": {
    "set": [
      {
        "properties": {
          "property": [
            {
              "propety_entry": {
                "propety_entries": {
                  "datetime": "2020-05-05",
                  "description": "Test Description",
                  "event_type": "TestType"
                }
              },
              "propety_class": {
                "propety_classes": {
                  "type": "TestType"
                },
                "name": "TestName",
                "period_start_date": "2019-01-01",
                "period_end_date": "2019-12-31"
              },
              "content": {
                "foreign_object": "7z6t5r4e-d93d-4f31-92d3-45c2cb8255ea"
              }
            }
          ]
        }
      }
    ]
  }
}

Collection successfully updated

{
  "collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
  "data": {
    "sets": {
      "set": [
        {
          "properties": {
            "property": [
              {
                "property_data": {
                  "property_class": {
                    "datetime": "2020-05-05",
                    "description": "Info",
                    "event_type": "TestEvent"
                  }
                },
                "document_classification": {
                  "document_classes": {
                    "type": "TestType"
                  },
                  "name": "TestName",
                  "period_start_date": "2019-01-01",
                  "period_end_date": "2019-12-31"
                },
                "content": {
                  "foreign_object": "7z6t5r4e-d93d-4f31-92d3-45c2cb8255ea"
                }
              }
            ]
          }
        }
      ]
    }
  },
  "metadata": {},
  "transaction_id": "6t5r4wq1-9d74-g17e-99ca-a36b30vdfd35"
}