Callback Notification

Identity Verification Solution will use the callbackUrl from Generate URL API's request params to notify caller that the full result is completed and can be fetched.

Callback functions are not 100% reliable. Please implement a polling mechanism to ensure retrieval of the final status. We recommend setting the polling interval to 10 minutes or greater.

Callback Interface Requirements

Caller need to provide an HTTPS interface capable of receiving callback notifications, according to the following specifications:

  • URL: Users should provide an HTTPS URL address to receive notifications.
    • the URL should not be expired in 24 hours.
    • the URL should contains the authorization query param for safety.
  • Method: Callbacks will be sent using the POST request method.
  • Content Type: Notifications will be sent with a content body in the application/json format.
  • Request Body: The request will contain a JSON object that includes the processing status and relevant data.
  • Response: The receiver must return an HTTP 200 status code to acknowledge successful receipt. If a non-200 response is returned or the request times out, the system may retry the callback.

Request Body Example

{  
  "signatureId": "1234567890",  
  "type": "COMPLETED", //COMPLETED,SUBMIT_COMPLETED  
}
typeSimple Explain
COMPLETEDThe whole verification finished. (overallResultINCOMPLETE is not included)
SUBMIT_COMPLETEDSubmit data (document and face if needed) finished.