--- title: Verification Metadata description: For each verification attempt, you can retrieve all scores in the transaction returned from verification services. The metaData endpoint, /environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData, receives all requests for scores associated with the verification attempt and returned from verification services. component: pingone-api page_id: pingone-api:verify:verification-metadata canonical_url: https://developer.pingidentity.com/pingone-api/verify/verification-metadata.html section_ids: verify-all-verification-metadata-data-model: All verification metaData data model verify-specific-verification-metadata-data-model: Specific verification metaData data model verify-verification-metadata-data-model: Verification metaData data model verify-data-object-data-model: data object data model verify-data-object-for-type-aadhaar-and-provider-trinsic: data object for AADHAAR + TRINSIC verify-data-object-for-type-aamva-and-provider-mitek: data object for AAMVA + MITEK verify-data-object-for-type-biographic_match-and-provider-babel_street: data object for BIOGRAPHIC_MATCH + BABEL_STREET verify-metadata-biographic-match-results-match-definitions: Biographic match results match definitions verify-data-object-for-type-biographic_match-and-provider-biographic_matcher: data object for BIOGRAPHIC_MATCH + BIOGRAPHIC_MATCHER verify-data-object-for-type-data_based_identity_verification-and-provider-datazoo: data object for DATA_BASED_IDENTITY_VERIFICATION + DATAZOO verify-metadata-serviceResponses-overview: serviceResponses Overview serviceresponses-object: serviceResponses object verify-data-object-for-type-data_based_identity_verification-and-provider-transunion: data object for DATA_BASED_IDENTITY_VERIFICATION + TRANSUNION verify-data-object-for-type-document_authentication-and-provider-mitek: data object for DOCUMENT_AUTHENTICATION + MITEK verify-data-object-for-type-document_authentication-and-provider-veriff: data object for DOCUMENT_AUTHENTICATION + VERIFF verify-data-object-for-type-document_manual_authentication-and-provider-mitek: data object for DOCUMENT_MANUAL_AUTHENTICATION + MITEK verify-data-object-for-type-facial_comparison-and-provider-amazon: data object for FACIAL_COMPARISON + AMAZON verify-data-object-for-type-facial_comparison_reference_selfie-and-provider-amazon: data object for FACIAL_COMPARISON_REFERENCE_SELFIE + AMAZON verify-data-object-for-type-identity_record_matching-and-provider-babel_street: data object for IDENTITY_RECORD_MATCHING + BABEL_STREET verify-metadata-identity-record-match-results-match-definitions: Identity record match results match definitions verify-data-object-for-type-injection_detection-and-provider-idrnd: data object for INJECTION_DETECTION + IDRND verify-data-object-for-type-liveness-and-provider-idrnd: data object for LIVENESS + IDRND verify-data-object-for-type-voice_enrollment-and-provider-idrnd: data object for VOICE_ENROLLMENT + IDRND verify-data-object-for-type-voice_verification-and-provider-idrnd: data object for VOICE_VERIFICATION + IDRND --- # Verification Metadata For each verification attempt, you can retrieve all scores in the transaction returned from verification services. The `metaData` endpoint, `/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData`, receives all requests for scores associated with the verification attempt and returned from verification services. Only those with an Identity Data Admin role are permitted to use the `metaData` endpoint. ## All verification metaData data model When [all metadata](verification-metadata/read-all-verification-metadata.html) for a verification transaction are requested, the [verification metadata](#verify-verification-metadata-data-model) for each verification type of the most recent retry appears in a `metaData` array in the response. The verification metaData 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. | | `metaData` | Object\[] | N/A | Read-only | Array of [verification metaData objects](#verify-verification-metadata-data-model) for each verification type for the most recent verification attempt. | | `previousAttempts` | Object\[] | N/A | Read-only | Array of [verification metaData objects](#verify-verification-metadata-data-model) for each verification type for unacceptable verification attempts. | | `size` | Integer | N/A | Read-only | The number of objects returned in `metaData`. | ## Specific verification metaData data model When [specific metadata](verification-metadata/read-one-verification-metadata.html) for a verification type within a verification transaction are requested, the [verification metaData data model](#verify-verification-metadata-data-model) appears as the response, regardless of which retry attempt it is. ### Verification metaData data model | Property | Type | Required? | Mutable? | Description | | --------------- | ------- | --------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `data` | Object | N/A | Read-only | Data model by provider and type as seen in the *Data model* column of [Data object data model](#verify-data-object-data-model). | | `id` | String | N/A | Read-only | Identifier (UUID) of the transaction metadata. | | `provider` | String | N/A | Read-only | The provider of metadata in the object as seen in the *Provider* column of [Data object data model](#verify-data-object-data-model). | | `retry.attempt` | Integer | N/A | Read-only | Number of the retry attempt when submitting images. | | `status` | String | N/A | Read-only | Status of the check. Can be `SUCCESS` or `FAIL`. | | `type` | String | N/A | Read-only | The type of metadata in the object as seen in the *Type* column of [Data object data model](#verify-data-object-data-model). | ### data object data model The `data` object in verification metadata varies depending on the values of `type` and `provider` as seen in the table. | Type | Provider | Data model | | ------------------------------------- | ------------------- | --------------------------------------------------------------------------------------------------- | | AADHAAR | TRINSIC | [data model](#verify-data-object-for-type-aadhaar-and-provider-trinsic) | | AAMVA | MITEK | [data model](#verify-data-object-for-type-aamva-and-provider-mitek) | | BIOGRAPHIC\_MATCH | BABEL\_STREET | [data model](#verify-data-object-for-type-biographic_match-and-provider-babel_street) | | BIOGRAPHIC\_MATCH | BIOGRAPHIC\_MATCHER | [data model](#verify-data-object-for-type-biographic_match-and-provider-biographic_matcher) | | DATA\_BASED\_IDENTITY\_VERIFICATION | DATAZOO | [data model](#verify-data-object-for-type-data_based_identity_verification-and-provider-datazoo) | | DATA\_BASED\_IDENTITY\_VERIFICATION | TRANSUNION | [data model](#verify-data-object-for-type-data_based_identity_verification-and-provider-transunion) | | DOCUMENT\_AUTHENTICATION | MITEK | [data model](#verify-data-object-for-type-document_authentication-and-provider-mitek) | | DOCUMENT\_AUTHENTICATION | VERIFF | [data model](#verify-data-object-for-type-document_authentication-and-provider-veriff) | | DOCUMENT\_MANUAL\_AUTHENTICATION | MITEK | [data model](#verify-data-object-for-type-document_manual_authentication-and-provider-mitek) | | FACIAL\_COMPARISON | AMAZON | [data model](#verify-data-object-for-type-facial_comparison-and-provider-amazon) | | FACIAL\_COMPARISON\_REFERENCE\_SELFIE | AMAZON | [data model](#verify-data-object-for-type-facial_comparison_reference_selfie-and-provider-amazon) | | GEOLOCATION | | No metadata returned | | IDENTITY\_RECORD\_MATCHING | BABEL\_STREET | [data model](#verify-data-object-for-type-identity_record_matching-and-provider-babel_street) | | INJECTION\_DETECTION | IDRND | [data model](#verify-data-object-for-type-injection_detection-and-provider-idrnd) | | LIVENESS | IDRND | [data model](#verify-data-object-for-type-liveness-and-provider-idrnd) | | VOICE\_ENROLLMENT (deprecated) | IDRND | [data model](#verify-data-object-for-type-voice_enrollment-and-provider-idrnd) | | VOICE\_VERIFICATION (deprecated) | IDRND | [data model](#verify-data-object-for-type-voice_verification-and-provider-idrnd) | #### data object for AADHAAR + TRINSIC | Property | Type | Required? | Mutable? | Description | | --------- | ------- | --------- | --------- | --------------------------------------------------------------- | | `success` | Boolean | N/A | Read-only | Indicates whether the Aadhaar verification was successful. | | `done` | Boolean | N/A | Read-only | Indicates whether the Aadhaar verification process is complete. | #### data object for AAMVA + MITEK | Property | Type | Required? | Mutable? | Description | | ----------------------------- | ------- | --------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | | `matchResults.dateOfBirth` | Boolean | N/A | Read-only | Whether the data of birth on the submitted government identity document matches the date of birth in the system of record. | | `matchResults.documentNumber` | Boolean | N/A | Read-only | Whether the document number on the submitted government identity document matches the document number in the system of record. | | `requestId` | String | N/A | Read-only | Identifier (UUID) of the request for Mitek AAMVA verification. | #### data object for BIOGRAPHIC\_MATCH + BABEL\_STREET While GOVERNMENT\_ID configuration includes BIOGRAPHIC\_MATCH in [Verify Policies](verify-policy.html), results are returned separately in verification metadata. | 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](#verify-metadata-biographic-match-results-match-definitions). | | `detailedResults.address.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `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](#verify-metadata-biographic-match-results-match-definitions). | | `detailedResults.birth_date.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `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](#verify-metadata-biographic-match-results-match-definitions). | | `detailedResults.family_name.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `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](#verify-metadata-biographic-match-results-match-definitions). | | `detailedResults.given_name.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `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](#verify-metadata-biographic-match-results-match-definitions). | | `detailedResults.name.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `overallWeightedResult` | String | N/A | Read-only | Weighted result of all reviewed fields as described in [Biographic match results match definitions](#verify-metadata-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 BIOGRAPHIC\_MATCH + BIOGRAPHIC\_MATCHER While GOVERNMENT\_ID configuration includes BIOGRAPHIC\_MATCH in [Verify Policies](verify-policy.html), results are returned separately in verification metadata. | Property | Type | Required? | Mutable? | Description | | ---------------------------------------- | --------- | --------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `biographic_match_results` | Object\[] | N/A | Read-only | Array of objects containing the results | | `biographic_match_results.` `identifier` | String | N/A | Read-only | Attribute that was checked. Can be `address`, `birth_date`, `family_name`, `given_name`, or `name`. | | `biographic_match_results.` `match` | String | N/A | Read-only | Relative indicator of success as described in [Biographic match results match definitions](#verify-metadata-biographic-match-results-match-definitions) | #### data object for DATA\_BASED\_IDENTITY\_VERIFICATION + DATAZOO Properties returned in `serviceResponses.verifications` and `serviceResponses.returnedData` vary by country. | Property | Type | Required? | Mutable? | Description | | --------------------------------------------------------- | --------- | --------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `countryCode` | String | N/A | Read-only | Two-character country code for the country. Refer to [Groups for identities outside the US](verify-policy.html#groups-for-identities-outside-the-us). | | `clientReference` | String | N/A | Read-only | Client reference, if given as input | | `reportingReference` | String | N/A | Read-only | Reference number generated, which is unique to each transaction | | `validationErrors` | String | N/A | Read-only | Returned with HTTP status code 400 when the request contains invalid or improperly formatted input data | | `matchStatus` | String | N/A | Read-only | Match status. Can be `Full Match 1+1 Verification`, `Full Match 2+2 Verification`, or `No Match` | | `searchErrorMessage` | String | N/A | Read-only | Error message returned querying the data source | | `safeHarbour` | Boolean | N/A | Read-only | Whether or not an identity was verified against two or more independent data sources to reach a high level of confidence | | `searchStatus` | String | N/A | Read-only | Search status. Can be `Successful` or `Not Successful` | | `serviceResponses` | Object | N/A | Read-only | Object containing the responses from each service checked. Refer to [serviceResponses overview](#verify-metadata-serviceResponses-overview). | | `serviceResponses.` `status` | Integer | N/A | Read-only | Status of all service responses. Can be: 0 - identityVerified TRUE, element verifications all TRUE; 1 - identityVerified TRUE, element verifications not all TRUE; 2 - identityVerified FALSE, sourceStatus SUCCESSFUL; 3 - identityVerified FALSE, sourceStatus NOT SUCCESSFUL | | `serviceResponses.` `sourceStatus` | String | N/A | Read-only | Status of the verification source. Can be: `Successful` or `Unsuccessful` | | `serviceResponses.` `errorMessage` | String | N/A | Read-only | Error message(s) from the data source, such as "Error querying data source" | | `serviceResponses.` `identityVerified` | Boolean | N/A | Read-only | Whether or not the identity is deemed verified | | `serviceResponses.` `safeHarbourScore` | String | N/A | Read-only | Safe Harbour score. Refer to [Safe Harbour Scores and Status](https://docs.datazoo.com/api/safe-harbour-scores-and-status). | | `serviceResponses.` `nameMatchScore` | String | N/A | Read-only | Score for matching name. Can be: `1.000` - matched; `0.000` - no match | | `serviceResponses.` `addressMatchScore` | String | N/A | Read-only | Score for matching address. Can be: `1.000` - matched; `0.000` - no match | | `serviceResponses.` `verifications` | Object | N/A | Read-only | Object that contains service-specific boolean indicators for individual verification checks | | `serviceResponses.` `verifications.addressElement1` | Boolean | N/A | Read-only | Whether or not full address element 1 matched | | `serviceResponses.` `verifications.addressElement2` | Boolean | N/A | Read-only | Whether or not full address element 2 matched | | `serviceResponses.` `verifications.addressElement3` | Boolean | N/A | Read-only | Whether or not full address element 3 matched | | `serviceResponses.` `verifications.addressElement4` | Boolean | N/A | Read-only | Whether or not full address element 4 matched | | `serviceResponses.` `verifications.addressElement5` | Boolean | N/A | Read-only | Whether or not full address element 5 matched | | `serviceResponses.` `verifications.bankVerificationNo` | Boolean | N/A | Read-only | Whether or not bank verification number matched | | `serviceResponses.` `verifications.city` | Boolean | N/A | Read-only | Whether or not city matched | | `serviceResponses.` `verifications.cpf` | Boolean | N/A | Read-only | Whether or not the Brazilian national identity card matched | | `serviceResponses.` `verifications.curp` | Boolean | N/A | Read-only | Whether or not the Mexican national identity card matched | | `serviceResponses.` `verifications.dateOfBirth` | Boolean | N/A | Read-only | Whether or not date of birth matched | | `serviceResponses.` `verifications.email` | Boolean | N/A | Read-only | Whether or not email matched | | `serviceResponses.` `verifications.emailAddress` | Boolean | N/A | Read-only | Whether or not email address matched | | `serviceResponses.` `verifications.firstName` | Boolean | N/A | Read-only | Whether or not first name matched | | `serviceResponses.` `verifications.fullAddress` | Boolean | N/A | Read-only | Whether or not full address matched | | `serviceResponses.` `verifications.fullName` | Boolean | N/A | Read-only | Whether or not full name matched | | `serviceResponses.` `verifications.gender` | Boolean | N/A | Read-only | Whether or not gender matched | | `serviceResponses.` `verifications.landlineNo` | Boolean | N/A | Read-only | Whether or not land line phone number matched | | `serviceResponses.` `verifications.lastName` | Boolean | N/A | Read-only | Whether or not last name matched | | `serviceResponses.` `verifications.middleName` | Boolean | N/A | Read-only | Whether or not middle name matched | | `serviceResponses.` `verifications.nationalIDNo` | Boolean | N/A | Read-only | Whether or not national identification number matched | | `serviceResponses.` `verifications.phoneNo` | Boolean | N/A | Read-only | Whether or not phone number matched | | `serviceResponses.` `verifications.postCode` | Boolean | N/A | Read-only | Whether or not postal code matched | | `serviceResponses.` `verifications.state` | Boolean | N/A | Read-only | Whether or not state matched | | `serviceResponses.` `verifications.street` | Boolean | N/A | Read-only | Whether or not street matched | | `serviceResponses.` `verifications.voterNo` | Boolean | N/A | Read-only | Whether or not voter number matched | | `serviceResponses.` `returnedData` | Object | N/A | Read-only | Object that contains metadata, including `category` and `source`, indicating the data provider used for verification | | `serviceResponses.` `returnedData.accountClass` | String | N/A | Read-only | Account class for Canada Residential | | `serviceResponses.` `returnedData.accountType` | String | N/A | Read-only | Account type for Canada Residential | | `serviceResponses.` `returnedData.activationDate` | String | N/A | Read-only | Activation date for Canada Residential | | `serviceResponses.` `returnedData.address` | String | N/A | Read-only | Full address of the individual. | | `serviceResponses.` `returnedData.altAddressMatchScore` | Object | N/A | Read-only | Match score for each address element (if configured) | | `serviceResponses.` `returnedData.altDobScore` | String | N/A | Read-only | Date of birth Matching Logic indicator (if configured) | | `serviceResponses.` `returnedData.altNameMatchScore` | Object | N/A | Read-only | Match score for each name element (if configured) | | `serviceResponses.` `returnedData.brandName` | String | N/A | Read-only | Brand name for Canada Residential | | `serviceResponses.` `returnedData.carrierName` | String | N/A | Read-only | Carrier name for Canada Residential | | `serviceResponses.` `returnedData.category` | String | N/A | Read-only | Data source type or category, such as telco or consumer | | `serviceResponses.` `returnedData.dpId` | String | N/A | Read-only | Delivery Point Identifier of the address | | `serviceResponses.` `returnedData.fullName` | String | N/A | Read-only | Full name of the individual - included or omitted based on the client's configured settings | | `serviceResponses.` `returnedData.nationalIdNo` | String | N/A | Read-only | National identification number from Denmark National ID service | | `serviceResponses.` `returnedData.PersonStatus` | String | N/A | Read-only | Person status from Denmark National ID service | | `serviceResponses.` `returnedData.phoneStatus` | String | N/A | Read-only | Phone status for Canada Residential | | `serviceResponses.` `returnedData.possibleDeceasedRecord` | Boolean | N/A | Read-only | Flag indicating Deceased Check of the identity owner | | `serviceResponses.` `returnedData.source` | String | N/A | Read-only | Identifies the data source used | | `serviceResponses.` `returnedData.subscriberId` | String | N/A | Read-only | Subscriber identification number for Canada Residential | | `remarks` | String\[] | N/A | Read-only | Array of remarks regarding any encountered issues or pre-validation errors. | ##### serviceResponses Overview Each service returns its own self-contained response block, ensuring modular and source-specific verification results. Consumers of this API should handle varying response structures dynamically based on the requested services. Safe Harbour is the determination of verifying an identity owner against two independent data sources to reach a high level of confidence. A positive Safe Harbour Status can only be achieved when the identity owner's name is verified in at least two independent sources, in combination with a verified address or a verified date of birth in the same two independent sources. ###### serviceResponses object The `serviceResponses` object in the API response contains verification results from one or more data sources, structured under their respective service names. Each service returns a distinct response block with service-specific data. Structure and behavior: * Each key within `serviceResponses` corresponds to a `service name`, representing an individual verification source. * Services may return data from a single source or multiple sources in a sequenced API call. * The structure of each service response varies, with fields such as `status`, `identityVerified`, and `safeHarbourScore` differing between services. * The `verifications` block contains service-specific boolean indicators for individual verification checks such as `addressElement1`, `dateOfBirth`, `firstName`. * The `returnedData` block provides metadata, including `category` and `source`, indicating the data provider used for verification. #### data object for DATA\_BASED\_IDENTITY\_VERIFICATION + TRANSUNION Ping Identity reports confidence levels of verification as: `HIGH` (0.71), `MEDIUM` (0.61), and `LOW` (0.51). Scores returned in this response are a measure of risk: `low` (`verificationPoint` 0-29), `medium` (30-49), or `high` (50+). Lower risk represents higher confidence in the verification: * Low risk, 0-29, is high confidence * Medium risk, 30-39, is medium confidence * Medium risk, 40-49, is low confidence * High risk, 50 or greater, is failed confidence | | | | - | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | From the vendor: The Risk Indicator, `riskIndicator`, can be used to determine success or failure. However, it is ultimately up to you to decide how you wish to leverage the additional information provided, such as Verification Analysis and Fraud Alerts. Please note that since this solution is non-FCRA \[Fair Credit Reporting Act] compliant, you are not permitted to take adverse action solely based on its output. You may need to undertake additional steps to perform further verification as appropriate. | | Property | Type | Required? | Mutable? | Description | | ----------------------------------------------------------------------------------------------------------------- | --------- | --------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `subject` | Object | N/A | Read-only | Object containing the results. | | `subject.number` | String | N/A | Read-only | Index of the subject. | | `subject.subjectRecord` | Object | N/A | Read-only | Object containing the subject record. | | `subject.subjectRecord.fileNumber` | String | N/A | Read-only | Index of the file. | | `subject.subjectRecord.fileSummary.` `fileHitIndicator` | Object | N/A | Read-only | Type of file entry. | | `subject.subjectRecord.fileSummary.` `creditDataStatus.suppressed` | Boolean | N/A | Read-only | Whether or not the data provider provided no response within 28 days. | | `subject.subjectRecord.fileSummary.` `creditDataStatus.doNotPromote.indicator` | Boolean | N/A | Read-only | Whether or not the person opted out of promotional offers. | | `subject.subjectRecord.fileSummary.` `creditDataStatus.freeze.indicator` | Boolean | N/A | Read-only | Whether or not the person restricted access to their file. | | `subject.subjectRecord.fileSummary.` `creditDataStatus.minor` | Boolean | N/A | Read-only | Whether or not the person is a minor. | | `subject.subjectRecord.fileSummary.` `creditDataStatus.disputed` | Boolean | N/A | Read-only | Whether or not the person disputes the file entry. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationSummary.` `riskIndicator` | String | N/A | Read-only | Risk level. Can be `low`, `medium`, or `high`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationSummary.` `bestMatch` | String | N/A | Read-only | The `source` determined to provide the best match. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationSummary.` `verificationPoint` | Integer | N/A | Read-only | Numeric risk rating for the person equal to or greater than 0. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationSummary.` `lowerThreshold` | Integer | N/A | Read-only | Vendor-defined lower threshold of the medium risk verification point range, always 30. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationSummary.` `upperThreshold` | Integer | N/A | Read-only | Vendor-defined upper threshold of the medium risk verification point range, always 49. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationSummary.` `keyMessages` | Object\[] | N/A | Read-only | Array of key message objects. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationSummary.` `keyMessages.keyMessage.code` | String | N/A | Read-only | Code for the key message. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationSummary.` `keyMessages.keyMessage.text` | String | N/A | Read-only | Text for the key message. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `region.source` | String | N/A | Read-only | Source of the geographic information, such as `input` (provided in the request) or `file` (credit file). | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `region.zipVsCity` | String | N/A | Read-only | Result of comparing the source ZIP Code to the source city. Can be `valid`, `invalid`, `notAvailable`, `zipNotIssued`, `newZIP`, `notRequested`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `region.zipVsState` | String | N/A | Read-only | Result of comparing the source ZIP Code to the source state. Can be `valid`, `invalid`, `notAvailable`, `zipNotIssued`, `newZIP`, `notRequested`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `region.phoneVsState` | String | N/A | Read-only | Result of comparing the source phone number to the source state. Can be `valid`, `invalid`, `notAvailable`, `zipNotIssued`, `newZIP`, `notRequested` | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `region.phoneVsZIP` | String | N/A | Read-only | Result of comparing the source phone number to the source ZIP Code. Can be `valid`, `invalid`, `notAvailable`, `zipNotIssued`, `newZIP`, `notRequested`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `region.phoneVsZIPDistance` | String | N/A | Read-only | Mileage between the phone number and ZIP Code. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.source` | Object | N/A | Read-only | Source of the employment information of the person, such as `input` (provided in the request), `file` (credit file), or `vendor`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.location` | Object | N/A | Read-only | Location of the person. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.location.county.source` | String | N/A | Read-only | Source of the county, such as `input` (provided in the request) or `file` (credit file). | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.location.county.inputElement` | String | N/A | Read-only | Element from the input object used to find the location, such as `phoneNumber` or `zipCode`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.location.county.name` | String | N/A | Read-only | Name of the county associated with the source `inputElement`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.location.county.population` | String | N/A | Read-only | Population bracket, such as `inLargestMSA`, `over150`, `over35`, `over35`, or `notRequested` | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.location.county.city` | String | N/A | Read-only | Name of the city associated with the source `inputElement`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.location.county.state` | String | N/A | Read-only | Name of the state associated with the source `inputElement`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.location.zip.source` | String | N/A | Read-only | Source of the ZIP Code, such as `input` (provided in the request) or `file` (credit file). | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.location.zip.inputElement` | String | N/A | Read-only | Element from the input object used to find the ZIP Code, such as `phoneNumber` or `zipCode`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.location.zip.code` | String | N/A | Read-only | ZIP Code associated with the source `inputElement`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.location.zip.indicator` | String | N/A | Read-only | Whether the ZIP Code is literal or estimated. Can be `input`, `closest`, or `mostCommon`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.region.source` | String | N/A | Read-only | Source of the geographic information, such as `input` (provided in the request) or `file` (credit file). | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.region.zipVsCity` | String | N/A | Read-only | Result of comparing the source ZIP Code to the source city. Can be `valid`, `invalid`, `notAvailable`, `zipNotIssued`, `newZIP`, `notRequested`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.region.zipVsState` | String | N/A | Read-only | Result of comparing the source ZIP Code to the source state. Can be `valid`, `invalid`, `notAvailable`, `zipNotIssued`, `newZIP`, `notRequested`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.region.phoneVsState` | String | N/A | Read-only | Result of comparing the source phone number to the source state. Can be `valid`, `invalid`, `notAvailable`, `zipNotIssued`, `newZIP`, `notRequested` | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.region.phoneVsZIP` | String | N/A | Read-only | Result of comparing the source phone number to the source ZIP Code. Can be `valid`, `invalid`, `notAvailable`, `zipNotIssued`, `newZIP`, `notRequested`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `employment.region.phoneVsZIPDistance` | String | N/A | Read-only | Mileage between the phone number and ZIP Code. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `distance.source` | String | N/A | Read-only | Source of the distance, such as `input` (provided in the request) or `file` (credit file). | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `distance.minimum.` | String | N/A | Read-only | Minimum distance between home and business where the sub-element, `homeToBusinessPhone`, `homePhoneToBusinessZIP`, `homeZIPToBusinessPhone`, `homeToBusinessZIP`, or `noAnalysisReason`, indicates the comparison used to determine the minimum mileage. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.fraudAnalysis.` `distance.maximum.` | String | N/A | Read-only | Maximum distance between home and business where the sub-element, `homeToBusinessPhone`, `homePhoneToBusinessZIP`, `homeZIPToBusinessPhone`, `homeToBusinessZIP`, or `noAnalysisReason`, indicates the comparison used to determine the minimum mileage. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationAnalysis` | Object\[] | N/A | Read-only | Object containing the identification verification results for each data source used in the analysis. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationAnalysis.` `source` | String | N/A | Read-only | Source of the information, such as `file` (credit file) or `vendorFile` (non-credit file). | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationAnalysis.` `verificationStatus` | String | N/A | Read-only | Status of the verification for this source. Can be `insufficientInput`, `subjectFound`, `subjectNotFound`, `verificationDiscrepancy`, `privateListingFound`, `residentialListingFound`, `businessListingFound`, `listingWithNoNameFound`, `nonMailableAddressFound`, `phoneNotInput`, `unavailable`, `dataRestricted`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationAnalysis.` `firstNameVerification` | String | N/A | Read-only | First name verification results. Can be `notFound`, `noMatch`, `partialMatch`, `match`, `inputNotAvailable`, `lastFourMatch`, `dataRestricted`, `matchNotPerformed`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationAnalysis.` `middleNameVerification` | String | N/A | Read-only | Middle name verification results. Can be `notFound`, `noMatch`, `partialMatch`, `match`, `inputNotAvailable`, `lastFourMatch`, `dataRestricted`, `matchNotPerformed`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationAnalysis.` `lastNameVerification` | String | N/A | Read-only | Last name verification results. Can be `notFound`, `noMatch`, `partialMatch`, `match`, `inputNotAvailable`, `lastFourMatch`, `dataRestricted`, `matchNotPerformed`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationAnalysis.` `nameSuffixVerification` | String | N/A | Read-only | Name suffix verification results. Can be `notFound`, `noMatch`, `partialMatch`, `match`, `inputNotAvailable`, `lastFourMatch`, `dataRestricted`, `matchNotPerformed`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationAnalysis.` `currentAddressVerification` | String | N/A | Read-only | Current address verification results. Can be `notFound`, `noMatch`, `partialMatch`, `match`, `inputNotAvailable`, `lastFourMatch`, `dataRestricted`, `matchNotPerformed`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationAnalysis.` `previousAddressVerification` | String | N/A | Read-only | Previous address verification results. Can be `notFound`, `noMatch`, `partialMatch`, `match`, `inputNotAvailable`, `lastFourMatch`, `dataRestricted`, `matchNotPerformed`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationAnalysis.` `phoneNumberVerification` | String | N/A | Read-only | Phone number verification results. Can be `notFound`, `noMatch`, `partialMatch`, `match`, `inputNotAvailable`, `lastFourMatch`, `dataRestricted`, `matchNotPerformed`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationAnalysis.` `ssnVerification` | String | N/A | Read-only | Sodial Security number verification. Can be `notFound`, `noMatch`, `partialMatch`, `match`, `matchLastFour`, `inputNotAvailable`, `matchNotPerformed`, \`dataRestricted \`. | | `subject.subjectRecord.custom.` `idmanagerVerAnalysisV2.verificationAnalysis.` `dateOfBirthVerification` | String | N/A | Read-only | Date of birth verification results. Can be `notFound`, `noMatch`, `partialMatch`, `match`, `inputNotAvailable`, `lastFourMatch`, `dataRestricted`, `matchNotPerformed`. | | `subject.subjectRecord.addOnProduct.` `code` | String | N/A | Read-only | Vendor code for the add-on product. | | `subject.subjectRecord.addOnProduct.` `status` | String | N/A | Read-only | Status of the add-on product. Can be `clear`, `delivered`, `notAvailable`, `notAuthorized`. | | `subject.subjectRecord.addOnProduct.` `highRiskFraudAlert.message.source` | String | N/A | Read-only | Source of the message, such as `input` (provided in the request) or `file` (credit file). | | `subject.subjectRecord.addOnProduct.` `highRiskFraudAlert.message.code` | String | N/A | Read-only | Vendor code for the alert. | | `subject.subjectRecord.addOnProduct.` `highRiskFraudAlert.message.text` | String | N/A | Read-only | Text of the alert. | | `subject.subjectRecord.addOnProduct.` `idManagerVerification.searchStatus` | String | N/A | Read-only | Result of the subject search. Can be `clear`, `hit`, `unavailable`, `systemError`, `inputError`. | | `subject.subjectRecord.addOnProduct.` `idManagerVerification.returnMessage` | String | N/A | Read-only | Specifies how returned messages are displayed in the response. Can be `codes`, `text`, `codesAndText`. | #### data object for DOCUMENT\_AUTHENTICATION + MITEK | Property | Type | Required? | Mutable? | Description | | ---------------------------------------- | ------- | --------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `backImageDocumentId` | String | N/A | Read-only | Identifier (UUID) that is referenced in `mitekVerifications` object to determine the image the verification ran on. | | `documentEvidenceId` | String | N/A | Read-only | Identifier (UUID) that is referenced in `mitekVerifications` object to determine the image the verification ran on. | | `frontImageDocumentId` | String | N/A | Read-only | Identifier (UUID) that is referenced in `mitekVerifications` object to determine the image the verification ran on. | | `mitekVerifications` | Object | N/A | Read-only | Verification results object. | | `mitekVerifications.` `documentId` | String | N/A | Read-only | Identifier (UUID) of the image the verification ran on. | | `mitekVerifications.` `judgement` | String | N/A | Read-only | Overall determination of the authenticity of the dossier based on the evidence presented. Permitted values are: Authentic, Fraudulent, and Undetermined. | | `mitekVerifications.` `name` | String | N/A | Read-only | Name of the authenticator (test). | | `mitekVerifications.` `notifications` | Object | N/A | Read-only | An object of any number of name-value pairs, where the name is a notification code and the value is its description, in the event an authenticator was unable to run. | | `mitekVerifications.` `probability` | Integer | N/A | Read-only | A number that represents the overall authenticity score used in determining the authenticity of the dossier. | | `mitekVerifications.` `verificationType` | Integer | N/A | Read-only | A 3-digit number (code) that indicates the type of authenticator. | | `mitekVerifications.` `version` | String | N/A | Read-only | Version of the individual authenticator. | #### data object for DOCUMENT\_AUTHENTICATION + VERIFF | Property | Type | Required? | Mutable? | Description | | ----------------------------------- | -------- | --------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `veriffVerification` | Object | N/A | Read-only | Verification results object. | | `veriffVerification.acceptanceTime` | DateTime | N/A | Read-only | Timestamp for acceptance of the document. | | `veriffVerification.code` | String | N/A | Read-only | Vendor's verification result code. | | `veriffVerification.decisionTime` | DateTime | N/A | Read-only | Timestamp of the decision on the document. | | `veriffVerification.id` | String | N/A | Read-only | Unique identifier (UUID) for the results. | | `veriffVerification.status` | String | N/A | Read-only | Vendor's status for the verification. Can be `approved`, `abandoned`, `declined`, `expired`, `resubmission_requested`, `review`, `started`, or `submitted`. | | `veriffVerification.vendorData` | String | N/A | Read-only | Vendor's unique identifier (UUID) for the results. | | `veriffVerification.reason` | String | N/A | Read-only | Vendor's reason description for disapproval. | | `veriffVerification.reasonCode` | String | N/A | Read-only | Vendor's reason code for disapproval. | #### data object for DOCUMENT\_MANUAL\_AUTHENTICATION + MITEK | Property | Type | Required? | Mutable? | Description | | --------------------------------------------------- | --------- | --------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `customerReferenceId` | String | N/A | Read-only | Identifier (UUID) of the customer. | | `mitekVerifications` | Object | N/A | Read-only | Verification results object. | | `mitekVerifications.` `authenticity.result.reasons` | String\[] | N/A | Read-only | Array of strings with the reasons why the authenticity result is `NOT_AUTHENTIC`. | | `mitekVerifications.` `authenticity.result` | String | N/A | Read-only | Whether the document authenticity is deemed `AUTHENTIC` or `NOT_AUTHENTIC`. | | `mitekVerifications.` `notifications` | Object | N/A | Read-only | An object of any number of name-value pairs, where the name is a notification code and the value is its description, in the event an authenticator was unable to run. | | `mitekVerifications.` `originality.result.reasons` | String\[] | N/A | Read-only | Array of strings with the reasons why the originality result is `NOT_ORIGINAL`. | | `mitekVerifications.` `originality.result` | String | N/A | Read-only | Whether the document originality is deemed `ORIGINAL` or `NOT_ORIGINAL`. | | `mitekVerifications.` `validity.result.reasons` | String\[] | N/A | Read-only | Array of strings with the reasons why the validity result is `NOT_VALID`. | | `mitekVerifications.` `validity.result` | String | N/A | Read-only | Whether the document validity is deemed `VALID` or `NOT_VALID`. | | `requestId` | String | N/A | Read-only | Identifier (UUID) of the request for manual authentication. | #### data object for FACIAL\_COMPARISON + AMAZON A `metaData.type` of `FACIAL_COMPARISON` returns from the comparison of a live selfie to an image extracted from a government identification document. | Property | Type | Required? | Mutable? | Description | | ----------------------- | ------ | --------- | --------- | --------------------------------------------------------------------------------------------------------------------- | | `confidence` | Double | N/A | Read-only | A float between 0 and 100 that represents the level of confidence that the image contains a face. | | `quality.` `brightness` | Double | N/A | Read-only | A float between 0 and 100 that represents the brightness of the face. A higher value indicates a brighter face image. | | `quality.` `sharpness` | Double | N/A | Read-only | A float between 0 and 100 that represents the sharpness of the face. A higher value indicates a sharper face image. | | `similarity` | Double | N/A | Read-only | A float between 0 and 100 that represents the level of confidence that the faces match. | #### data object for FACIAL\_COMPARISON\_REFERENCE\_SELFIE + AMAZON A `metaData.type` of `FACIAL_COMPARISON_REFERENCE_SELFIE` returns from the comparison of a live selfie to a reference selfie image provided on a [Create Verify Transaction](verify-transactions/create-verify-transaction.html). | Property | Type | Required? | Mutable? | Description | | --------------------------------------------------- | --------- | --------- | --------- | --------------------------------------------------------------------------------------------------------------------- | | `comparisons` | Object\[] | N/A | Read-only | Array of objects with results of comparisons. | | `comparisons.detailedResults.` `confidence` | Double | N/A | Read-only | A float between 0 and 100 that represents the level of confidence that the image contains a face. | | `comparisons.detailedResults.` `quality.brightness` | Double | N/A | Read-only | A float between 0 and 100 that represents the brightness of the face. A higher value indicates a brighter face image. | | `comparisons.detailedResults.` `quality.sharpness` | Double | N/A | Read-only | A float between 0 and 100 that represents the sharpness of the face. A higher value indicates a sharper face image. | | `comparisons.detailedResults.` `similarity` | Double | N/A | Read-only | A float between 0 and 100 that represents the level of confidence that the faces match. | | `comparisons.source` | String | N/A | Read-only | The `type` of identity document to which submitted data is compared. Always `SELFIE`. | | `comparisons.status` | String | N/A | Read-only | Status of the comparison. | | `comparisons.target` | String | N/A | Read-only | How the submitted data was collected. Always `REQUIREMENTS`. | #### data object for IDENTITY\_RECORD\_MATCHING + BABEL\_STREET | 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](#verify-metadata-identity-record-match-results-match-definitions). | | `comparisons.detailedResults.address.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `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](#verify-metadata-identity-record-match-results-match-definitions). | | `comparisons.detailedResults.birth_date.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `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](#verify-metadata-identity-record-match-results-match-definitions). | | `comparisons.detailedResults.family_name.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `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](#verify-metadata-identity-record-match-results-match-definitions). | | `comparisons.detailedResults.given_name.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `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](#verify-metadata-identity-record-match-results-match-definitions). | | `comparisons.detailedResults.name.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `comparisons.overallWeightedResult` | String | N/A | Read-only | Weighted result of all reviewed fields as described in [Identity record match results match definitions](#verify-metadata-identity-record-match-results-match-definitions). | | `comparisons.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 comparison. | | `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 INJECTION\_DETECTION + IDRND `INJECTION_DETECTION` is not configured separately in [Verify Policies](verify-policy.html), it is performed automatically when `LIVENESS` or `FACIAL_COMPARISON` are performed. Results are returned separately in [Verification Metadata](#). | Property | Type | Required? | Mutable? | Description | | ------------- | ------ | --------- | --------- | ------------------------------------------------------------------------------------------------- | | `error` | String | N/A | Read-only | Error message if face detection fails. | | `error_code` | String | N/A | Read-only | Error code if face detection fails. | | `probability` | Double | N/A | Read-only | A float, either 0.0 or 1.0, that represents the probability of no injection attacks in the image. | #### data object for LIVENESS + IDRND | Property | Type | Required? | Mutable? | Description | | ------------- | ------ | --------- | --------- | -------------------------------------------------------------------------------- | | `error` | String | N/A | Read-only | Error message if face detection fails. | | `error_code` | String | N/A | Read-only | Error code if face detection fails. | | `probability` | Double | N/A | Read-only | A float between 0 and 1 that represents the liveness probability of the image. | | `quality` | Double | N/A | Read-only | A float between 0 and 1 that represents the quality of the image. | | `score` | Double | N/A | Read-only | A float that represents the raw liveness score. A higher value means more alive. | #### data object for VOICE\_ENROLLMENT + IDRND Available with voice enrollment. | | | | - | -------------------------------------------------------------------------- | | | Voice verification is deprecated and will be removed on November 25, 2026. | | Property | Type | Required? | Mutable? | Description | | ----------------------------------------------------- | --------- | --------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `recordingComparisons` | Object\[] | N/A | Read-only | Array of objects of voice enrollment comparisons between pairs of samples. | | `recordingComparisons.` `probability` | Double | N/A | Read-only | A float between 0 and 1 that represents the comparison probability of the voice enrollment sample. | | `recordingComparisons.` `score` | Double | N/A | Read-only | A float that represents a raw comparison score, intended to be used for evaluation and data calibration. A higher value means more closely matched voice enrollment samples. | | `recordingComparisons.` `voiceTemplateIds` | String\[] | N/A | Read-only | Array of identifiers (UUIDs) of the voice templates (a construct that contains the uniquely identifying biological characteristics of a person's voice) for the voice enrollment samples compared. | | `recordings` | Object\[] | N/A | Read-only | Array of objects of voice enrollment samples. | | `recordings.antispoof.probability` | Double | N/A | Read-only | A float between 0 and 1 that represents the probability that the voice enrollment sample is not a spoofed recording. | | `recordings.antispoof.` `score` | Double | N/A | Read-only | A float that represents a raw comparison score, intended to be used for evaluation and data calibration. A higher value means the voice enrollment sample is less likely a spoofed recording. | | `recordings.antispoof.` `unsuitable_input_message` | Boolean | N/A | Read-only | Whether or not the voice enrollment sample is a suitable submission. | | `recordings.quality.` `obtained_values.SNR` | Double | N/A | Read-only | A float that represents the signal-to-noise ratio of the submitted voice enrollment sample in deciBels (dB). | | `recordings.quality.` `obtained_values.SpeechLength` | Double | N/A | Read-only | A float that represents duration of the voice enrollment sample in milliseconds. | | `recordings.quality.` `threshold_values.SNR` | Double | N/A | Read-only | A float that represents the threshold for acceptable signal-to-noise ratio of the voice enrollment sample in deciBels (dB). | | `recordings.quality.` `threshold_values.SpeechLength` | Double | N/A | Read-only | A float that represents the threshold for acceptable duration of the voice enrollment sample in milliseconds. | | `recordings.recordingId` | String | N/A | Read-only | Identifier (UUID) of the voice enrollment sample. | | `recordings.voiceTemplateIds` | String | N/A | Read-only | Identifier (UUID) of the voice template (a construct that contains the uniquely identifying biological characteristics of a person's voice) for this voice enrollment sample. | #### data object for VOICE\_VERIFICATION + IDRND Available with voice verification. | | | | - | -------------------------------------------------------------------------- | | | Voice verification is deprecated and will be removed on November 25, 2026. | | Property | Type | Required? | Mutable? | Description | | -------------------------------------------------------- | --------- | --------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `matchResult.probability` | Double | N/A | Read-only | A float between 0 and 1 that represents the match probability of the voice verification sample. | | `matchResult.score` | Double | N/A | Read-only | A float that represents a raw comparison score, intended to be used for evaluation and data calibration. A higher value means more closely matched voice verification samples. | | `matchResult.voiceTemplateIds` | String\[] | N/A | Read-only | Array of identifiers (UUIDs) of the voice templates (a construct that contains the uniquely identifying biological characteristics of a person's voice) for the voice enrollment samples compared. | | `recordingData.antispoof.` `score` | Double | N/A | Read-only | A float that represents a raw comparison score, intended to be used for evaluation and data calibration. A higher value means the voice verification sample is less likely a spoofed recording. | | `recordingData.antispoof.` `unsuitable_input_message` | Boolean | N/A | Read-only | Whether or not the voice verification sample is a suitable submission. | | `recordingData.quality.` `obtained_values.SNR` | Double | N/A | Read-only | A float that represents the signal-to-noise ratio of the submitted voice verification sample in deciBels (dB). | | `recordingData.quality.` `obtained_values.SpeechLength` | Double | N/A | Read-only | A float that represents duration of the voice verification sample in milliseconds. | | `recordingData.quality.` `threshold_values.SNR` | Double | N/A | Read-only | A float that represents the threshold for acceptable signal-to-noise ratio of the voice verification sample in deciBels (dB). | | `recordingData.quality.` `threshold_values.SpeechLength` | Double | N/A | Read-only | A float that represents the threshold for acceptable duration of the voice verification sample in milliseconds. | | `recordingData.recordingId` | String | N/A | Read-only | Identifier (UUID) of the voice verification sample. | | `recordings.voiceTemplateIds` | String | N/A | Read-only | Identifier (UUID) of the voice template (a construct that contains the uniquely identifying biological characteristics of a person's voice) for this voice enrollment sample. |