Transaction Details API

Purpose of This Page

Documents GET /api/v2/transaction?transactionId=UUID - used to retrieve the full payload for a specific operation attempt for audit, billing, and dispute resolution.

Step 3 - Transaction Details API

Use this API to retrieve the full result payload for any individual operation attempt. This is essential for billing reconciliation - VIDA sends you a list of transaction IDs for billing, and this API lets you match and verify each one.

Endpoint

GET /api/v2/transaction?transactionId=UUID

When to Call

• When you need the full OCR result, ID verification scores, or face match details for a specific attempt

• When reconciling billed transaction IDs against your own records

• When auditing a specific operation for a support or dispute case

• When fetching a document image URL (note: URL expires in 60 seconds)

This API only serves My-Verify transactions

This endpoint serves OCR, ID Verification, and Face Match transactions only.

Liveness transaction details are NOT available here. For liveness details, use the Liveness Service's own GET transaction API with the transactionId from livenessDetails.

Note: Clarification on Transaction API vs KYC Status

Note: Transaction Details API vs KYC Status API This API returns the result of a single operation attempt (e.g., one OCR attempt, one Face Match attempt). It does NOT return the overall KYC decision. To determine the overall KYC outcome:

• Use the SDK callback response as your primary signal for real-time decision-making.

• If the SDK returns a success callback, confirm with GET /api/v2/verify/status?verificationId=UUID.

• If the SDK returns an error callback (failedOperation is not null), treat it as a failed verification. The GET KYC Status API may still show IN_PROGRESS, but the session is effectively terminal.

Use this Transaction Details API specifically for audit, billing reconciliation, and dispute resolution of individual operation attempts.

Request

Parameter	Location	Type	Required	Description
transactionId	Query variable	string (uuid)	Yes	A transactionId from the SDK response or from any latestExecution / previousTransactionIds in GET /verify/status
includeDocuments	Query string	boolean	No	Default: false. When true, includes a documents object with presigned S3 URLs for ID front, ID back, and portrait images (each expires 60 seconds after the response).

Supported by this API

Operation	Supported	Where to Get transactionId
OCR	Yes	SDK: frontCardVerificationDetails.transactionId or backCardVerificationDetails.transactionId
ID Verification	Yes	Same transactionId as OCR (same call)
Face Match	Yes	SDK: faceMatchDetails.transactionId
Liveness	No - use Liveness Service	SDK: livenessDetails.transactionId

Querying a Liveness transaction

Liveness runs on a separate service, so GET /api/v2/transaction?transactionId=UUID does not accept a liveness transactionId. If you send one, the transaction will not be found. To get liveness results, take livenessDetails.transactionId from the SDK response and call the Liveness Service API instead:

GET<LIVENESS_SERVICE_ENDPOINT>

What you need	Where to get it
transactionId	livenessDetails.transactionId in the SDK response

The liveness score is also returned directly in the SDK response, in livenessDetails.livenessScore and livenessDetails.manipulationScore. If you only need the score, you do not need to call this API at all. For full details, see the Liveness Service page.

Response Fields

Field	Description
transactionId	The queried transaction ID
partnerTrxId	Your own reference for this operation. Not identical to the value you sent - the SDK adds the operation name and attempt number.
groupId	The verificationId this transaction belongs to
card	Document country, type, and ISO codes
ocrResult	Extracted text fields (name, ID number, DOB, address, etc.)
idVerificationResult	Spoofing check scores, landmark detection results, and forgery detection scores
imageQualityResult	Blur (blurriness) and low-light scores for front and/or back
documents	Only present when includeDocuments=true. Contains documents.idFrontSide, documents.idBackSide, and documents.portrait - each with a url and expiresAt. Fields are omitted if not captured for this transaction.

Presigned image URLs expire after 60 seconds

Each URL in the documents object is a short-lived presigned S3 URL that expires 60 seconds after the API response is received.

Fetch and store the image bytes immediately. Cached URLs will return HTTP 403 from S3 after expiry.

Call the API again with includeDocuments=true to get a fresh set of URLs.

Sample Response (with includeDocuments=true)

JSON Response

{
  "transactionId": "70f5e8df-45ca-4142-bb44-6a3879fcd532",
  "partnerTrxId":  "f8072750-1475-3a52-9ad6-7d6d3193ac89",
  "groupId":       "005e9def-c93a-3703-af5b-424a42f7c08a",
  "card": {
    "country": "MALAYSIA", "type": "MyKad",
    "isoAlpha3CountryCode": "MYS", "isoAlpha2CountryCode": "MY"
  },
  "ocrResult": {
    "front": { "data": {
      "idNumber":    { "value": "020326-14-0525",      "score": 0.992589, "threshold": 0.95 },
      "name":        { "value": "SAGAR CHANDRAKANT",  "score": 0.998204, "threshold": 0.95 },
      "dob":         { "value": "20020326",            "score": 0.992589, "threshold": 0.95 },
      "gender":      { "value": "M",                   "score": 1,        "threshold": 0.95 },
      "citizenship": { "value": "WARGANEGARA",         "score": 1,        "threshold": 0.95 },
      "address":     { "value": "NO 41 JALAN SERI TAMING 6 ...", "score": 0.999596, "threshold": 0.95 }
    }},
    "back": { "data": {
      "extendedIdNumber": { "value": "020326-14-0525-02-01", "score": 0.999577, "threshold": 0.95 }
    }}
  },
  "idVerificationResult": {
    "front": {
      "spoofingResult": { "code": 5000, "message": "Success",
        "recapScore":  { "score": 0.144171, "threshold": 0.95 },
        "blackWhite":  { "score": 0.003719, "threshold": 0.95 },
        "colorPrint":  { "score": 0.363406, "threshold": 0.95 }
      },
      "landmarkResult": { "code": 5000, "message": "Success",
        "containerResult": [
          { "name": "portrait",       "score": 0.9736 },
          { "name": "hibiscus_logo",  "score": 0      },  // ← 0 = occluded
          { "name": "chip",           "score": 0.9778 }
        ]
      },
      "forgeryResult": { "code": 5000,
        "summary": { "score": 0.245567, "threshold": 0.95 }
      }
    }
  },
  "imageQualityResult": {
    "front": {
      "blurriness": { "score": 0.00015,  "threshold": 0.95 },
      "lowLight":   { "score": 0.014529, "threshold": 0.95 }
    }
  },
  // Only present when includeDocuments=true
  "documents": {
    "idFrontSide": { "url": "https://<bucket>.s3.amazonaws.com/...?X-Amz-Signature=..."},
    "idBackSide":  { "url": "https://<bucket>.s3.amazonaws.com/...?X-Amz-Signature=..."},
    "portrait":    { "url": "https://<bucket>.s3.amazonaws.com/...?X-Amz-Signature=..."}
    // Fields are omitted if not captured (e.g. passport: idBackSide absent)
  }
}