Migrating from ComplyOne API v5

The intent of this Migration Guide document is to help existing businesses seamlessly port their integrations with Comply One API v5 to Comply One API v6.

Comply One API v6 contain some breaking changes. Comply One now allows user to assign multiple users to scheduled and public form profile. There are also changes around Hazard operations in order to provide similar experience with Stems One API. Please refer below for updated endpoints and request/response data.

1. Breaking Changes

Please check changes described below and update your integration accordingly.

Endpoint Breaking Change Version Introduced
GET /profiles/search The following parameters is renamed:
  • 'notificationToId' is renamed to 'assignedToId'. This parameter is expanded to search assigned user in both public form and scheduled profiles.

The following response data is added/removed:
  • new 'assignedToUsers' property is added to return selected assigned users to the profile
  • 'notificationToUser' property is removed from 'scheduleSettings' and replaced by new 'assignedToUsers'
 6.0
GET /profiles/{profileId} The following response data is added/removed:
  • new 'assignedToUsers' property is added to return selected assigned users to the profile.
  • 'notificationToUser' property is removed from 'scheduleSettings'. Please use the new 'assignedToUsers'.
 6.0
POST /profiles/scheduled The following request data is added/removed:
  • new 'assignedToUsers' property is added to 'details' section. The value is expected in array of number.
  • 'notificationTo' property is removed from 'schedule' section. Please use the new 'assignedToUsers' property.
 6.0
POST /profiles/publicform The following request data is added:
  • new 'assignedToUsers' property is added to 'details' section. The value is expected in array of number.
  • 'notificationTo' property is removed from 'schedule' section.
 6.0
PUT /profiles/{id}/detail The following request data is added:
  • new 'assignedToUsers' property is added. The value is expected in array of number.
 6.0
PUT /profiles/{id}/schedulesetting The following request data is removed:
  • 'notificationTo' property is removed. To update notified/assigned user, please use PUT /profiles/{id}/detail endpoint and set the new 'assignedToUsers' property.
 6.0
GET /profiles/items/exporttoexcel The following parameter is renamed:
  • 'notificationToId' is renamed to 'assignedToId'
 6.0
GET /items/search The following parameter is renamed:
  • 'notificationToId' is renamed to 'assignedToId'

The following response data is renamed:
  • 'notificationTo' property is renamed to 'assignedTo'
 6.0
GET /items/{itemid} The following response data is renamed:
  • 'notificationTo' property is renamed to 'assignedTo'
 6.0
GET /items/exporttoexcel The following parameter is renamed:
  • 'notificationToId' is renamed to 'assignedToId'
 6.0
POST /hazards/complianceItem/bulk The following fields on request data are updated:
  • 'dateReported' is renamed to 'reportedDate'. It is now expect the value in 'yyyy-MM-dd' string format.
  • 'timeReported' is renamed to 'reportedTime'. It is now expect the value in 'HH:mm:ss' string format.
  • 'dateDue' is renamed to 'dueDate'. It is now expect the value in 'yyyy-MM-dd' string format.
  • 'immediateActionTaken' is renamed to 'immediateAction'.
  • 'orgStructureRelationshipId' is renamed to 'orgStructureId'.
  • 'location' value is now expected in the following format:
    {
    "description": "string",
    "lat": 0.0,
    "lng": 0.0
    }
  • 'reportedByEmployee', 'reportedByAsssociate', and 'reportedByUser' are removed.
    A new 'reportedBy' field is introduced and the value is expected in the following format:
    {
    "id": "int | guid",
    "type": "'User' | 'Personnel' | 'Associate'"
    }
6.0
POST /hazards/complianceItem Similar as changes above 6.0
POST /hazards/complianceProfile Similar as changes above 6.0