POST a comparison order

This API allows you to request a comparison order and retrieve a ComparisonOrderId.

API technical description

Endpoint:

POST /comparisons

Body:

Attribute	Type	Required	Description
leftDocumentId	String	yes	Id of the first document to compare.
rightDocumentId	String	yes	Id of the second document to compare.
fuzz	String	no	Determine the accurate pixel comparison calculation. The value is between 0 and 100.
highlightColor	String	no	Color of the differences. The value is in hexadecimal without the '#' character, for example "ff0000" for red color.
lowlightColor	String	no	Color of the similarities. The value is in hexadecimal without the '#' character, for example "ffffff" for white color.

Response:

Attribute	Type	Description
comparisonOrderId	ComparisonOrderId	Comparison order ID. This can allow you to use other APIs like the one to retrieve some information about the comparison or to delete it.

Examples

Order Comparison

The call below generates a comparison request of two documents already known from the rendition.

curl -X 'POST' \
  'http://localhost:8761/comparisons' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -d '{
      "fuzz": 0,
      "highlightColor": "ff0000"",
      "leftDocumentId": "docId1",
      "lowlightColor": "ffffff",
      "rightDocumentId": "docId2"
}'