Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

^XUVERIFY: Verify Access and Verify Codes

Reference Type: Supported, Category: Signon/Security, ICR#: 10051

Description

The ^XUVERIFY API validates Access and Verify codes. You can use it anytime within an application program to verify that the person using the system is the same person who signed onto the system.

Format

  ^XUVERIFY

Make sure to perform the following steps before calling this API:

  1. NEW all non-namespaced variables.

  2. Set all input variables.

  3. Call the API.

Input Variables

%:

(required) If % equals:

  • A—Check the Access code.

  • V—Check the Verify code.

  • AV—Check both the Access and Verify code.
%DUZ:

(required) The user's number (DUZ value).

Output Variables

%:

Returns the following values:

  • 2—Failure (the incorrect code was entered).

  • 1—Success (the correct code was entered).

  • 0—A question mark was entered.

  • -1—A caret (^) was entered.