---
title: Verified Data
description: "Explains the PingOne Verify verifiedData endpoint for reading a user's submitted verification transaction data and retention rules"
component: pingone-api
page_id: pingone-api:verify:verified-data/index
canonical_url: https://developer.pingidentity.com/pingone-api/verify/verified-data/index.html
llms_txt: https://developer.pingidentity.com/pingone-api/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
revdate: 2026-08-26
section_ids:
verified-data-a-note-on-extracted-data: A note on extracted data
assigning-admin-roles-and-permissions-to-this-service: Assigning admin roles and permissions to this service
verify-all-verified-data-data-model: All verified data data model
assigning-admin-roles-and-permissions-to-this-service-2: Assigning admin roles and permissions to this service
verify-specific-verified-data-data-model: Specific verified data data model
verify-verified-data-data-model: verified data data model
verify-data-object-types: Data object data models by type
verify-data-object-for-type-barcode: data object for type = BARCODE
verify-data-object-for-type-biographic_match: data object for type = BIOGRAPHIC_MATCH
verified-data-biographic-match-results-match-definitions: Biographic match results match definitions
verify-data-object-for-type-data_based_identity_verification: data object for type = DATA_BASED_IDENTITY_VERIFICATION
verify-data-object-for-type-email: data object for type = EMAIL
verify-data-object-for-type-end_user_client: data object for type = END_USER_CLIENT
verify-data-object-for-type-government_id: data object for type = GOVERNMENT_ID
verify-data-object-for-type-ida: data object for type = IDA
verified_claims-verification-object-data-model: verified_claims verification object data model
verified_claims-verification-evidence-object-data-model: verified_claims verification evidence object data model
verified_claims-verification-assurance_process-assurance_details-object-data-model: verified_claims verification assurance_process assurance_details object data model
verified_claims-claims-object-data-model: verified_claims claims object data model
verified_claims-check_details-object-data-model: verified_claims check_details object data model
verified_claims-check_details-check_id-source: verified_claims check_details check_id source
verified_claims-document_details-object-data-model: verified_claims document_details object data model
verify-data-object-for-type-identity_record_matching: data object for type = IDENTITY_RECORD_MATCHING
verified-data-identity-record-match-results-match-definitions: Identity record match results match definitions
verify-data-object-for-type-phone: data object for type = PHONE
verify-data-object-for-type-all-other-types: data object for type = BACK_IMAGE, CROPPED_DOCUMENT, CROPPED_PORTRAIT (deprecated), CROPPED_SIGNATURE, DOCUMENT_PORTRAIT, FRONT_IMAGE, SELFIE
verified-data-portrait-background-data-model: Verified data portrait background data model
---
# Verified Data
For each verification attempt, you can read data submitted in the transaction for a short time. The `verifiedData` endpoint, `/v1/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/verifiedData`, receives all requests for data associated with the verification attempt.
Only those with an Identity Data Admin role are permitted to use the `verifiedData` endpoint.
User's verification data are retained for 30 minutes after a verification decision is made. Until removed, any number of requests to the `verifiedData` endpoint can be successfully performed.
## A note on extracted data
Identity document verification uses two methods to extract personally identifiable information (PII): barcodes and optical character recognition (OCR).
If the identity document has a barcode, PII is extracted from it. Barcodes are designed to enhance the reliability of data extraction and have error rates of fewer than 1 in a million. Barcodes are on all US driver licenses, but on few other identity documents.
OCR is most commonly used to extract PII. With OCR, the scanner attempts to recognize the individual characters and words on the image of the identity document and convert them to a digital representation of that character or word. With optimized sources, OCR can achieve error rates as low as 1 in 10,000. However, error rates with non-optimized images often exceed 1 in 100. Identity documents captured by smartphone cameras often suffer from poor focus, skew, low contrast, or too-low or too-high illumination that make effective OCR difficult.
It is important to note that, unless licensed for AAMVA checks for US driver licenses, PII extracted from identity document images is not checked against a system of record. That is, the verification service can show that the holder of the identity document matches the portrait on the identity document, but it does not show that the PII on the identity document is true or accurate.
## Assigning admin roles and permissions to this service
Admin role assignments determine access to PingOne APIs. When assigning admin roles to this service, refer to [PingOne Permissions by Service](../../platform/reference/roles-and-permissions-in-pingone/permissions-by-service.html) for the service-specific permissions.
You can also choose to assign admin roles based on particular service resources. Refer to [PingOne Permissions by Resource](../../platform/reference/roles-and-permissions-in-pingone/permissions-by-resource.html) when assigning admin roles per service resources.
Admin assignments to roles are set by:
* [Automatic assignment for some roles](../../platform/roles/predefined-roles/index.html#automatic-role-assignment).
* [Group Role Assignments](../../platform/group-role-assignments/group-role-assignments.html).
* [User Role Assignments](../../platform/users/user-role-assignments/index.html).
Refer to [Roles Management](../../platform/roles/index.html) for more information.
## All verified data data model
When [all verified data](read-all-user-verified-data.html) for a verification transaction are requested, the [verified data](#verify-verified-data-data-model) for each verification type of the most recent retry appears in a `verifiedData` array in the response. The verified data data model for each verification type of earlier retries appear in a `previousAttempts` array in the response.
| Property | Type | Required | Mutable | Description |
| ------------------ | --------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `_embedded` | Object | N/A | Read-only | Container for returned data. |
| `verifiedData` | Object\[] | N/A | Read-only | Array of [verifiedData objects](#verify-verified-data-data-model) for each verification type for the most recent verification attempt. |
| `previousAttempts` | Object\[] | N/A | Read-only | Array of [verifiedData objects](#verify-verified-data-data-model) for each verification type for unacceptable verification attempts. |
| `size` | Integer | N/A | Read-only | Number of objects returned in `verifiedData`. |
If a verification type of `DATA_BASED_IDENTITY_VERIFICATION` was submitted for non-US-based identities, Data Zoo returns no personally identifiable information (PII). When Data Zoo is the vendor for `DATA_BASED_IDENTITY_VERIFICATION`, no `verifiedData` object is available or returned for data-based identity verification by [Read All User Verified Data](read-all-user-verified-data.html).
## Assigning admin roles and permissions to this service
Admin role assignments determine access to PingOne APIs. When assigning admin roles to this service, refer to [PingOne Permissions by Service](../../platform/reference/roles-and-permissions-in-pingone/permissions-by-service.html) for the service-specific permissions.
You can also choose to assign admin roles based on particular service resources. Refer to [PingOne Permissions by Resource](../../platform/reference/roles-and-permissions-in-pingone/permissions-by-resource.html) when assigning admin roles per service resources.
Admin assignments to roles are set by:
* [Automatic assignment for some roles](../../platform/roles/predefined-roles/index.html#automatic-role-assignment).
* [Group Role Assignments](../../platform/group-role-assignments/group-role-assignments.html).
* [User Role Assignments](../../platform/users/user-role-assignments/index.html).
Refer to [Roles Management](../../platform/roles/index.html) for more information.
## Specific verified data data model
When [specific verified data](read-one-user-verified-data.html) for a verification type within a verification transaction are requested, the [verified data data model](#verify-verified-data-data-model) appears as the response, regardless of which retry attempt it is.
## verified data data model
| Property | Type | Required | Mutable | Description |
| --------------- | ------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data` | Object | N/A | Read-only | Verification data for each data type as referenced via [Data object data models by type](#verify-data-object-types). |
| `id` | String | N/A | Read-only | Transaction identifier (UUID) |
| `retry.attempt` | Integer | N/A | Read-only | Number of the retry attempt when submitting images. |
| `type` | String | Required | Immutable | The type of personally identifiable information (PII) in the object. Can be any of the types seen in the `type` column of [Data object data models by type](#verify-data-object-types). |
## Data object data models by type
| Type | Data Model |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| BACK_IMAGE | [data object for all other types](#verify-data-object-for-type-all-other-types) |
| BARCODE | [data object for type = BARCODE](#verify-data-object-for-type-barcode) |
| BIOGRAPHIC_MATCH | [data object for type = BIOGRAPHIC_MATCH](#verify-data-object-for-type-biographic_match) |
| CROPPED_DOCUMENT | [data object for all other types](#verify-data-object-for-type-all-other-types) |
| CROPPED_PORTRAIT (deprecated) | [data object for all other types](#verify-data-object-for-type-all-other-types) |
| CROPPED_SIGNATURE | [data object for all other types](#verify-data-object-for-type-all-other-types) |
| DATA_BASED_IDENTITY_VERIFICATION | [data object for type = DATA_BASED_IDENTITY_VERIFICATION](#verify-data-object-for-type-data_based_identity_verification) |
| DEVICE_OWNERSHIP_VERIFICATION | No verified data returned |
| DOCUMENT_PORTRAIT | [data object for all other types](#verify-data-object-for-type-all-other-types) |
| EMAIL | [data object for type = EMAIL](#verify-data-object-for-type-email) |
| END_USER_CLIENT | [data object for type = END_USER_CLIENT](#verify-data-object-for-type-end_user_client) |
| FRONT_IMAGE | [data object for all other types](#verify-data-object-for-type-all-other-types) |
| GOVERNMENT_ID | [data object for type = GOVERNMENT_ID](#verify-data-object-for-type-government_id) |
| IDA | [data object for type = IDA](#verify-data-object-for-type-ida) |
| IDENTITY_RECORD_MATCHING | [data object for type = IDENTITY_RECORD_MATCHING](#verify-data-object-for-type-identity_record_matching) |
| PHONE | [data object for type = PHONE](#verify-data-object-for-type-phone) |
| SELFIE | [data object for all other types](#verify-data-object-for-type-all-other-types) |
### data object for type = BARCODE
| Property | Type | Required | Mutable | Description |
| -------- | ------ | -------- | --------- | --------------------------------------------------- |
| `PDF417` | String | N/A | Read-only | The data parsed off the barcode of a driver license |
### data object for type = BIOGRAPHIC_MATCH
| Property | Type | Required | Mutable | Description |
| -------------------------------------------------- | ------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `detailedResults.address` | String | N/A | Read-only | Address of the identity. |
| `detailedResults.address.` `confidence` | String | N/A | Read-only | Confidence level of the match returned by the service as described in [Biographic match results match definitions](#verified-data-biographic-match-results-match-definitions). |
| `detailedResults.address.` `governmentIdValue` | String | N/A | Read-only | Value of address found on the government ID of the identity. |
| `detailedResults.address.` `rawScore` | Float | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. |
| `detailedResults.address.` `requirementsValue` | String | N/A | Read-only | Value of address on reference records provided by the requester. |
| `detailedResults.birth_date` | String | N/A | Read-only | Birth date of the identity in ISO 8601 YYYY-MM-DD format. |
| `detailedResults.birth_date.` `confidence` | String | N/A | Read-only | Confidence level of the match returned by the service as described in [Biographic match results match definitions](#verified-data-biographic-match-results-match-definitions). |
| `detailedResults.birth_date.` `governmentIdValue` | String | N/A | Read-only | Value of birth date found on the government ID of the identity. |
| `detailedResults.birth_date.` `rawScore` | Float | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. |
| `detailedResults.birth_date.` `requirementsValue` | String | N/A | Read-only | Value of birth date on reference records provided by the requester. |
| `detailedResults.family_name` | String | N/A | Read-only | Family name of the identity. |
| `detailedResults.family_name.` `confidence` | String | N/A | Read-only | Confidence level of the match returned by the service as described in [Biographic match results match definitions](#verified-data-biographic-match-results-match-definitions). |
| `detailedResults.family_name.` `governmentIdValue` | String | N/A | Read-only | Value of family name found on the government ID of the identity. |
| `detailedResults.family_name.` `rawScore` | Float | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. |
| `detailedResults.family_name.` `requirementsValue` | String | N/A | Read-only | Value of family name on reference records provided by the requester. |
| `detailedResults.given_name` | String | N/A | Read-only | Given name of the identity. Can optionally include middle name. |
| `detailedResults.given_name.` `confidence` | String | N/A | Read-only | Confidence level of the match returned by the service as described in [Biographic match results match definitions](#verified-data-biographic-match-results-match-definitions). |
| `detailedResults.given_name.` `governmentIdValue` | String | N/A | Read-only | Value of given name found on the government ID of the identity. |
| `detailedResults.given_name.` `rawScore` | Float | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. |
| `detailedResults.given_name.` `requirementsValue` | String | N/A | Read-only | Value of given name on reference records provided by the requester. |
| `detailedResults.name` | String | N/A | Read-only | Full name of the identity. |
| `detailedResults.name.` `confidence` | String | N/A | Read-only | Confidence level of the match returned by the service as described in [Biographic match results match definitions](#verified-data-biographic-match-results-match-definitions). |
| `detailedResults.name.` `governmentIdValue` | String | N/A | Read-only | Value of name found on the government ID of the identity. |
| `detailedResults.name.` `rawScore` | Float | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. |
| `detailedResults.name.` `requirementsValue` | String | N/A | Read-only | Value of name on reference records provided by the requester. |
| `overallWeightedResult` | String | N/A | Read-only | Weighted result of all reviewed fields as described in [Biographic match results match definitions](#verified-data-biographic-match-results-match-definitions). |
| `overallWeightedScore` | Decimal | N/A | Read-only | Weighted score of all reviewed fields. A decimal number between 0 and 1. |
#### Biographic match results match definitions
| Value | Description |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `HIGH` | Based on a threshold, the quality of the match indicates that the match is an exact match or can be qualified as a near-exact match. |
| `MEDIUM` | Based on a threshold, the quality of the match is not exact but can be qualified as a partial match or an alternate spelling for the same value. |
| `LOW` | Based on a threshold, the quality of the match cannot be qualified as exact, near-exact, partial, or misspelled. |
| `NONE` | A raw score was so low that we have no confidence in a match. |
| `NOT_APPLICABLE` | A value was not found in the processed document for the given identifier. For example, the user is required to supply an address but the document supplied, such as a passport, does not have an address. |
### data object for type = DATA_BASED_IDENTITY_VERIFICATION
For US-based identities, personally identifiable information (PII) is not returned unless Social Security Number or birth date are an exact match, and given name and family name are either a partial match or an exact match. This results in an empty `verifiedData` element for `DATA_BASED_IDENTITY_VERIFICATION` in response to [Read All User Verified Data](read-all-user-verified-data.html), which implies that one cannot [Read One User Verified Data](read-one-user-verified-data.html) because no `id` is returned for `DATA_BASED_IDENTITY_VERIFICATION`. If Social Security Number was not provided in `requirements` when creating the transaction, it is not returned.
| Property | Type | Required | Mutable | Description |
| ------------------------------------------- | --------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `source` | String | N/A | Read-only | Source of the best match information, such as `input` (provided in the request), `file` (credit file), or `vendorFile` (non-credit file). |
| `firstName` | String | N/A | Read-only | Given name of the person. |
| `middleName` | String | N/A | Read-only | Middle name of the person. |
| `lastName` | String | N/A | Read-only | Family name of the person. |
| `nameGenerationalSuffix` | String | N/A | Read-only | Generational suffix of the person, such as `Junior` or `IV`. |
| `fullName` | String | N/A | Read-only | Full name of the person, all name fields concatenated. |
| `addressQualifier` | String | N/A | Read-only | A qualifier of the address, such as `personal` or `business`. |
| `addressStatus` | String | N/A | Read-only | Status of the address, such as `current`, `previous`, or `secondPrevious`. |
| `addressStreet` | String | N/A | Read-only | Complete street information including number, street name, street directions before or after the name, and unit number and type. |
| `addressCity` | String | N/A | Read-only | City of the address. |
| `addressState` | String | N/A | Read-only | State of the address. |
| `addressZip` | String | N/A | Read-only | ZIP Code or postal code of the address. |
| `birthDate` | String | N/A | Read-only | Date of birth in YYYY-MM-DD format. |
| `nationalIdNumber` | String | N/A | Read-only | Social Security number of the person. |
| `phoneQualifier` | String | N/A | Read-only | A qualifier of the phone number, such as `personal`. |
| `phoneType` | String | N/A | Read-only | Type of the phone number, such as `standard` or `mobile`. |
| `phoneExtension` | String | N/A | Read-only | Extension of the phone number. |
| `phone` | String | N/A | Read-only | Phone number in ``-``-`` format. |
| `gender` | String | N/A | Read-only | Gender of the person. |
| `additionalHistory` | Object | N/A | Read-only | Object containing additional historical entries. |
| `additionalHistory.name` | Object\[] | N/A | Read-only | Array of objects containing additional name entries. |
| `additionalHistory.name.qualifier` | String | N/A | Read-only | Type of name, such as `alsoKnownAs`. |
| `additionalHistory.name.firstName` | String | N/A | Read-only | Given name of the person. |
| `additionalHistory.name.middleName` | String | N/A | Read-only | Middle name of the person. |
| `additionalHistory.name.lastName` | String | N/A | Read-only | Family name of the person. |
| `additionalHistory.name.generationalSuffix` | String | N/A | Read-only | Generational suffix of the person, such as `Junior` or `IV`. |
| `additionalHistory.name.fullName` | String | N/A | Read-only | Full name of the person, all name fields concatenated. |
| `additionalHistory.address` | Object\[] | N/A | Read-only | Array of objects containing additional address entries. |
| `additionalHistory.address.qualifier` | String | N/A | Read-only | A qualifier of the address, such as `personal` or `business`. |
| `additionalHistory.address.status` | String | N/A | Read-only | Status of the address, such as `current`, `previous`, or `secondPrevious`. |
| `additionalHistory.address.addressStreet` | String | N/A | Read-only | Complete street information including number, street name, street directions before or after the name, and unit number and type. |
| `additionalHistory.address.addressCity` | String | N/A | Read-only | City of the address. |
| `additionalHistory.address.addressState` | String | N/A | Read-only | State of the address. |
| `additionalHistory.address.addressZip` | String | N/A | Read-only | ZIP Code or postal code of the address. |
| `additionalHistory.phone` | Object\[] | N/A | Read-only | Array of objects containing additional phone entries. |
| `additionalHistory.phone.qualifier` | String | N/A | Read-only | A qualifier of the phone number, such as `personal`. |
| `additionalHistory.phone.type` | String | N/A | Read-only | Type of the phone number, such as `standard` or `mobile`. |
| `additionalHistory.phone.extension` | String | N/A | Read-only | Extension of the phone number. |
| `additionalHistory.phone.phoneNumber` | String | N/A | Read-only | Phone number in ``-``-`` format. |
### data object for type = EMAIL
| Property | Type | Required | Mutable | Description |
| --------------------- | ------ | -------- | --------- | ---------------------------------------------------------- |
| `EMAIL` | String | N/A | Read-only | Email address submitted. |
| `VERIFICATION_METHOD` | String | N/A | Read-only | The method used to verify `EMAIL`. Can be `OTP` or `link`. |
### data object for type = END_USER_CLIENT
| Property | Type | Required | Mutable | Description |
| ----------- | ------ | -------- | --------- | ---------------------------------------------------------------------------- |
| `ipAddress` | String | N/A | Read-only | The IP address, version 4 or 6, of the device that performs the verification |
| `userAgent` | String | N/A | Read-only | The HTTP user agent of the device that performs the verification |
### data object for type = GOVERNMENT_ID
If a government identification document has two different identification numbers, such as a New York state driver license, and the vendor is Veriff, the front-side identification number returns in `documentNumber` and the back-side identification number returns in `idNumber`. If the government identification document has only one identification number, or the vendor is Mitek, it returns the front-side identification number in both `documentNumber` and `idNumber`.
Aadhaar verification results for `birthDate`, `fullName`, and `gender` return in the corresponding properties in this object and the Aadhaar identity number returns in `documentNumber` and `idNumber`.
| Property | Type | Required | Mutable | Description |
| -------------------- | --------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `addressCity` | String | N/A | Read-only | City in the address |
| `addressFull` | String | N/A | Read-only | Complete address as discovered (Veriff or Trinsic only) |
| `addressHouseNumber` | String | N/A | Read-only | Street number in the address (Veriff or Trinsic only) |
| `addressState` | String | N/A | Read-only | State or province in the address |
| `addressStreet` | String | N/A | Read-only | Street in the address |
| `addressZip` | String | N/A | Read-only | ZIP Code or postal code in the address |
| `birthDate` | String | N/A | Read-only | Birth date in YYYY-MM-DD format of the identity |
| `country` | String | N/A | Read-only | Country in the address (Mitek only) |
| `documentNumber` | String | N/A | Read-only | Identification number of the identity document found on the front side of the document. |
| `documentSubtype` | String | N/A | Read-only | Subtype of the identity document, such as `NON-DOMICILED COMMERCIAL DRIVER LICENSE`. |
| `expirationDate` | String | N/A | Read-only | Expiration date in YYYY-MM-DD format of the identity document |
| `firstName` | String | N/A | Read-only | First name of the identity. Can optionally include middle name. |
| `fullName` | String | N/A | Read-only | Full name of the identity. |
| `gender` | String | N/A | Read-only | Gender of the identity. Used only with agent assisted flows. |
| `idNumber` | String | N/A | Read-only | Identification number of the identity document on the back side of the document reported by Veriff. A repetition of the front-side identification number reported by Mitek. |
| `idType` | String\[] | Required | Immutable | Array of the types of personally identifiable information (PII) submitted, such as `DriversLicenseFront` or `RESIDENCE_PERMIT` |
| `issueDate` | String | N/A | Read-only | Issue date in YYYY-MM-DD format of the identity document |
| `issuingCountry` | String | N/A | Read-only | Country of the document issuer |
| `lastName` | String | N/A | Read-only | Last name of the identity |
| `middleName` | String | N/A | Read-only | Middle name of the identity |
| `nationality` | String | N/A | Read-only | Nationality of the identity. Used only with agent assisted flows. (Mitek only) |
| `weight` | String | N/A | Read-only | Confidence weight of the identity. Used only with agent assisted flows. (Mitek only) |
| | |
| - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| | The content of the `data` object for government identity documents varies by the type of document issued and its country of origin. This data model includes all properties, specific government identity documents can exclude some properties. |
### data object for type = IDA
IDA claims are stored in the user's system attribute, `identityAssurance`.
The verify policy must enable IDA by setting `ida.enabled` to `true` in the [transaction configuration object](../verify-transactions/index.html#verify-transaction-configuration-object) to return this object.
| Property | Type | Required | Mutable | Description |
| ---------------------------------- | ------ | -------- | --------- | -------------------------------------------------------------------------------------------------------------------- |
| `verified_claims` | Object | N/A | Read-only | The data parsed off the barcode of a driver license |
| `verified_claims.check_details` | Object | N/A | Read-only | Information regarding [check details of the verified_claims](#verified_claims-check_details-object-data-model) |
| `verified_claims.claims` | Object | N/A | Read-only | Information regarding [claims of the verified_claims](#verified_claims-claims-object-data-model) |
| `verified_claims.document_details` | Object | N/A | Read-only | Information regarding [document details of the verified_claims](#verified_claims-document_details-object-data-model) |
| `verified_claims.type` | String | N/A | Read-only | Type of verification claim. Always `document`. |
| `verified_claims.verification` | Object | N/A | Read-only | Information regarding [verification of the verified_claims](#verified_claims-verification-object-data-model) |
#### verified_claims verification object data model
| Property | Type | Required | Mutable | Description |
| ---------------------------------------- | --------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `assurance_level` | String | N/A | Read-only | The assurance level offered by the `trust_framework`. Supports only `ial2`. |
| `assurance_process` | Object | N/A | Read-only | Contains the assurances checked |
| `assurance_process.` `assurance_details` | Object\[] | N/A | Read-only | Array of objects that contain the assurances details. |
| `evidence` | Object | N/A | Read-only | Information regarding [evidence of the verified_claims.verification](#verified_claims-verification-evidence-object-data-model) |
| `time` | DateTime | N/A | Read-only | When the top level status changed to `SUCCESS` |
| `trust_framework` | String | N/A | Read-only | The policy name applied to the verification. Supports only `nist_800_63A`. |
| `verification_process` | String | N/A | Read-only | Identifier (UUID) of the verify transaction |
#### verified_claims verification evidence object data model
The `evidence` object is returned only from manual override verification.
| Property | Type | Required | Mutable | Description |
| -------------- | -------- | -------- | --------- | ------------------------------------------ |
| `attestation` | String | N/A | Read-only | Always `manual_override` |
| `organization` | String | N/A | Read-only | Always `pingidentity` |
| `time` | DateTime | N/A | Read-only | Date and time the manual override occurred |
| `type` | String | N/A | Read-only | Always `vouch` |
#### verified_claims verification assurance_process assurance_details object data model
| Property | Type | Required | Mutable | Description |
| -------------------------- | --------- | -------- | --------- | --------------------------------------------------------------------------------------------- |
| `assurance_type` | String | N/A | Read-only | Always `manual_override` |
| `assurance_classification` | String | N/A | Read-only | Always `pingidentity` |
| `evidence_ref` | Object\[] | N/A | Read-only | Date and time the manual override occurred |
| `evidence_ref.check_id` | String | N/A | Read-only | A reference to an [evidence object](#verified_claims-verification-evidence-object-data-model) |
#### verified_claims claims object data model
For government identity document verification, PingOne offers several types of additional verification to enhance the quality of verification. Parenthetic abbreviations reflect the additional verification that the property applies to.
* AAMVA - American Association of Motor Vehicle Administrators verification of US driver licenses
* Face - Selfie liveness check with injection detection
* OTP - One-time passcode verification of email or phone
| Property | Type | Required | Mutable | Description |
| ------------------------ | ------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `address` | Object | N/A | Read-only | Address of the user |
| `address.country` | String | N/A | Read-only | Country of the user |
| `address.locality` | String | N/A | Read-only | City of the user |
| `address.postal_code` | String | N/A | Read-only | Postal code of the user |
| `address.region` | String | N/A | Read-only | State, province, or geography of the user |
| `address.street_address` | String | N/A | Read-only | Street address of the user |
| `birthdate` | String | N/A | Read-only | Birthdate of the user |
| `family_name` | String | N/A | Read-only | Family name of the user |
| `full_name` | String | N/A | Read-only | Full name of the user |
| `given_name` | String | N/A | Read-only | Given name of the user |
| `email` | String | N/A | Read-only | Email address verified (OTP) |
| `idnumber` | String | N/A | Read-only | Identification card, such as passport or Aadhaar card, or driver license number (AAMVA) |
| `injection_detection` | Boolean | N/A | Read-only | Whether injection detection passed in face verification (Face). Not returned if injection detection is disabled or absent in the verify policy. |
| `liveness` | Boolean | N/A | Read-only | Whether liveness check passed in face verification (Face). Not returned if liveness is disabled or absent in the verify policy. |
| `phone` | String | N/A | Read-only | Telephone number verified (OTP) of the user |
| `ssn` | String | N/A | Read-only | Social Security number of the user |
#### verified_claims check_details object data model
| Property | Type | Required | Mutable | Description |
| -------------- | ------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `check_id` | String | N/A | Read-only | Identifier of the verification check. Refer to [verified_claims check_details check_id source](#verified_claims-check_details-check_id-source). |
| `check_method` | String | N/A | Read-only | Verification method as shown in the following table |
| `organization` | String | N/A | Read-only | Subprocessor name as shown in the following table |
##### verified_claims check_details check_id source
| Verification type | check_method | organization | check_id |
| -------------------------------- | ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Government identification | `document` | `Mitek` or `Veriff` | Subprocessor's request identifier, if available, otherwise the verify transaction identifier (UUID) returned by [Create Verify Transaction](../verify-transactions/create-verify-transaction.html) |
| Facial comparison | `face_matching` | `AWS` | Verify transaction identifier (UUID) returned by [Create Verify Transaction](../verify-transactions/create-verify-transaction.html) |
| Liveness | `liveness` | `IDRND` | Verify transaction identifier (UUID) returned by [Create Verify Transaction](../verify-transactions/create-verify-transaction.html) |
| AAMVA | `electronic_record` | `aamva` | Subprocessor's request identifier, if available, otherwise the verify transaction identifier (UUID) returned by [Create Verify Transaction](../verify-transactions/create-verify-transaction.html) |
| AADHAAR | `document` | `TRINSIC` | Subprocessor's session identifier |
| AADHAAR | `electronic_record` | `aadhaar` | Subprocessor's session identifier |
| AADHAAR | `SMS` | `aadhaar` | Subprocessor's session identifier |
| Data-based identity verification | `electronic_record` | `TransUnion` | Subprocessor's tracking identifier |
| Data-based identity verification | `electronic_record` | `DataZoo` | Subprocessor's reporting reference identifier |
| Email | `email` | `pingidentity` | Verify transaction identifier (UUID) returned by [Create Verify Transaction](../verify-transactions/create-verify-transaction.html) |
| Phone | `SMS` | `pingidentity` | Verify transaction identifier (UUID) returned by [Create Verify Transaction](../verify-transactions/create-verify-transaction.html) |
#### verified_claims document_details object data model
If a government identification document has two different identification numbers, such as a New York state driver license, and the vendor is Veriff, the front-side identification number returns in `document_number` and the back-side identification number returns in `serial_number`. If the government identification document has only one identification number, or the vendor is Mitek, it returns the front-side identification number in `document_number` only and `serial_number` is not present.
| Property | Type | Required | Mutable | Description |
| ------------------ | ------ | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------- |
| `date_of_expiry` | Date | N/A | Read-only | Date of expiration as reported by the subprocessor |
| `date_of_issuance` | Date | N/A | Read-only | Date of issuance as reported by the subprocessor |
| `document_number` | String | N/A | Read-only | Unique identifier found on the front side as reported by the subprocessor |
| `issuer.country` | String | N/A | Read-only | Country that issued the document as reported by the subprocessor |
| `serial_number` | String | N/A | Read-only | Unique identifier found on the back side of the document as reported by Veriff, otherwise not present |
| `type` | String | N/A | Read-only | Type of document presented as reported by the subprocessor, such as passport, visa, driver license, or identification card |
### data object for type = IDENTITY_RECORD_MATCHING
| Property | Type | Required | Mutable | Description |
| -------------------------------------------------------- | --------- | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `comparisons` | Object\[] | N/A | Read-only | Array of objects with results of comparisons. |
| `comparisons.detailedResults.address` | String | N/A | Read-only | Address of the identity. |
| `comparisons.detailedResults.address.` `confidence` | String | N/A | Read-only | Confidence level of the match returned by the service as described in [Identity record match results match definitions](#verified-data-identity-record-match-results-match-definitions). |
| `comparisons.detailedResults.address.` `sourceValue` | String | N/A | Read-only | Value of address in the source (as submitted to the subprocessor). |
| `comparisons.detailedResults.address.` `rawScore` | Float | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. |
| `comparisons.detailedResults.address.` `targetValue` | String | N/A | Read-only | Value of address in the target (as submitted to the subprocessor). |
| `comparisons.detailedResults.birth_date` | String | N/A | Read-only | Birth date of the identity in ISO 8601 YYYY-MM-DD format. |
| `comparisons.detailedResults.birth_date.` `confidence` | String | N/A | Read-only | Confidence level of the match returned by the service as described in [Identity record match results match definitions](#verified-data-identity-record-match-results-match-definitions). |
| `comparisons.detailedResults.birth_date.` `sourceValue` | String | N/A | Read-only | Value of birth date in the source (as submitted to the subprocessor). |
| `comparisons.detailedResults.birth_date.` `rawScore` | Float | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. |
| `comparisons.detailedResults.birth_date.` `targetValue` | String | N/A | Read-only | Value of birth date in the target (as submitted to the subprocessor). |
| `comparisons.detailedResults.family_name` | String | N/A | Read-only | Family name of the identity. |
| `comparisons.detailedResults.family_name.` `confidence` | String | N/A | Read-only | Confidence level of the match returned by the service as described in [Identity record match results match definitions](#verified-data-identity-record-match-results-match-definitions). |
| `comparisons.detailedResults.family_name.` `sourceValue` | String | N/A | Read-only | Value of family name in the source (as submitted to the subprocessor). |
| `comparisons.detailedResults.family_name.` `rawScore` | Float | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. |
| `comparisons.detailedResults.family_name.` `targetValue` | String | N/A | Read-only | Value of family name in the target (as submitted to the subprocessor). |
| `comparisons.detailedResults.given_name` | String | N/A | Read-only | Given name of the identity. Can optionally include middle name. |
| `comparisons.detailedResults.given_name.` `confidence` | String | N/A | Read-only | Confidence level of the match returned by the service as described in [Identity record match results match definitions](#verified-data-identity-record-match-results-match-definitions). |
| `comparisons.detailedResults.given_name.` `sourceValue` | String | N/A | Read-only | Value of given name in the source (as submitted to the subprocessor). |
| `comparisons.detailedResults.given_name.` `rawScore` | Float | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. |
| `comparisons.detailedResults.given_name.` `targetValue` | String | N/A | Read-only | Value of given name in the target (as submitted to the subprocessor). |
| `comparisons.detailedResults.name` | String | N/A | Read-only | Full name of the identity. |
| `comparisons.detailedResults.name.` `confidence` | String | N/A | Read-only | Confidence level of the match returned by the service as described in [Identity record match results match definitions](#verified-data-identity-record-match-results-match-definitions). |
| `comparisons.detailedResults.name.` `sourceValue` | String | N/A | Read-only | Value of name in the source (as submitted to the subprocessor). |
| `comparisons.detailedResults.name.` `rawScore` | Float | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. |
| `comparisons.detailedResults.name.` `targetValue` | String | N/A | Read-only | Value of name in the target (as submitted to the subprocessor). |
| `overallWeightedResult` | String | N/A | Read-only | Weighted result of all reviewed fields as described in [Identity record match results match definitions](#verified-data-identity-record-match-results-match-definitions). |
| `overallWeightedScore` | Decimal | N/A | Read-only | Weighted score of all reviewed fields. A decimal number between 0 and 1. |
| `comparisons.source` | String | N/A | Read-only | The `type` of identity document to which submitted data is compared. Always `GOVERNMENT_ID`. |
| `comparisons.status` | String | N/A | Read-only | Status of the transaction. |
| `comparisons.target` | String | N/A | Read-only | How the submitted data was collected. Always `REQUIREMENTS`. |
#### Identity record match results match definitions
| Value | Description |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `HIGH` | Based on a threshold, the quality of the match indicates that the match is an exact match or can be qualified as a near-exact match. |
| `MEDIUM` | Based on a threshold, the quality of the match is not exact but can be qualified as a partial match or an alternate spelling for the same value. |
| `LOW` | Based on a threshold, the quality of the match cannot be qualified as exact, near-exact, partial, or misspelled. |
| `NONE` | A raw score was so low that we have no confidence in a match. |
| `NOT_APPLICABLE` | A value was not found in the processed document for the given identifier. For example, the user is required to supply an address but the document supplied, such as a passport, does not have an address. |
### data object for type = PHONE
| Property | Type | Required | Mutable | Description |
| --------------------- | ------ | -------- | --------- | ---------------------------------------------------------- |
| `PHONE` | String | N/A | Read-only | Phone number submitted. |
| `VERIFICATION_METHOD` | String | N/A | Read-only | The method used to verify `PHONE`. Can be `OTP` or `link`. |
### data object for type = BACK_IMAGE, CROPPED_DOCUMENT, CROPPED_PORTRAIT (deprecated), CROPPED_SIGNATURE, DOCUMENT_PORTRAIT, FRONT_IMAGE, SELFIE
Data types CROPPED_DOCUMENT, CROPPED_PORTRAIT (deprecated), and CROPPED_SIGNATURE are returned only when the subprocessor for a government ID is Mitek. The extracted portrait is returned in DOCUMENT_PORTRAIT from a government ID by Mitek and from an Aadhaar document by Trinsic.
| Property | Type | Required | Mutable | Description |
| -------- | ------ | -------- | --------- | ----------------------------------------- |
| `FORMAT` | String | N/A | Read-only | The format of the image, typically `JPEG` |
| `IMAGE` | String | N/A | Read-only | The Base64-encoded image |
## Verified data portrait background data model
This data model applies to [Update Verified Data Portrait Background](update-verified-data-portrait-background.html) to replace the background of a self portrait (selfie) with a background of a uniform color defined in the `backgroundColor` object.
| Property | Type | Required | Mutable | Description |
| ----------------- | ------- | -------- | --------- | ------------------------------------------------------------------------------------------ |
| `backgroundColor` | Object | Required | Immutable | Color of the replacement background as an RGB color mode. |
| `red` | Integer | Required | Immutable | Value of RED in the range 0-255. |
| `green` | Integer | Required | Immutable | Value of GREEN in the range 0-255. |
| `blue` | Integer | Required | Immutable | Value of BLUE in the range 0-255. |
| `aspectRatio` | Object | Required | Immutable | An object that represents an aspect ratio between 1/30 and 30. Both integers are required. |
| `aspectHeight` | Integer | Required | Immutable | Value of the height in the aspect ratio in the range 1-1000. |
| `aspectWidth` | Integer | Required | Immutable | Value of the width in the aspect ratio in the range 1-1000. |