Behavioral Biometrics (BehavioIQ)

Create a challenge

POST/v1/behavior/create_challenge

Opens a behavioral data-collection session and returns the challenge id, nonce and server public key the SDK needs for end-to-end encryption.

Request

MethodPOST
Path/v1/behavior/create_challenge
Content-Typeapplication/json
Auth requiredYes — Customer User Device

The SDK calls this endpoint to initiate a data collection session. Request and response are both encrypted — see End-to-End Encryption; the field below is the plaintext body.

NameTypeRequiredDescription
session_idstringRequiredUnique session identifier from the SDK

Sample request

The plaintext before encryption:

JSON
{
  "session_id": "session-xyz-789"
}

Response

data carries the challenge id, the nonce and the server's public key. Push an event batch echoes the nonce back in its body and the challenge id in its X-Challenge-ID header.

FieldTypeDescription
challenge_idstringUUID of the created challenge
noncestring64-character hex string (256-bit), single-use nonce for the session
server_public_keystringBase64-encoded RSA-2048 public key (PKIX/DER format)

The plaintext before encryption:

JSON
{
  "data": {
    "challenge_id": "d4e5f6a7-b8c9-0123-4567-89abcdef0123",
    "nonce": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2",
    "server_public_key": "MIIBIjANBgkqhk..."
  }
}

Failure codes

Errors arrive in the envelope described under Error Responses, and the codes every Behavioral call can return are listed under Common Error Codes.