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 v4

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

ComplyOne API v5 contain some breaking changes. Compliance Record and Type are renamed to Category and Sub Category. These changes are reflected on endpoints and api models. Please refer below for renamed endpoints and request/response data.

Endpoint	New Endpoint	Request/Response data rename
`GET /records`	`GET /categories`	The following fields on response data are renamed: 'record' is renamed to 'name'
`POST /records`	`POST /categories`	The following fields on response data are renamed: 'record' is renamed to 'name'
`PUT /records/{id}`	`PUT /categories/{id}`	The following fields on request data are renamed: 'record' is renamed to 'name'
`PUT /records/{id}/archive`	`PUT /categories/{id}/archive`	-
`PUT /records/{id}/restore`	`PUT /categories/{id}/restore`	-
`GET /types`	`GET /subcategories`	The following fields on response data are renamed: 'type' is renamed to 'name' 'complianceRecord' is renamed to 'category' 'record' field under complianceRecord is renamed to 'name'
`POST /types`	`POST /subcategories`	The following fields on request and response data are renamed: 'type' is renamed to 'name' 'complianceRecord' is renamed to 'category' 'record' field under complianceRecord is renamed to 'name'
`PUT /types/{id}`	`PUT /subcategories/{id}`	The following fields on request data are renamed: 'type' is renamed to 'name' 'complianceRecord' is renamed to 'category' 'record' field under complianceRecord is renamed to 'name'
`PUT /types/{id}/archive`	`PUT /subcategories/{id}/archive`	-
`PUT /types/{id}/restore`	`PUT /subcategories/{id}/restore`	-
`GET/profiles/simpleList`	-	The following parameters are renamed: 'typeIds' is renamed to 'subCategoryIds'
`GET /profiles/search`	-	The following parameters are renamed: 'recordIds' is renamed to 'categoryIds' 'typeIds' is renamed to 'subCategoryIds' The following fields on response data are renamed: 'complianceRecord' is renamed to 'category' 'complianceType' is renamed to 'subCategory'
`GET /profiles/{profileId}`	-	The following fields on response data are renamed: 'complianceRecord' is renamed to 'category' 'complianceType' is renamed to 'subCategory'
`POST /profiles/scheduled`	-	The following fields on request data are renamed: 'complianceRecordId' is renamed to 'categoryId' 'complianceTypeId' is renamed to 'subCategoryId'
`POST /profiles/publicform`	-	The following fields on request data are renamed: 'complianceRecordId' is renamed to 'categoryId' 'complianceTypeId' is renamed to 'subCategoryId'
`PUT /profiles/{id}/detail`	-	The following fields on request data are renamed: 'complianceRecordId' is renamed to 'categoryId' 'complianceTypeId' is renamed to 'subCategoryId'
`GET /profiles/items/exportToExcel`	-	The following parameters are renamed: 'typeIds' is renamed to 'subCategoryIds'
`GET /items/search`	-	The following parameters are renamed: 'recordIds' is renamed to 'categoryIds' 'typeIds' is renamed to 'subCategoryIds' The following fields on response data are renamed: 'record' is renamed to 'category' 'type' is renamed to 'subCategory'
`GET /items/mytestforms`	-	The following fields on response data are renamed: 'record' is renamed to 'category' 'type' is renamed to 'subCategory'
`GET /items/exportToExcel`	-	The following parameters are renamed: 'recordIds' is renamed to 'categoryIds' 'typeIds' is renamed to 'subCategoryIds'
`GET /items/answer`	-	The response data headerId value are renamed: 'complianceRecord' is renamed to 'category' 'complianceType' is renamed to 'subCategory'
`GET /items/{itemid}/answer`	-	The response data headerId value are renamed: 'complianceRecord' is renamed to 'category' 'complianceType' is renamed to 'subCategory'
`GET /items/{itemid}`	-	The following fields on response data are renamed: 'record' is renamed to 'category' 'type' is renamed to 'subCategory'
`GET /itemHistories/{itemHistoryId}/answer`	-	The response data headerId value are renamed: 'complianceRecord' is renamed to 'category' 'complianceType' is renamed to 'subCategory'
`GET /templates/search`	-	The following parameters are renamed: 'recordId' is renamed to 'categoryId' The following fields on response data are renamed: 'record' is renamed to 'category'
`GET /templates/{id}`	-	The following fields on response data are renamed: 'complianceRecord' is renamed to 'category'
`PUT /templates/{id}`	-	The following fields on request data are renamed: 'recordId' is renamed to 'categoryId'
`POST /templates`	-	The following fields on request data are renamed: 'recordId' is renamed to 'categoryId'
`GET /templates/{id}/associatedProfiles`	-	The following fields on response data are renamed: 'recordName' is renamed to 'categoryName' 'typeName' is renamed to 'subCategoryName'
`GET /nonCompliance/search`	-	The following parameters are renamed: 'recordIds' is renamed to 'categoryIds' 'typeIds' is renamed to 'subCategoryIds'
`GET /nonCompliance/exportToExcel`	-	The following parameters are renamed: 'recordIds' is renamed to 'categoryIds' 'typeIds' is renamed to 'subCategoryIds'
`GET /notificationProfiles/{id}`	-	The following fields on response data are renamed: 'associatedTypes' is renamed to 'associatedSubCategories'
`POST /notificationProfiles/add`	`POST /notificationProfiles`	The following fields on request data are renamed: 'associatedTypes' is renamed to 'associatedSubCategories'
`PUT /notificationProfiles/update`	`PUT /notificationProfiles/{id}`	The following fields on request data are renamed: 'associatedTypes' is renamed to 'associatedSubCategories'