188 Enforcement Actions in the U.S. over past 30 days

-
FINRA enforcements decreased 70% over the past 30 days
-
SEC issued enforcements: $289,563,885 over the past 30 days
-
161 Final Rules go into effect in the next 30 days
-

65 Mortgage Lending docs published in the last 7 days

-
1460 docs with 2637 extracted obligations from the last 7 days
-

new Proposed and Final Rules were published in the past 7 days

-

5953 new docs in pro.compliance.ai within the last 7 days

-
Considering RCM Solutions?  Here's an RFP to get started.
-

All Courses > API

API

Overviewhttps://www.compliance.ai/api/docs/rss-integration-guide/

  • Compliance.ai offers multiple solutions to integrate with the platform and retrieve enhanced regulatory content for use in your third party GRC systems. 
    • In addition to the RSS feed option, we also have a RESTful API service available that allows you to make authorized requests in order to access enriched documents and the various lists of values that are used throughout the platform.
  • All API endpoints available on the Compliance.ai Developer Platform support OAuth 2.0 Authentication when making requests, and provide the results in JSON format
  • There are three steps required to start using the API and these are outlined on the API User Guide found on the Compliance.ai Developer Platform:
    • First is to register for an account to get the API credentials
    • Second, get an access token issued to you after making a well formatted authorization request
    • Lastly, when making a request to any Compliance.ai API endpoints using OAuth 2.0 authentication, include that Access Token in the Request Header
  • We’ll walk you through how you can get started and test the API right on the Developer Platform or through other methods

Register to get your own API credentials

  • If you haven’t already, register for an account on Compliance.ai’s developer platform by clicking on the “Register” button on the top right of the webpage. If you have an account, then click on “Sign in”
  • Once you are logged in, you can go to the Application section to create a new application to get your own set of Client ID and Client Secret. In this case, we’ll use our existing application that already has an approved set of credentials.
  • After you request the API credentials, the Compliance.ai team will review & approve the application to activate your keys
    • Please note, that the Client ID is also referred to as Key or API Key
    • The API Key string will always be 24 characters long and the Client Secret string will be 10 characters long

Authorization

  • Now that you have an API key and client secret, you can make a well formatted authorization request to get back an Access token. This access token will be used to authenticate the requests made to the API endpoints
  • There are a few ways to generate an access token:
    • Firstly, you can do it through the Interactive API available right on the Compliance.ai Developer Platform – we’ll use this example in our video
    • You can also generate access tokens using a direct API call through postman or through code – 
      • In the API User Guide, we have outlined all the details you need to include in the request and provided and example using postman
      • We have also included sample code in Python, which you can download and use it to get started with authorization and authentication requests
    • An access token can also be generated using a Refresh token so you don’t have to pass through the API credentials every time. A new refresh token is issued every time an access token is generated
  • Let’s go to Compliance.ai’s Interactive API to plug in our API credentials and generate an access token for us to use
    • Let’s add in the API key and the client secret
    • Now with this access token, we can use it to authenticate our requests to the API endpoints

Request Authentication

  • When making a request to any Compliance.ai API endpoint using OAuth 2.0 authentication, include the Access Token in the Request Header as an Authorization Bearer. You can also find more details in the API User Guide
  • Let’s try out some of the endpoints that are available on the I/O Docs

Interactive API

  • There are quite a few API endpoints available on the Developer Platform. The main endpoint used to access enhanced regulatory content is Search Documents which is available as GET and POST, and also has many filters that can be passed through as parameters in the request to refine your search and filter out the noise.
    • The filter parameters are similar to what you can find on our application and the same results will be returned, the main difference is that you will get the API results in JSON format which includes all the document attributes available
    • Each filter parameter available is listed here with descriptions and can be tested out as you would with any application
  • We also have many endpoints for the list of values that are referenced throughout the platform – for example: agencies, jurisdictions, topics, document types, regulations etc
    • Making a request to these endpoints will return all the active values used in the platform for each one, along with additional information on each value
    • For example – in agencies, you will see the shortname, full name, jurisdiction, and more for each agency found on the platform
    • These endpoints also have a few filters available for you to narrow down the reference values you are interested in
  • There are a few endpoints that help enhance the content returned by search documents –
    • Diffing allows you to compare the text of two documents to see what changed, what was added or what was removed
    • Get PDF allows you to get the PDF file of a specific document if it is available
    • Suggestion returns the auto-suggest results based on what text was input in the request
  • Another set of endpoints allow API users to access user related content that is created on the pro.compliance.ai application. This is only available after your API key is associated with your user account on the application by Compliance.ai
    • For example, a request to Tasks returns all the tasks that are assigned to that specific user
    • Update Tasks allows you to post an update to the task status without having to log in to the application
  • This Interactive API allows you to test the request and results of each endpoint right on our platform once you receive the API keys
  • Another quick way to understand what is available on Compliance.ai is by visiting our Documentation

Documentation

  • On the documentation section of the developer platform, we have all the user guides for each integration method, including the one we just reviewed for API
  • Another helpful piece of documentation is the Document Search Response Schema – this shows you the list of all document attributes that can be found in the results when you invoke the Search Document API endpoint
  • Some other useful documentation is the list of values that are referenced in the platform. You can view the list of all jurisdictions, agencies, document types, topics, and more in an easy to read view. These are updated on a regular basis 

Closing

  • The API integration method essentially gives you access to all the enhanced regulatory content and related information found on Compliance.ai’s very own application. These endpoints can be used to build out your own application to review content or even integrate it with your existing GRC systems.
  • This video was mainly to get you started with the basics of what is possible with the API. With the combination of all the available endpoints, this is a very popular solution for our clients and partners alike.
  • For more integration options, check out our “Integration Options with Compliance” video or dive deeper into the Basic Training for each one