Ping

Retrieving Ping Data

Retrieve ping data directly from a Certificate.

When a lead vendor only provides a TrustedForm Certificate URL, Ping data can be retrieved directly without a Ping URL. Simply append /ping to the Certificate URL and perform an authenticated POST.

Request
path Parameters
cert_id
required
string

Certificate ID

Responses
200

Created

400

Malformed Certificate URL

401

Unauthorized

404

TrustedForm certificate has expired or could not be found

post/{cert_id}/ping
Request samples 
Response samples 
application/json
{
  • "cert": {
    • "age_seconds": 33,
    • "approx_ip_geo": {
      • "city": "Austin",
      • "country_code": "US",
      • "lat": 30.4548,
      • "lon": -97.7664,
      • "postal_code": "78729",
      • "state": "TX",
      • "time_zone": "America/Chicago"
      },
    • "browser": {
      • "full": "Chrome 95.0.4638.69",
      • "name": "Chrome",
      • "version": {
        • "full": "95.0.4638.69",
        • "major": "95",
        • "minor": "0",
        • "patch": "4638.69"
        }
      },
    • "created_at": "2021-11-12T22:06:44Z",
    • "domain": "example.com",
    • "event_duration_ms": 21110,
    • "expires_at": "2021-11-15T22:06:44Z",
    • "form_input_method": [
      • "typing",
      • "autofill"
      ],
    • "ip": "8.8.8.8",
    • "is_framed": true,
    • "is_mobile": false,
    • "kpm": 68.2314,
    • "operating_system": {
      • "full": "Mac OS X 10.15.7",
      • "name": "Mac OS X",
      • "version": {
        • "full": "10.15.7",
        • "major": "10",
        • "minor": "15",
        • "patch": "7"
        }
      },
    • "page_id": "5d8ce3c9502b426f77001ae7",
    • "page_url": "https://www.example.com/contact.html",
    • "parent_page_url": "https://www.example.com/index.html",
    • "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.69 Safari/537.36",
    • "wpm": 77.1234
    },
  • "fingerprints": {
    • "matching": [
      • "c4a8e7fe184993964ae81380e91579015306838a",
      • "d511850d569bcd7802c30f54de34bb9f2b31eede"
      ],
    • "non_matching": [
      • "d511850d569bcd7802c30f54de34bb9f2b31eed1"
      ]
    },
  • "is_masked": false,
  • "outcome": "success",
  • "scans": {
    • "forbidden_found": [
      • "Enim sit amet venenatis"
      ],
    • "forbidden_not_found": [
      • "Est velit egestas"
      ],
    • "required_found": [
      • "lorem ipsum dolor"
      ],
    • "required_not_found": [
      • "Ad qui aperiri"
      ]
    },
  • "warnings": [ ]
}
Generate Ping URL
When a lead vendor only provides a TrustedForm Certificate URL, you can
generate a new Ping URL for the Certificate. Simply append /ping_url to
the Certificate URL and perform an unauthenticated GET.


Each call to this endpoint will generate a new Ping URL, they are all
equally valid.


A successful call to this endpoint does not guarantee that the Certificate
URL you have provided is valid and unexpired. The
standard Certificate expiration window still
applies.


Request 
path Parameters
cert_id
required
string
Certificate ID


 
Responses 
200
Created


400
Malformed Certificate URL


get/{cert_id}/ping_url
Request samples 
Response samples