HITRUST

MyCSF API

Table of Contents

Authentication

Each API call requires an "X-API-KEY" header to be set within the request. The format of this header field must be "User:Key".

For example, if the Username is "testuser" and their API key is "12345", then the API request should contain this header:

X-API-KEY: testuser:12345

Creating an API User

To generate an API User and Key, follow the instructions outlined below:
* This option will only be available if you have a subscription that permits API access

  1. Login to MyCSF with an Administrator Account that can manage API Permissions.
  2. Navigate to the Administration page for your Organization.
  3. Click "New API User".
  4. Select the privileges that the API user should have. Click "Create API User".
  5. A Username and API key will be generated and displayed on your screen. Save these values as they are used in your calls to the MyCSF API. Please note, the API Key will not be retrievable if it is lost. Ensure that you have it documented somewhere securely.

Testing Connectivity

Once you have an X-API-KEY header value, make a call to "/v1/start". This is the starting point of the API. The MyCSF API follows the HATEOAS concept. The URL to every other "GET" API call is described in the object results.

Documentation

JSON & XML Responses

This API supports both JSON and XML results. You can select output format by setting the "Accept" request header. If you use Accept: text/json you will get a JSON formatted response. If you use Accept: text/xml you will get XML instead.