Skip to main content
GET
/
remote-verification
/
v1
/
status
/
{remoteVerificationId}
Get Verification Status
curl --request GET \
  --url https://uaekyc-proxy.uaekyc-docs.workers.dev/remote-verification/v1/status/{remoteVerificationId} \
  --header 'x-transaction-key: <api-key>'
{
  "status": "success",
  "message": "Remote verification status retrieved",
  "data": {
    "remoteVerificationId": "RVF-2025-1753213901873CG123455",
    "journeyToken": "jrn_98765fedcba321",
    "verificationStatus": "COMPLETED",
    "verificationUrl": "https://your-domain.com/verify/abc123def456",
    "linkOpened": true,
    "createdAt": 1699123456789,
    "expiresAt": 1699209856789,
    "lastUpdated": 1699124567890,
    "urlAccessedAt": 1699124000000,
    "journeyTokenCreatedAt": 1699124100000,
    "rejectedAt": null,
    "rejectionReason": null
  },
  "meta": {},
  "errors": [],
  "signature": ""
}

Overview

Retrieves the current status of a remote verification process using the remoteVerificationId obtained from the Create Journey URL API. This API allows you to monitor whether the user has accessed the verification link, track the verification progress, and obtain the journeyToken once the user starts the verification process. The journeyToken is required to fetch journey details and customer details.
Polling Required: This API should be polled periodically to check the verification status. We recommend polling every 5-10 seconds until the verificationStatus changes to COMPLETED, REJECTED, ABANDONED, or EXPIRED.

Request Headers

HeaderRequiredDescription
x-transaction-keyYesYour API key

URL Parameters

ParameterTypeDescription
remoteVerificationIdStringUnique identifier from create-journey-url response

Response Fields

FieldTypeDescription
remoteVerificationIdStringUnique identifier for this verification
journeyTokenStringJourney token to fetch customer and journey details
verificationStatusEnumCurrent status of the verification
verificationUrlStringThe verification URL (one-time access only)
linkOpenedBooleanWhether verification link has been accessed
createdAtNumberCreation timestamp in milliseconds
expiresAtNumberExpiration timestamp in milliseconds
lastUpdatedNumberLast update timestamp
urlAccessedAtNumberWhen URL was first accessed
journeyTokenCreatedAtNumberWhen journey token was created
rejectedAtNumberRejection timestamp (null if not rejected)
rejectionReasonStringReason for rejection if applicable

Verification Status Values

StatusDescription
NOT_STARTEDURL created but not yet accessed by user
IN_PROGRESSUser has started the verification process
COMPLETEDVerification completed successfully
REJECTEDVerification was rejected
ABANDONEDUser abandoned the verification process
EXPIREDVerification URL has expired
Status-Specific Scenarios
  • URL Expired: Status API returns EXPIRED status
  • URL Not Accessed: linkOpened will be false, journeyToken will be null
  • Verification In Progress: journeyToken available, use for detailed tracking
  • Verification Complete: Full journey and customer details available
Use the journeyToken to retrieve verification results based on business requirement:
For more error codes, see Error Codes.

Authorizations

x-transaction-key
string
header
required

Path Parameters

remoteVerificationId
string
required

Unique identifier from create-journey-url response

Response

Remote verification status retrieved

status
string
Example:

"success"

message
string
Example:

"Remote verification status retrieved"

data
object
meta
object
errors
object[]
signature
string