---
title: "Face Match"
method: POST
path: "/api/v2/facematch"
tags: ["FaceMatch"]
---

# Face Match

`POST /api/v2/facematch`

Recebe foto da face e a foto do documento, então realiza a comparação biométrca.

**Requisitos:**

1. A imagem do documento deve ter no mínimo 1000 pixels de largura. Para melhores resultados, é recomendável que possua pelo menos 2000 pixels.
    
2. A foto do sujeito deve ter resolução mínima de 250 x 250 pixels.
    
3. Somente os formatos JPG e PNG são aceitos no momento.
    
4. Tamanho de cada imagem não pode ultrapassar 5MB.
    

**Liveness\*:**

- Liveness pode ser usado nessa operação.
    
- O uso de liveness, por padrão, é definido pela aplicação, mas pode ser sobrescrito em cada chamada com parâmetro 'liveness', que aceita valores booleanos, presente no corpo da requisição.
    
- O teste de liveness pode ser realizado à partir de uma foto ou de uma evidência de liveness.
    
- A foto deve ser enviada no campo 'selfie'. A evidência deve ser enviada no campo 'liveness_evidence'.
    
- Caso opte por usar a evidência de livensess, a foto usada na operação será extraída da mesma.
    
- Retorna o resultado do liveness na mensagem de resposta: 'liveness_result'.
    

**Importante:** Os campos 'selfie' e 'liveness_evidence' são mutualmente exclusivos, ou seja: Não devem ser eviados juntos na mesma requisição.

Em caso de reprovação no teste de liveness, a operação é anulada e o retorno é a seguinte mensagem:

`{`

`"message": "As imagens capturadas falharam no teste de liveness.",`

`"error_code": 4007`

`}`

Caso ocorra um problema para realizar o teste de liveness, a API irá retornar um dos seguintes erros:

| message | **error_code** | Status HTTP |
| --- | --- | --- |
| Nenhuma face detectada na imagem. | 9006 | 422 |
| A face está apenas parcialmente dentro da imagem. | 9007 | 422 |
| A face está parcialmente coberta por um objeto. | 9008 | 422 |
| Mais de uma face visível na imagem. | 9009 | 422 |
| O ângulo da face correspondete ao ponto de vista da câmera é largo demais. | 9010 | 422 |
| Face pequena. A face deve estar mais próxima da câmera. | 9011 | 422 |
| Face pequena. A face deve estar mais próxima da câmera. | 9012 | 422 |
| A face está muito próxima da borda, centralize a face na imagem. | 9013 | 422 |
| A face está muito próxima da câmera. | 9014 | 422 |
| Face com olhos fechados. | 9016 | 422 |
| Falha ao obter resultado de liveness. | 9017 | 500 |

Caso o erro com código 9017 persista, deve-se entrar em contato com o administrador do sistema.

Os códigos de erro são os mesmos para qualquer operação feita com liveness ativado.

## Response `200`

- object

## Other responses

- `400`
- `422`
- `500`
- `x-200:Liveness Selfie - Biometria Confere`
- `x-200:Liveness Evidência - Biometria Confere`
- `x-200:Liveness Desligado - Biometria Confere`
- `x-200:Biometria Não Confere`
- `x-400:Documento Tipo Inválido`
- `x-422:Documento PDF não validado`
- `x-400:Excedeu Tamanho Limite`
- `x-400:Formato Arquivo Inválido`
- `x-422:Foto Baixa Qualidade`
- `x-400:Foto Baixa Resolução`

---

[API](https://skmtc.net/bry/apis/bry-easy-sign-api-rest.md) · [All operations](https://skmtc.net/bry/apis/bry-easy-sign-api-rest/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bry/bry-easy-sign-api-rest/revisions/c87e026e87ac/schema)