Skip to main content
POST
/
{cert_id}
/
ping
Retrieving Ping Data
curl --request POST \
  --url https://cert.trustedform.com/{cert_id}/ping
{
  "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": []
}

Path Parameters

​
cert_id
string
required

Certificate ID

Response

Created

Ping Response

​
cert
DataServiceCert · object
required
Example:
{
  "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
Fingerprints · object
required
Example:
{
  "matching": [
    "c4a8e7fe184993964ae81380e91579015306838a",
    "d511850d569bcd7802c30f54de34bb9f2b31eede"
  ],
  "non_matching": ["d511850d569bcd7802c30f54de34bb9f2b31eed1"]
}
​
is_masked
boolean
required

A boolean indicating whether the certificate is masked

​
outcome
enum<string>
default:success
required

The result of the attempt to verify consent. Success indicates that the request did not generate any warnings related to consent verification. Failure indicates that the requests generated warnings because no fingerprints matched, forbidden scan terms were found or required scan terms were missing. Error indicates that the request was not successfull and the request should be reviewed and potentially retried.

Available options:
success,
failure,
error
​
scans
PageScans · object
required
Example:
{
  "forbidden_found": ["Enim sit amet venenatis"],
  "forbidden_not_found": ["Est velit egestas"],
  "required_found": ["lorem ipsum dolor"],
  "required_not_found": ["Ad qui aperiri"]
}
​
reason
string

Provides an explanation for failure or error.

Only used for outcome of failure or error.

​
warnings
enum<string>[]

An array of strings indicating possible issues with the certificate

  • none of the provided fingerprints match: No fingerprints matched.
  • string not found in snapshot: A required page scan text was not found.
  • string found in snapshot: A forbidden page scan text was found.
Available options:
none of the provided fingerprints match,
string not found in snapshot,
string found in snapshot