doc_ids |
|
integer |
Represents a valid Compliance.ai document id. If other submitted parameters are inlcuded in the request then the results will be based on all the parameters submitted. An invalid doc_ids input will return an error, and acceptable input data currently ranges from 1-7 digits. Example Doc ID: 3428065 - 'OCC Guidelines Establishing Standards for Recovery Planning by Certain Large Insured National Banks' |
doc_id |
|
integer |
Represents a valid Compliance.ai document id. This doc_id attribute is replaced by doc_ids and will be phased out. If other submitted parameters are inlcuded in the request then the results will be based on all the parameters submitted. An invalid doc_id input will return an error, and acceptable input data currently ranges from 1-7 digits. Example Doc ID: 3428065 - 'OCC Guidelines Establishing Standards for Recovery Planning by Certain Large Insured National Banks' |
resource_id |
|
string |
Represents a valid Compliance.ai document resource id. If provided, and doc_id is not provided, all other submitted parameters will be ignored and the call will return one document based on the specified resource id. An invalid resource_id input will return an error, and acceptable input data currently is made of alpha numeric characters. Example Resource ID: '35 CFR' should return a document with the title: 'Title 35-Panama Canal' |
more_like_doc_id |
|
integer |
Returns three documents similiar to the provided doc_id. An invalid doc_id input will return null, and acceptable input data currently ranges from 1-7 digits. |
get_count_only |
|
bool |
Returns only the number of documents found in the search, shown as 'count' in the response body. Use 'true' to show the number of documents, otherwise leave blank. |
query |
|
string |
Allows a random bag of words search with boolean search terms. By default, the call returns latest documents for query term. Example query with search operators: ('consumer protection' OR 'data protection') AND 'financial institution' |
advanced_search |
|
string |
Allows to build a query with advanced search operators that require the correct sequence of attributes, comparators, and values. The Advanced Search parameter can be used by itself, or combined with other parameters. More info on this feature can be found here, under the Advanced Search section. |
topic_id |
|
integer |
Returns documents based on an available topic. List of topics and the associated topic_id can be found here. |
topic_threshold_key |
|
query |
Returns documents based on the selected threshold for topics. Thresholds available are low, medium, and high. |
regulation_id |
|
integer |
Returns documents based on a specific regulation. List of regulations and the associated reg_id can be found here. |
agency_id |
|
integer |
Limit the query to documents from a specific agency. A list of agencies and the associated agency_id can be retrieved from the 'Agencies' query below or can be found here. |
skip_agency |
|
integer |
Skips documents published by a specific agency. A list of agencies and the associated agency_id can be retrieved from the 'Agencies' query below or can be found here |
all_agencies |
|
bool |
Return documents for all agencies in compliance.ai. Use 'true' if a specific agency is not selected |
cai_category |
|
integer |
Filter based on a type of document. List of categories and the associated cai_category_id can be found using the Document Type API endpoint. |
category |
|
string |
Filter based on a type of document. List of categories and the associated category_id can be found here. Please note that the values are case-sensitive. |
skip_category |
|
string |
Skips documents under a specific category. List of categories and the associated category_id can be found here. Please note that the values are case-sensitive. |
bank_id |
|
integer |
Returns documents associated with a bank_id. A list of banks and the associated bank_id can be found here. |
citation_id |
|
integer |
Returns documents associated with a citation_id |
docket_id |
|
integer |
Returns documents in a docket |
act_id |
|
integer |
Returns documents based on a query for an act_id. A list of popular acts and the associated act_id can be found here. |
jurisdiction |
|
integer |
Returns documents published by a jurisdiction. A list of jurisdictions and the associated jurisdiction_id can be found here. |
news_source_id |
|
integer |
Returns documents published by a specific news source. A list of news sources and the associated news_source_id can be found here. |
publication_date |
|
string |
Optional filter for date. Get only documents for your query that were published on a specific date. Please use format MM/DD/YYYY for absolute date and note that dates are in UTC. This can be used with specific relative dates like 'Today', 'Tomorrow', 'Yesterday', or with a range of relative dates like 'within 30 days' by using the value '[x]:[days/weeks/months/years]. For example '30:days'. Please note that the input '30:days' does not pass through this Interactive API but works as intended when making a request directly. |
published_from |
|
string |
Optional filter for date. Get only documents for your query that were published from a specific date forward. Can be used with 'published_to' to provide a date range. Please use format MM/DD/YYYY. |
published_to |
|
string |
Optional filter for date. Get only documents for your query that were published up until a specific date. Can be used with 'published_from' to provide a date range. Please use format MM/DD/YYYY. |
key_date_from |
|
string |
Returns documents that have a comments_close_from OR compliance_from date from a specific date forward. Can be used with 'key_date_to' to provide a range. Please use format MM/DD/YYYY. |
key_date_to |
|
string |
Returns documents that have a comments_close_to or a compliance_to date up until a specific date. Can be used with 'key_date_from' to provide a range. Please use format MM/DD/YYYY. |
comments_close_date |
|
string |
Returns documents that have a comments close date from a specific date. Please use format MM/DD/YYYY for absolute date and note that dates are in UTC. This can be used with specific relative dates like 'Today', 'Tomorrow', 'Yesterday', or with a range of relative dates like 'within 30 days' by using the value '[x]:[days/weeks/months/years]. For example '30:days'. Please note that the input '30:days' does not pass through this Interactive API but works as intended when making a request directly. |
comments_close_from |
|
string |
Returns documents that have a comments close date from a specific date forward. Can be used with 'comments_close_to' to provide a range. Please use format MM/DD/YYYY. |
comments_close_to |
|
string |
Returns documents that have a comments close date up until a specific date. Can be used with 'comments_close_from' to provide a range. Please use format MM/DD/YYYY. |
compliance_date |
|
string |
Returns documents that were effective from a specific date. Please use format MM/DD/YYYY for absolute date and note that dates are in UTC. This can be used with specific relative dates like 'Today', 'Tomorrow', 'Yesterday', or with a range of relative dates like 'within 30 days' by using the value '[x]:[days/weeks/months/years]. For example '30:days'. Please note that the input '30:days' does not pass through this Interactive API but works as intended when making a request directly. |
compliance_from |
|
string |
Returns documents that were effective from a specific date forward. Can be used with 'compliance_to' to provide a range. Please use format MM/DD/YYYY. |
compliance_to |
|
string |
Returns documents that were effective up until a specific date. Can be used with 'compliance_from' to provide a range. Please use format MM/DD/YYYY. |
created_date |
|
string |
Returns documents that were created in the system from a specific date. Please use format MM/DD/YYYY for absolute date and note that dates are in UTC. This can be used with specific relative dates like 'Today', 'Tomorrow', 'Yesterday', or with a range of relative dates like 'within 30 days' by using the value '[x]:[days/weeks/months/years]. For example '30:days'. Please note that the input '30:days' does not pass through this Interactive API but works as intended when making a request directly. |
created_from |
|
string |
Returns documents that were created in the system from a specific date forward. Can be used with 'created_to' to provide a range. Please use format YYYY-MM-DD HH:MM:SS.MS |
created_to |
|
string |
Returns documents that were created in the system up until a specific date. Can be used with 'created_from' to provide a range. Please use format YYYY-MM-DD HH:MM:SS.MS. If no time value is provided, then the request will assume 00:00:00:00 |
updated_date |
|
string |
Returns documents that were updated in the system from a specific date. Please use format MM/DD/YYYY for absolute date. This can be used with specific relative dates like 'Today', 'Tomorrow', 'Yesterday', or with a range of relative dates like 'within 30 days' by using the value '[x]:[days/weeks/months/years]. For example '30:days'. Please note that the input '30:days' does not pass through this Interactive API but works as intended when making a request directly. |
updated_from |
|
string |
Returns documents that were updated in the system from a specific date forward. Can be used with 'updated_to' to provide a range. Please use format YYYY-MM-DD HH:MM:SS.MS |
updated_to |
|
string |
Returns documents that were updated in the system up until a specific date. Can be used with 'updated_from' to provide a range. Please use format YYYY-MM-DD HH:MM:SS.MS. If no time value is provided, then the request will assume 00:00:00:00 |
has_individual_respondent |
|
bool |
Returns enforcement documents that have an individual respondent. Will return null if there are no documents with individual respondents that exactly match the input. |
has_entity_respondent |
|
bool |
Returns enforcement documents that have an entity respondent. Will return null if there are no documents with entity respondents that exactly match the input. |
monetary_penalty |
|
integer |
Returns only documents that have this monetary penalty. Will return null if there are no documents with a monetary penalty that exactly match the input. Any numerical and decimal value is acceptable without the use of special characters such as commas. |
monetary_penalty_min |
|
integer |
Returns only documents that have a monetary greater than monetary_penalty_min. Can be used with 'monetary_penalty_max' to provide a penatly range. Any numerical and decimal value is acceptable without the use of special characters such as commas. |
monetary_penalty_max |
|
integer |
Returns only documents that have a monetary less than monetary_penalty_max. Can be used with 'monetary_penalty_min' to provide a penatly range. Any numerical and decimal value is acceptable without the use of special characters such as commas. |
min_score |
|
integer |
Returns documents that have a search relevance score above the input. Use a value between 1-100; a number closer to 100 will return more relevant results with fewer documents. Please note that there can be a result of 0 documents if the relevant score is too high. |
offset |
|
integer |
If your search finds 'count'=100 documents, offset=20 will return 80 documents and remove the first 20. Search results will still show the document 'count' without the offset. If offset input value is greater than the document 'count', search result will return 0 documents. Offset is limited to 9,999 and we recommend refining the search criteria when result count is >10K. |
order |
|
string |
Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error. |
sort |
|
string |
Sort documents by 'category', 'id' or 'publication_date'. A secondary sort value can also be added, for example - 'publication_date,category'. Any other input value will return an error. |
limit |
|
integer |
Limit the number of documents returned. |
exclusive_fields |
|
string |
The returned document JSON will contain only the attribute and sub attributes specified by exclusive_fields. For example - exclusive_fields=attribute_1&exclusive_fields=attribute_2.sub_attribute_1&....&exclusive_fields=field_N. Please note that multiple inputs does not pass through this Interactive API but works as intended when making a request directly. |
folder_id |
|
integer |
Only returns documents that are under the specified user-created folder id. |
task_owner |
|
string |
Returns documents that have workflow tasks associated with the 'current_user' or 'organization'. Any other input value will return an error. |
title |
|
string |
Returns documents published with the provided search terms in the title. |
text |
|
string |
Returns documents published with the provided search terms in the full_text of the document. |
formatted_full_text |
|
bool |
Returns an cleanly formatted full_text attrribute for documents that have sentences available. Use 'true' to show documents with formatted_full_text, otherwise leave blank. |
has_obligations |
|
bool |
Returns documents that have obligations available. Use 'true' to show documents with obligations, otherwise leave blank. Note - ignore has_obligation field in the results as it is not currently used, and instead we use obligation_probability to determine if a document has obligations |
has_sentences |
|
bool |
Returns documents that have their text split into separate sentences. Use 'true' to show documents with sentences, otherwise leave blank. |