https://github.com/ctsit/survey_participant_ip

REDCap module that provides a new action tag - @SURVEY-PARTICIPANT-IP - which sets a hidden field that collects the survey participant's IP address.
https://github.com/ctsit/survey_participant_ip

redcap redcap-external-module

Last synced: 7 months ago
JSON representation

REDCap module that provides a new action tag - @SURVEY-PARTICIPANT-IP - which sets a hidden field that collects the survey participant's IP address.

• Host: GitHub
• URL: https://github.com/ctsit/survey_participant_ip
• Owner: ctsit
• License: other
• Created: 2018-07-18T17:53:35.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-06-20T20:40:38.000Z (almost 7 years ago)
• Last Synced: 2025-02-27T20:32:57.985Z (over 1 year ago)
• Topics: redcap, redcap-external-module
• Language: PHP
• Size: 74.2 KB
• Stars: 1
• Watchers: 6
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# REDCap Survey Participant IP

Provides a new action tag - `@SURVEY-PARTICIPANT-IP` - which sets a hidden field that collects the survey participant's IP address.

## Prerequisites

- REDCap >= 8.0.3

## Easy Installation

- Obtain this module from the Consortium [REDCap Repo](https://redcap.vanderbilt.edu/consortium/modules/index.php) from the Control Center.

## Manual Installation

- Clone this repo into `/modules/survey_participant_ip_v` .

- Go to **Control Center > Manage External Modules** and enable Survey Participant IP.

## How to use it

The first step is accessing Online Desinger of your project to create a text field responsible for storing the IP addresses. Then, add `@SURVEY-PARTICIPANT-IP` action tag to it.

![Action tag setup](img/field_annotation.png)

And that's it! The field will be invisible for survey participants, and the IPs will be automatically collected.

## Using ipify to collect IP addresses

By default, REDCap system is used to get IP addresses. Alternatively, you may enable [ipify](https://www.ipify.org/), a third-party API that increases reliability of the collected IPs.

![Configuration screen](img/config.png)

The ipify mode works from the client browser, so keep in mind that survey participants may spoof the IP value by via browser developer tools.

## Important

Please keep in mind an IP address can be easily spoofed (e.g. VPN, proxy servers), so there is no guaranteed way to get a "real" IP.