Skip to main content
POST
Report Candidate IP Telemetry

Authorizations

x-api-key
string
header
required

Path Parameters

candidateId
string
required

The unique identifier of the candidate

Body

application/json
ipAddress
string
required

The publicly routable IPv4 or IPv6 address observed for the candidate, e.g. 93.184.216.34

observedAt
string<date-time>
required

ISO 8601 / RFC 3339 timestamp of when the external provider observed the IP. A UTC offset is accepted, e.g. 2026-08-25T12:00:00Z or 2026-08-25T21:00:00+09:00

source
string
required

Name of the system that observed the IP, shown to reviewers on the Trust Center, e.g. "acme-proctor"

Required string length: 1 - 64

Response

Reading accepted for enrichment

status
enum<string>
required

The reading was accepted for enrichment

Available options:
accepted
id
string | null
required

Identifier of the stored reading, or null when it was a duplicate

duplicate
boolean
required

True when an identical reading for this candidate was already stored