Notifications

AI Tools

If the webhook endpoint is provided during the Share session creation, the notifications will be sent for each share performed by the end-user. These will also contain the Receipt ID that can be used to retrieve the decrypted user profile.

The notifications will be sent in the following format:

Completed status

JSON
    
 
{    "id": "ss.v2.ChZV8h5GZTlLT1JrSzc5QkVMc1F0a9JR3gkyLmxkNS5nYnI=",    "status": "COMPLETED",    "created": "2023-08-01T13:21:06.389Z",    "updated": "2023-08-01T13:22:48.284Z",    "receipt": {        "id": "RPA4ZvOZ/xIRhIeHh9Jw9HNpEK//610kEpCbZmQwNZlZ6H6w41VUlDQWn+4p7Lk"    }}
Copy

Failed status

JSON
    
 
{    "id": "ss.v2.ChYwYk5mSG9sdlJSbWNFQ1VJHw4kYlZ3EgkzLmxkNS5nYnI=",    "status": "FAILED",    "created": "2023-08-02T08:33:23.326Z",    "updated": "2023-08-02T08:34:40.885Z",    "receipt": {      "id": "FYWI8nE8GAo8xMBVprPCG78J4TaWsW+prX5DEj9WN0eEROlg7avAP/ZAlJmlP3C1",      "error": "MANDATORY_DOCUMENT_NOT_PROVIDED"    }}
Copy

Last updated on

Was this page helpful?