Call this API to get E-Sign result.

Request Example:

curl -X GET  \
-H "X-ACCESS-TOKEN: {Your Access Token}" \
-H "Content-Type: application/json" \
"https://api.advance.ai/openapi/face-identity/e-sign/v1/get-result?resultId=5c68f22d-bcf0-4fe5-a2a4-4bff14fbfd64"

Request Url

https://api.advance.ai/openapi/face-identity/e-sign/v1/get-result
POST (application/json)

Parameter	Description
X-ACCESS-TOKEN	`string` Please use Token Authentication API to get your access token.

Request Parameters

Parameter	Description
resultId	`string` resultId which can use it to get the E-Sign result. from Get E-Sign ID API.

Response Description

Parameter	Description
code	Response's Status Code.
transactionId	The request id, the max length is 64.
pricingStrategy	Whether the request will be charged, enum type: FREE, PAY.
message	Status Code Explanation.
data	`object` : the business result of Identity Verification.
extra	Extra response info (Exception Message).

Response.code

Status Code	Message
SUCCESS	`free` OK.
PARAMETER_ERROR	`free` Parameter should not be empty.
NO_RECORD	`free` No results.
ERROR	`free` Server error.

Response.data

Parameter	Description
partnerTrxId	`string` Partner transaction ID.
code	`enum` Business result code of this E-Sign transaction. Refer to Response.data.code.
signedDocs	`list` List of signed documents. Refer to Response.data.signedDoc.
lastUpdateAt	`string` Last update time. Format is ISO 8601 . Eg. "2024-10-25T00:06:05Z".

Response.data.code

Value	Description
0	Created.
1	Certificate Generated.
2	Signing Task complete.
3	Request Failed.

Response.data.signedDoc

Parameter	Description
pdfTemplateId	`string` PDF Template ID.
documentUrl	`string` Document link.
code	`string` Document response code. Refer to Response.data.signedDoc.code.

Response.data.signedDoc.code

Value	Description
0	Processed Successfully.
1	Processed Failed (generic error).

Response Examples

SUCCESS

{
    "code":"SUCCESS",
    "message":"OK",
    "data":{
        "partnerTrxId":"580760cdbb798abf",
        "code":2,
        "signedDocs":[
            {
                "pdfTemplateId":"0",
                "documentUrl":"https://XXXXXXXXXXX",
                "code":0
            }
        ],
        "lastUpdateAt":"2024-10-25T00:06:05Z"
    },
    "extra":null,
    "transactionId":"1658dd13ccf2885c",
    "pricingStrategy":"FREE"
}

PARAMETER_ERROR

{
    "code":"PARAMETER_ERROR",
    "message":"Parameter should not be empty",
    "data":null,
    "extra":null,
    "transactionId":"3f4b694074059006",
    "pricingStrategy":"FREE"
}

NO_RECORD

{
    "code":"NO_RECORD",
    "message":"No results",
    "data":null,
    "extra":null,
    "transactionId":"db9a3f97eb48ad80",
    "pricingStrategy":"FREE"
}

ERROR Response

{
    "code":"ERROR",
    "message":"Server error",
    "data":null,
    "extra":null,
    "transactionId":"1deae5a13ef2bd5e",
    "pricingStrategy":"FREE"
}