Validic Inform

Validic Inform Developer Hub

Welcome to the Validic Inform developer hub. You'll find comprehensive guides and documentation to help you start working with Validic Inform as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Provision and Managing Users

It all starts here...

The first step to accessing an end user's data is to first “provision” a user in our system. Provisioning creates a representation of your end user in our system, which we’ll use to store data for that user. To do this, you’ll need to POST the following request.

Note: The “uid” will be the ID you’ll use to request user data in the future. Please ensure this ID does not include any identifiable data. Doing so could violate HIPAA regulations.

You may also choose to provide the user's location, time zone, and country code. This information will only be used in the event that a data source does not provide Validic with adequate context for a timestamp.

1. Create A User

To create a user in Validic, you simply need to POST the following request:

POST /organizations/:org_id/users?token=:token

Within this request, you can post the following request parameters.

Request Parameters

Name
Required Field
Type
Description

org_id

required

URI Param

The Validic Organization ID to associate the user with.

token

required

Query Param

The token provided by Validic to access Validic API’s.

uid

required

string

Customer's user identifier. This value should not include any identifying information which could violate HIPAA regulations.
A uid must have more than 3 and less than 255 characters and may only contain alphanumeric characters or single hyphens, and cannot begin or end with a hyphen.

location

optional

string

Information associated with a user’s location.

location > timezone

optional

string

Default user timezone. Please see list of supported timezones below. When retrieving data from a source that provides no UTC offset information the default timezone will be used to calculate the UTC offset.

location > country_code

optional

string

User’s country identified as a two character country code using the ISO 3166-1 standard. Validic uses this information for integrations that provide data access based upon the user’s country.

HTTP Response Status

Response Code
Description

201 (Created)

Indicates the request was received and the object was created successfully.

422 (Unprocessable Entity)

An error occurred and an error response has been sent with details.

The following request shows how you'd create a new user located in New York area.

Format Warning: "uid'

When provisioning a user, the "uid" you provide will be the ID used to request user level data with the REST API.

A uid must have more than 3 and less than 255 characters and may only contain alphanumeric characters or single hyphens, and cannot begin or end with a hyphen.

The "uid" MUST NOT CONTAIN any identifying data which may violate HIPAA regulations. This includes, but is not limited to

  • Name
  • Social Security Number
  • Date of Birth
https://api.v2.validic.com/organizations/59b02bbSAMPLE00001e13e75/users?token=5cf04ad4a94dSAMPLE1653cfc28a26

{  
   "uid":"277040620sol3",
   "location":{  
      "timezone":"America/New_York",
      "country_code":"US"
   }
}
{
    "id": "59b0664cf758800001e13ea9",
    "uid": "277040620sol3",
    "marketplace": {
        "token": "ee889ef9d7fb7a9644c97ef9d69ZSAMPLEa0be23352bdee46a775c066ef0f890",
        "url": "https://syncmydevice.com?token=ee889ef9d7fb7a9644c97ef9d69ZSAMPLEa0be23352bdee46a775c066ef0f890"
    },
    "mobile": {
        "token": "7c001f84255SAMPLE8c168ba563035"
    },
    "location": {
        "timezone": "America/New_York",
        "country_code": "US"
    },
    "sources": [],
    "created_at": "2017-09-06T21:19:08Z",
    "updated_at": "2017-09-06T21:19:08Z"
}

Required Field

Make sure you retain the information from this response, you'll need it the next section.

The following table outlines the possible fields which can be expected in the API response.

Name
Type
Description

id

string

Validic user ID

uid

string

Customer’s user identifier.

marketplace > token

Unique marketplace identifier.

marketplace > url

string

The user’s marketplace URL. Requesting this URL with the ‘Accept’ header as ‘application/json’ will provide a JSON representation of the marketplace. Otherwise an HTML representation will be presented.

mobile > token

string

Unique identifier used to connect users to the Validic mobile solution.

location > timezone

string

Default user timezone. When retrieving data from a source that provides no UTC offset information the default timezone will be used to calculate the UTC offset.

location > country_code

string

User’s country identified as a two character country code using the ISO 3166-1 standard. Validic uses this information for integrations that provide data access based upon the user’s country.

sources

string

List of sources the user has connected to including the connection time in UTC.

created_at

string

The date and time the resource was created.

updated_at

string

The date and time the resource was updated.

Supported Timezones
Validic supports over 400 Olson format timezones. When setting a default timezone for a user the value must match one of the timezones listed in the table found here.


What's Next

Learn how you'll gain permission to access your user's data.

Requesting Access to Data

Provision and Managing Users

It all starts here...