# Callbacks
This topic describes how to receive callback notifications from the Assure API.
You can request to be notified from the Assure API when a process is finished, either successfully or not. To do that, you must provide your server’s URL (notificationUrl
) and an authorizationHeader
(if needed) in the Create process request body or in the Start capture flow request body.
# Whitelisting of server URLs
Note:
To receive callback notifications, Signicat must whitelist your server’s URL. To get help with this, send an email to support@signicat.com.
If you are just testing, use one of the following options instead of going through the whitelisting process:
For example:
"notificationUrl": "https://webhook.site/#!/705bcdd5-72dc-4018-832f-5b64ba26b5d8"
# notificationUrl
When the process verification is done, the Assure API will POST a request to your
notificationUrl
with the process ID, its status and the ID of the dossier it belongs to. Here is an example:
{
"dossierId":"54a1ad5f-74dd-47ba-b992-1cb2b4636341",
"processId":"3065980b-f26b-4ec2-8987-7833b7781dae",
"status":"accepted"
}
# Field descriptions
Field name | Description | Field type |
---|---|---|
dossierId | The unique ID of the dossier where the process belongs. | string |
processId | The unique ID of the process. | string |
status | The final status of the process after the provider has analysed it. | Enum: accepted, rejected etc. (see status ) |
# Verifying notificationUrl
After getting the notification, your notificationUrl
must respond with an HTTP 200 OK
code as soon as possible (and no longer than 10 seconds). For that reason, it is important that the endpoint receiving the notification does not perform lengthy processing that can delay its response time.
Note:
Whether a callback notification is resent or not, depends on the provider. For more information, see Callback retry mechanism.
At this point you can get the updated process information using the dossierId
and processId
from the callback.
# Callback retry mechanism
Assure API does not have an automatic callback retry mechanism. Instead, you can request a new notification by calling the Notify endpoint.