> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-pt-br/api-rest/identity-api/identity-api-reference/shared-biometric-components/evaluate-passive-liveness-token.md). # Avaliar token de Liveness passivo Este serviço realiza um teste de vida utilizando a **melhor imagem tokenizada** obtida durante a captura da selfie do usuário. Para gerar a imagem tokenizada, utiliza-se a **função nativa do Widget Selphi**, com o **parâmetro bestImage** (imagem aberta) gerada pelo Widget. ### Integração Requer a implementação do **Widget Selphi Mobile** ou do **Widget Selphi Web**. ### Endpoint ``` POST /services/evaluatePassiveLivenessToken ``` ### Cabeçalhos | Nome | Tipo | Obrigatório | Descrição | | ------------- | ------ | ----------- | ------------------------------------------------------------- | | **x-api-key** | string | **Sim** | API Key de autorização de acesso. | | **family** | string | Não | Valor: **Onboarding**. Obrigatório com o serviço de tracking. | {% hint style="info" %} Todas as chamadas aos Endpoints para tracking com **Identity Platform** devem conter o header `family`. {% endhint %} ### Corpo da solicitação **Content-Type:** `application/json` #### Parâmetros | Parâmetro | Tipo | Obrigatório | Descrição | | ---------------------- | ------ | ----------- | --------------------------------------------------------------------------------------------------------- | | `imageBuffer` | string | **Sim** | Propriedade **BestImage** gerada pelo Widget Selphi e **tokenizada** por meio da função nativa do Widget. | | `tracking` | object | Não | Objeto que representa as informações de tracking necessárias. | | `tracking.extraData` | string | Não | Token gerado pelo SDK Mobile/Web. Contém informações de tracking tokenizadas com a Plataforma. | | `tracking.operationId` | string | Não | Identificador de operação gerado pelo SDK Mobile/Web. | #### Exemplo de solicitação ```json { "imageBuffer": "BAMBAQLNHJoWGPjfeuDIzDXdZuP...", "tracking": { "extraData": "BQABAQG2gBNjuHN4kLmPqYf7R...", "operationId": "123e4567-e89b-12d3-a456-426614174000" } } ``` ### Respostas #### `200` Sucesso #### Parâmetros de resposta | Parâmetro | Tipo | Descrição | | ----------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | | `serviceResultCode` | integer | Código que indica o **resultado geral** da execução do serviço. Veja [Service Result Code](#service-result-code) | | `serviceResultLog` | string | Campo descritivo do resultado da execução do serviço. Inclui detalhes quando há um erro ou exceção. | | `serviceTime` | string | Tempo total de resposta **(milissegundos)**. | | `serviceTransactionId` | string | Identificador de transação associado à solicitação processada pela API. | | `serviceLivenessResult` | integer | Código que indica o **resultado do teste de vida passivo**. Ver [Resultado do Service Liveness](#service-liveness-result) | #### Service Result Code O `serviceResultCode` indica o resultado geral da execução do serviço: | serviceResultCode | Descrição | Código HTTP | | ----------------- | -------------------------------------------------------------------------------------- | ----------- | | 0 | A execução do serviço foi bem-sucedida, o módulo processou a solicitação corretamente. | 200 | #### Resultado do Service Liveness O `serviceLivenessResult` indica o resultado da avaliação do teste de vida passivo: | Código | Resultado | Descrição | | ------ | ------------------------------- | ----------------------------------------------------------------------------------------------------- | | 0 | None | Não foi possível avaliar o teste de vida. | | 1 | Spoof | DEPRECIADO. Usar 'NoLive' em seu lugar. | | 2 | Uncertain | DEPRECIADO | | 3 | Live | Assume-se que o sujeito está vivo. | | 4 | NoneBecauseBadQuality | Não foi possível avaliar o teste de vida devido à má qualidade da imagem. | | 5 | NoneBecauseFaceTooClose | Não foi possível avaliar o teste de vida porque os rostos detectados estão muito próximos das bordas. | | 6 | NoneBecauseFaceNotFound | Não foi possível avaliar o teste de vida porque não foram detectados rostos. | | 7 | NoneBecauseFaceTooSmall | Não foi possível avaliar o teste de vida porque os rostos detectados são muito pequenos. | | 8 | NoneBecauseAngleTooLarge | Não foi possível avaliar o teste de vida porque o ângulo entre os rostos excede o limite permitido. | | 9 | NoneBecauseImageDataError | Não foi possível avaliar o teste de vida devido a erros no formato da imagem. | | 10 | NoneBecauseInternalError | Não foi possível avaliar o teste de vida devido a um erro interno. | | 11 | NoneBecauseImagePreprocessError | Não foi possível avaliar o teste de vida devido a um erro no pré-processamento da imagem. | | 12 | NoneBecauseTooManyFaces | Não foi possível avaliar o teste de vida porque foram detectados muitos rostos na imagem. | | 13 | NoneBecauseFaceTooCloseToBorder | Não foi possível avaliar o teste de vida porque o rosto está muito próximo da borda. | | 14 | NoneBecauseFaceCropped | Não foi possível avaliar o teste de vida porque o rosto está recortado. | | 15 | NoneBecauseLicenseError | Não foi possível avaliar o teste de vida devido a um erro de licença. | | 16 | NoneBecauseFaceOccluded | Não foi possível avaliar o teste de vida porque o rosto está ocluído. | | 17 | NoLive | Nenhuma vida foi detectada. | | 18 | NoneBecauseEyesClosed | Não foi possível avaliar o teste de vida porque os olhos da pessoa estão fechados. | #### Exemplo de resposta: Live ```json { "serviceResultCode": 0, "serviceResultLog": "Live", "serviceTime": "799", "serviceTransactionId": "35d93da8-b843-4033-8e78-c0aabedcef8b", "serviceLivenessResult": 3 } ``` #### Exemplo de resposta: NoLive ```json { "serviceResultCode": 0, "serviceResultLog": "NoLive", "serviceTime": "81", "serviceTransactionId": "3f332c81-3dfa-4952-b593-20e3b5651b5b", "serviceLivenessResult": 0 } ``` #### `400` Solicitação inválida ```json { "status": 400, "title": "Solicitação inválida", "detail": "Requisição inválida.", "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "errors": [] } ``` #### `401` Não autorizado ```json { "message": "Não autorizado" } ``` #### `403` Acesso negado ```json { "Message": "O usuário não está autorizado a acessar este recurso com uma negação explícita" } ``` #### `502` Gateway inválido ```json { "status": 502, "title": "Gateway inválido", "detail": "O servidor recebeu uma resposta inválida.", "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502" } ``` #### `504` Gateway Timeout ```json { "message": "A solicitação do Endpoint excedeu o tempo limite" } ```