API Quickstart List

Here is a quick start for integrating with the API:

Access Accounts:

Tasks

  1. Read and process account data including all accounts that have authorized your account to access their data via the API.

Endpoints

Endpoint Response
/my-account
Returns CCH account info associated with the given bearer token (this will be the user's account who was redirected to the OAuth server and completed the authorization code flow), including an array of all of their shared lists => "ad_lists": []
/cch-account/<ACCOUNT_ID>/details
Returns CCH account info for a CCH user that has authorized your application to access their data via the CCH API, including an array of all of their shared lists => "ad_lists": []

Access UCF Data Shared by an Account

Tasks

  1. Read and process shared lists including all shareds lists for accounts that have authorized your account to access their data via the API.
  2. Read and process authority documents contained in a shared list.
  3. Read and process detailed authority document data for each authority document in a shared list.
  4. Get mandated, implied, and implementation Controls for an Authority Document list.
  5. Get mandated and implementation Audit Items for an Authority Document list.

Endpoints

Endpoint Response
/cch-ad-list/<CCH_AUTHORITY_DOCUMENT_LIST_ID>/authority-documents
Returns an array of authority document ID’s contained in a shared list
/authority-document/<AUTHORITY_DOCUMENT_ID>/details
Returns detailed data about an authority document that is contained in a shared list including all of its associations to UCF elements such as citations, common controls and audit items.
/cch-ad-list/<CCH_AUTHORITY_DOCUMENT_LIST_ID>/tracked-controls/details
 
/cch-ad-list/<CCH_AUTHORITY_DOCUMENT_LIST_ID>/audit-items
 

Access and Write Attestation Data

Tasks

  1. Get a list of CCH Authority Document list shares initiated by the account.
  2. Get a list of CCH Authority Document list shares received by the account.
  3. (Recommended) Update tracking information for multiple controls passed as an array of cch-tracked-control objects. Each object must have an "id" field.
  4. (Optional) Update tracking information for a single control in a list.
  5. Get tracking information for a CCH Authority Document list sent to and accepted by another account.

Endpoints

Endpoint Response
/cch-share/sent
Returns a list of CCH Authority Document list shares initiated by the account
/cch-share/recieved
Returns a list of CCH Authority Document list shares received by the account
/cch-tracked-control
 
/cch-tracked-control/<UCF_COMMON_CONTROL_ID>
 
/cch-share/<CCH_AUTHORITY_DOCUMENT_LIST_ID>/returned-tracking/get_cch_share_id_returned_tracking
 
Have more questions? Submit a request

Comments

Powered by Zendesk