Read All Verification Metadata

GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData

Get all the results of identity data submitted by, and returned from verification for, a specified user with the GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData request.

The examples show metadata from:

government identity metadata
Aadhaar metadata
Government identity document verification with facial comparison to both the document portrait and a reference selfie

Headers

Authorization Bearer {{accessToken}}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData' \
--header 'Authorization: Bearer {{accessToken}}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

GET /environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests

url = "{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData"

payload = {}
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Bearer {{accessToken}}'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

require "uri"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData"
        },
        "user": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "verifyTransaction": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6"
        }
    },
    "_embedded": {
        "metaData": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData/4ebb9165-4e5c-4270-94e4-d50d7b17ecb4"
                    }
                },
                "id": "4ebb9165-4e5c-4270-94e4-d50d7b17ecb4",
                "provider": "IDRND",
                "type": "LIVENESS",
                "status": "SUCCESS",
                "data": {
                    "score": 6.4909873,
                    "probability": 0.99848527,
                    "quality": 0.94462675
                },
                "retry": {
                    "attempt": 2
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData/ae186d6c-1a79-4912-bad8-79afa3626cca"
                    }
                },
                "id": "ae186d6c-1a79-4912-bad8-79afa3626cca",
                "provider": "IDRND",
                "type": "INJECTION_DETECTION",
                "status": "SUCCESS",
                "data": {
                    "probability": 1.0
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData/546d3a8e-f606-4078-92f1-96a5c2d003e9"
                    }
                },
                "id": "546d3a8e-f606-4078-92f1-96a5c2d003e9",
                "provider": "AMAZON",
                "type": "FACIAL_COMPARISON",
                "status": "SUCCESS",
                "data": {
                    "similarity": 99.37002,
                    "confidence": 99.99767,
                    "quality": {
                        "brightness": 36.77353,
                        "sharpness": 20.92731
                    }
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData/96315a69-fb46-4d28-9b0d-c79927e59df1"
                    }
                },
                "id": "96315a69-fb46-4d28-9b0d-c79927e59df1",
                "provider": "BIOGRAPHIC_MATCHER",
                "type": "BIOGRAPHIC_MATCH",
                "status": "SUCCESS",
                "data": {
                    "biographic_match_results": [
                        {
                            "identifier": "address",
                            "match": "NOT_APPLICABLE"
                        },
                        {
                            "identifier": "given_name",
                            "match": "NONE"
                        },
                        {
                            "identifier": "family_name",
                            "match": "HIGH"
                        },
                        {
                            "identifier": "birth_date",
                            "match": "HIGH"
                        }
                    ]
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData/fba13756-8c24-49ff-9b42-ff1a3661d0ae"
                    }
                },
                "id": "fba13756-8c24-49ff-9b42-ff1a3661d0ae",
                "provider": "MITEK",
                "type": "DOCUMENT_AUTHENTICATION",
                "status": "SUCCESS",
                "data": {
                    "mitekVerifications": [
                        {
                            "name": "Document Ensemble Authenticator",
                            "judgement": "Authentic",
                            "verificationType": 202,
                            "probability": 753,
                            "version": "3.47.0.7114",
                            "documentId": "048f28f1-a7fe-42a5-9722-f10977606719"
                        },
                        {
                            "name": "Black And White Copy",
                            "judgement": "Authentic",
                            "verificationType": 102,
                            "probability": 717,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "Image Classification",
                            "judgement": "Authentic",
                            "verificationType": 105,
                            "probability": 1000,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "Data Comparison",
                            "judgement": "Authentic",
                            "verificationType": 700,
                            "probability": 1000,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "Ensemble Authenticator",
                            "judgement": "Authentic",
                            "verificationType": 201,
                            "probability": 753,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "ID Document Blacklist",
                            "judgement": "Authentic",
                            "verificationType": 101,
                            "probability": 1000,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "Generic Font",
                            "judgement": "Authentic",
                            "verificationType": 104,
                            "probability": 926,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "MRZ Check Digit",
                            "judgement": "Authentic",
                            "verificationType": 601,
                            "probability": 1000,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "MRZ Font Type Authentication",
                            "judgement": "Authentic",
                            "verificationType": 600,
                            "probability": 1000,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "Image Processing",
                            "judgement": "Authentic",
                            "verificationType": 710,
                            "probability": 1000,
                            "version": "1.0",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "Document Liveness",
                            "judgement": "Authentic",
                            "verificationType": 108,
                            "probability": 999,
                            "version": "1.0",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        }
                    ],
                    "frontImageDocumentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856",
                    "documentEvidenceId": "048f28f1-a7fe-42a5-9722-f10977606719",
                    "retry": {
                        "attempt": 1
                    }
                }
            }
        ]
    },
    "previousAttempts": [
        {
            "_links": {
                "self": {
                    "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData/06aebfbd-0053-4860-8b59-4f3cb7371dcb"
                }
            },
            "id": "06aebfbd-0053-4860-8b59-4f3cb7371dcb",
            "provider": "IDRND",
            "type": "LIVENESS",
            "status": "FAIL",
            "data": {
                "score": 2.4509223,
                "probability": 0.40062885,
                "quality": 0.40874674
            },
            "retry": {
                "attempt": 1
            }
        }
    ],
    "size": 5
}

Example Response

200 OK

{
    "_links": {
        "environment": {
            "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "verifyTransaction": {
            "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/af1397ec-189b-4ae5-a99b-d6f8bc91664e/verifyTransactions/703f0eb4-f996-48df-812d-42ae69582774"
        },
        "self": {
            "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/af1397ec-189b-4ae5-a99b-d6f8bc91664e/verifyTransactions/703f0eb4-f996-48df-812d-42ae69582774/metaData"
        },
        "user": {
            "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/af1397ec-189b-4ae5-a99b-d6f8bc91664e"
        }
    },
    "_embedded": {
        "metaData": [
            {
                "_links": {
                    "self": {
                        "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/af1397ec-189b-4ae5-a99b-d6f8bc91664e/verifyTransactions/703f0eb4-f996-48df-812d-42ae69582774/metaData/18258efd-c8ef-4365-b80e-730f4b730203"
                    }
                },
                "id": "18258efd-c8ef-4365-b80e-730f4b730203",
                "provider": "VERIFF",
                "type": "AADHAAR",
                "status": "SUCCESS",
                "data": {
                    "aadhaarVerification": {
                        "vendorData": "703f0eb4-f996-48df-812d-42ae69582774",
                        "status": "approved",
                        "id": "4fa064f2-6571-4c70-a7f7-3c063287a6b5",
                        "code": 9102,
                        "decisionTime": "2025-02-07T20:42:07.823977Z",
                        "acceptanceTime": "2025-02-07T20:42:01.451111Z"
                    }
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/af1397ec-189b-4ae5-a99b-d6f8bc91664e/verifyTransactions/703f0eb4-f996-48df-812d-42ae69582774/metaData/9ae17c91-5d6a-491f-b541-8c92c804422a"
                    }
                },
                "id": "9ae17c91-5d6a-491f-b541-8c92c804422a",
                "provider": "IDRND",
                "type": "LIVENESS",
                "status": "SUCCESS",
                "data": {
                    "score": 0,
                    "probability": 0.99,
                    "quality": 0
                },
                "retry": {
                    "attempt": 1
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/af1397ec-189b-4ae5-a99b-d6f8bc91664e/verifyTransactions/703f0eb4-f996-48df-812d-42ae69582774/metaData/39b4d2b8-52a2-483e-8c3a-bce5102424ee"
                    }
                },
                "id": "39b4d2b8-52a2-483e-8c3a-bce5102424ee",
                "provider": "AMAZON",
                "type": "FACIAL_COMPARISON",
                "status": "SUCCESS",
                "data": {
                    "similarity": 99,
                    "quality": {
                        "brightness": 50,
                        "sharpness": 50
                    }
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/af1397ec-189b-4ae5-a99b-d6f8bc91664e/verifyTransactions/703f0eb4-f996-48df-812d-42ae69582774/metaData/89357261-baae-4c4f-9019-7d965613e784"
                    }
                },
                "id": "89357261-baae-4c4f-9019-7d965613e784",
                "provider": "IDRND",
                "type": "INJECTION_DETECTION",
                "status": "SUCCESS",
                "data": {
                    "probability": 1
                },
                "retry": {
                    "attempt": 1
                }
            }
        ]
    },
    "size": 4
}

Example Response

200 OK

{
    "_links": {
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "verifyTransaction": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8d68b29b-f510-4ebf-8a99-b3c90d56ca4d/verifyTransactions/20fa1e5e-12fb-4305-8feb-799af19620d9"
        },
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8d68b29b-f510-4ebf-8a99-b3c90d56ca4d/verifyTransactions/20fa1e5e-12fb-4305-8feb-799af19620d9/metaData"
        },
        "user": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8d68b29b-f510-4ebf-8a99-b3c90d56ca4d"
        }
    },
    "_embedded": {
        "metaData": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8d68b29b-f510-4ebf-8a99-b3c90d56ca4d/verifyTransactions/20fa1e5e-12fb-4305-8feb-799af19620d9/metaData/60a28117-8233-4d58-a99b-e08b061e9714"
                    }
                },
                "id": "60a28117-8233-4d58-a99b-e08b061e9714",
                "provider": "MITEK",
                "type": "AAMVA",
                "status": "SUCCESS",
                "data": {
                    "requestId": "680e5025-a682-4917-8367-0dced7c9af17",
                    "matchResults": {
                        "dateOfBirth": true,
                        "documentNumber": true
                    },
                    "status": "Successful"
                },
                "retry": {
                    "attempt": 1
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8d68b29b-f510-4ebf-8a99-b3c90d56ca4d/verifyTransactions/20fa1e5e-12fb-4305-8feb-799af19620d9/metaData/61d8c027-1689-4720-9cda-f0698228bba5"
                    }
                },
                "id": "61d8c027-1689-4720-9cda-f0698228bba5",
                "provider": "AMAZON",
                "type": "FACIAL_COMPARISON_REFERENCE_SELFIE",
                "status": "SUCCESS",
                "data": {
                    "comparisons": [
                        {
                            "source": "SELFIE",
                            "target": "REQUIREMENTS",
                            "status": "SUCCESS",
                            "detailedResults": {
                                "similarity": 99.99906,
                                "confidence": 99.99642,
                                "quality": {
                                    "brightness": 87.33947,
                                    "sharpness": 99.549995
                                }
                            }
                        }
                    ]
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8d68b29b-f510-4ebf-8a99-b3c90d56ca4d/verifyTransactions/20fa1e5e-12fb-4305-8feb-799af19620d9/metaData/cc82876c-08f1-4a6d-a100-836f99303ace"
                    }
                },
                "id": "cc82876c-08f1-4a6d-a100-836f99303ace",
                "provider": "VERIFF",
                "type": "DOCUMENT_AUTHENTICATION",
                "status": "SUCCESS",
                "data": {
                    "veriffVerification": {
                        "vendorData": "20fa1e5e-12fb-4305-8feb-799af19620d9",
                        "status": "approved",
                        "id": "bd0bd1a1-7b59-4ba0-a19b-3f308c109821",
                        "code": 9001,
                        "decisionTime": "2025-05-28T18:47:47.425621Z",
                        "acceptanceTime": "2025-05-28T18:47:37.738651Z"
                    }
                },
                "retry": {
                    "attempt": 1
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8d68b29b-f510-4ebf-8a99-b3c90d56ca4d/verifyTransactions/20fa1e5e-12fb-4305-8feb-799af19620d9/metaData/0a454f32-9ebc-4b0a-bee2-ecbb4a4e1cd2"
                    }
                },
                "id": "0a454f32-9ebc-4b0a-bee2-ecbb4a4e1cd2",
                "provider": "IDRND",
                "type": "LIVENESS",
                "status": "SUCCESS",
                "data": {
                    "score": 0.12734735,
                    "probability": 0.5317939,
                    "quality": 0.99473304
                },
                "retry": {
                    "attempt": 1
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8d68b29b-f510-4ebf-8a99-b3c90d56ca4d/verifyTransactions/20fa1e5e-12fb-4305-8feb-799af19620d9/metaData/462790f2-d29d-4928-b8d7-7d902bd36719"
                    }
                },
                "id": "462790f2-d29d-4928-b8d7-7d902bd36719",
                "provider": "AMAZON",
                "type": "FACIAL_COMPARISON",
                "status": "SUCCESS",
                "data": {
                    "similarity": 99.88053,
                    "confidence": 99.99928,
                    "quality": {
                        "brightness": 79.84607,
                        "sharpness": 73.3221
                    }
                }
            }
        ]
    },
    "size": 5
}

PingOne Platform APIs

Read All Verification Metadata

Headers

Example Request

Example Response

Example Response

Example Response