Creating Users

Owned by Selma Pittman
Last updated: Mar 15, 2023
2 min read

Legacy API: Create Users

 

Request

Example Request

POST https://api.validic.com/v1/organizations/{ORGANIZATION_ID}/users.json { "user": { "uid": ":uid" }, "access_token": ":access_token" }

Results

 

{ "code": 201, "message": "Ok", "user": { "_id": "{USER_ID}", "access_token": "{USER_ACCESS_TOKEN}" } }

📘

Concept: What is a User?

A "user" represents one of your end users. For example, if Jane Smith is using your wellness application, you'll need to create a user inside Validic to represent Jane. You may refer to your users as a participant, program member, patient, or subject. In our examples, we'll simply call them users or end users.
​
Regardless of the name, it's important to remember that in order to prevent violating HIPPA guidelines, you must not send identifying information like name, social security number, date of birth, etc.

There are two steps to connect your user population to Validic.

  1. Create the user

  2. Ask permission to use their data.

In this section, we'll focus on creating a representation of your user. This is also known as provisioning or registering users.

Provisioning Users

Provisioning users is an ID exchange process that allows user data to remain de-identified, safe, and secure. Essentially, this process creates a user profile in our system and provides a unique ID to represent that user.

In the Concept shown above, we talked about an example user named Jane. To create a representation of Jane in Validic, you'd send the following:

Sample Request

POST https://api.validic.com/v1/organizations/55f6dd49SAMPLE00088/users.json { "user": { "uid": "03-K64-F" }, "access_token": "a86540dfb5d7817166397ba13d3b9SAMPLEdda28eb6efSAMPLE06d9" }

In this example, "uid": "03-K64-F" is the unique identifier that represents Jane in your system.

To successfully make this request:

  • You must set HTTP headers to “Content-Type: application/json”.

  • You must include the "uid" field that represents the user ID used in your own systems. We require using non-identifiable IDs instead of emails or names in order to remain compliant with HIPAA/PHI de-identification standards.

  • You must include the Organization Access Token provided by our Integration Support team.

Validic would respond:

Sample Response

Once this POST is made, you've exchanged Jane's ID from your system ("uid": "03-K64-F") for a unique Validic User ID. Moving forward, when you want to ask us about Jane, you'll use that unique Validic User ID (565c8821SAMPLE7000031).
For example:

users/565c8821SAMPLE7000031

❗️

Tip: Store Response Fields

It is important to store the following values from the response:

"_id""access_token"

These fields will be used to communicate with Validic in the future.

Updated less than a minute ago