The REACH online audience API will return additional contact points for targeting users on Adroll, Facebook, Google, LinkedIn or a Generic format.
The API returns data that is pre-formatted for these services (i.e. what each service can accept). The JSON response will have appropriate header to separate and identify each service.

In addition, each service section will contain the appropriate headers for each data type.

📘
Hashed Output
Depending on the service used, some (if not all) of the data will be hashed with SHA256 with the exception of
AdRoll that will be hashed with MD5.
Note: The API will first transform the string to lowercase and then perform the hashing.
See Output for sample and details.

The below table shows these headers and their meaning.

Service Name	Headers	Hashed field	Max Field Count
AdRoll	email	email (MD5)	email: 8
Facebook	email phone fn (first name) ln (last name) fi (first initial) ct (city) st (state) country zip	all are hashed (SHA256)	email: 3 phone: 3
Google	email phone first name last name zip country	email (SHA256) phone (SHA256) first name (SHA256) last name (SHA256)	email: 8 phone: 7
LinkedIn	email firstname lastname jobtitle employeecompany country appleidfa googleaid	email (SHA256)	email: 1
TikTok	email phone	email (SHA256) phone (SHA256)	email: 3 phone: 3
Generic	email	email (SHA256)	email: 14

Format

Here's the format to call the Online Audience API:

Data Tool

The Onlineaudience API accepts the following data tools:

Data Tool Value	Description
b2cOnlineAudience	Used to search for consumer (B2C) contacts.
b2bOnlineAudience	Used to search for business (B2B) contacts.

Examples:

https://api.versium.com/v2/b2cOnlineAudience?first=john&last=doe&email=jdoe@gmail.com

https://api.versium.com/v2/b2bOnlineAudience?first=john&last=doe&email=jdoe@versium.com

Inputs - what the API uses to search

Inputs are information that the Online Audience API will use to search in the Versium REACH back end.
This API service accepts a the below search parameters and it matches your inputs with records in the Versium Data store, and returns information, as available.

Minimum required search parameters combinations for each Online Audience API:
b2bOnlineAudience

first, last, email
business, first, last, city, state
domain, first, last, city, state
fullname, email
business, fullname, city, state
domain, fullname, city, state
LinkedIn URL

b2cOnlineAudience

email
phone
address, city, state, zip
first, last, city, state
first, last, zip

value	description	example
first	A person's first name	John
last	A person's last name	Smith
fullname	A person First and Last name	John Smith
address	A house/building number and street	123 Main st.
address_2	The unit number of an address	Apt 12 or Unit 510
city	A city name	Seattle
state	A US State two letter abbreviation	WA
zip	A 5 digit US ZIP Code	98052
country	A 2 letter country abbreviation	US
phone	A valid 10 digit North American phone number	2061235555
email	A valid email address (Business or Consumer)	jsmith@versium.com
domain	A business domain	versium.com
business	A business name	Versium
li_url	A valid LinedIn URL	https://www.linkedin.com/in/john-smith

Optional Parameters

Optional Configuration Parameters are used to specify and configure how the Online Audience Append API will perform the search.

Optional Config. Parameter

Value

Description

cfg_maxrecs

1 (default) -> 100

Number of returned records

rcfg_max_time

A whole or decimal number

Maximum allowed API run time (in seconds).

rcfg_oa_services[]

possible values:

facebook
google
linkedin
generic
adroll
original
liveramp (requires permission)
stackadapt (requires permission)

Specifies which services to return hashed data for. The default is every service.