Webhook Event
You will receive the event vai POST request to the webhook URL the was set on Merchant Portal Setting
Doucument SENT Event
This Event was triggered when the document was trigger send to customer
Webhook Event Payload
Field | Description |
---|---|
type | The type of event. |
document_id | The unique identifier of the document. |
verification_link | The verification link for the document. |
document | The document associated with the event. |
document_hash | The hash of the document for verification purposes. |
Example Event Payload
{
"type": "DOCUMENT.RECEIVED",
"document_id": "df5dcf78-e78b-4396-87bb-2d2a44c1302e",
"verification_link": "https://example.com/verification?data=df5dcf78-e78b-4396-87bb-2d2a44c1302e",
"document": "PEludm9pY2UgeG1sbnM6Y2FjPSJ1cm46b2FzaXM6bmFtZXM6c3BlY2lmaWNhdGlvbjp1Ymw6c2NoZW1hOnhzZDpDb21tb25BZ2dyZWdhdGVDb21wb25lbnRzLTIiIHhtbG5zOmNiYz0idXJuOm9hc2lzOm5hbWVzOnNwZWNpZmljYXRpb246dWJsOnNjaGVtYTp4c2Q6Q29tbW9uQmFzaWNDb21wb25lbnRzLTIiIHhtbG5zPSJ1cm46b2FzaXM6bmFtZXM6c3BlY2lmaWNhdGlvbjp1Ymw6c2NoZW1hOnhzZDpJbnZvaWNlLTIiPgogIDxjYmM6VUJMVmVyc2lvbklEPjIuMTwvY2JjOlVCTFZlcnNpb25JRD4KICA8Y2JjOklEPjI0MDMwMTkyMTEwPC9jYmM6SUQ+CiAgPGNiYzpJc3N1ZURhdGU+MjAyNC0wMy0wNTwvY2JjOklzc3VlRGF0ZT4KICA8Y2JjOkludm9pY2VUeXBlQ29kZSBsaXN0SUQ9IlVOL0VDRSAxMDAxIFN1YnNldCI+Mzg4PC9jYmM6SW52b2ljZVR5cGVDb2RlPgogIDxjYmM6RG9jdW1lbnRDdXJyZW5jeUNvZGU+VVNEPC9jYmM6RG9jdW1lbnRDdXJyZW5jeUNvZGU+CiAgPGNiYzpCdXllclJlZmVyZW5jZT5QaGFuZXk8L2NiYzpCdXllclJlZmVyZW5jZT4KICA8Y2FjOkFjY291bnRpbmdTdXBwbGllclBhcnR5PgogICAgPGNhYzpQYXJ0eT4KICAgICAgPGNhYzpQYXJ0eU5hbWU+CiAgICAgICAgPGNiYzpOYW1lPuGek+GetuGen+GetuGemuGfieGetuGekOGfkuGemOGeuCDhnq8u4Z6APC9jYmM6TmFtZT4KICAgICAgPC9jYWM6UGFydHlOYW1lPgogICAgICA8Y2FjOlBvc3RhbEFkZHJlc3M+CiAgICAgICAgPGNiYzpTdHJlZXROYW1lPlBQPC9jYmM6U3RyZWV0TmFtZT4KICAgICAgICA8Y2JjOkFkZGl0aW9uYWxTdHJlZXROYW1lLz4KICAgICAgICA8Y2JjOkNpdHlOYW1lPlBobm9tIFBlbmg8L2NiYzpDaXR5TmFtZT4KICAgICAgICA8Y2JjOlBvc3RhbFpvbmUvPgogICAgICAgIDxjYWM6Q291bnRyeT4KICAgICAgICAgIDxjYmM6SWRlbnRpZmljYXRpb25Db2RlPktIPC9jYmM6SWRlbnRpZmljYXRpb25Db2RlPgogICAgICAgIDwvY2FjOkNvdW50cnk+CiAgICAgIDwvY2FjOlBvc3RhbEFkZHJlc3M+CiAgICAgIDxjYWM6UGFydHlUYXhTY2hlbWU+CiAgICAgICAgPGNiYzpDb21wYW55SUQ+MjMxNDQxMjI8L2NiYzpDb21wYW55SUQ+CiAgICAgICAgPGNhYzpUYXhTY2hlbWU+CiAgICAgICAgICA8Y2JjOklEPlZBVDwvY2JjOklEPgogICAgICAgIDwvY2FjOlRheFNjaGVtZT4KICAgICAgPC9jYWM6UGFydHlUYXhTY2hlbWU+CiAgICAgIDxjYWM6UGFydHlMZWdhbEVudGl0eT4KICAgICAgICA8Y2JjOlJlZ2lzdHJhdGlvbk5hbWUgbGFuZ3VhZ2VJRD0iZW4iPk5FQVNBUkFORVcgQ08uLCBMVEQuPC9jYmM6UmVnaXN0cmF0aW9uTmFtZT4KICAgICAgICA8Y2JjOkNvbXBhbnlJRD4xMDEwMDE1MTcyPC9jYmM6Q29tcGFueUlEPgogICAgICA8L2NhYzpQYXJ0eUxlZ2FsRW50aXR5PgogICAgICA8Y2FjOlBhcnR5TGVnYWxFbnRpdHk+CiAgICAgICAgPGNiYzpSZWdpc3RyYXRpb25OYW1lIGxhbmd1YWdlSUQ9ImttIj7hnpPhnrbhnp/hnrbhnprhn4nhnrbhnpDhn5Lhnpjhnrgg4Z6vLuGegDwvY2JjOlJlZ2lzdHJhdGlvbk5hbWU+CiAgICAgICAgPGNiYzpDb21wYW55SUQ+MTAxMDAxNTE3MjwvY2JjOkNvbXBhbnlJRD4KICAgICAgPC9jYWM6UGFydHlMZWdhbEVudGl0eT4KICAgICAgPGNhYzpDb250YWN0PgogICAgICAgIDxjYmM6TmFtZT5QaGFuZXk8L2NiYzpOYW1lPgogICAgICAgIDxjYmM6VGVsZXBob25lPjY1NDUzMzIyMjI0PC9jYmM6VGVsZXBob25lPgogICAgICAgIDxjYmM6RWxlY3Ryb25pY01haWw+cGhlbnBhbmlAZ21haWwuY29tPC9jYmM6RWxlY3Ryb25pY01haWw+CiAgICAgIDwvY2FjOkNvbnRhY3Q+CiAgICA8L2NhYzpQYXJ0eT4KICA8L2NhYzpBY2NvdW50aW5nU3VwcGxpZXJQYXJ0eT4KICA8Y2FjOkFjY291bnRpbmdDdXN0b21lclBhcnR5PgogICAgPGNhYzpQYXJ0eT4KICAgICAgPGNhYzpQYXJ0eU5hbWU+CiAgICAgICAgPGNiYzpOYW1lPuGek+GetuGen+GetuGemuGfieGetuGekOGfkuGemOGeuCDhnq8u4Z6APC9jYmM6TmFtZT4KICAgICAgPC9jYWM6UGFydHlOYW1lPgogICAgICA8Y2FjOlBvc3RhbEFkZHJlc3M+CiAgICAgICAgPGNiYzpTdHJlZXROYW1lPlBQPC9jYmM6U3RyZWV0TmFtZT4KICAgICAgICA8Y2JjOkFkZGl0aW9uYWxTdHJlZXROYW1lLz4KICAgICAgICA8Y2JjOkNpdHlOYW1lPlBobm9tIFBlbmg8L2NiYzpDaXR5TmFtZT4KICAgICAgICA8Y2JjOlBvc3RhbFpvbmUvPgogICAgICAgIDxjYWM6Q291bnRyeT4KICAgICAgICAgIDxjYmM6SWRlbnRpZmljYXRpb25Db2RlPktIPC9jYmM6SWRlbnRpZmljYXRpb25Db2RlPgogICAgICAgIDwvY2FjOkNvdW50cnk+CiAgICAgIDwvY2FjOlBvc3RhbEFkZHJlc3M+CiAgICAgIDxjYWM6UGFydHlUYXhTY2hlbWU+CiAgICAgICAgPGNiYzpDb21wYW55SUQ+MjMxNDQxMjI8L2NiYzpDb21wYW55SUQ+CiAgICAgICAgPGNhYzpUYXhTY2hlbWU+CiAgICAgICAgICA8Y2JjOklEPlZBVDwvY2JjOklEPgogICAgICAgIDwvY2FjOlRheFNjaGVtZT4KICAgICAgPC9jYWM6UGFydHlUYXhTY2hlbWU+CiAgICAgIDxjYWM6UGFydHlMZWdhbEVudGl0eT4KICAgICAgICA8Y2JjOlJlZ2lzdHJhdGlvbk5hbWUgbGFuZ3VhZ2VJRD0iZW4iPk5FQVNBUkFORVcgQ08uLCBMVEQuPC9jYmM6UmVnaXN0cmF0aW9uTmFtZT4KICAgICAgICA8Y2JjOkNvbXBhbnlJRD4xMDEwMDE1MTcyPC9jYmM6Q29tcGFueUlEPgogICAgICA8L2NhYzpQYXJ0eUxlZ2FsRW50aXR5PgogICAgICA8Y2FjOlBhcnR5TGVnYWxFbnRpdHk+CiAgICAgICAgPGNiYzpSZWdpc3RyYXRpb25OYW1lIGxhbmd1YWdlSUQ9ImttIj7hnpPhnrbhnp/hnrbhnprhn4nhnrbhnpDhn5Lhnpjhnrgg4Z6vLuGegDwvY2JjOlJlZ2lzdHJhdGlvbk5hbWU+CiAgICAgICAgPGNiYzpDb21wYW55SUQ+MTAxMDAxNTE3MjwvY2JjOkNvbXBhbnlJRD4KICAgICAgPC9jYWM6UGFydHlMZWdhbEVudGl0eT4KICAgICAgPGNhYzpDb250YWN0PgogICAgICAgIDxjYmM6TmFtZT5QaGFuZXk8L2NiYzpOYW1lPgogICAgICAgIDxjYmM6VGVsZXBob25lPjY1NDUzMzIyMjI0PC9jYmM6VGVsZXBob25lPgogICAgICAgIDxjYmM6RWxlY3Ryb25pY01haWw+cGhlbnBhbmlAZ21haWwuY29tPC9jYmM6RWxlY3Ryb25pY01haWw+CiAgICAgIDwvY2FjOkNvbnRhY3Q+CiAgICA8L2NhYzpQYXJ0eT4KICA8L2NhYzpBY2NvdW50aW5nQ3VzdG9tZXJQYXJ0eT4KICA8Y2FjOlByZXBhaWRQYXltZW50PgogICAgPGNiYzpQYWlkQW1vdW50IGN1cnJlbmN5SUQ9IlVTRCI+MDwvY2JjOlBhaWRBbW91bnQ+CiAgPC9jYWM6UHJlcGFpZFBheW1lbnQ+CiAgPGNhYzpUYXhFeGNoYW5nZVJhdGU+CiAgICA8Y2JjOlNvdXJjZUN1cnJlbmN5Q29kZT5VU0Q8L2NiYzpTb3VyY2VDdXJyZW5jeUNvZGU+CiAgICA8Y2JjOlRhcmdldEN1cnJlbmN5Q29kZT5LSFI8L2NiYzpUYXJnZXRDdXJyZW5jeUNvZGU+CiAgICA8Y2JjOkNhbGN1bGF0aW9uUmF0ZT40MDY0PC9jYmM6Q2FsY3VsYXRpb25SYXRlPgogIDwvY2FjOlRheEV4Y2hhbmdlUmF0ZT4KICA8Y2FjOlRheFRvdGFsPgogICAgPGNiYzpUYXhBbW91bnQgY3VycmVuY3lJRD0iVVNEIj4xPC9jYmM6VGF4QW1vdW50PgogICAgPGNhYzpUYXhTdWJ0b3RhbD4KICAgICAgPGNiYzpUYXhhYmxlQW1vdW50IGN1cnJlbmN5SUQ9IlVTRCI+MTA8L2NiYzpUYXhhYmxlQW1vdW50PgogICAgICA8Y2JjOlRheEFtb3VudCBjdXJyZW5jeUlEPSJVU0QiPjE8L2NiYzpUYXhBbW91bnQ+CiAgICAgIDxjYWM6VGF4Q2F0ZWdvcnk+CiAgICAgICAgPGNiYzpJRD5TPC9jYmM6SUQ+CiAgICAgICAgPGNiYzpQZXJjZW50PjEwPC9jYmM6UGVyY2VudD4KICAgICAgICA8Y2FjOlRheFNjaGVtZT4KICAgICAgICAgIDxjYmM6SUQ+VkFUPC9jYmM6SUQ+CiAgICAgICAgPC9jYWM6VGF4U2NoZW1lPgogICAgICA8L2NhYzpUYXhDYXRlZ29yeT4KICAgIDwvY2FjOlRheFN1YnRvdGFsPgogIDwvY2FjOlRheFRvdGFsPgogIDxjYWM6TGVnYWxNb25ldGFyeVRvdGFsPgogICAgPGNiYzpMaW5lRXh0ZW5zaW9uQW1vdW50IGN1cnJlbmN5SUQ9IlVTRCI+MTA8L2NiYzpMaW5lRXh0ZW5zaW9uQW1vdW50PgogICAgPGNiYzpUYXhFeGNsdXNpdmVBbW91bnQgY3VycmVuY3lJRD0iVVNEIj4xMDwvY2JjOlRheEV4Y2x1c2l2ZUFtb3VudD4KICAgIDxjYmM6VGF4SW5jbHVzaXZlQW1vdW50IGN1cnJlbmN5SUQ9IlVTRCI+MTE8L2NiYzpUYXhJbmNsdXNpdmVBbW91bnQ+CiAgICA8Y2JjOlBheWFibGVBbW91bnQgY3VycmVuY3lJRD0iVVNEIj4xMTwvY2JjOlBheWFibGVBbW91bnQ+CiAgPC9jYWM6TGVnYWxNb25ldGFyeVRvdGFsPgogIDxjYWM6SW52b2ljZUxpbmU+CiAgICA8Y2JjOklEPjE8L2NiYzpJRD4KICAgIDxjYmM6SW52b2ljZWRRdWFudGl0eSB1bml0Q29kZT0ibm9uZSI+MTwvY2JjOkludm9pY2VkUXVhbnRpdHk+CiAgICA8Y2JjOkxpbmVFeHRlbnNpb25BbW91bnQgY3VycmVuY3lJRD0iVVNEIj4xMDwvY2JjOkxpbmVFeHRlbnNpb25BbW91bnQ+CiAgICA8Y2FjOkl0ZW0+CiAgICAgIDxjYmM6RGVzY3JpcHRpb24+aXRlbTE8L2NiYzpEZXNjcmlwdGlvbj4KICAgICAgPGNiYzpOYW1lPml0ZW0xPC9jYmM6TmFtZT4KICAgICAgPGNhYzpDbGFzc2lmaWVkVGF4Q2F0ZWdvcnk+CiAgICAgICAgPGNiYzpJRD5TPC9jYmM6SUQ+CiAgICAgICAgPGNiYzpQZXJjZW50PjEwPC9jYmM6UGVyY2VudD4KICAgICAgICA8Y2FjOlRheFNjaGVtZT4KICAgICAgICAgIDxjYmM6SUQ+VkFUPC9jYmM6SUQ+CiAgICAgICAgPC9jYWM6VGF4U2NoZW1lPgogICAgICA8L2NhYzpDbGFzc2lmaWVkVGF4Q2F0ZWdvcnk+CiAgICA8L2NhYzpJdGVtPgogICAgPGNhYzpQcmljZT4KICAgICAgPGNiYzpQcmljZUFtb3VudCBjdXJyZW5jeUlEPSJVU0QiPjEwPC9jYmM6UHJpY2VBbW91bnQ+CiAgICA8L2NhYzpQcmljZT4KICA8L2NhYzpJbnZvaWNlTGluZT4KPC9JbnZvaWNlPg==",
"document_hash": "a1b2c3d4e5f6..."
}
Doucument RECEIVED Event
This Event was triggered when the document send & validated For this event you are as the receiver for the document
Webhook Event Payload
Field | Description |
---|---|
type | The type of event. |
document_id | The unique identifier of the document. |
verification_link | The verification link for the document. |
document_hash | The hash of the document for verification purposes. |
** As receive document_id
we can get document xml document via Download XML document
Example Event Payload
{
"type": "DOCUMENT.SENT",
"document_id": "df5dcf78-e78b-4396-87bb-2d2a44c1302e",
"verification_link": "https://example.com/verification?data=df5dcf78-e78b-4396-87bb-2d2a44c1302e",
"document_hash": "a1b2c3d4e5f6..."
}