Interactive API

OAuth 2.0 Flow: Select OAuth 2.0 Flow

Existing Client Credentials: Manual Input

API Key:

App/Key: Select Application Key Manually provide key information

Shared Secret:

Client ID:

Client Secret: Authorize

Client ID: Get Access Token

Client ID:

Client Secret:

---

Username:

Password: Get Access Token

Client ID:

Client Secret: Get Access Token

Authorization Code: Get Access Token

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

• Search

  • List Methods
  • Expand Methods

  • GET Search Documents /v1/search

    This method returns relevant documents based on the query provided. Query will return zero / null results if there are no documents matching the query, or an unaccepted value is used for one of the parameters. When making a request that includes the parameters agency, jurisdiction, and news source, the search will include these as an OR statement and results will include documents that match any of those values. In order to input multiple values into a parameter, please include the parameter and the multiple values into the advanced_search parameter or manually update the request URL to include the multiple values as attribute=1&attribute=2&attribute=3

    Parameter	Value	Type	Description
    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.
    language_id		integer	This field enables document retrieval based on the available language; i.e., when searching for documents with 'doc type = Rule' and 'language = English,' the system displays English language versions if available, but if there are no English versions, it shows all other language versions of the documents. To obtain the 'language_id,' please refer to the language endpoint.
    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		string	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		string	Returns documents published by a jurisdiction based on a query for a Short_Name (i.e.: FRA). A list of jurisdictions and the associated Short_Name 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.
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    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.
    label		integer	Only returns documents that are labeled with a specified label 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.

  • POST Search Documents POST v1/search_post

    This method returns relevant documents based on the query provided. Query will return zero / null results if there are no documents matching the query, or an unaccepted value is used for one of the parameters. When making a request that includes the parameters agency, jurisdiction, and news source, the search will include these as an OR statement and results will include documents that match any of those values. In order to input multiple values into a parameter, please include comma separated values for the parameter.

    Request Body

    { "advanced_search": "(agency = CYM-CIMA AND cai_category IN [1071, 1238])", "sort": "publication_date", "limit": "10" }

    { "advanced_search": "(agency = CYM-CIMA AND cai_category IN [1071, 1238])", "sort": "publication_date", "limit": "10" }
  • GET Pre-Filtered Content /v1/pre_filtered_content

    This method returns content based on the alerts configured in the Compliance.ai application. User can only access this content if their organization has been set up with a Service Connector.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    date_processed_from		string	Optional filter for processed date. Get only documents for your query that were processed from a specific date forward. Can be used with 'date_processed_to' to provide a date range. Please use format YYYY-MM-DD HH:MM:SS.MS(i.e.: 2021-08-20 02:31:04.218132).
    date_processed_to		string	Optional filter for processed date. Get only documents for your query that were processed up until a specific date. Can be used with 'date_processed_from' to provide a date range. Please use format YYYY-MM-DD HH:MM:SS.MS(2021-08-20 02:34:47.347985).

  • GET Agencies /v1/agencies

    This method returns the most up-to-date list of agencies. A list of agencies and the associated agency_id can be retrieved from the 'Agencies' query below or can be found here

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    id		integer	Represents a valid Compliance.ai agency id. An invalid agency id input will return an error, and acceptable input data currently ranges from 1-9 digits. Example Agency ID: 573 - 'CFPB'
    exclusive_fields		string	The response will exclusively include the attribute specified by the 'exclusive_fields' parameter. For instance, if you specify exclusive_fields=id&exclusive_fields=jurisdiction as the exclusive fields, the response will provide agencies information specifically for these attributes. It's important to note that while multiple inputs don't pass through this Interactive API, they function as intended when making a request directly.
    sort		string	Sort agencies by 'id'. Any other input value will not affect the search results.
    order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.

  • GET Jurisdictions /v1/jurisdictions

    This method returns the most up-to-date list of jurisdictions. A list of jurisdictions and the associated jurisdiction_id can be found here

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    active		bool	If set to true, results will only return jurisdictions that are active in Comlpiance.ai.
    id		integer	Represents a valid Compliance.ai jurisdiction id. An invalid jurisdiction id input will return an error, and acceptable input data currently ranges from 1-4 digits. Example Jurisdiction ID: 6 - 'US-CA, California'
    sort		string	Sort jurisdictions by 'id'. Any other input value will not affect the search results.
    order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.

  • GET Topics /v1/topics

    This method returns the most up-to-date list of topics. List of topics and the associated topic_id can be found here.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    active_streaming		bool	If set to true, results will only return topics that are active in Comlpiance.ai.
    id		integer	Represents a valid Compliance.ai topic id. An invalid topic id input will return an error, and acceptable input data currently ranges from 1-2 digits. Example Topic ID: 11 - 'Securities'
    sort		string	Sort topics by 'id'. Any other input value will return an error.
    order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.

  • GET Languages /v1/languages

    This method provides the latest list of supported languages for document retrieval, and you can use the returned language_id in the search method to fetch matched documents.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.

  • GET Document Types /v1/document_type

    This method returns the most up-to-date list of document types. You can use these in the 'category' parameter in the Search API. The Search API accepts values from the list in section 'scrap_category_dic' of the results. List of document types/categories and the associated category_ids can be found here.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    query		string	Allows a random bag of words search with boolean search terms and does a relevancy search against Cateogry and Metacategory name and description
    cai_category_id		integer	Represents a valid Compliance.ai document category. An invalid document category input will return an error.
    cai_metacategory_id		integer	Represents a valid Compliance.ai document metacategory. An invalid document metacategory input will return an error.

  • GET Regulations /v1/regulations

    This method returns the most up-to-date list of regulations. List of regulations and the associated regulation_ids can be found here.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    id		integer	Represents a valid Compliance.ai regulation id. An invalid regulation id input will return an error, and acceptable input data currently has 1-3 digits. Example Regulation ID: 120 - 'Basel III'
    sort		string	Sort jurisdictions by 'id'. Any other input value will return an error.
    order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.

  • GET Acts /v1/acts

    This method returns the most up-to-date list of acts. To get the full list of Acts, use limit and offset to paginate results over multiple queries. ie. limit=100 & offset=500 => return businesses 500-599. List of regulations and the associated regulation_ids can be found here.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    id		integer	Represents a valid Compliance.ai act id. An invalid act id input will return an error, and acceptable input data currently ranges from 1-5 digits. Example Jurisdiction ID: 769 - 'Bank Secrecy Act'
    date		string	Returns acts based on date. Format the input value as such - 'YYYY-MM-DDT00:00:00', please keep include the 'T00:00:00' at the end of the date without any space. Example input: '1970-10-26T00:00:00'
    sort		string	Sort acts by 'id'. Any other input value will return an error.
    order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.
    limit		integer	Limit the number of documents returned. Default = 1000. Max value = 1000.
    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.

  • GET concepts /v1/concepts

    This method retrieves a list of most up-to-date of concepts.

    Parameter	Value	Type	Description
    accept-encoding		string	This method allows you to retrieve a comprehensive list of Concepts, providing detailed information about each concepts. Please keep 'identity' as this parameter's value.
    count_per_page		integer	This parameter sets the number of results to display per page.
    page		integer	This parameter indicates the page number of results to retrieve.

  • POST Diffing /v1/diff_documents

    Compare two documents by inputting two document IDs. doc_id_v1 & doc_id_v2 represents a valid Compliance.ai document id. 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'

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header

    Request Body

    { "doc_id_v1": "5660867", "doc_id_v2": "5660866" }

    { "doc_id_v1": "5660867", "doc_id_v2": "5660866" }
  • GET Suggestion /v1/suggestion

    This returns auto-suggest results based on text input.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    query		string	Type any term to get back auto-suggest results. Can return 0 results.

  • GET Get PDF /v1/pdf

    This returns a PDF file for the document requested. Please note that PDF files are not available for 'Mainstream News' document categories and also not for documents that are protected by copyright by the publishing source.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    doc_id		integer	Returns a PDF document based on a valid Document ID provided.

• Search

  • List Methods
  • Expand Methods

  • GET Search Documents v1/searchoauth

    This method returns relevant documents based on the query provided. Query will return zero / null results if there are no documents matching the query, or an unaccepted value is used for one of the parameters. When making a request that includes the parameters agency, jurisdiction, and news source, the search will include these as an OR statement and results will include documents that match any of those values. In order to input multiple values into a parameter, please include the parameter and the multiple values into the advanced_search parameter or manually update the request URL to include the multiple values as attribute=1&attribute=2&attribute=3

    Parameter	Value	Type	Description
    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.
    language_id		integer	This field enables document retrieval based on the available language; i.e., when searching for documents with 'doc type = Rule' and 'language = English,' the system displays English language versions if available, but if there are no English versions, it shows all other language versions of the documents. To obtain the 'language_id,' please refer to the language endpoint.
    topic_threshold_key		query	Returns documents based on the selected threshold for topics. Thresholds available are low, medium, and high.
    concept_id		integer	Returns documents based on an available concept. List of concepts and the associated concept_id can be found here.
    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 and here
    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		string	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		string	Returns documents published by a jurisdiction based on a query for a Short_Name (i.e.: FRA). A list of jurisdictions and the associated Short_Name 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.
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    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
    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.
    label		integer	Only returns documents that are labeled with a specified label 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.

  • POST Search Documents POST v1/searchoauth_post

    This method returns relevant documents based on the query provided. Query will return zero / null results if there are no documents matching the query, or an unaccepted value is used for one of the parameters. When making a request that includes the parameters agency, jurisdiction, and news source, the search will include these as an OR statement and results will include documents that match any of those values. In order to input multiple values into a parameter, please include comma separated values for the parameter.

    Request Body

    { "advanced_search": "(agency = CYM-CIMA AND cai_category IN [1071, 1238])", "sort": "publication_date", "limit": "10" }

    { "advanced_search": "(agency = CYM-CIMA AND cai_category IN [1071, 1238])", "sort": "publication_date", "limit": "10" }
  • GET Pre-Filtered Content /v1/pre_filtered_content_oauth

    This method returns content based on the alerts configured in the Compliance.ai application. User can only access this content if their organization has been set up with a Service Connector.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    date_processed_from		string	Optional filter for processed date. Get only documents for your query that were processed from a specific date forward. Can be used with 'date_processed_to' to provide a date range. Please use format YYYY-MM-DD HH:MM:SS.MS(i.e.: 2021-08-20 02:31:04.218132).
    date_processed_to		string	Optional filter for processed date. Get only documents for your query that were processed up until a specific date. Can be used with 'date_processed_from' to provide a date range. Please use format YYYY-MM-DD HH:MM:SS.MS(2021-08-20 02:34:47.347985).

  • GET Agencies /v1/agencies_oauth

    This method returns the most up-to-date list of agencies.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    id		integer	Represents a valid Compliance.ai agency id. An invalid agency id input will return an error, and acceptable input data currently ranges from 1-9 digits. Example Agency ID: 573 - 'CFPB'
    exclusive_fields		string	The response will exclusively include the attribute specified by the 'exclusive_fields' parameter. For instance, if you specify exclusive_fields=id&exclusive_fields=jurisdiction as the exclusive fields, the response will provide agencies information specifically for these attributes. It's important to note that while multiple inputs don't pass through this Interactive API, they function as intended when making a request directly.
    sort		string	Sort agencies by 'id'. Any other input value will not affect the search results.
    order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.

  • GET News Sources & Premium Content Providers /v1/news_sources_premium_providers_oauth

    This method returns the most up-to-date list of news sources and premium content providers. Note that premium content providers are treated as news sources.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    sort_by		string	Sort results by 'id'. Any other input value will not affect the search results.
    sort_order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.
    is_premium_content_provider		string	Returns results based on whether the news source is also a premium content provider or not. Use 'true', 'false', or leave blank.

  • GET Jurisdictions /v1/jurisdictions_oauth

    This method returns the most up-to-date list of jurisdictions.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    active		bool	If set to true, results will only return jurisdictions that are active in Comlpiance.ai.
    id		integer	Represents a valid Compliance.ai jurisdiction id. An invalid jurisdiction id input will return an error, and acceptable input data currently ranges from 1-4 digits. Example Jurisdiction ID: 6 - 'US-CA, California'
    sort		string	Sort jurisdictions by 'id'. Any other input value will not affect the search results.
    order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.

  • GET Topics /v1/topics_oauth

    This method returns the most up-to-date list of topics.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    active_streaming		bool	If set to true, results will only return jurisdictions that are active in Comlpiance.ai.
    id		integer	Represents a valid Compliance.ai topic id. An invalid topic id input will return an error, and acceptable input data currently ranges from 1-2 digits. Example Topic ID: 11 - 'Securities'
    sort		string	Sort topics by 'id'. Any other input value will return an error.
    order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.

  • GET Languages /v1/languages_oauth

    This method provides the latest list of supported languages for document retrieval, and you can use the returned language_id in the search method to fetch matched documents.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.

  • GET Document Types /v1/document_type_oauth

    This method returns the most up-to-date list of document types. You can use these in the 'category' parameter in the Search API. The Search API accepts values from the list in section 'scrap_category_dic' of the results.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    query		string	Allows a random bag of words search with boolean search terms and does a relevancy search against Cateogry and Metacategory name and description
    cai_category_id		integer	Represents a valid Compliance.ai document category. An invalid document category input will return an error.
    cai_metacategory_id		integer	Represents a valid Compliance.ai document metacategory. An invalid document metacategory input will return an error.

  • GET Regulations /v1/regulations_oauth

    This method returns the most up-to-date list of regulations.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    id		integer	Represents a valid Compliance.ai regulation id. An invalid regulation id input will return an error, and acceptable input data currently has 1-3 digits. Example Regulation ID: 120 - 'Basel III'
    sort		string	Sort jurisdictions by 'id'. Any other input value will return an error.
    order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.

  • GET Acts /v1/acts_oauth

    This method returns the most up-to-date list of acts. To get the full list of Acts, use limit and offset to paginate results over multiple queries. ie. limit=100 & offset=500 => return businesses 500-599

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    id		integer	Represents a valid Compliance.ai act id. An invalid act id input will return an error, and acceptable input data currently ranges from 1-5 digits. Example Jurisdiction ID: 769 - 'Bank Secrecy Act'
    date		string	Returns acts based on date. Format the input value as such - 'YYYY-MM-DDT00:00:00', please keep include the 'T00:00:00' at the end of the date without any space. Example input: '1970-10-26T00:00:00'
    sort		string	Sort acts by 'id'. Any other input value will return an error.
    order		string	Sort in Descending 'desc' or Ascending 'asc' order. Any other input value will return an error.
    limit		integer	Limit the number of documents returned. Default = 1000. Max value = 1000.
    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.

  • GET concepts /v1/concepts_oauth_1

    This method retrieves a list of most up-to-date of concepts.

    Parameter	Value	Type	Description
    accept-encoding		string	This method allows you to retrieve a comprehensive list of Concepts, providing detailed information about each concepts. Please keep 'identity' as this parameter's value.
    count_per_page		integer	This parameter sets the number of results to display per page.
    page		integer	This parameter indicates the page number of results to retrieve.

  • POST Diffing /v1/diff_documents_oauth

    Compare two documents by inputting two document IDs. doc_id_v1 & doc_id_v2 represents a valid Compliance.ai document id. 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'

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header

    Request Body

    { "doc_id_v1": "5660867", "doc_id_v2": "5660866" }

    { "doc_id_v1": "5660867", "doc_id_v2": "5660866" }
  • GET Tasks /v2/tasks_oauth

    COMING SOON - This method returns the most up-to-date tasks for an assignee.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header

  • POST Tasks - Old /v1/tasks_oauth

    This method returns the most up-to-date tasks for an assignee.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header

  • POST Update Task /v2/update_task_oauth

    This method updates the status of a task.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    task_id		integer	Specifies a task whose status should be updated.
    task_status		string	Specifies the new status of the task.

  • POST Update Task - Old /v1/update_task_oauth

    This method updates the status of a task.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    task_id		integer	Specifies a task whose status should be updated.
    task_status		string	Specifies the new status of the task.

  • GET Suggestion /v1/suggestion_oauth

    This returns auto-suggest results based on text input.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    query		string	Type any term to get back auto-suggest results. Can return 0 results.

  • GET Get PDF /v1/pdf_oauth

    This returns a PDF file for the document requested. Please note that PDF files are not available for 'Mainstream News' document categories and also not for documents that are protected by copyright by the publishing source.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    doc_id		integer	Returns a PDF document based on a valid Document ID provided.

• Folders

  • List Methods
  • Expand Methods

  • GET Get list of Folders /v1/folders_1

    This end point retrieves details about folders and their subfolders

    Parameter	Value	Type	Description
    count_per_page		integer	Number of items per page
    created_from		string	Filter data created from this date
    created_to		string	Filter data created to this date
    name		string	Filter data by name
    owner		string	Filter data by owner
    sort_field		string	Field to sort by
    sort_order		string	Sort order (asc or desc)
    updated_from		string	Filter data updated from this date
    updated_to		string	Filter data updated to this date

  • GET Details of a folder /v1/folders_1/:folder_id/details

    This endpoint is used to provide details of a folder or Subfolder.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :folder_id		integer	Folder ID

  • GET Path information of a Folder or subfolder /v1/folders_1/:folder_id/paths

    This endpoint is used to provide path information of a folder or Subfolder.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :folder_id		integer

  • POST Copy a Folder or subfolder /v1/folders_1/{folder_id}/copy

    This endpoint is used to copy a folder or Subfolder.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :folder_id		integer

    Request Body

    { "name": "Copy of Folder AB" }

    { "name": "Copy of Folder AB" }
  • GET Get a Document Folder by ID /v1/folders_1/:folder_id

    This end point retrieves details about a document folder or subfolder based on the provided ID

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :folder_id		integer

  • PATCH Update a Folder /v1/folders_1/:folder_id

    This endpoint is used to update a folder.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :folder_id		integer

    Request Body

    { "name": "Updated folder" }

    { "name": "Updated folder" }
  • POST Create a subfolder /v1/folders_1/:parent_folder_id

    This endpoint is used to create a Subfolder.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :parent_folder_id		integer

    Request Body

    { "name": "Name of a sub folder" }

    { "name": "Name of a sub folder" }
  • PATCH Update a subfolder /v1/folders_1/:parent_folder_id/:folder_id

    This endpoint is used to update a Subfolder.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :parent_folder_id		integer
    :folder_id		integer

    Request Body

    { "name": "Updated sub folder" }

    { "name": "Updated sub folder" }
  • POST Add Documents to a Folder or subfolder /v1/folders_1/:folder_id/add_documents

    This endpoint is used to add documents to a folder or Subfolder. It's important to note that while multiple inputs don't pass through this Interactive API, they function as intended when making a request directly.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :folder_id		integer

    Request Body

    { "document_ids": "13636419" }

    { "document_ids": "13636419" }
  • GET Get number of documents /v1/folders_1/doc_saved_folders_count/:document_id

    This endpoint returns the count of the folders in which a particular document is saved.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :document_id		integer

• References

  • List Methods
  • Expand Methods

  • GET concepts /v1/concepts

    This method retrieves a list of most up-to-date of concepts.

    Parameter	Value	Type	Description
    accept-encoding		string	This method allows you to retrieve a comprehensive list of Concepts, providing detailed information about each concepts. Please keep 'identity' as this parameter's value.
    count_per_page		integer	This parameter sets the number of results to display per page.
    page		integer	This parameter indicates the page number of results to retrieve.

• SCIM Endpoints

  • List Methods
  • Expand Methods

  • GET SCIM Users - GET /scim/Users

    This method returns a set of Users that are a part of your Organization, along with the attributes for each.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    filter		string	This endpoint allows you to retrieve a list of all users with the specified username user@domain.com. Use the filter parameter to apply the username filter in this format: userName eq "user@domain.com".

  • GET SCIM Users by ID - GET /scim/Users/:user_id

    This endpoint, where 'id' is the unique identifier of the user resource, retrieves the details of a specific user resource, allowing clients to retrieve the details of a particular user from your Organization.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :user_id		integer	Returns attributes based on a valid User ID provided

  • PUT SCIM Users - PUT /scim/Users/:user_id

    This method allows you to modify specific attribuets of a User from your Organization. Currently, only roles, externalID, and enabled are the only attributes that can be modified.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :user_id		integer	Provide a valid User ID.

    Request Body

    { "userName": "", "externalId": "", "active": true, "userType": "Org Admin" }

    { "userName": "", "externalId": "", "active": true, "userType": "Org Admin" }
  • POST SCIM Users - POST /scim/Users

    This method allows you to create/provision a new user with the required attributes included in the request. Please make sure to use an email for the UserName value so the new user can use that email to login to pro.compliance.ai using the Corporate Login.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header

    Request Body

    { "userName": "", "externalId": "", "active": true, "userType": "Org Admin" }

    { "userName": "", "externalId": "", "active": true, "userType": "Org Admin" }
  • PATCH SCIM Users - PATCH /scim/Users/:user_id

    The PATCH method enables you to modify specific attributes of a User within your Organization. This method is particularly useful when integrating with Azure Active Directory. Currently, the supported attributes that can be modified using the PATCH method are userType, externalId, and active.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :user_id		integer	Returns based on a valid User ID provided

    Request Body

    { "schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"], "Operations":[ { "op":"replace", "path":"externalId", "value":"" } ] }

    { "schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"], "Operations":[ { "op":"replace", "path":"externalId", "value":"" } ] }
  • GET SCIM ResourceTypes /scim/ResourceTypes

    This method returns information about what Resources we support and where those Resources are located. Currently, only one ResourceType is supported - User.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.

  • GET SCIM ResourceTypes by Type /scim/ResourceTypes/:resource_type

    This method returns information about a specific Resources we support and where it is located. Currently, only one ResourceType is supported - User.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :resource_type		integer	Returns information based on a valid Resource Type provided

  • GET SCIM Schemas /scim/Schemas

    This method returns information about all the attributes supported by each resource.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.

  • GET SCIM Schemas by Type /scim/Schemas/:schema_type

    This method returns information about all the attributes supported by a specific resource.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :schema_type		integer	Returns information based on a valid Schema Type provided

  • GET SCIM ServiceProviderConfigs /scim/ServiceProviderConfigs

    This method returns information about what type of operations we support, as well as information on where to find our documentation.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.

• SCIM Endpoints

  • List Methods
  • Expand Methods

  • GET SCIM Users - GET /staging/scim/Users

    This method returns a set of Users that are a part of your Organization, along with the attributes for each..

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.
    filter		string	This filter allows you to retrieve a list of all users with the specified username user@domain.com. Use the filter parameter to apply the username filter in this format: userName eq "user@domain.com".

  • GET SCIM Users by ID - GET /staging/scim/Users/:user_id

    This endpoint, where 'id' is the unique identifier of the user resource, retrieves the details of a specific user resource, allowing clients to retrieve the details of a particular user from your Organization.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :user_id		integer	Returns _____ based on a valid User ID provided

  • PUT SCIM Users - PUT /staging/scim/Users/:user_id

    This method allows you to modify specific attribuets of a User from your Organization. Currently, userType, externalId, and active are the only attributes that can be modified.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :user_id		integer	Returns _____ based on a valid User ID provided

    Request Body

    { "userName": "", "externalId": "", "active": true, "userType": "Org Admin" }

    { "userName": "", "externalId": "", "active": true, "userType": "Org Admin" }
  • PATCH SCIM Users - PATCH /staging/scim/Users/:user_id

    The PATCH method enables you to modify specific attributes of a User within your Organization. This method is particularly useful when integrating with Azure Active Directory. Currently, the supported attributes that can be modified using the PATCH method are userType, externalId, and active.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :user_id		integer	Returns based on a valid User ID provided

    Request Body

    { "schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"], "Operations":[ { "op":"replace", "path":"externalId", "value":"" } ] }

    { "schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"], "Operations":[ { "op":"replace", "path":"externalId", "value":"" } ] }
  • POST SCIM Users - POST /staging/scim/Users

    This method allows you to create/provision a new user with the required attributes included in the request. Please make sure to use an email for the UserName value so the new user can use that email to login to pro.compliance.ai using the Corporate Login.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header

    Request Body

    { "userName": "", "externalId": "", "active": true, "userType": "Org Admin" }

    { "userName": "", "externalId": "", "active": true, "userType": "Org Admin" }
  • GET SCIM ResourceTypes /staging/scim/ResourceTypes

    This method returns information about what Resources we support and where those Resources are located. Currently, only one ResourceType is supported - User.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.

  • GET SCIM ResourceTypes by Type /staging/scim/ResourceTypes/:resource_type

    This method returns information about a specific Resources we support and where it is located. Currently, only one ResourceType is supported - User.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :resource_type		string	Returns _____ based on a valid Resource Type provided

  • GET SCIM Schemas /staging/scim/Schemas

    This method returns information about all the attributes supported by each resource.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.

  • GET SCIM Schemas by Type /staging/scim/Schemas/:schema_type

    This method returns information about all the attributes supported by a specific resource.

    Parameter	Value	Type	Description
    Content-Type		string	Content-Type Request Header
    :schema_type		string	Returns _____ based on a valid Schema Type provided

  • GET SCIM ServiceProviderConfigs /staging/scim/ServiceProviderConfigs

    This method returns information about what type of operations we support, as well as information on where to find our documentation.

    Parameter	Value	Type	Description
    accept-encoding		string	This allows the response to be in JSON so it can be rendered in this Interactive API. Please keep 'identity' as this parameter's value.