For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Pular para o conteúdo

Evaluate a capture with an explicit pipeline

Evaluates the capture like POST /api/v1/iad/evaluate, but with the analysis pipeline and calibration chosen by the client. The response and the errors are the same as for /evaluate, plus the validation of pipeline and calibration.

  • pipeline (required): iad_r01 or iad_r00.

  • calibration (optional): regular (default) or hardened.

  • Both values are compared case-insensitively and ignoring leading and trailing whitespace. When calibration is missing or empty, regular is used.

  • Errors of the capture field are checked before those of pipeline.

  • In the deployment with the Facephi Docker image, /evaluate is equivalent to iad_r01 with regular, and every combination is available without additional configuration. If a combination the analysis engine does not have available is requested, the response is HTTP 400 with ErrorProcessing.

post
Autorizações
AuthorizationstringObrigatório

JWT signed with HS256 and sent as Authorization: Bearer <jwt>. Only required when JWT authentication is enabled.

Corpo
capturestring · binaryObrigatório

Encrypted facial capture generated by the Facephi capture component.

pipelinestring · enumObrigatório

Analysis pipeline.

Example: iad_r01Valores possíveis:
calibrationstring · enumOpcional

Pipeline calibration.

Default: regularExample: hardenedValores possíveis:
Respostas
200

Evaluation verdict.

application/json

Public injection attack detection result. The order of the keys is not part of the contract, and clients must ignore unknown fields.

diagnosticstring · enumObrigatório

Binary verdict of the evaluation. It is the only field that must decide whether the capture is accepted; any value other than NoAttack must be treated as a rejection.

  • NoAttack: no injection attack was detected; the capture is accepted.
  • Attack: an injection attack was detected; the capture is rejected.
Example: NoAttackValores possíveis:
reasonstring · enumObrigatório

Reason for the rejection. It is informative and must not be used to decide the outcome. When there are several reasons, only the first one is returned. The service converts the reasons reported by the analysis to PascalCase, so new values may appear; show a generic message for the ones you do not recognize.

Possible values:

  • None: the capture was accepted (NoAttack).
  • Unknown: the capture was rejected without a specific reason reported by the analysis.
  • UntrustedEnvironment: the capture was generated in an untrusted runtime environment.
  • SuspiciousActivity: the device showed activity patterns associated with an attack.
  • UntrustedDevice: the device could not be trusted to be what it claims to be.
  • SdkIntegrityViolation: the capture SDK or its libraries appear to have been tampered with.
  • UntrustedCorruptedPayload: the payload appears to be corrupted or tampered with.
  • UntrustedContent: an injection attack was detected.
  • UntrustedContentLowConfidence: signs of an injection attack were detected with lower confidence; the capture must still be treated as rejected.
Example: NoneValores possíveis:
transactionIdstring · uuidObrigatório

Unique identifier of the evaluation (lowercase UUID v4). A new one is generated on every request, also when the same capture is retried.

Example: f58dccd4-f2ce-4057-a99b-4dc916015745
timestampstring · date-timeObrigatório

UTC instant at which the service started handling the request, in ISO-8601 format with milliseconds (YYYY-MM-DDTHH:mm:ss.SSSZ).

Example: 2026-09-24T09:04:03.776Z
post/api/v1/iad/evaluate/custom
POST /api/v1/iad/evaluate/custom HTTP/1.1
Host: 127.0.0.1:6982/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 66

{
  "capture": "binary",
  "pipeline": "iad_r01",
  "calibration": "hardened"
}
{
  "diagnostic": "NoAttack",
  "reason": "None",
  "transactionId": "f58dccd4-f2ce-4057-a99b-4dc916015745",
  "timestamp": "2026-09-24T09:04:03.776Z"
}

Atualizado