Verify Passcodes

This documentation will describe the Verify Passcodes (XMVERPAS) endpoint. This endpoint is responsible for authenticating contact passcodes. When passcodes are verified the system will write a history event to the corresponding account.

See the Authentication documentation for information on how to obtain the authentication headers within the request.

Use Cases #

• Generate history events when passcodes are verified.

Verify Passcode #

Confirm a contact’s provided passcode is correct.

Supported Attributes #

Example Request #

curl --location "https://example.securemcloud.com/rest/rest.php?dataSource=methods&*view=xmsubmit" \
--header 'X-DICE-APPKEY: {{X-DICE-APPKEY}}' \
--header 'X-DICE-USERNAME: {{X-DICE-USERNAME}}' \
--header 'X-DICE-DATE: {{X-DICE-DATE}}' \
--header 'X-DICE-NONCE: {{X-DICE-NONCE}}' \
--header 'X-DICE-DIGEST: {{X-DICE-DIGEST}}' \
--header 'Accept: application/json' \
--form '*setMethod="XMVERPAS"' \
--form 'ACCOUNT_NUMBER="TEST01"' \
--form 'LOOKUP_ACCOUNT="TEST01"' \
--form 'PASSCODE="55555"' \
--form 'INVALID_TRIES="0"' \
--form 'MESSAGE_CODE="Updating zone list"' \
--form 'FROM_ACTIVE_ALARM="TRUE"'

Example Reponses #

Valid Passcode #

{
    "XMVERPAS": {
        "ACTIVATE": "Y",
        "STATUS": "VERIFIED",
        "PASSCODE_TYPE": "ACCOUNT",
        "MESSAGE": "TESTING - LOGIN",
        "DEFAULT_LIST_NO": "07",
        "CANCEL_ALARM": "Y",
        "INSTALLER_TEST": "Y",
        "REQUEST_SERVICE": "Y",
        "FAX_REPORTS": "Y",
        "TEMP_SCHED_CHANGE": "Y",
        "DEALER_INFORMATION": "Y",
        "RECENT_HISTORY": "Y",
        "SPECIAL_INSTRUCTIONS": "Y",
        "TEMPORARY_NOTES": "Y",
        "PANEL_INFORMATION": "Y",
        "SUBS_INFORMATION": "Y",
        "PAGING": "Y",
        "ZONES_LOOKUP": "Y",
        "GROUPING": "Y",
        "TEMP_PASSCODES": "N",
        "VIEW_CONTACTS": "N",
        "LOG_MESSAGE": "N",
        "ALL_DATA_ENTRY": "N",
        "CUSTOMER_INQUIRY": "N",
        "CAN_LOGIN_ELINK": "Y",
        "PASSCODE_STATUS": "V",
        "DUP_IN_MON": "Operator DGC is monitoring that account or its linked account"
    }
}

Invalid Passcode #

{
    "XMVERPAS": {
        "ACTIVATE": "Y",
        "STATUS": "INVALID",
        "MESSAGE": "INVALID PASSCODE",
        "INVALID_COUNT": "INVALID TRIES: 1",
        "INVALID_COUNT_NUMBER": "1"
    }
}

Response Fields #

Possible Error Messages #

No Account #

Verify an account number was specified.

{
    "XMVERPAS": {
        "STATUS": "NO ACCOUNT"
    }
}

Invalid Account #

Verify the account number is correct.

{
    "XMVERPAS": {
        "INVALID_ACCOUNT": " 0192475d",
        "STATUS": "NO ACCOUNT"
    }
}

Invalid Method #

Verify you are specifying XMVERPAS as the method.

{
    "ERROR_CODE": "999",
    "ERROR_DESCRIPTION": "INVALID%20METHOD%20METHOD",
    "PROGRAM_ERROR": "11",
    "PROGRAM_ERROR_DESCRIPTION": "Missing%20or%20Duplicate%20key",
    "ERROR_ON_LINE": "240",
    "ADDITIONAL_INFO": "%3CMETHOD_NAME%3EXMVERPA%20%3C%2FMETHOD_NAME%3E"
}