Status
Overview
You can get sign status of document by using this API.
API detail
Request
- URL:
/sign/getStatus/{{GUID}}
- Method:
GET
Response
Success
- Status code:
200
- Body:
{
"data" : {
"GUID": "0fe75c65-70cc-4517-ac7f-ebba85bfa63e",
"doc_id": "50361222",
"document": "/document/0fe75c65-70cc-4517-ac7f-ebba85bfa63e.pdf",
"origin_document": "document/0fe75c65-70cc-4517-ac7f-ebba85bfa63e.pdf",
"file_name": "test from postman.pdf",
"subject": null,
"description": "test from postman",
"created_at": "2021-09-18T20:13:18.230672Z",
"updated_at": "2021-09-18T20:13:18.278573Z",
"sign_status": 0,
"origin": 1,
"comment": null,
"signature_key": null,
"callback_url": null,
"callback_key": null,
"delete_after_callback": false,
"is_skip_notification": false,
"owner": "babytiger0617@gmail.com",
"sing_list": [
{
"id": 200,
"sign_flow": "me",
"sign_method": "certification",
"sign_status": 1,
"x1": 217,
"y1": 626,
"x2": 400,
"y2": 687,
"pageno": 1,
"signer_info": {
"id": 207,
"email": "signer@gmail.com",
"phone": "56933332222",
"country_code": "CL",
"firstname": "John",
"lastname1": "Doe",
"lastname2": null,
},
"tablet_info": null,
"video": null,
"selfie_image": null,
"id_image": null,
"started_at": "2022-02-10T16:53:19.972398Z",
"opened_at": "2022-02-10T16:53:19.972398Z",
"signed_at": "2022-02-10T16:53:19.972398Z"
}
]
},
"code": null,
"message": ""
}
flow_type
Value | Description |
---|---|
priority | In this case, document will be signed one by one based on the order of signers. So document will be sent to another signer after completing one signer's sign flow |
simultaneously | In this case, document will be signed regardless signer order. So document will be sent to all signers at the same time, all signers can sign with his method regardless others' sign status |
sign_status
Value | Description |
---|---|
0 | Not signed |
1 | Signed |
2 | Rejected |
sign_status
(Insign_list
)
Value | Description |
---|---|
0 | Not signed |
1 | In process |
2 | Signed |
3 | Rejected |
4 | Stopped |
sign_flow
Value | Description |
---|---|
me | Sign by myself, this means document will be signed by you. In this flow, you are the signer of document |
other | Sign by other person, this means document will be signed by other person, not by legale user |
legale | Sign by legale user, this means document will be signed by other legale user |
approve | This flow is to approve document by some persons, not adding digital signature into document, just approve current document sign flow by person |
sign_method
Value | Description |
---|---|
sms | Sign document using Remote SMS, signer will receive the sign request through his email. In this case, phone number is required, otherwise signer will not be able to receive OTP |
no_sms | Sign document using Remote, in this case, signer will receive the sign request through his email. No need to pass the phone number |
certification | Sign document using cloud certificate, in this case, signer can be you or other legale person. Signer will receive sign request in his legale account |
no_certification | Sign document using other sign method such as Remote or Remote SMS, in this case, signer can choose his sign method except certification. Signer will receive sign request in his legale account |
local_certificate | Sign document using local certificate, in this case, signer can be you or other legale person. Signer will receive sign request in his legale account. Signer should have his local certificate. This method is working on only Windows 10 for now |
approve | This is not digital sign. This method will send document to approver to approve current flow by himself. Approver is not legale user in this case |
approve_legale | This is not digital sign. This method will send document to approver to approve current flow by himself. Approver should be legale user in this case |
approve_api | This is not digital sign. You will receive a url from API response in this method, after that, you can approve that document by sending a new POST request to that url |