{
"opencollection": "1.0.0",
"info": {
"name": "Canoe API v1 Documents API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Documents",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Document Data",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.canoesoftware.com/v1/documents/data",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "This page number. For example, if you specify \"2\" you will see all documents on page 2. By default, this is set to 1. This parameter is only valid if the X-API-VERSION header is set to 2022-09-19. Example: 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The number of documents for each page. The maximum number of documents limit is 100. This parameter is only valid if the X-API-VERSION header is set to 2022-09-19. Example: 50"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "The fields you need in the partial response. The value of the fields parameter MUST be a comma-separated (U+002C COMMA, \",\") list that refers to the name(s) of the fields to be returned."
},
{
"name": "allocation_id",
"value": "",
"type": "query",
"description": "The IDs of the allocations in Canoe."
},
{
"name": "document_id",
"value": "",
"type": "query",
"description": "The IDs of the documents in Canoe."
},
{
"name": "client_document_id",
"value": "",
"type": "query",
"description": "The custom document IDs."
},
{
"name": "fund_id",
"value": "",
"type": "query",
"description": "The IDs of funds in Canoe. To retrieve these, use the v1/funds endpoint."
},
{
"name": "account_id",
"value": "",
"type": "query",
"description": "The IDs of accounts in Canoe. To retrieve these, use the v1/organizations?type=account endpoint."
},
{
"name": "investment_entity_id",
"value": "",
"type": "query",
"description": "The IDs of investment entities in Canoe. To retrieve these, use the v1/organizations?type=entity endpoint."
},
{
"name": "not_account_id",
"value": "",
"type": "query",
"description": "Exclude documents with the specified Account IDs. To retrieve Account IDs, use the v1/accounts endpoint."
},
{
"name": "document_type",
"value": "",
"type": "query",
"description": "The document types. To retrieve these, use the v1/documents/types endpoint."
},
{
"name": "fund_sponsor",
"value": "",
"type": "query",
"description": "The Fund Sponsors. The entered Fund Sponsors must be an exact match, although all query parameters are case-insensitive."
},
{
"name": "data_date_start",
"value": "",
"type": "query",
"description": "All documents returned will have data date greater than or equal to the given data_date_start. This will be in EST (Eastern Standard Time)."
},
{
"name": "data_date_end",
"value": "",
"type": "query",
"description": "All documents returned will have data date less than or equal to the given data_date_end. This will be in EST (Eastern Standard Time)."
},
{
"name": "document_status",
"value": "",
"type": "query",
"description": "This is the validation status determined by Canoe. For example, Complete means that Canoe has successfully categorized, recognized, extracted, and validated data from the document.
Our current statuses are:
Complete
Potential Discrepancy
Duplicate
Password Protected
Configuration Required
Unsupported Formats
Anomaly Detected
Awaiting Confirmation
Storage Only
A misspelled status will return an empty array."
},
{
"name": "document_source",
"value": "",
"type": "query",
"description": "The method of document ingestion. These sources are:
Upload Engine
Email
Intralinks
API"
},
{
"name": "document_tag_id",
"value": "",
"type": "query",
"description": "The IDs of tags in Canoe. To retrieve these, use the v1/documents/tags endpoint."
},
{
"name": "file_upload_time_start",
"value": "",
"type": "query",
"description": "All documents downloaded will have an uploaded timestamp greater than or equal to the given file_upload_time_start. Unless otherwise specified, the timestamp will be in EST (Eastern Standard Time). We suggest using the ISO 8601 format for the parameter. For example, '2019-09-18T00:00:00-07:00' represents the time in Pacific Daylight Time; this will be automatically converted to EST. In this case, the user will receive the documents uploaded on or after 2019-09-19 at 03:00:00."
},
{
"name": "file_upload_time_end",
"value": "",
"type": "query",
"description": "All documents downloaded will have an uploaded timestamp less than or equal to the given file_upload_time_end. Unless otherwise specified, the timestamp will be in EST (Eastern Standard Time). We suggest using the ISO 8601 format for the parameter. For example, '2019-09-18T00:00:00-07:00' represents the time in Pacific Daylight Time; this will be automatically converted to EST. In this case, the user will receive the documents uploaded on or after 2019-09-19 at 03:00:00."
},
{
"name": "account_group",
"value": "",
"type": "query",
"description": "The Account Group the documents belong to."
},
{
"name": "last_modified_time_start",
"value": "",
"type": "query",
"description": "All documents returned will have a last updated timestamp greater than or equal to the given last_modified_time_start. Unless otherwise specified, the timestamp will be in EST (Eastern Standard Time). We suggest using the ISO 8601 format for the parameter. For example, '2019-09-18T00:00:00-07:00' represents the time in Pacific Daylight Time; this will be automatically converted to EST. In this case, the user will receive the documents updated on or after 2019-09-19 at 03:00:00."
},
{
"name": "last_modified_time_end",
"value": "",
"type": "query",
"description": "All documents returned will have a last updated timestamp less than or equal to the given last_modified_time_end. Unless otherwise specified, the timestamp will be in EST (Eastern Standard Time). We suggest using the ISO 8601 format for the parameter. For example, '2019-09-18T00:00:00-07:00' represents the time in Pacific Daylight Time; this will be automatically converted to EST. In this case, the user will receive the documents updated on or after 2019-09-19 at 03:00:00."
},
{
"name": "is_locked",
"value": "",
"type": "query",
"description": "The is_locked status of the document in Canoe. Accepted values are either true or false. The default is false."
},
{
"name": "ready_for_extract",
"value": "",
"type": "query",
"description": "The extraction status of the document in Canoe. Accepted values are either true or false. The default is false."
},
{
"name": "sum_values",
"value": "",
"type": "query",
"description": "Whether to return the sums of multi-data point fields in validated_data. Accepted values are either true or false. If it is set to false, multi-data points are returned as a list of values. The default is false."
},
{
"name": "approval_status",
"value": "",
"type": "query",
"description": "The approval status of the documents in Canoe. If searching for multiple statuses, they should be separated by commas. Valid statuses are:
Approved
Flagged
Ignored
Pending"
},
{
"name": "approved_by",
"value": "",
"type": "query",
"description": "The User ID of the approver of the documents in Canoe."
},
{
"name": "approval_date_start",
"value": "",
"type": "query",
"description": "All documents returned will have an approval date greater than or equal to the given approval_date_start. This will be in EST (Eastern Standard Time)."
},
{
"name": "approval_date_end",
"value": "",
"type": "query",
"description": "All documents returned will have an approval date less than or equal to the given approval_date_end. This will be in EST (Eastern Standard Time)."
},
{
"name": "assignee",
"value": "",
"type": "query",
"description": "The User ID of the assignee for the document in Canoe. If searching for multiple assignees, they should be separated by commas. Example:- user_1,user_2"
},
{
"name": "not_document_tag_id",
"value": "",
"type": "query",
"description": "The IDs of tags in Canoe. To retrieve these, use the v1/documents/tags endpoint. This will search for documents that have NOT been tagged with a specified tag."
},
{
"name": "category",
"value": "",
"type": "query",
"description": "The category of the document. Our current categories are:
Capital Activity
Email & System Messages
Financial Statements & Performance
Investment & Transactional
Investor Administration & Communication
Legal, Compliance & Regulatory
Other
Tax
Multiple categories can be passed as a comma-delimited list (e.g. Capital Activity,Tax)."
},
{
"name": "downstream_ids",
"value": "",
"type": "query",
"description": "Filter documents by downstream system identifiers. Accepts an array of key-value pairs where the key represents the downstream system name and the value represents the identifier in that system. Multiple pairs can be provided to filter by multiple downstream systems.This parameter is only valid if the X-API-VERSION header is set to 2022-09-19 and pagination is provided."
}
]
},
"docs": "Fetch documents' extracted data and metadata.\n\nBy default, Canoe's server sends back the full representation of each document object after processing requests.\nFor faster performance, you can use optional parameters to retrieve a subset of documents.\n\n\nThis endpoint offers optional pagination. \nPagination supports the return of large results and is highly recommended for all use cases. \nUnpaginated calls will be depreciated in future versions of the Canoe API.\n
This parameter is only valid if the X-API-VERSION header is set to 2022-09-19. Example: 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The number of documents for each page. The maximum number of documents limit is 100. This parameter is only valid if the X-API-VERSION header is set to 2022-09-19. Example: 50"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "The fields you need in the partial response. The value of the fields parameter MUST be a comma-separated (U+002C COMMA, \",\") list that refers to the name(s) of the fields to be returned."
},
{
"name": "document_id",
"value": "",
"type": "query",
"description": "The IDs of the documents in Canoe."
},
{
"name": "client_document_id",
"value": "",
"type": "query",
"description": "The custom document IDs."
},
{
"name": "fund_id",
"value": "",
"type": "query",
"description": "The IDs of funds in Canoe. To retrieve these, use the v1/funds endpoint."
},
{
"name": "account_id",
"value": "",
"type": "query",
"description": "The IDs of accounts in Canoe. To retrieve these, use the v1/organizations?type=account endpoint."
},
{
"name": "investment_entity_id",
"value": "",
"type": "query",
"description": "The IDs of investment entities in Canoe. To retrieve these, use the v1/organizations?type=entity endpoint."
},
{
"name": "document_type",
"value": "",
"type": "query",
"description": "The document types. To retrieve these, use the v1/documents/types endpoint."
},
{
"name": "fund_sponsor",
"value": "",
"type": "query",
"description": "The Fund Sponsors. The entered Fund Sponsors must be an exact match, although all query parameters are case-insensitive."
},
{
"name": "data_date_start",
"value": "",
"type": "query",
"description": "All documents returned will have data date greater than or equal to the given data_date_start. This will be in EST (Eastern Standard Time)."
},
{
"name": "data_date_end",
"value": "",
"type": "query",
"description": "All documents returned will have data date less than or equal to the given data_date_end. This will be in EST (Eastern Standard Time)."
},
{
"name": "document_status",
"value": "",
"type": "query",
"description": "This is the validation status determined by Canoe. For example, Complete means that Canoe has successfully categorized, recognized, extracted, and validated data from the document.
Our current statuses are:
Complete
Potential Discrepancy
Duplicate
Password Protected
Configuration Required
Unsupported Formats
Anomaly Detected
Awaiting Confirmation
Storage Only
A misspelled status will return an empty array."
},
{
"name": "document_source",
"value": "",
"type": "query",
"description": "The method of document ingestion. These sources are:
Upload Engine
Email
Intralinks
API"
},
{
"name": "skip_downloaded",
"value": "",
"type": "query",
"description": "Setting to true excludes documents from the response that have previously been downloaded through the API for the document allocations that match the call's other request parameters. The default value is false."
},
{
"name": "document_tag_id",
"value": "",
"type": "query",
"description": "The IDs of tags in Canoe. To retrieve these, use the v1/documents/tags endpoint."
},
{
"name": "file_upload_time_start",
"value": "",
"type": "query",
"description": "All documents downloaded will have an uploaded timestamp greater than or equal to the given file_upload_time_start. Unless otherwise specified, the timestamp will be in EST (Eastern Standard Time). We suggest using the ISO 8601 format for the parameter. For example, '2019-09-18T00:00:00-07:00' represents the time in Pacific Daylight Time; this will be automatically converted to EST. In this case, the user will receive the documents uploaded on or after 2019-09-19 at 03:00:00."
},
{
"name": "file_upload_time_end",
"value": "",
"type": "query",
"description": "All documents downloaded will have an uploaded timestamp less than or equal to the given file_upload_time_end. Unless otherwise specified, the timestamp will be in EST (Eastern Standard Time). We suggest using the ISO 8601 format for the parameter. For example, '2019-09-18T00:00:00-07:00' represents the time in Pacific Daylight Time; this will be automatically converted to EST. In this case, the user will receive the documents uploaded on or after 2019-09-19 at 03:00:00."
},
{
"name": "account_group",
"value": "",
"type": "query",
"description": "The Account Group the documents belong to."
},
{
"name": "last_modified_time_start",
"value": "",
"type": "query",
"description": "All documents returned will have a last updated timestamp greater than or equal to the given last_modified_time_start. Unless otherwise specified, the timestamp will be in EST (Eastern Standard Time). We suggest using the ISO 8601 format for the parameter. For example, '2019-09-18T00:00:00-07:00' represents the time in Pacific Daylight Time; this will be automatically converted to EST. In this case, the user will receive the documents updated on or after 2019-09-19 at 03:00:00."
},
{
"name": "last_modified_time_end",
"value": "",
"type": "query",
"description": "All documents returned will have a last updated timestamp less than or equal to the given last_modified_time_end. Unless otherwise specified, the timestamp will be in EST (Eastern Standard Time). We suggest using the ISO 8601 format for the parameter. For example, '2019-09-18T00:00:00-07:00' represents the time in Pacific Daylight Time; this will be automatically converted to EST. In this case, the user will receive the documents updated on or after 2019-09-19 at 03:00:00."
},
{
"name": "is_locked",
"value": "",
"type": "query",
"description": "The is_locked status of the document in Canoe. Accepted values are either true or false. The default is false."
},
{
"name": "file_name_type",
"value": "",
"type": "query",
"description": "The document name format to return for each document. The available options are name, original_file_name and id. The default value for this is name, which is your tenant's custom \"Document Name Format\" specified in the Intelligent Document Center. original_file_name returns the name of the file as it appeared when loaded into Canoe. id returns the document’s Canoe Document Identifier."
},
{
"name": "ready_for_extract",
"value": "",
"type": "query",
"description": "The extraction status of the document in Canoe. Accepted values are either true or false. The default is false."
},
{
"name": "approval_status",
"value": "",
"type": "query",
"description": "The approval status of the documents in Canoe. If searching for multiple statuses, they should be separated by commas. Valid statuses are:
Approved
Flagged
Ignored
Pending"
},
{
"name": "approved_by",
"value": "",
"type": "query",
"description": "The User ID of the approver of the documents in Canoe."
},
{
"name": "approval_date_start",
"value": "",
"type": "query",
"description": "All documents returned will have an approval date greater than or equal to the given approval_date_start. This will be in EST (Eastern Standard Time)."
},
{
"name": "approval_date_end",
"value": "",
"type": "query",
"description": "All documents returned will have an approval date less than or equal to the given approval_date_end. This will be in EST (Eastern Standard Time)."
},
{
"name": "assignee",
"value": "",
"type": "query",
"description": "The User ID of the assignee for the document in Canoe. If searching for multiple assignees, they should be separated by commas. Example:- user_1,user_2"
},
{
"name": "not_document_tag_id",
"value": "",
"type": "query",
"description": "The IDs of tags in Canoe. To retrieve these, use the v1/documents/tags endpoint. This will search for documents that have NOT been tagged with a specified tag."
},
{
"name": "category",
"value": "",
"type": "query",
"description": "The category of the document. Our current categories are:
Capital Activity
Email & System Messages
Financial Statements & Performance
Investment & Transactional
Investor Administration & Communication
Legal, Compliance & Regulatory
Other
Tax
Multiple categories can be passed as a comma-delimited list (e.g. Capital Activity,Tax)."
}
]
},
"docs": "Download documents in a ZIP file. Each fetch will download up to 100 documents. By default, this will fetch the first 100 documents in the Intelligent Document Center. A successful call to this endpoint will only contain the binary file and not the JSON data.\n\nTo retrieve additional information, you can inspect the response header data. There, you can find the total number of documents filtered by current query parameters."
},
{
"info": {
"name": "Upload A Single Document",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.canoesoftware.com/v1/documents",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upload a Single Document"
},
{
"info": {
"name": "Update Allocation Tags",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.canoesoftware.com/v1/documents/:allocationId/allocation-tags",
"params": [
{
"name": "allocationId",
"value": "",
"type": "path",
"description": "The unique identifier of the allocation"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the allocation tags for a specific document allocation. You can either add tags to existing ones or completely replace them using the overwrite option."
}
]
}
],
"bundled": true
}