When configuring your transaction, you can set a time limit for a participant to perform his/her action. If this participant is still inactive after a period defined on your side, we will send you an alert via email. The participant’s action, as well as the transaction, will be flagged as stalled
. This period can be defined via the endpoint POST /v1/transactions/{transaction_id}/participants
with the stall_trigger
argument, which must be expressed in hours.
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants \
-d email=john@company.com \
-d stall_trigger=72
If the participant does not perform his/her action in the allotted time, the API returns a transction object with a stalled
set to true
as well as a stalled_reason
. For the full list of all possible stall reasons, refer to the List of stall reasons.
{
"object": {
"participant_email": "john@company.com",
"action_id": "act_oX393gobbrK31",
"transaction_id": "tx_Y0K9egJm6VBL",
"stalled_reason": "signature_refusal"
}
}
Note that the stalled
flag has no effect on the transaction workflow. Universign only notifies you (we do not block the participant or cancel the transaction on our side), it will be up to you to take the appropriate action (manually or with the use of webhooks).