# Valuation
# Valuation
A blended value opinion combining automated valuation, appraisal and listing signal into one number surfaced to pricing.
Three signals with different failure modes. An automated model is fast and uniform but blind to condition; an appraisal is condition-aware and slow; a listing shows what the market was asked to pay rather than what it paid. The product returns a blended opinion together with the components behind it.
The components are returned, not just the blend. A caller weighing collateral risk needs to know whether the number rests on a recent appraisal or on a model extrapolating from comparables.
## Operations
### Platform
`GET` `/partners`
#### Retrieve Partners
`retrievePartners`
Retrieve Partners retrieves an object containing all Partners active for the product and information about them. You can use the `invoke_name` variable to invoke the partner directly in the product invocation.
##### Response
200403
application/json Copy 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 ...."
}
]
```
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"
}
```
##### Response `200``application/json`
4 fields
Successfully returned the partner list
| Field | Type | Description |
| --- | --- | --- |
| `company_name` | `string` | Name of the partner |
| `invoke_name` | `string` | This string type object can be passed directly into the product invocation |
| `status` | `string` | Describes whether the partner is available to use`active``deprecated``upcoming` |
| `description` | `string` | Further information on the partner |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
`GET` `/response-elements`
#### Retrieve Response Elements
`responseElements`
Retrieve Response Elements provides a list of elements that will be returned by a partner providing an automated valuation model.
##### Response
200403
application/json Copy 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
}
```
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"
}
```
##### Response `200``application/json`
2 fields
Elements retrieved successfully
| Field | Type | Description |
| --- | --- | --- |
| `path` | `string` | Contains the path in Staircase language |
| `value` | `string` | Enter your own values here |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Other responses
`400``404``500`
`GET` `/schema/{data_object}`
#### Retrieve Schema
`retrieveSchema`
Retrieve Schema retrieves a JSON schema for the request and the response returned by the product.
##### Response
200400 InvalidDataObject400 InvalidVersionValue400 MissingVersionParameter400 InvalidReturnExamplesValue403
application/json Copy 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"
]
}
```
application/json Copy Error
```
{
"message": "Please provide one of valid data object values: request, response"
}
```
application/json Copy Error
```
{
"message": "Please provide one of valid version values: v0"
}
```
application/json Copy Error
```
{
"message": "Please make sure your query parameters contains version parameter."
}
```
application/json Copy Error
```
{
"message": "Please provide one of valid return examples values: true, false"
}
```
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"
}
```
##### Parameters
3
| Parameter | Type | Description |
| --- | --- | --- |
| `data_object` required | `string` path | Describes the particular data object you are getting a schema for. |
| `return_examples` | `boolean` query | If included and set to `true`, returns one or more pre-filled examples that conform to the schema. Default to `false` |
| `version` required | `string` query | Defines the version of the Staircase language you want the JSON to return in. |
##### Response `200``application/json`
1 fields
Successfully returned the list of elements needed for AUS.
| Field | Type | Description |
| --- | --- | --- |
| `schema` | `object` | — |
##### Response `400``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
`GET` `/transactions/{transaction_id}/collections`
#### Retrieve Transaction Collections
`retrieveCollections`
Retrieve Transaction Collections returns all collections that associated with a transaction_id.
##### Response
200403404
application/json Copy 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"
}
}
}
]
}
}
]
}
}
]
}
}
}
]
```
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"
}
```
application/json Copy Resource not found
```
{
"message": "Unable to get collections of given transaction. Please check the transaction id"
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string (ulid)` path | `01EZZEHJY0J6Y2C6R2C26C1V2F` | Staircase Transaction Identifier |
##### Response `200``application/json`
4 fields
Successfully Retrieved Collection
| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | Customer Input Data |
| `metadata` | `object` | Staircase metadata |
| `transaction_id` | `string (ulid)` | Staircase Transaction IdentifierExample `01EZZEHJY0J6Y2C6R2C26C1V2F` |
| `collection_id` | `string (ulid)` | Staircase Collection IdentifierExample `01EZZEJ3W6MHW9W75CYHEC9PAZ` |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Other responses
`400`
`PUT` `/transactions/{transaction_id}/collections/{collection_id}`
#### Update Collection
`updateCollection`
Update Collection allows you to update the content of a given collection_id associated with a transaction_id.
##### Response
400 UpdateCollectionError400 MissingTransactionID400 MissingCollectionID403404
application/json Copy Error
```
{
"message": "Unable to update collection. Please check the collection data"
}
```
application/json Copy Error
```
{
"message": "transaction_id value is missing"
}
```
application/json Copy Error
```
{
"message": "collection_id value is missing"
}
```
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"
}
```
application/json Copy Resource not found
```
{
"message": "Unable to update collection. Please check the given ids"
}
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string (ulid)` path | `01EZZEHJY0J6Y2C6R2C26C1V2F` | Staircase Transaction Identifier |
| `collection_id` required | `string (ulid)` path | `01EZZEJ3W6MHW9W75CYHEC9PAZ` | Staircase collection_id |
##### Response `400``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | — |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Other responses
`200`
`POST` `/request-elements/complete`
#### Validate Collection
`validateCollection`
Validate Collection allows you to validate an input collection prior to submitting to our partners. This service will return messages with all the corrections you need to make to your collection in order for it to be accepted by our partner call.
##### Request
application/json Copy
```
{
"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": {}
}
```
##### Response
200400403
application/json Copy Collection is valid
```
{
"message": "Collection is valid."
}
```
application/json Copy 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']:"
}
```
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"
}
```
##### Request body`application/json`
4 fields
| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | Customer Input Data |
| `metadata` | `object` | Staircase metadata |
| `transaction_id` | `string (ulid)` | Staircase Transaction IdentifierExample `01EZZEHJY0J6Y2C6R2C26C1V2F` |
| `collection_id` | `string (ulid)` | Staircase Collection IdentifierExample `01EZZEJ3W6MHW9W75CYHEC9PAZ` |
##### Response `200``application/json`
1 fields
Collection is valid
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `400``application/json`
1 fields
Validation Error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Other responses
`500`
### Workflow
`POST` `/transactions`
#### Create Transaction
`createTransaction`
Create Transaction creates a transaction in Staircase.
Transactions in Staircase are containers for all the data related to an instance of a transaction type. They enable you to correlate the output of various products to a single transaction type, where the transaction type depends on your line of business.
Transactions are identified by a unique key called transaction_id. As you use different Staircase products to gather the data needed for a specific instance of your transaction type, and receive different sets of output from each product, use the same transaction_id to correlate all the outputs to the same transaction.
A transaction_id, when used properly, gives you a holistic view of the data related to the transaction you’ve assembled.
##### Response
201400403
application/json Copy Transaction created successfully
```
{
"transaction_id": {
"$ref": "#/components/schemas/TransactionId/example"
}
}
```
application/json Copy Transaction creation unsuccessfully
```
{
"error": "Response status not OK while creating a new transaction, status_code: [01EZZEHJY0J6Y2C6R2C26C1V2F]",
"error_code": 4050
}
```
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"
}
```
##### Response `201``application/json`
1 fields
Transaction created successfully
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string (ulid)` | Staircase Transaction IdentifierExample `01EZZEHJY0J6Y2C6R2C26C1V2F` |
##### Response `400``application/json`
2 fields
Transaction creation unsuccessfully
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | — |
| `error_code` | `integer` | — |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
`GET` `/request-elements`
#### Retrieve Request Elements
`requestElements`
Retrieve Request Elements retrieves a list of elements needed to invoke a partner for valuation.
##### Response
200403
application/json Copy 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
}
```
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"
}
```
##### Response `200``application/json`
2 fields
Elements retrieved successfully
| Field | Type | Description |
| --- | --- | --- |
| `path` | `string` | Contains the path in Staircase language |
| `value` | `string` | Enter your own values here |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Other responses
`400``500`
`POST` `/build-payload`
#### Build JSON Payload
`retrieveExampleJSON`
Build JSON Payload helps you build a JSON payload using the JSON paths from Retrieve Request Elements/requestElements) or Retrieve Response Elements/responseElements). You can use this payload to either:
- submit a request to valuate collateral.
- simulate a response containing collateral valuation details. Simply add key/value pairs of path/desired output and POST to /build-payload. It will then build a nested JSON. You can find examples below.
##### Request
application/json Copy
```
{
"$.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"
}
```
##### Response
200403
application/json Copy 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"
}
}
}
]
}
}
]
}
}
]
}
}
```
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"
}
```
##### Request body`application/json`
2 fields
| Field | Type | Description |
| --- | --- | --- |
| `path` | `string` | Contains the path in Staircase language |
| `value` | `string` | Enter your own values here |
##### Response `200``application/json`
1 fields
Valuation Payload.
| Field | Type | Description |
| --- | --- | --- |
| `deal_sets` | `object` | — |
| `deal_set` | `object[]` | — |
| `deals` | `object` | — |
| `deal` | `object[]` | — |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Other responses
`400``404``500`
`POST` `/transactions/{transaction_id}/collections`
#### Create Collection
`createCollection`
Create Collection creates a collection of elements required for valuation. A collection contains a digital representation of the borrower and is identified by collection_id. A collection_id is passed to the partner when requesting valuation.
##### Request
EstatedExampleHouseCanaryExample
application/json Copy
```
{
"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": {}
}
```
application/json Copy
```
{
"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": {}
}
```
##### Response
201400403404
application/json Copy 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"
}
```
application/json Copy Error
```
{
"message": "Unable to create collection. Please check the collection data"
}
```
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"
}
```
application/json Copy Resource not found
```
{
"message": "Unable to create collection. Please check the transaction Id"
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string (ulid)` path | `01EZZEHJY0J6Y2C6R2C26C1V2F` | Staircase Transaction Identifier |
##### Request body`application/json`
2 fields
| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | — |
| `deal_sets` | `object` | — |
| `deal_set` | `object[]` | — |
| `deals` | `object` | — |
| `metadata` | `object` | Staircase metadata |
##### Response `201``application/json`
1 fields
Collection created successfully
| Field | Type | Description |
| --- | --- | --- |
| `collection_id` | `string (ulid)` | Staircase Collection IdentifierExample `01EZZEJ3W6MHW9W75CYHEC9PAZ` |
##### Response `400``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | — |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
`POST` `/valuation`
#### Valuate Collateral
`valuation`
Valuate Collateral invokes a partner to provide automated valuation modeling for a property. To invoke Valuate Collateral, you will need:
- a transaction_id/createTransaction), and
- a collection_id/createCollection).
Once you have a transaction_id and collection_id, you can send them, along with your Authorization Key (api_key), to as many partners as you want.
Simply invoke Valuate Collateral with the same transaction_id and collection_id, but with different partner names. The partner_name parameter is optional. You can retrieve partner_name information by querying the /partners endpoint. Doing so enables you to get automated valuation modeling results from multiple partners, and to see which one provides the optimal response.
Valuate Collateral returns, as a synchronous acknowledgement, a new collection_id. The new collection_id represents an empty container which will hold the partner's response once processing has completed.
##### Response
201400 MissingTransactionID400 MissingCollectionID400 InvalidPartnerName400 InvalidJSONBody403404 GetCollectionError404 PostalCodeNotFoundError
application/json Copy Request for valuation successfully.
```
{
"transaction_id": "01EZZEHJY0J6Y2C6R2C26C1V2F",
"collection_id": "01EZZEJ3W6MHW9W75CYHEC9PAZ"
}
```
application/json Copy General error
```
{
"message": "transaction_id value is missing"
}
```
application/json Copy General error
```
{
"message": "collection_id value is missing"
}
```
application/json Copy General error
```
{
"message": "Please provide a valid partner name. To get available partners, you can use /partners endpoint."
}
```
application/json Copy General error
```
{
"message": "Request body had invalid format. Please provide a valid JSON"
}
```
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"
}
```
application/json Copy Resource not found
```
{
"message": "Unable to get collection. Please check input collection id"
}
```
application/json Copy 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"
}
```
##### Request body`application/json`
3 fields
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id`required | `string (ulid)` | Staircase Transaction IdentifierExample `01EZZEHJY0J6Y2C6R2C26C1V2F` |
| `collection_id`required | `string (ulid)` | Staircase Collection IdentifierExample `01EZZEJ3W6MHW9W75CYHEC9PAZ` |
| `partner_name` | `string` | To get available partners, you can use /partners endpoint |
##### Response `201``application/json`
2 fields
Request for valuation successfully.
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string (ulid)` | Staircase Transaction IdentifierExample `01EZZEHJY0J6Y2C6R2C26C1V2F` |
| `collection_id` | `string (ulid)` | Staircase Collection IdentifierExample `01EZZEJ3W6MHW9W75CYHEC9PAZ` |
##### Response `400``application/json`
1 fields
General error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `422``application/json`
1 fields
Unprocessable Entity
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
`GET` `/status/{transaction_id}/{collection_id}`
#### Retrieve Status
`retrieveStatus`
Retrieve Status determines if a partner has completed valuation.
##### Response
400 MissingTransactionID400 MissingCollectionID403404
application/json Copy Error
```
{
"message": "transaction_id value is missing"
}
```
application/json Copy Error
```
{
"message": "collection_id value is missing"
}
```
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"
}
```
application/json Copy Resource not found
```
{
"message": "Unable to get status. Please check the given ids"
}
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string (ulid)` path | `01EZZEHJY0J6Y2C6R2C26C1V2F` | Staircase Transaction Identifier |
| `collection_id` required | `string (ulid)` path | `01EZZEJ3W6MHW9W75CYHEC9PAZ` | Staircase collection_id |
##### Response `200``application/json`
1 fields
Request for getting AVM request status.
| Field | Type | Description |
| --- | --- | --- |
| `status` | `string` | Potential status responses: 'IN_PROGRESS', 'WAITING_FOR_RESPONSE', 'COMPLETED', 'ERROR' |
##### Response `400``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Other responses
`500`
`GET` `/transactions/{transaction_id}/collections/{collection_id}`
#### Retrieve Collection
`retrieveCollection`
Retrieve Collection returns the content of a given collection_id associated with a transaction_id.
##### Response
200400 MissingTransactionID400 MissingCollectionID403404
application/json Copy 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
}
]
}
}
]
}
}
}
]
}
}
]
}
}
]
}
}
}
```
application/json Copy Error
```
{
"message": "transaction_id value is missing"
}
```
application/json Copy Error
```
{
"message": "collection_id value is missing"
}
```
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"
}
```
application/json Copy Resource not found
```
{
"message": "Unable to get collection. Please check the given ids"
}
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string (ulid)` path | `01EZZEHJY0J6Y2C6R2C26C1V2F` | Staircase Transaction Identifier |
| `collection_id` required | `string (ulid)` path | `01EZZEJ3W6MHW9W75CYHEC9PAZ` | Staircase collection_id |
##### Response `200``application/json`
4 fields
Successfully Retrieved Collection
| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | Customer Input Data |
| `metadata` | `object` | Staircase metadata |
| `transaction_id` | `string (ulid)` | Staircase Transaction IdentifierExample `01EZZEHJY0J6Y2C6R2C26C1V2F` |
| `collection_id` | `string (ulid)` | Staircase Collection IdentifierExample `01EZZEJ3W6MHW9W75CYHEC9PAZ` |
##### Response `400``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
### Operations
`POST` `/avm`
#### Create AVM
`post-avm`
##### Request
application/json Copy
```
{
"transaction_id": "uhz6t54e-9d74-g17e-99ca-a36b30vdfd35",
"collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
"partner_name": "PartnerName"
}
```
##### Response
application/json Copy 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."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Request body`application/json`
3 fields
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id`required | `string` | Transaction ID |
| `collection_id`required | `string` | Collection ID |
| `partner_name`required | `string` | — |
##### Response `200``application/json`
2 fields
AVM request created successfully.
| Field | Type | Description |
| --- | --- | --- |
| `collection_id` | `string` | Collection ID |
| `message` | `string` | Message |
`GET` `/avm/elements`
#### Retrieve Elements
`get-avm-elements`
Retrieve Elements provides a list of the elements needed to invoke a partner product.
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Response `200``application/json`
1 fields
Elements needed for request.
| Field | Type | Description |
| --- | --- | --- |
| `elements` | `object` | List of elements |
`POST` `/avm/elements/complete`
#### Validate Collection
`post-avm-collection-complete`
Validate Collection validates that a collection contains all of the elements needed to invoke a partner product.
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Request body`application/json`
1 fields
| Field | Type | Description |
| --- | --- | --- |
| `collection`required | `object` | — |
##### Response `400``application/json`
2 fields
Collection is invalid.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message |
| `errors` | `object` | List of elements that are missing |
##### Other responses
`200`
`GET` `/avm/status/{transaction_id}/{collection_id}`
#### Retrieve Status
`get-avm-status`
Retrieve Status checks status of your request. Possible statuses:
- REQUEST_MADE
- REQUEST_ACCEPTED
- WAITING_FOR_RESPONSE
- COMPLETED
##### Response
200400
application/json Copy Statuses include: * REQUEST_MADE * REQUEST_ACCEPTED
* WAITING_FOR_RESPONSE
* COMPLETED
```
{
"status": "COMPLETED"
}
```
application/json Copy Status is unavailable
```
{
"error": "Request for specified transaction_id and collection_id was not found!"
}
```
##### Parameters
3
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string` path | `9u8z7t65-cb71-4f20-8e40-7a829b52e91e` | Transaction ID |
| `collection_id` required | `string` path | `e4502ed2-8df8-4b8f-84bd-a1097e999a77` | Collection ID |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Response `200``application/json`
1 fields
Statuses include: * REQUEST_MADE
* REQUEST_ACCEPTED
* WAITING_FOR_RESPONSE
* COMPLETED
| Field | Type | Description |
| --- | --- | --- |
| `status` | `object` | Current execution status |
##### Response `400``application/json`
1 fields
Status is unavailable
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message |
`POST` `/avm/transactions`
#### Create Transaction
`post-avm-transaction`
Create Transaction creates a transaction in Staircase. A transaction in Staircase is an acknowledgement that you want to call a Staircase product. It's a container for everything associated with that product invocation, and is correlated with a collection related to the product (e.g. a document). You need to create a new transaction every time you want to connect with a Staircase product. Staircase then associates everything, from a data and API execution standpoint, to that transaction.
##### Response
application/json Copy Transaction successfully created.
```
{
"transaction_id": "a34c40a6-3c02-44f9-a696-cd7388f506d3"
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Response `200``application/json`
1 fields
Transaction successfully created.
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string` | Transaction ID |
`POST` `/avm/transactions/{transaction_id}/collections`
#### Create Collection
`post-avm-collection`
Create Collection creates a collection of elements . The elements within the collection are required.
##### Request
application/json Copy
```
{
"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"
}
}
]
}
}
]
}
}
```
##### Response
application/json Copy 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"
}
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string` path | `3wet53r4-cb71-8u74-8e40-7a829b52e91e` | Transaction ID |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Request body`application/json`
2 fields
| Field | Type | Description |
| --- | --- | --- |
| `data`required | `object` | — |
| `metadata` | `object` | — |
##### Response `200``application/json`
4 fields
Collection successfully created.
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `object` | Transaction ID |
| `collection_id` | `object` | Collection ID |
| `data` | `object` | Data object |
| `metadata` | `object` | Metadata object |
`PUT` `/avm/transactions/{transaction_id}/collections/{collection_id}`
#### Update Collection
`put-avm-collection`
Update Collection updates a collection of elements by new elements.
##### Request
application/json Copy
```
{
"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"
}
}
]
}
}
]
}
}
```
##### Response
application/json Copy 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"
}
```
##### Parameters
3
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string` path | `3wet53r4-cb71-8u74-8e40-7a829b52e91e` | Transaction ID |
| `collection_id` required | `string` path | `9u8z7t65-cb71-8u74-8e40-7a829b52e91e` | Transaction ID |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | API Key |
##### Request body`application/json`
2 fields
| Field | Type | Description |
| --- | --- | --- |
| `data`required | `object` | — |
| `metadata` | `object` | — |
##### Response `200``application/json`
4 fields
Collection successfully updated
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `object` | Transaction ID |
| `collection_id` | `object` | Collection ID |
| `data` | `object` | Data object |
| `metadata` | `object` | Metadata object |
`GET` `/info`
#### Info endpoint
Placeholder endpoint. As this is a language repo, it must be used in conjunction with the Translator Service.
##### Other responses
`200`
`POST` `/inspection`
#### Create Inspection
`post-inspection`
##### Request
application/json Copy
```
{
"transaction_id": "uhz6t54e-9d74-g17e-99ca-a36b30vdfd35",
"collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
"partner_name": "PartnerName"
}
```
##### Response
application/json Copy 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."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Request body`application/json`
3 fields
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id`required | `string` | Transaction ID |
| `collection_id`required | `string` | Collection ID |
| `partner_name`required | `string` | — |
##### Response `200``application/json`
2 fields
Inspection request created successfully.
| Field | Type | Description |
| --- | --- | --- |
| `collection_id` | `string` | Collection ID |
| `message` | `string` | Message |
`GET` `/inspection/elements`
#### Retrieve Elements
`get-inspection-elements`
Retrieve Elements provides a list of the elements needed to invoke a partner product.
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Response `200``application/json`
1 fields
Elements needed for request.
| Field | Type | Description |
| --- | --- | --- |
| `elements` | `object` | List of elements |
`POST` `/inspection/elements/complete`
#### Validate Collection
`post-inspection-collection-complete`
Validate Collection validates that a collection contains all of the elements needed to invoke a partner product.
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Request body`application/json`
1 fields
| Field | Type | Description |
| --- | --- | --- |
| `collection`required | `object` | — |
##### Response `400``application/json`
2 fields
Collection is invalid.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message |
| `errors` | `object` | List of elements that are missing |
##### Other responses
`200`
`GET` `/inspection/status/{transaction_id}/{collection_id}`
#### Retrieve Status
`get-inspection-status`
Retrieve Status checks status of your request. Possible statuses:
- REQUEST_MADE
- REQUEST_ACCEPTED
- WAITING_FOR_RESPONSE
- COMPLETED
##### Response
200400
application/json Copy Statuses include: * REQUEST_MADE
* REQUEST_ACCEPTED
* WAITING_FOR_RESPONSE
* COMPLETED
```
{
"status": "COMPLETED"
}
```
application/json Copy Status is unavailable
```
{
"error": "Request for specified transaction_id and collection_id was not found!"
}
```
##### Parameters
3
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string` path | `9u8z7t65-cb71-4f20-8e40-7a829b52e91e` | Transaction ID |
| `collection_id` required | `string` path | `e4502ed2-8df8-4b8f-84bd-a1097e999a77` | Collection ID |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Response `200``application/json`
1 fields
Statuses include: * REQUEST_MADE
* REQUEST_ACCEPTED
* WAITING_FOR_RESPONSE
* COMPLETED
| Field | Type | Description |
| --- | --- | --- |
| `status` | `object` | Current execution status |
##### Response `400``application/json`
1 fields
Status is unavailable
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message |
`POST` `/inspection/transactions`
#### Create Transaction
`post-inspection-transaction`
Create Transaction creates a transaction in Staircase. A transaction in Staircase is an acknowledgement that you want to call a Staircase product. It's a container for everything associated with that product invocation, and is correlated with a collection related to the product (e.g. a document). You need to create a new transaction every time you want to connect with a Staircase product. Staircase then associates everything, from a data and API execution standpoint, to that transaction.
##### Response
application/json Copy Transaction successfully created.
```
{
"transaction_id": "a34c40a6-3c02-44f9-a696-cd7388f506d3"
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Response `200``application/json`
1 fields
Transaction successfully created.
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string` | Transaction ID |
`POST` `/inspection/transactions/{transaction_id}/collections`
#### Create Collection
`post-inspection-collection`
Create Collection creates a collection of elements . The elements within the collection are required.
##### Request
application/json Copy
```
{
"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"
}
}
]
}
}
]
}
}
```
##### Response
application/json Copy 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"
}
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string` path | `3wet53r4-cb71-8u74-8e40-7a829b52e91e` | Transaction ID |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Request body`application/json`
2 fields
| Field | Type | Description |
| --- | --- | --- |
| `data`required | `object` | — |
| `metadata` | `object` | — |
##### Response `200``application/json`
4 fields
Collection successfully created.
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `object` | Transaction ID |
| `collection_id` | `object` | Collection ID |
| `data` | `object` | Data object |
| `metadata` | `object` | Metadata object |
`PUT` `/inspection/transactions/{transaction_id}/collections/{collection_id}`
#### Update Collection
`put-inspection-collection`
Update Collection updates a collection of elements by new elements.
##### Request
application/json Copy
```
{
"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"
}
}
]
}
}
]
}
}
```
##### Response
application/json Copy 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"
}
```
##### Parameters
3
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string` path | `3wet53r4-cb71-8u74-8e40-7a829b52e91e` | Transaction ID |
| `collection_id` required | `string` path | `9u8z7t65-cb71-8u74-8e40-7a829b52e91e` | Transaction ID |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | API Key |
##### Request body`application/json`
2 fields
| Field | Type | Description |
| --- | --- | --- |
| `data`required | `object` | — |
| `metadata` | `object` | — |
##### Response `200``application/json`
4 fields
Collection successfully updated
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `object` | Transaction ID |
| `collection_id` | `object` | Collection ID |
| `data` | `object` | Data object |
| `metadata` | `object` | Metadata object |
## Errors
`400``403``404``422``500`
## More in Assessment
- Previous product: Tax