VerifiedVisitors visitor access control API (1.0.0)

Download OpenAPI specification:Download

verifyVisitor

Authorizations:

bearerAuth

Request Body schema: application/json

timestamp	integer Epoch timestamp in milliseconds
required	object
host required	string Value of the 'host' header. This must match the site hostname set up in the VerifiedVisitors console.
uri	string Request URI path and query
method	string Request method
headers	Array of strings List of headers included in the request
connection	string Value of the `connection` header, if present
referer	string Value of the `referer` header, if present
origin	string Value of the `origin` header, if present
pragma	string Value of the `pragma` header, if present
xForwardedFor	string Value of the `x-forwarded-for` header, if present
xForwardedProto	string Value of the `x-forwarded-proto` header, if present
xRequestedWith	string Value of the `x-requested-with` header, if present
xRealIp	string Value of the `x-real-ip` header, if present
trueClientIp	string Value of the `true-client-ip` header, if present
via	string Value of the `via` header, if present
accept	string Value of the `accept` header, if present
acceptEncoding	string Value of the `accept-encoding` header, if present
acceptLanguage	string Value of the `accept-language` header, if present
acceptCharset	string Value of the `accept-charset` header, if present
contentType	string Value of the `content-type` header, if present
contentLength	string Value of the `content-length` header, if present
cacheControl	string Value of the `cache-control` header, if present
from	string Value of the `from` header, if present
cc	string [ 2 .. 6 ] characters Two-letter country code of the visitor. If omitted, the value will be inferred from the IP address.
hCaptchaToken	string The `h-captcha-response` token as passed to the `data-callback` function. For use when processing responses to a served CAPTCHA challenge.
jsChallengeToken	string
	object For internal use. Omit for manual integrations.
log	boolean Default: true For internal use. This should always be 'true'.

Responses

Request samples

Content type

application/json

{"timestamp": 1683643245768,
"visitorId": {"vid": "9a20079bc4597fce683c583c18797156",
"ip": "203.0.113.0",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36"
},
"host": "verifiedvisitors.com",
"uri": "https://verifiedvisitors.com/blog?param=value",
"method": "GET",
"headers": ["user-agent",
"accept",
"accept-encoding"
],
"connection": "keep-alive",
"referer": "www.verifiedvisitors.com",
"origin": "string",
"pragma": "no-cache",
"xForwardedFor": "203.0.113.1,192.0.2.0",
"xForwardedProto": "https",
"xRequestedWith": "XMLHttpRequest",
"xRealIp": "203.0.113.0",
"trueClientIp": "203.0.113.0",
"via": "1.1 vegur",
"accept": "text/html",
"acceptEncoding": "gzip",
"acceptLanguage": "en-US",
"acceptCharset": "string",
"contentType": "text/html",
"contentLength": "30012",
"cacheControl": "max-age=604800",
"from": "[email protected]",
"cc": "GB",
"hCaptchaToken": "10000000-aaaa-bbbb-cccc-000000000001",
"jsChallengeToken": "string",
"worker": {"name": "string",
"version": "string"
},
"log": true
}

Response samples

Content type

application/json

{"action": "captcha",
"ruleId": 0,
"captchaSiteKey": "10000000-ffff-ffff-ffff-000000000001",
"jsChallengeToken": "string",
"visitorId": "9a20079bc4597fce683c583c18797156",
"rootDomain": "verifiedvisitors.com",
"countryCode": "GB",
"traceId": "string",
"htmlBody": "string"
}