Use Cases

The typical steps used by an application using the Compliance.ai API are:  

 Step 1: The application uses a filter to specify the regulatory data it wants, and then receives that data through the API.  

For example: The application is looking for changes or notices from an agency like FDIC published during a specified time period OR getting all "recent" documents from the FDIC 

Step 2: The application uses the response from the API to display the requested content. The response from the API includes links to the requested regulatory information, full text, key dates, and sources. 


Example Applications

Sample 1) Imagine you are writing an application to get all regulatory documents related to the topic Lending. This could be relevant for a variety of firms and banks involed in the Lending space. The example below is a scenario that addresses this request.  

 All "Final Rule" documents related to "Lending" published in August 2017. For this example, you can have the Compliance.ai API send your app all documents that are "Final Rule" related to the topic "Lending" that were published between August 1st to August 31st 2017 from the source: CFPB. Select the following Filters as parameters when invoking the Search Documents method: 

  • to find out the agency_id for CFPB, you can access the full list of Agency Sources for the "agency_id" through the Agencies Method in the API. A request will respond with the "id", "name", "short_name" and "type" for each Agency Source. View a full list of Agency Sources

  • use the following parameters in the Search Documents method: query = lending, published_from=08/01/2017, published_to=08/31/2017, category= Final Rule, Limit= 10, agency_id= 573 

  • the Response Body will include the following for each document:

{
 "count": 3,
 "documents": [{
"agencies": [{
"id": 573,
"name": "Consumer Financial Protection Bureau",
"short_name": "CFPB"
 }],
"category": "Final Rule",
"comments_close_on": null,
"effective_on": "2018-01-01",
"full_text":  NOT SHOWN
"id": 2492957,
"jurisdiction": "US",
"pdf_url": "https://www.gpo.gov/fdsys/pkg/FR-2017-08-11/pdf/2017-15764.pdf",
"publication_date": "2017-08-11T00:00:00",
"title": "Amendments to Federal Mortgage Disclosure Requirements Under the Truth in Lending Act (Regulation Z)",
"web_url": "https://www.federalregister.gov/documents/2017/08/11/2017-15764/amendments-to-federal-mortgage-disclosure-requirements-under-the-truth-in-lending-act-regulation-z"
 }, 

 

Sample 2) In a scenario where you are interested in getting all regulatory documents from the Agency Source "CFPB," you can use the Compliance.ai API to write an application that sends the app all content published by the CFPB. The example below is a scenario that addresses this request. 

CFPB Watcher, to stay informed on regulatory documents related to "Privacy" published by the Consumer Finance Protection Bureau since September 1, 2017 with real-time updates sent to the app when new publications or notices are posted. 

  • to find out the agency_id for CFPB, you can access the full list of Agency Sources for the "agency_id" through the Agencies Method in the API. A request will respond with the "id", "name", "short_name" and "type" for each Agency Source. View a full list of Agency Sources. 
  • use the following parameters in the Search Documents method: query =Privacy, published_from=09/01/2017,  Limit= 10, agency_id= 573 
  • The Response Body will include the following for each document: 
]
 "count": 4,
"documents": [{
"agencies": [{
"id": 573,
"name": "Consumer Financial Protection Bureau",
"short_name": "CFPB"
 }],
"category": "Notice",
"comments_close_on": "2017-11-24",
"effective_on": null,
"full_text": NOT SHOWN
 "id": 2535995,
"jurisdiction": "US",
"pdf_url": "https://www.gpo.gov/fdsys/pkg/FR-2017-09-25/pdf/2017-20409.pdf",
"publication_date": "2017-09-25T00:00:00",
"title": "Disclosure of Loan-Level HMDA Data",
"web_url": "https://www.federalregister.gov/documents/2017/09/25/2017-20409/disclosure-of-loan-level-hmda-data"
 }, 

 



     To view more, visit the Interactive API page.