Call this API to generate a E-Sign transaction ,and get a E-Sign ID.

Request Example:

curl -X POST  \
-H "X-ACCESS-TOKEN: {Your Access Token}" \
-H "Content-Type: application/json" \
-d '{
    "user": {
        "fullName": "MOCHA",
        "email": "[email protected]",
        "mobile": "+628123456781",
        "dob": "1980-01-01",
        "govId": "0000000000000000",
        "idCardPhoto": "base64",
        "selfiePhoto": "base64",
        "partnerId": "rxxxxxxxxxxxxxxxxxxxxxxxxxou"   
    },
       "requestInfo": 
    {       
        "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36",
        "srcIp": "172.217.22.14",
        "consentTimestamp": "1729049311"   
    },
       "device": 
    {       
        "os": "R",
        "model": "KB2001",
        "uniqueId": "xxxxxxxxxxxxxxx",
        "networkProvider": "IND idea"   
    },
       "signingInfo": [{             
        "pdfFile": "base64",
        "pageNo": "2",
        "xPoint": "60",
        "yPoint": "150",
        "height": "36",
        "width": "139"       
    }   ]
}' 
"https://api.advance.ai/openapi/face-identity/e-sign/v1/generate"

Request Url

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

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

Request Parameters

Parameter	Description
user	`object` User specific information. Refer to user.
requestInfo	`object` User requests data. Refer to requestInfo.
device	`object` User device information. Refer to device.
signingInfo	`object` Signature Information,. Refer to signingInfo.

user

Parameter	Description
fullName	`string` Full name of the user.
email	`string` User’s email address.
mobile	`string` User’s mobile phone number.
dob	`string` User’s date of birth, formatted as YYYY-MM-DD.
govId	`string` IDGovernment-issued identification number for the user.
idCardPhoto	`string` Base64 encoded string representing the user’s identification card photo.
selfiePhoto	`string` Base64 encoded string representing the user’s selfie photo.
partnerId	`string` IDUnique identifier representing the user’s associated partner in UUID format.

requestInfo

Parameter	Description
userAgent	`string` [Optional] Identifies the browser and operating system used by the user.
srcIp	`string` [Optional] Source IP address from which the request originated.
consentTimestamp	`string` [Optional] Timestamp indicating when the user gave consent in Unix time format.

device

Parameter	Description
os	`string` [Optional] Operating system of the user’s device.
model	`string` [Optional] Model identifier of the user’s device.
uniqueId	`string` [Optional] Unique identifier for the user’s device.
networkProvider	`string` [Optional] Name of the network provider for the user’s device.

signingInfo

Parameter	Description
pdfFile	`string` Base64 encoded string of the PDF file to be used in the signing.
pageNo	`string` Page number in the PDF document where the signing or action is to occur.
xPoint	`string` X-coordinate on the PDF page to position the signature.
yPoint	`string` Y-coordinate on the PDF page to position the signature.
height	`string` Height of the signature.
width	`string` Width of the signature.

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.data

Parameter	Description
id	Id which can use it to get the E-Sign result.

Response Code

Status Code	Message
SUCCESS	`free` OK.
PARAMETER_ERROR	`free` Parameter should not be empty.
	`free` Parameter error, please check your request whether has illegal parameters.
	`free` Parameter error, please check your input.
ERROR	`free` Server error.

Response Examples

SUCCESS

{
       "code":"SUCCESS",
       "message":"OK",
       "data":{
              "id":"5c68f22d-bcf0-4fe5-a2a4-4bff14fbfd64"
       },
       "extra":null,
       "transactionId":"580760cdbb798abf",
       "pricingStrategy":"PAY"
}

PARAMETER_ERROR

{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"user.fullNameis Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"517d80f429ff254f",
       "pricingStrategy":"FREE"
}


{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"user.emailis Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"041ec9289d08743a",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"user.mobileis Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"ab35bd2623313cd3",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"user.dobis Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"32b70c04e57c3fd3",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"user.govIdis Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"971c61cd3a243a73",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"user.idCardPhotois Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"962cf2326904e767",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"user.selfiePhotois Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"82db53bc32459430",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"user.partnerIdis Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"928c72f758219c3c",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"signingInfo[0].signingInfo.pdfFileis Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"329f14027bdc7599",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"signingInfo[ 0].signingInfo.pageNois Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"613b80ad03a13c6f",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"signingInfo[0].signingInfo.xPointis Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"04e0e1a6cccb4db2",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"signingInfo[0].signingInfo.yPointis Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"ba4cae5d6cd89357",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"signingInfo[0].signingInfo.height is Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"bd516de30f3d0672",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"signingInfo[0].signingInfo.widthis Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"598edb502076f2b9",
       "pricingStrategy":"FREE"
}



{
    "code": "PARAMETER_ERROR",
    "message": "Parameter should not be empty",
    "data": {
        "errors": [{
            "title": "Parameter should not be empty",
            "detail": "user.fullName,user.email,user.mobile,user.dob,user.govId,user.idCardPhoto,user.selfiePhoto,user.partnerId,signingInfo[0].signingInfo.pdfFile,signingInfo[0].signingInfo.pageNo,signingInfo[0].signingInfo.xPoint,signingInfo[0].signingInfo.yPoint,signingInfo[0].signingInfo.height,signingInfo[0].signingInfo.width is Empty"
        }]
    },
    "extra": null,
    "transactionId": "05f13f27f025c0ab",
    "pricingStrategy": "FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter error, please check your request whether has illegal parameters",
       "data":{
              "errors":[
                     {
                            "title":"Missing required parameter",
                            "detail":"must be a well-formed email address"
                     }
              ]
       },
       "extra":null,
       "transactionId":"85787c477a8eb968",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter error, please check your request whether has illegal parameters",
       "data":{
              "errors":[
                     {
                            "title":"Missing required parameter",
                            "detail":"Invalid phone number"
                     }
              ]
       },
       "extra":null,
       "transactionId":"1b5df42bcf53b09b",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"user.dob is invalid"
                     }
              ]
       },
       "extra":null,
       "transactionId":"930f5a6ecfbef71c",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter error, please check your request whether has illegal parameters",
       "data":{
              "errors":[
                     {
                            "title":"Missing required parameter",
                            "detail":"Invalid GovId card number"
                     }
              ]
       },
       "extra":null,
       "transactionId":"e61c1d031a61dd91",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter error, please check your request whether has illegal parameters",
       "data":{
              "errors":[
                     {
                            "title":"signingInfo[0].pageNo",
                            "detail":"Must be an integer"
                     }
              ]
       },
       "extra":null,
       "transactionId":"85fc002b25acb22f",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter error, please check your input.",
       "data":null,
       "extra":null,
       "transactionId":"ada83cd224b8a057",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter should not be empty",
       "data":{
              "errors":[
                     {
                            "title":"Parameter should not be empty",
                            "detail":"user.idCardPhoto,user.selfiePhoto,signingInfo[0].signingInfo.pdf File is Empty"
                     }
              ]
       },
       "extra":null,
       "transactionId":"5e72c9c6fa09e98a",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter error, please check your request whether has illegal parameters",
       "data":{
              "errors":[
                     {
                            "title":"Missing required parameter",
                            "detail":"Invalid image base64 String"
                     },
                     {
                            "title":"Missing required parameter",
                            "detail":"Invalid image base64 String"
                     }
              ]
       },
       "extra":null,
       "transactionId":"708dcb95308c6a84",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter error, please check your request whether has illegal parameters",
       "data":{
              "errors":[
                     {
                            "title":"signingInfo[0].pageNo",
                            "detail":"Must be an integer"
                     }
              ]
       },
       "extra":null,
       "transactionId":"e363013df84e5562",
       "pricingStrategy":"FREE"
}



{
       "code":"PARAMETER_ERROR",
       "message":"Parameter error, please check your request whether has illegal parameters",
       "data":{
              "errors":[
                     {
                            "title":"Name contains invalid characters.",
                            "detail":"Name contains invalid characters."
                     }
              ]
       },
       "extra":null,
       "transactionId":"4ba2160adaa969f1",
       "pricingStrategy":"FREE"
}

ERROR Response

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