Introduction
This documentation aims to provide all the information you need to work with our API.
Base URL
https://api.validiform.comAuthenticating requests
Authenticate requests to this API's endpoints by sending an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".
All authenticated endpoints are marked with a requires authentication badge in the documentation below.
You can retrieve your token by visiting your dashboard.
Sessions
Get Sessions
requires authentication
Example request:
curl --request GET \
--get "https://api.validiform.com/v1/sessions?page=1&count=10" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.validiform.com/v1/sessions"
);
const params = {
"page": "1",
"count": "10",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
access-control-allow-origin: *
{
"data": [
{
"id": 6271,
"project_id": 1,
"visitor_id": 6352,
"key": "N9SCsLUur83YEsPptwVMoWD1clWKJMxXGnkRqHQnnXZlBlVpHpmmfc9ySVWfF6MMKMdq5yYDAvBHZI03kWuOIkOQcYAjkT2U8kESls3pdOHcHXWYeoZf6vdCPcMi07m7",
"url": "https:\/\/stripe.com\/contact\/sales",
"title": "Stripe: Contact our Sales Team",
"initial_state": {
"size": {
"width": 1764,
"height": 417
},
"scroll": {
"top": 0,
"left": 0
}
},
"duration": 251608,
"visitor_ip": "95.105.65.235",
"created_at": "2021-06-09T16:00:37.000000Z",
"updated_at": "2021-06-09T16:00:48.000000Z",
"deleted_at": null,
"has_submitted_form": false,
"storage_path": "18\/c68edf21a09ffd28187f\/",
"pin": "N9SCsLUu",
"forms": [
{
"id": 8,
"page_id": 6271,
"ub_id": 3864,
"created_at": "2021-06-09T16:00:44.000000Z",
"updated_at": "2021-06-09T16:00:44.000000Z",
"is_submitted": false
}
]
},
{
"id": 39117,
"project_id": 1,
"visitor_id": 39198,
"key": "vsRwfewaTma6nphVQkWC64o898H2aw4cgXpnIGXTBVXlpE1GJGSpExtBFWI9WOsbmrgKkSOU3JDmUowIQStwPVsRVypclL6hsENNky7KekZW12Q9V9fUKlAnbFaoH9cf",
"url": "https:\/\/stripe.com\/contact\/sales",
"title": "Stripe: Contact our Sales Team",
"initial_state": {
"size": {
"width": 1782,
"height": 535
},
"scroll": {
"top": 148,
"left": 0
}
},
"duration": 209034,
"visitor_ip": "95.105.65.235",
"created_at": "2021-06-25T19:02:09.000000Z",
"updated_at": "2021-06-25T19:05:38.000000Z",
"deleted_at": null,
"has_submitted_form": false,
"storage_path": "98\/4f031c4718105d7298cd\/",
"pin": "vsRwfewa",
"forms": [
{
"id": 63,
"page_id": 39117,
"ub_id": 4102,
"created_at": "2021-06-25T19:02:17.000000Z",
"updated_at": "2021-06-25T19:02:17.000000Z",
"is_submitted": false
}
]
}
],
"links": {
"first": "https:\/\/api.validiform.com\/v1\/sessions?page=1",
"last": "https:\/\/api.validiform.com\/v1\/sessions?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https:\/\/api.validiform.com\/v1\/sessions",
"per_page": 10,
"to": 2,
"total": 2
}
}
Received response:
Request failed with error:
Get Session by ID
requires authentication
Example request:
curl --request GET \
--get "https://api.validiform.com/v1/sessions/774476" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.validiform.com/v1/sessions/774476"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
access-control-allow-origin: *
{
"data": {
"id": 774476,
"project_id": 63,
"visitor_id": 774557,
"key": "GDIH81ggZSUwG14tqKKXB5lJDLEM7P46NwCxmuDFmvkPY1VcuCwFWGHmwcYv876RFx3OOykDQgTuvP3x1wp6LuXurR5DquYvNo3ocTHms9K9gWm6MnvDSblggA0DuVeD",
"url": "https:\/\/renttoownhomefinder.com\/l\/signup\/?subone=11609&subtwo=&subthree=&subfour=11609_&transaction=6b15c556d7fc4eecb75f17b394a46b74&ip=172.56.26.125&fname=&lname=&email=&phone=&kp_leadid=&su",
"title": "Primary Lander | Rent-to-Own Home Finder",
"initial_state": {
"size": {
"width": 384,
"height": 726
},
"scroll": {
"top": 0,
"left": 0
}
},
"duration": 19646,
"visitor_ip": "172.56.26.125",
"created_at": "2021-08-03T15:50:40.000000Z",
"updated_at": "2021-08-03T15:50:59.000000Z",
"deleted_at": null,
"has_submitted_form": true,
"storage_path": "bd1\/0b\/70804321c96d1044bd14c\/",
"pin": "GDIH81gg",
"forms": [
{
"id": 365228,
"page_id": 774476,
"ub_id": 208,
"created_at": "2021-08-03T15:50:44.000000Z",
"updated_at": "2021-08-03T15:50:58.000000Z",
"is_submitted": true,
"inputs": [
{
"id": 922572,
"page_id": 774476,
"form_id": 365228,
"type": "text",
"name": "first_name",
"title": "First Name",
"value": "Kelvin",
"created_at": "2021-08-03T15:50:44.000000Z",
"updated_at": "2021-08-03T15:50:44.000000Z"
},
{
"id": 922578,
"page_id": 774476,
"form_id": 365228,
"type": "text",
"name": "last_name",
"title": "Last Name",
"value": "Feliciano",
"created_at": "2021-08-03T15:50:48.000000Z",
"updated_at": "2021-08-03T15:50:48.000000Z"
},
{
"id": 922580,
"page_id": 774476,
"form_id": 365228,
"type": "tel",
"name": "phone_number",
"title": "Phone Number",
"value": "8634580907",
"created_at": "2021-08-03T15:50:50.000000Z",
"updated_at": "2021-08-03T15:50:54.000000Z"
},
{
"id": 922583,
"page_id": 774476,
"form_id": 365228,
"type": "email",
"name": "email_address",
"title": "Email Address",
"value": "joselynhernandez546@gmail.com",
"created_at": "2021-08-03T15:50:55.000000Z",
"updated_at": "2021-08-03T15:50:57.000000Z"
},
{
"id": 922586,
"page_id": 774476,
"form_id": 365228,
"type": "checkbox",
"name": "terms_of_service",
"title": "I agree to the terms of service.",
"value": null,
"created_at": "2021-08-03T15:50:59.000000Z",
"updated_at": "2021-08-03T15:50:59.000000Z"
}
]
}
]
}
}
Received response:
Request failed with error: