Return Value Specification
The SDK returns a structured object to indicate the outcome of the workflow. This object contains the following fields.
| Field | Type | Nullable | Description |
|---|---|---|---|
code | String | No | The status code of the workflow. This is the primary field for determining the state of the process. • FINISH: Indicates that the user has completed the entire workflow. To determine the final success or failure, refer to the extraInfo or the finishRedirectUrl.• Other values: Indicate that the workflow failed during the initialization or pre-check phase, meaning the user did not enter the core process. Examples include IAM_FAILED (Authentication failed) or SERVICE_BUSY (Server busy).See the [ Complete Status Code List ] for all possible values. |
finishRedirectUrl | String | Yes | The redirect URL upon completion. This field is populated only when the code is FINISH; otherwise, it is null.• If the workflow is successful, the value of this field will be the returnUrl that you provided when generating the Solution URL.• If the workflow fails (e.g., liveness check failed), the value will be your provided failedReturnUrl, appended with errorCode and message query parameters. |
signatureId | String | No | The unique identifier for this workflow session. The signatureId is assigned as soon as you call the start method. You can use this ID to query or verify the final status and detailed information of this session via server-side APIs. |
extraInfo | Map<String, Object> | Yes | A collection of extended information, provided as a map of key-value pairs. Typically provided when code is FINISH and the workflow has failed, used to return structured error details.It contains errorCode and message keys, whose values mirror the parameters carried in the finishRedirectUrl. |
↳ "errorCode" | String | Yes | The specific error code. See the [ Complete Status Code List ] for all possible values. |
↳ "message" | String | Yes | A human-readable description of the error. |
Data Redundancy for Error Details
The extraInfo object mirrors the error details found in the finishRedirectUrl. The errorCode and message values are available both as keys within the extraInfo map and as query parameters in the finishRedirectUrl string. Both sources provide the exact same information and can be used interchangeably.
Updated 9 days ago
