Comply One API Documentation

New Version Available

There's a new version of Comply One API! We strongly-recommend to start migrating your API Clients as this version will not be supported in the near future. Please review the new version and read the Migration Guides

New Version Migration Guides

Comply One API

Migrating from ComplyOne API v3

The intent of this Migration Guide document is to help existing businesses seamlessly port their integrations with ComplyOne API v3 to ComplyOne API v4.

To provide better Action information, ComplyOne API v4 contain some breaking changes on the way Action data is presented on the response data.

Endpoint	Recommended Action
`GET /actions/search`	The following fields' type on response data are updated from string to object with Id and Name properties actionType actionPriority raisedBy raisedAgainst The following fields are added to the response data. CC OrganisationStructure
`GET /actions/item/{itemId}`	Please refer to GET /actions/search endpoint changes above
`GET /actions/items`	Please refer to GET /actions/search endpoint changes above

Endpoint

Recommended Action

GET /actions/search

The following fields' type on response data are updated from string to object with Id and Name properties

actionType
actionPriority
raisedBy
raisedAgainst

The following fields are added to the response data.

CC
OrganisationStructure

GET /actions/item/{itemId}

Please refer to GET /actions/search endpoint changes above

GET /actions/items

Please refer to GET /actions/search endpoint changes above