Skip to main content
GET
/
{cert_id}
/
ping
Retrieve Ping Data
curl --request GET \
  --url https://cert.trustedform.com/{cert_id}/ping \
  --header 'Authorization: Basic <encoded-value>'
{
  "age": 123,
  "client": {
    "ip": "<string>",
    "user_agent": "<string>",
    "dimensions": {
      "screen": {
        "width": 123,
        "height": 123
      },
      "window": {
        "width": 123,
        "height": 123
      }
    },
    "geo": {
      "city": "<string>",
      "country": "<string>",
      "postal_code": "<string>",
      "subdivisions": [
        "<string>"
      ]
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "location": {
    "framed": true,
    "parent_url": "<string>",
    "url": "<string>"
  },
  "time_on_page": 123,
  "type": "<string>"
}

Authorizations

Authorization
string
header
required

TrustedForm uses HTTP Basic Authentication with the username API and your API key as the password.

For example: API:1f1b96c9150d8050e858c043d543bb4eadae0e6f

Path Parameters

cert_id
string
required

Certificate ID

Response

Ping Data

age
integer<int64>

Lead Age, in milliseconds. (The time elapsed between the final recorded interaction event and the call to this API)

client
object

Information about the user's device and browser.

created_at
string<date-time>

When the certificate was issued, in ISO8601 format.

location
object

Information about the page's location.

time_on_page
integer<int64>

The amount of time the user spent interacting with the page, in milliseconds. (The time elapsed between created_at and the final recorded interaction event)

type
string

The type of certificate associated with this response. Possible values are limited to "standard", "masked", or "facebook".