callBackUrl, the system sends a POST request to your callback URL after the validation phrase task reaches a terminal state.
Callback Mechanism Overview
Use callbacks in production to avoid polling the validation phrase query endpoint.
Callback Timing
- Validation phrase generated and ready for the user to record
- Validation phrase generation failed
- Error occurred during task processing
Callback Method
- HTTP Method: POST
- Content Type: application/json
- Timeout: 15 seconds
Callback Request Format
Field Description
integer
required
Callback status code.
200 indicates success; non-200 values indicate task failure or processing error.string
required
Status message describing the callback result.
string
required
Task ID returned by the validation phrase generation API.
string
Validation phrase text. Returned when
status is wait_validating.string
required
Task status. Common callback statuses are
wait_validating, processing_validate_fail, and fail.integer
Error code returned when the task fails.
string
Detailed error message returned when the task fails.
Receiving Callbacks
Node.js
Related Endpoint
Get Verification Phrase
Query the same task status manually with taskId
