---
title: "Retrieving Ping Data"
method: POST
path: "/{cert_id}/ping"
tags: ["Ping"]
deprecated: true
---

# Retrieving Ping Data

`POST /{cert_id}/ping`

> **Deprecated.**

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`.

## Path parameters

- `cert_id` string, required

## Response `200`

Created

- PingResponseV3 — Ping Response
  - `cert` DataServiceCert, required
    - `age_seconds` integer, required — Number of seconds since the last user interaction with the certificate
    - `approx_ip_geo` object, nullable, required — Approximate geolocation based on IP
      - `city` string, nullable — City Name
      - `country_code` string, nullable — Country Code
      - `lat` number, nullable — Latitude
      - `lon` number, nullable — Longitude
      - `postal_code` string, nullable — Mailing address postal code
      - `state` string, nullable — State/Province or Political Subdivision abbreviation
      - `time_zone` string, nullable — Timezone name
    - `browser` object, nullable, required — Browser parsed from the user-agent, when known
      - `full` string — A human-friendly version of the browser parsed from the user-agent
      - `name` string — Browser name
      - `version` object — Browser version
        - `full` string — A String containing the version
        - `major` string — A String containing the major version
        - `minor` string — A String containing the minor version
        - `patch` string — A String containing the patch version
    - `created_at` string, date-time, required — The UTC ISO8601 formatted date and time when the TrustedForm script was loaded
    - `domain` string, nullable, required — The domain of the page url
    - `event_duration_ms` integer, nullable, required — The time in milliseconds between when the script was loaded and when the most recent event was received
    - `expires_at` string, date-time, required — The UTC ISO8601 formatted date and time when the claim period for the certificate will expire
    - `form_input_method` string[], nullable, required — The detected input method or methods the consumer used to fill out the form * `autofill`: The form was filled out using browser autofill. * `paste`: The form was filled out pasting text. * `typing`: The form was filled out typing.
    - `ip` string, nullable, required — The consumer's public IP address
    - `is_framed` boolean, nullable, required — A boolean indicating that the form was displayed within an iframe
    - `is_mobile` boolean, nullable, required — A boolean indicating that the form was filled out on a mobile device or tablet, based on user-agent
    - `kpm` number, nullable, required — Approximate calculated words per minute
    - `operating_system` object, nullable, required — Operating system information parsed from the user-agent, when known
      - `full` string — A human-friendly version of the operating system information parsed from the user-agent
      - `name` string — Operating system name
      - `version` object — Operating system version
        - `full` string — A String containing the version
        - `major` string — A String containing the major version
        - `minor` string — A String containing the minor version
        - `patch` string — A String containing the patch version
    - `page_id` string, nullable, required — The account based unique page id
    - `page_url` string, url, nullable, required — The URL of the page hosting the TrustedForm script
    - `parent_page_url` string, url, nullable, required — The parent URL of the page hosting the TrustedForm script, if framed
    - `user_agent` string, nullable, required — The consumer's browser user-agent
    - `wpm` number, nullable, required — Approximate calculated key presses per minute
  - `fingerprints` Fingerprints, required
    - `matching` string[] — Requested fingerprints that match fingerprints collected with the certificate
    - `not_matching` string[] — Fingerprints that do not match fingerprints collected with the certificate
  - `is_masked` boolean, required — A boolean indicating whether the certificate is masked
  - `outcome` 'success' | 'failure' | 'error', 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.
  - `reason` string — Provides an explanation for failure or error. Only used for `outcome` of `failure` or `error`.
  - `scans` PageScans, required
    - `forbidden_found` string[], required — Requested required text found on page
    - `forbidden_not_found` string[], required — Requested required text not found on page
    - `required_found` string[], required — Requested required text found on page
    - `required_not_found` string[], required — Requested required text not found on page
  - `warnings` 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.

## Other responses

- `400` — Malformed Certificate URL
- `401` — Unauthorized
- `404` — TrustedForm certificate has expired or could not be found

---

[API](https://skmtc.net/activeprospect/apis/trustedform-claiming-api.md) · [All operations](https://skmtc.net/activeprospect/apis/trustedform-claiming-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/activeprospect/trustedform-claiming-api/versions/d6b59eb89306/schema)