--- title: Verify Identity Record Matching description: With the Verify Identity Record Matching service, you can submit any of name, given name, family name, birth date, or address from an unverified source and corresponding values from one or more verified sources. The identityRecordMatching endpoint, /environments/{{envID}}/users/{{userID}}/identityRecordMatching, compares the unverified biographic data to the verified biographic data, and returns a raw score and confidence level of the match. component: pingone-api page_id: pingone-api:verify:verify-identity-record-matching canonical_url: https://developer.pingidentity.com/pingone-api/verify/verify-identity-record-matching.html section_ids: assigning-admin-roles-and-permissions-to-this-service: Assigning admin roles and permissions to this service verify-identity-record-matching-request-data-model: Verify identity record matching request data model verify-identity-record-matching-response-data-model: Verify identity record matching response data model --- # Verify Identity Record Matching With the Verify Identity Record Matching service, you can submit any of name, given name, family name, birth date, or address from an unverified source and corresponding values from one or more verified sources. The `identityRecordMatching` endpoint, `/environments/{{envID}}/users/{{userID}}/identityRecordMatching`, compares the unverified biographic data to the verified biographic data, and returns a raw score and confidence level of the match. ## 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.html#automatic-role-assignment). * [Group Role Assignments](../platform/group-role-assignments/group-role-assignments.html). * [User Role Assignments](../platform/users/user-role-assignments.html). Refer to [Roles Management](../platform/roles.html) for more information. ## Verify identity record matching request data model | Property | Type | Required? | Mutable? | Description | | -------------------------------- | --------- | ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `probe` | Object | Required | Mutable | Object containing the data submitted from the document to match. At least one property is required. | | `probe.address` | String | Required/Optional | Mutable | Address of the identity submitted from the document to match | | `probe.birth_date` | String | Required/Optional | Mutable | Birth date name of the identity submitted from the document to match | | `probe.family_name` | String | Required/Optional | Mutable | Family name of the identity submitted from the document to match | | `probe.given_name` | String | Required/Optional | Mutable | Given name of the identity submitted from the document to match | | `probe.name` | String | Required/Optional | Mutable | Name of the identity submitted from the document to match | | `gallery` | Object | Required | Mutable | Object containing the data submitted from source records to match. A property is required for each `probe` property submitted. | | `gallery.address` | String | Required/Optional | Mutable | Address of the identity submitted from the document to match | | `gallery.address.expression` | String | Required/Optional | Mutable | PingOne Expression Language (PEL) expression to retrieve the `address` value, such as supply a literal value, reformat the source value, or combine source attributes. For more information on PEL, refer to PingOne expression language. | | `gallery.address.options` | String\[] | Required/Optional | Mutable | Array of literal `address` values to match. | | `gallery.address.value` | String | Required/Optional | Mutable | Literal `address` value to match. | | `gallery.birth_date` | String | Required/Optional | Mutable | Birth date name of the identity submitted from the document to match | | `gallery.birth_date.expression` | String | Required/Optional | Mutable | PingOne Expression Language (PEL) expression to retrieve the `birth_date` value, such as supply a literal value, reformat the source value, or combine source attributes. For more information on PEL, refer to PingOne expression language. | | `gallery.birth_date.options` | String\[] | Required/Optional | Mutable | Array of literal `birth_date` values to match. | | `gallery.birth_date.value` | String | Required/Optional | Mutable | Literal `birth_date` value to match. | | `gallery.family_name` | String | Required/Optional | Mutable | Family name of the identity submitted from the document to match | | `gallery.family_name.expression` | String | Required/Optional | Mutable | PingOne Expression Language (PEL) expression to retrieve the `family_name` value, such as supply a literal value, reformat the source value, or combine source attributes. For more information on PEL, refer to PingOne expression language. | | `gallery.family_name.options` | String\[] | Required/Optional | Mutable | Array of literal `family_name` values to match. | | `gallery.family_name.value` | String | Required/Optional | Mutable | Literal `family_name` value to match. | | `gallery.given_name` | String | Required/Optional | Mutable | Given name of the identity submitted from the document to match | | `gallery.given_name.expression` | String | Required/Optional | Mutable | PingOne Expression Language (PEL) expression to retrieve the `given_name` value, such as supply a literal value, reformat the source value, or combine source attributes. For more information on PEL, refer to PingOne expression language. | | `gallery.given_name.options` | String\[] | Required/Optional | Mutable | Array of literal `given_name` values to match. | | `gallery.given_name.value` | String | Required/Optional | Mutable | Literal `given_name` value to match. | | `gallery.name` | String | Required/Optional | Mutable | Name of the identity submitted from the document to match. | | `gallery.name.expression` | String | Required/Optional | Mutable | PingOne Expression Language (PEL) expression to retrieve the `name` value to match, such as supply a literal value, reformat the source value, or combine source attributes. For more information on PEL, refer to PingOne expression language. | | `gallery.name.options` | String\[] | Required/Optional | Mutable | Array of literal `name` values to match. | | `gallery.name.value` | String | Required/Optional | Mutable | Literal `name` value to match. | ## Verify identity record matching response data model | 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. Can be `HIGH`, `MEDIUM`, `LOW`, or `NONE`. | | `detailedResults.address.` `probeValue` | String | N/A | Read-only | Value of address found on the government ID of the identity. | | `detailedResults.address.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `detailedResults.address.` `galleryValue` | 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. Can be `HIGH`, `MEDIUM`, `LOW`, or `NONE`. | | `detailedResults.birth_date.` `probeValue` | String | N/A | Read-only | Value of birth date found on the government ID of the identity. | | `detailedResults.birth_date.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `detailedResults.birth_date.` `galleryValue` | 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. Can be `HIGH`, `MEDIUM`, `LOW`, or `NONE`. | | `detailedResults.family_name.` `probeValue` | String | N/A | Read-only | Value of family name found on the government ID of the identity. | | `detailedResults.family_name.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `detailedResults.family_name.` `galleryValue` | 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. Can be `HIGH`, `MEDIUM`, `LOW`, or `NONE`. | | `detailedResults.given_name.` `probeValue` | String | N/A | Read-only | Value of given name found on the government ID of the identity. | | `detailedResults.given_name.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `detailedResults.given_name.` `galleryValue` | 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. Can be `HIGH`, `MEDIUM`, `LOW`, or `NONE`. | | `detailedResults.name.` `probeValue` | String | N/A | Read-only | Value of name found on the government ID of the identity. | | `detailedResults.name.` `rawScore` | String | N/A | Read-only | Raw numeric score returned by the service. Ranges from 0 to 1. | | `detailedResults.name.` `galleryValue` | 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. Can be `HIGH`, `MEDIUM`, `LOW`, or `NONE`. The lowest `confidence` value of non-zero `rawScore` results. | | `overallWeightedScore` | Decimal | N/A | Read-only | Weighted score of all reviewed fields. A decimal number between 0 and 1. The average of all non-zero `rawScore` results. | A `confidence` of `NONE` occurs when `rawScore` is very low or when a `governmentIdValue` value is missing but its corresponding `requirementsValue` is valued.