Skip to content
Staircase

Closing

Closing coordination: connecting title, escrow and the origination system at the closing table.

Closing is where three systems have to agree at once — the origination system holds the loan, the title company holds the commitment and the settlement statement, and escrow holds the funds. The slot covers keeping the document set and the figures aligned across them through the ceremony.

What is recorded is the closing surface of a service that routes several products under one contract, which is why the operations below sit alongside document creation and title rather than in a namespace of their own. The electronic-closing endpoints are the ones filed against this slot.

Operations

Operations

POST /eclosing

Create eClosing

post-eclosing

Create QC

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

eClosing request created successfully.

{
  "collection_id": "e4502ed2-8df8-4b8f-84bd-a1097e999a77",
  "message": "When ready, data will be available under the following collection_id. Use this new collection_id to get the execution status."
}
Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
Request bodyapplication/json
3 fields
FieldTypeDescription
transaction_idrequiredstringTransaction ID
collection_idrequiredstringCollection ID
partner_namerequiredstring—
Response 200application/json
2 fields

eClosing request created successfully.

FieldTypeDescription
collection_idstringCollection ID
messagestringMessage
GET /eclosing/elements

Retrieve Elements

get-eclosing-elements

Retrieve Elements provides a list of the elements needed to invoke a partner product.

Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
Response 200application/json
1 fields

Elements needed for request.

FieldTypeDescription
elementsobjectList of elements
POST /eclosing/elements/complete

Validate Collection

post-eclosing-collection-complete

Validate Collection validates that a collection contains all of the elements needed to invoke a partner product.

Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
Request bodyapplication/json
1 fields
FieldTypeDescription
collectionrequiredobject—
Response 400application/json
2 fields

Collection is invalid.

FieldTypeDescription
messagestringError message
errorsobjectList of elements that are missing
Other responses

200

POST /eclosing/lexicon/elements

Retrieve Lexicon Elements

You can retrieve element structure by providing specific element names (XPaths).

Request bodyapplication/json
1 fields
FieldTypeDescription
elementsstring[]An XPath to a valid staircase element
Other responses

200

GET /eclosing/status/{transaction_id}/{collection_id}

Retrieve Status

get-eclosing-status

Retrieve Status checks status of your request. Possible statuses:

  • REQUEST_MADE
  • REQUEST_ACCEPTED
  • WAITING_FOR_RESPONSE
  • COMPLETED
Response
application/json

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

{
  "status": "COMPLETED"
}
Parameters
3
ParameterTypeExampleDescription
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 200application/json
1 fields

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

FieldTypeDescription
statusobjectCurrent execution status
Response 400application/json
1 fields

Status is unavailable

FieldTypeDescription
errorstringError message
POST /eclosing/transactions

Create Transaction

post-eclosing-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

Transaction successfully created.

{
  "transaction_id": "a34c40a6-3c02-44f9-a696-cd7388f506d3"
}
Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
Response 200application/json
1 fields

Transaction successfully created.

FieldTypeDescription
transaction_idstringTransaction ID
POST /eclosing/transactions/{transaction_id}/collections

Create Collection

post-eclosing-collection

Create Collection creates a collection of elements. The elements within the collection are required.

Request
application/json 
{
  "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

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
ParameterTypeExampleDescription
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 bodyapplication/json
2 fields
FieldTypeDescription
datarequiredobject—
metadataobject—
Response 200application/json
4 fields

Collection successfully created.

FieldTypeDescription
transaction_idobjectTransaction ID
collection_idobjectCollection ID
dataobjectData object
metadataobjectMetadata object
PUT /eclosing/transactions/{transaction_id}/collections/{collection_id}

Update Collection

put-eclosing-collection

Update Collection updates a collection of elements by new elements.

Request
application/json 
{
  "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

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
ParameterTypeExampleDescription
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 bodyapplication/json
2 fields
FieldTypeDescription
datarequiredobject—
metadataobject—
Response 200application/json
4 fields

Collection successfully updated

FieldTypeDescription
transaction_idobjectTransaction ID
collection_idobjectCollection ID
dataobjectData object
metadataobjectMetadata object
POST /esign-enotary

Create eSign & eNotary

post-esign-enotary

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

eSign & eNotary request created successfully.

{
  "collection_id": "e4502ed2-8df8-4b8f-84bd-a1097e999a77",
  "message": "When ready, data will be available under the following collection_id. Use this new collection_id to get the execution status."
}
Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
Request bodyapplication/json
3 fields
FieldTypeDescription
transaction_idrequiredstringTransaction ID
collection_idrequiredstringCollection ID
partner_namerequiredstring—
Response 200application/json
2 fields

eSign & eNotary request created successfully.

FieldTypeDescription
collection_idstringCollection ID
messagestringMessage
GET /esign-enotary/elements

Retrieve Elements

get-esign-enotary-elements

Retrieve Elements provides a list of the elements needed to invoke a partner product.

Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
Response 200application/json
1 fields

Elements needed for request.

FieldTypeDescription
elementsobjectList of elements
POST /esign-enotary/elements/complete

Validate Collection

post-esign-enotary-collection-complete

Validate Collection validates that a collection contains all of the elements needed to invoke a partner product.

Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
Request bodyapplication/json
1 fields
FieldTypeDescription
collectionrequiredobject—
Response 400application/json
2 fields

Collection is invalid.

FieldTypeDescription
messagestringError message
errorsobjectList of elements that are missing
Other responses

200

GET /esign-enotary/status/{transaction_id}/{collection_id}

Retrieve Status

get-esign-enotary-status

Retrieve Status checks status of your request. Possible statuses:

  • REQUEST_MADE
  • REQUEST_ACCEPTED
  • WAITING_FOR_RESPONSE
  • COMPLETED
Response
application/json

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

{
  "status": "COMPLETED"
}
Parameters
3
ParameterTypeExampleDescription
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 200application/json
1 fields

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

FieldTypeDescription
statusobjectCurrent execution status
Response 400application/json
1 fields

Status is unavailable

FieldTypeDescription
errorstringError message
POST /esign-enotary/transactions

Create Transaction

post-esign-enotary-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

Transaction successfully created.

{
  "transaction_id": "a34c40a6-3c02-44f9-a696-cd7388f506d3"
}
Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
Response 200application/json
1 fields

Transaction successfully created.

FieldTypeDescription
transaction_idstringTransaction ID
POST /esign-enotary/transactions/{transaction_id}/collections

Create Collection

post-esign-enotary-collection

Create Collection creates a collection of elements . The elements within the collection are required.

Request
application/json 
{
  "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

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
ParameterTypeExampleDescription
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 bodyapplication/json
2 fields
FieldTypeDescription
datarequiredobject—
metadataobject—
Response 200application/json
4 fields

Collection successfully created.

FieldTypeDescription
transaction_idobjectTransaction ID
collection_idobjectCollection ID
dataobjectData object
metadataobjectMetadata object
PUT /esign-enotary/transactions/{transaction_id}/collections/{collection_id}

Update Collection

put-esign-enotary-collection

Update Collection updates a collection of elements by new elements.

Request
application/json 
{
  "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

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
ParameterTypeExampleDescription
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 bodyapplication/json
2 fields
FieldTypeDescription
datarequiredobject—
metadataobject—
Response 200application/json
4 fields

Collection successfully updated

FieldTypeDescription
transaction_idobjectTransaction ID
collection_idobjectCollection ID
dataobjectData object
metadataobjectMetadata object
POST /funding

Create Funding

post-funding

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

Funding request created successfully.

{
  "collection_id": "e4502ed2-8df8-4b8f-84bd-a1097e999a77",
  "message": "When ready, data will be available under the following collection_id. Use this new collection_id to get the execution status."
}
Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
Request bodyapplication/json
3 fields
FieldTypeDescription
transaction_idrequiredstringTransaction ID
collection_idrequiredstringCollection ID
partner_namerequiredstring—
Response 200application/json
2 fields

Funding request created successfully.

FieldTypeDescription
collection_idstringCollection ID
messagestringMessage
GET /funding/elements

Retrieve Elements

get-funding-elements

Retrieve Elements provides a list of the elements needed to invoke a partner product.

Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
Response 200application/json
1 fields

Elements needed for request.

FieldTypeDescription
elementsobjectList of elements
POST /funding/elements/complete

Validate Collection

post-funding-collection-complete

Validate Collection validates that a collection contains all of the elements needed to invoke a partner product.

Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
Request bodyapplication/json
1 fields
FieldTypeDescription
collectionrequiredobject—
Response 400application/json
2 fields

Collection is invalid.

FieldTypeDescription
messagestringError message
errorsobjectList of elements that are missing
Other responses

200

GET /funding/status/{transaction_id}/{collection_id}

Retrieve Status

get-funding-status

Retrieve Status checks status of your request. Possible statuses:

  • REQUEST_MADE
  • REQUEST_ACCEPTED
  • WAITING_FOR_RESPONSE
  • COMPLETED
Response
application/json

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

{
  "status": "COMPLETED"
}
Parameters
3
ParameterTypeExampleDescription
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 200application/json
1 fields

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

FieldTypeDescription
statusobjectCurrent execution status
Response 400application/json
1 fields

Status is unavailable

FieldTypeDescription
errorstringError message
POST /funding/transactions

Create Transaction

post-funding-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

Transaction successfully created.

{
  "transaction_id": "a34c40a6-3c02-44f9-a696-cd7388f506d3"
}
Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Authorization key
Response 200application/json
1 fields

Transaction successfully created.

FieldTypeDescription
transaction_idstringTransaction ID
POST /funding/transactions/{transaction_id}/collections

Create Collection

post-funding-collection

Create Collection creates a collection of elements . The elements within the collection are required.

Request
application/json 
{
  "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

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
ParameterTypeExampleDescription
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 bodyapplication/json
2 fields
FieldTypeDescription
datarequiredobject—
metadataobject—
Response 200application/json
4 fields

Collection successfully created.

FieldTypeDescription
transaction_idobjectTransaction ID
collection_idobjectCollection ID
dataobjectData object
metadataobjectMetadata object
PUT /funding/transactions/{transaction_id}/collections/{collection_id}

Update Collection

put-funding-collection

Update Collection updates a collection of elements by new elements.

Request
application/json 
{
  "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

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
ParameterTypeExampleDescription
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 bodyapplication/json
2 fields
FieldTypeDescription
datarequiredobject—
metadataobject—
Response 200application/json
4 fields

Collection successfully updated

FieldTypeDescription
transaction_idobjectTransaction ID
collection_idobjectCollection ID
dataobjectData object
metadataobjectMetadata object

Errors

400

Type to search.