id_verification Namespace

The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.

For example, the call center agent can ask the person to confirm their social security number, birth date, insurance details, or driver’s license number.

The person contacting the call center could be a patient, a parent or guardian if the patient’s a minor, the authorized representative of a patient, or a provider. No matter who the caller is, if they want sensitive information, an agent must verify the caller’s identity first. If the inquiry concerns information in the public domain (for example, the location of a hospital), then verification isn’t required.

The following are the classes in the id_verification namespace.

  • FieldValue Class

    Contains a key-value pair represented by the developer name and value of the field. The key-value pair is used for both search results and verification.

  • IdentityVerificationExt Interface

    The IdentityVerificationExt interface enables you to verify a caller’s identity.

  • ProcessDefinition Class

    Contains the verification process definition, including the list of process details.

  • ProcessDetail Class

    Contains the verification process details.

  • SearchFilter Class

    Contains data filters that is applied in object-based search.

  • SearchFilters Class

    Contains a list of data filters to be applied for object-based search.

  • SearchRequest Class

    Contains information about the search request data. The search request represents search filters for object-based search, search terms for text-based search, and the verification context that includes the process definition, process details, and process fields.

  • SearchResult Class

    Contains the contract of search results in tabular format for either the object-based or text-based search.

  • SearchResultHeader Class

    Contains information about the search result header field list. This list represents the metadata information of the columns that are part of the search result.

  • SearchResultRow Class

    Contains information about the search result row field list. This list represents the column values for a specific row that are part of the search result.

  • SelectedSearchResult Class

    Contains the details of the record that has been selected for verification.

  • SelectedVerifiedResult Class

    Contains information about the verified object that is used for the secondary search.

  • VerificationContext Class

    Contains information about the verification context, including the process definition, selected search result, selected verified result, and verified result.

  • VerificationProcessField Class

    Contains details of the fields used for both search and the verification process.

  • VerificationProcessFieldList Class

    Contains information about the list of fields used for both search and the verification process.

  • VerifiedDetails Class

    Contains details about the verified object that is used for secondary search, including the process that’s used to verify the search object.

  • VerifiedResult Class

    Contains information about the verification result that includes the required verifiers and optional verifiers and the verification status.

  • Verifier Class

    Contains a list of input representations for verifier fields, including the optional and required fields.