Service Guides for ResourceIQ

Investigate use cases. Find sample scenarios. Learn how your applications can best use ResourceIQ.

Search for an External Document Reference

After you have created your external document reference (POST /{custid}/externaldocument), you can search for your external document reference by the external document id. The search will yield the external document object that you have requested, any errors and a success flag.

To Search for an External Document Reference (example):

Gather the following information for the request:

  • The customer ID and the API Key.
  • The external document id for the external document reference.




200 OK

  "externalDocument": {
    "extensionObject": {
      "id": "50b4fa0d-a5cf-4ecb-92fd-58ac4c5800bc",
      "customerId": "123355",
      "status": "active",
      "objectType": "external_document",
      "objectDescription": "This is an external document object."
    "externalDocument": {
      "externalDocumentType": "Sample type",
      "fileFormat": "application/zip",
      "notes": "Sample notes",
      "url": ""
    "dateCreated": "2019-01-17T20:14:34.000Z",
    "dateLastUpdated": "2019-01-17T20:14:34.000Z"
  "errors": [],
  "successful": true

For more information on the GET search for external document by id resource, please refer to our interactive or service reference documentation.