Developer Center

Query contract comparison details

POST/esignglobal/v3/contract-compare-result

Interface Description

Query contract comparison details

 

Request Parameters

Parameter Name

Type

Required

Description

contractCompareBizId

string

true

Business ID for contract comparison

Request Example

{
    "contractCompareBizId": "Business ID for contract comparison"
}

Response Parameters

Parameter Name

Type

Description

status

int

Comparison status: 

COMPARING - In progress, 

SUCCESS - Success, 

FAIL - Failed, 

LAYOUT_ANALYZING - Layout analyzing, 

PROCESSING - Processing, 

PENDING - Pending

failMessage

string

Failure reason (null if successful)

compareResult

object

Comparison result

 

differenceCount

object

Count of differences

 

 

total

int

Total number of differences

 

 

add

int

Number of additions

 

 

replace

int

Number of replacements

 

 

delete

int

Number of deletions

 

details

array

Detailed comparison entries

 

 

originalWords

string

Original content value (from standard document)

 

 

compareWords

string

Compared content value (from compared document)

 

 

type

int

Change type: 

1 - Deleted, 

2 - Added, 

4 - Replaced

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "status": 2,
        "failMessage": null,
        "compareResult": {
            "differenceCount": {
                "total": 2,
                "add": 0,
                "replace": 2,
                "delete": 0
            },
            "details": [
                {
                    "originalWords": "3",
                    "compareWords": "5",
                    "type": 4
                },
                {
                    "originalWords": "3",
                    "compareWords": "5",
                    "type": 4
                }
            ]
        }
    }
}

 

Interface Description
Request Parameters
Request Example
Response Parameters
Response Example