KYC Status API
Step 2 - KYC Status API
Call this API immediately after your backend receives the SDK response. It returns the overall KYC decision and the status of every individual operation (OCR, IDV, Liveness, FaceMatch).
Endpoint
GET /api/v2/verify/status?verificationId=UUID
When to Call
Mobile app receives the SDK response
App forwards the payload to your backend
Backend calls
GET/api/v2/verify/status?using theverificationIdBackend acts on
overallStatusto route the user
Request
verificationId
Query string
string (uuid)
Yes
The verificationId from the SDK response
Response Fields
verificationId
string
The KYC case ID
overallStatus
string (enum)
Overall outcome: VERIFIED, REVIEW, ERROR, IN_PROGRESS, or FAILED
updatedTime
ISO 8601 string
Timestamp of the last status update
documentCaptureMode
string
FRONT_BACK_SEPARATE or BOTH_SIDE
requiredOperations
string[]
Operations that must complete for this flow type (determined by SDK kycFlowType)
fraudResult
object
Fraud Shield evaluation (if enabled). Empty object if not applicable.
operations
object
Per-operation status and transaction ID breakdown (see below)
operations Object
Each operation contains its latest result and a list of all previous attempt IDs.
overallStatus Values
FAILED
KYC session remained IN_PROGRESS beyond the configured timeout (user abandoned, SDK crashed, etc.). Terminal - no further updates accepted.
The configured timeout determines how long an IN_PROGRESS session remains open before
automatically transitioning to FAILED. Customers who need faster resolution should use the SDK
callback response as the primary signal for failure cases (see Important Note below).
1 (highest)
IN_PROGRESS
At least one required operation has not been attempted yet. Note: An IN_PROGRESS status does not guarantee the user will complete the flow. If the SDK has already returned an error callback to the host app, the user can no longer resume this verificationId.
In this case, treat the KYC outcome as not verified. See the Important Note section below for recommended decision-making logic.
2
ERROR
All required operations have been attempted, and at least one latest result is ERROR.
3
REVIEW
All required operations are complete, none are ERROR, but one or more are REVIEW.
4
VERIFIED
All required operations are complete and every latest result is VERIFIED.
5 (lowest)
Sample JSON Response
Verified - All Checks Passed
IN_PROGRESS - Liveness and FaceMatch not yet done
ERROR - Fraud detected on Face Match
Using previous TransactionIds for Reconciliation
The operations object returns not only the latest transactionId per operation, but also all previous attempt IDs from retries. You can pass any of these to the Transaction Details API.
Last updated
