API reference · Onboarding

Add device fingerprint signals

POST/omni/add/device-fingerprint-signals

Base URL: https://demo-api.incodesmile.com — Incode demo environment

Records signals (device, network, behaviour, or PID) captured during an interview event

Path & query parameters

Name In Type Required Description
api-version header string yes

Request body

Field Type Required Description
metadata string yes HMAC-signed Base64-encoded metadata blob. Format: .. Inner JSON shape: DeviceFingerprintSignalsMetadataDto (fields: timestamp, signalsType, payload, sdkPlatform, sdkVersion, signalsVersion). Server verifies HMAC via the service-configured hmac_key and rejects expired/replayed signatures based on the per-tenant CaptureMetadataConfig timestamp threshold.
interviewEvent string yes Frontend interview-event code categorizing these signals; resolved against the interview-event dictionary (must be a FRONTEND-sender code, e.g. "captureAttemptFinished").

Responses

200

OK

Response body (application/json):

Field Type Required Description
success boolean Flag indicating request passed successfully.
sessionStatus string Session status Enum: Alive, Closed, Deleted

400

Bad Request

Response body (application/json):

Field Type Required Description
timestamp integer (int64) UTC timestamp in milliseconds
status integer (int32) Custom error code or HTTP status code
error string HTTP status error
message string Custom error message
path string Endpoint path
details object Custom error details
Was this page helpful?