Métodos da API Lite

A partir da versão 1.1.0, Oz API Lite funciona com base64 como formato de entrada e também é capaz de retornar os modelos biométricos nesse formato. Para habilitar esta opção, adicione Content-Transfer-Encoding = base64 aos cabeçalhos da requisição.

version – verificação da versão dos componentes

Use este método para verificar quais versões dos componentes são usadas (disponível a partir da 1.1.1).

Chame GET /version

Parâmetros de entrada

-

Exemplo de requisição

GET localhost/version

Resposta bem-sucedida

Em caso de sucesso, o método retorna uma mensagem com os seguintes parâmetros.

Tipo de conteúdo da resposta HTTP: “application/json”.

Parâmetros de saída

Nome do parâmetro	Tipo	Descrição
core	String	Número da versão do núcleo do API Lite.
tfss	String	Número da versão do TFSS.
models	[String]	Um array de versões de modelos, cada registro contém o nome do modelo e o número da versão do modelo.

Exemplo de resposta

200 OK
Content-Type: application/json
{
2	"core": "core_version",
3	"tfss": "tfss_version",
4	"models": [
5		{
6			"name": "model_name",
7			"version": "model_version"
8		}
9	]
10}

Biometria

health – verificação do status do processador biométrico

Use este método para verificar se o processador biométrico está pronto para funcionar.

Chame GET /v1/face/pattern/health

Parâmetros de entrada

-

Exemplo de requisição

GET localhost/v1/face/pattern/health

Resposta bem-sucedida

Em caso de sucesso, o método retorna uma mensagem com os seguintes parâmetros.

Tipo de conteúdo da resposta HTTP: “application/json”.

Parâmetros de saída

Nome do parâmetro	Tipo	Descrição
status	Int	0 – o processador biométrico está funcionando corretamente. 3 – o processador biométrico está inoperante.
message	String	Mensagem.

Exemplo de resposta

200 OK
Content-Type: application/json
{“status”: 0, message: “”}

extract – a extração do modelo biométrico

O método foi projetado para extrair um modelo biométrico de uma imagem.

Tipo de conteúdo da requisição HTTP: “image / jpeg” ou “image / png”

Chame POST /v1/face/pattern/extract

Parâmetros de entrada

Nome do parâmetro	Tipo	Descrição
Não especificado*	Stream	Parâmetro obrigatório. Imagem para extrair o modelo biométrico. O campo de cabeçalho “Content-Type” deve indicar o tipo de conteúdo.

*

O próprio nome não é obrigatório para um parâmetro do tipo Stream.

Para transferir dados em base64, adicione Content-Transfer-Encoding = base64 aos cabeçalhos da requisição.

Exemplo de requisição

POST localhost/v1/face/pattern/extract
Content-Type: image/jpeg
{Image byte stream}

Resposta bem-sucedida

Em caso de sucesso, o método retorna um modelo biométrico.

O tipo de conteúdo da resposta HTTP é “application/octet-stream”.

Se você tiver passado Content-Transfer-Encoding = base64 nos cabeçalhos, o modelo também estará em base64.

Parâmetros de saída

Nome do parâmetro	Tipo	Descrição
Não especificado*	Stream	Um modelo biométrico derivado de uma imagem

*

O próprio nome não é obrigatório para um parâmetro do tipo Stream.

Exemplo de resposta

200 OK
Content-Type: application/octet-stream
{Biometric template byte stream}

compare – a comparação de modelos biométricos

O método foi projetado para comparar dois modelos biométricos.

O tipo de conteúdo da requisição HTTP é “multipart / form-data”.

ChamePOST /v1/face/pattern/compare

Parâmetros de entrada

Nome do parâmetro	Tipo	Descrição
bio_feature	Stream	Parâmetro obrigatório. Primeiro modelo biométrico.
bio_template	Stream	Parâmetro obrigatório. Segundo modelo biométrico.

Para transferir dados em base64, adicione Content-Transfer-Encoding = base64 aos cabeçalhos da requisição.

Exemplo de requisição

POST localhost/v1/face/pattern/compare
Content-Type: multipart/form-data;
boundary=--BOUNDARY--
Content-Length: Message body length
--BOUNDARY--
Content-Disposition: form-data; name=”bio_feature”
Content_type: application/octet-stream
{Biometric template byte stream}
--BOUNDARY--
Content-Disposition: form-data; name=”bio_template”
Content_type: application/octet-stream
{Biometric template byte stream}
--BOUNDARY--

Resposta bem-sucedida

Em caso de sucesso, o método retorna o resultado da comparação dos dois modelos.

Tipo de conteúdo da resposta HTTP: “application/json”.

Parâmetros de saída

Nome do parâmetro	Tipo	Descrição
score	Float	O resultado da comparação de dois modelos
decision	String	Solução recomendada com base na pontuação. approved – positivo. Os rostos correspondem. operator_required – é necessária verificação adicional do operador. declined – resultado negativo. Os rostos não correspondem.

Exemplo de resposta

200 OK
Content-Type: application/json
{“score”: 1.0, “decision”: “approved”}

verify – a verificação biométrica

O método combina os dois métodos acima, extract e compare. Ele extrai um modelo de uma imagem e compara o modelo biométrico resultante com outro modelo biométrico que também é passado na requisição.

O tipo de conteúdo da requisição HTTP é “multipart / form-data”.

Chame POST /v1/face/pattern/verify

Parâmetros de entrada

Nome do parâmetro	Tipo	Descrição
sample	Stream	Parâmetro obrigatório. Imagem para extrair o modelo biométrico.
bio_template	Stream	Parâmetro obrigatório. O modelo biométrico com o qual comparar.

Para transferir dados em base64, adicione Content-Transfer-Encoding = base64 aos cabeçalhos da requisição.

Exemplo de requisição

POST localhost/v1/face/pattern/verify
Content-Type: multipart/form-data;
boundary=--BOUNDARY--
Content-Length: Message body length
--BOUNDARY--
Content-Disposition: form-data; name=”bio_template”
Content_type: application/octet-stream
{Biometric template byte stream}
--BOUNDARY--
Content-Disposition: form-data; name=”sample”
Content_type: image/jpeg
{Image byte stream}
--BOUNDARY--

Resposta bem-sucedida

Em caso de sucesso, o método retorna o resultado da comparação de dois modelos biométricos e o modelo biométrico.

O tipo de conteúdo da resposta HTTP é “multipart/form-data”.

Parâmetros de saída

Nome do parâmetro	Tipo	Descrição
score	Float	O resultado da comparação de dois modelos
bio_feature	Stream	Modelo biométrico derivado da imagem

Exemplo de resposta

200 OK
Content-Type: multipart/form-data;
boundary=--BOUNDARY--
Content-Length: Message body length
--BOUNDARY--
Content-Disposition: form-data; name=”score”
Content_type: application/json
{“score”: 1.0}
--BOUNDARY--
Content-Disposition: form-data; name=”bio_feature”
Content_type: application/octet-stream
{Biometric template byte stream}
--BOUNDARY--

extract_and_compare – extração e comparação de modelos derivados de duas imagens

O método também combina os dois métodos acima, extract e compare. Ele extrai modelos de duas imagens, compara os modelos biométricos recebidos e transmite o resultado da comparação como resposta.

O tipo de conteúdo da requisição HTTP é “multipart / form-data”.

Chame POST /v1/face/pattern/extract_and_compare

Parâmetros de entrada

Nome do parâmetro	Tipo	Descrição
sample_1	Stream	Parâmetro obrigatório. Primeira imagem.
sample_2	Stream	Parâmetro obrigatório. Segunda imagem

Para transferir dados em base64, adicione Content-Transfer-Encoding = base64 aos cabeçalhos da requisição.

Exemplo de requisição

POST localhost/v1/face/pattern/extract_and_compare
Content-Type: multipart/form-data;
boundary=--BOUNDARY--
Content-Length: Message body length
--BOUNDARY--
Content-Disposition: form-data; name=”sample_1”
Content_type: image/jpeg
{Image byte stream}
--BOUNDARY--
Content-Disposition: form-data; name=”sample_2”
Content_type: image/jpeg
{Image byte stream}
--BOUNDARY--

Resposta bem-sucedida

Em caso de sucesso, o método retorna o resultado da comparação dos dois modelos biométricos extraídos.

Tipo de conteúdo da resposta HTTP: “application / json”.

Parâmetros de saída

Nome do parâmetro	Tipo	Descrição
score	Float	O resultado da comparação dos dois modelos extraídos.
decision	String	Solução recomendada com base na pontuação. approved – positivo. Os rostos correspondem. operator_required – é necessária verificação adicional do operador. declined – resultado negativo. Os rostos não correspondem.

Exemplo de resposta

200 OK
Content-Type: application/json
{“score”: 1.0, “decision”: “approved”}

compare_n – comparação 1:N de modelos biométricos

Use este método para comparar um modelo biométrico com outros N.

O tipo de conteúdo da requisição HTTP é “multipart/form-data”.

Chame POST /v1/face/pattern/compare_n

Parâmetros de entrada

Nome do parâmetro	Tipo	Descrição
template_1	Stream	Este parâmetro é obrigatório. O primeiro modelo biométrico (principal)
templates_n	Stream	Uma lista de N modelos biométricos. Cada um deles deve ser passado separadamente, mas o nome do parâmetro deve ser templates_n. Também é necessário passar o nome do arquivo no cabeçalho.

Exemplo de requisição

POST localhost/v1/face/pattern/compare_n
Content-Type: multipart/form-data;
boundary=--BOUNDARY--
Content-Length: message body length
--BOUNDARY--
Content-Disposition: form-data; name=”template_1”
Content_type: application/octet-stream
{biometric template byte stream}
--BOUNDARY--
Content-Disposition: form-data; name=”templates_n”; filename=”1.template”
Content_type: application/octet-stream
{biometric template byte stream}
--BOUNDARY--
Content-Disposition: form-data; name=”templates_n”; filename=”2.template”
Content_type: application/octet-stream
{biometric template byte stream}
--BOUNDARY--
Content-Disposition: form-data; name=”templates_n”; filename=”3.template”
Content_type: application/octet-stream
{biometric template byte stream}
--BOUNDARY--

Resposta bem-sucedida

Em caso de sucesso, o método retorna o resultado da comparação 1:N.

Tipo de conteúdo da resposta HTTP: “application / json”.

Parâmetros de saída

Nome do parâmetro	Tipo	Descrição
results	List[JSON]	Uma lista de N resultados de comparação. O N-ésimo resultado contém o resultado da comparação dos modelos principal e N-ésimo. O resultado possui os seguintes campos:
*filename	String	Um nome de arquivo para o N-ésimo modelo.
*score	Float	O resultado da comparação dos modelos principal e N-ésimo.
*decision	String	Solução recomendada com base na pontuação. approved – positivo. Os rostos correspondem. operator_required – é necessária verificação adicional do operador. declined – resultado negativo. Os rostos não correspondem.

Exemplo de resposta

200 OK
Content-Type: application/json
{'results': [
    {'filename': '1.template', 'score': 0.0, 'decision': 'declined'}, 
    {'filename': '2.template', 'score': 1.0, 'decision': 'approved'}, 
    {'filename': '3.template', 'score': 0.21, 'decision': 'declined'}
]}

verify_n – verificação biométrica 1:N

O método combina os extract e compare_n métodos. Ele extrai um modelo biométrico de uma imagem e o compara com N outros modelos biométricos que são passados na requisição como uma lista.

O tipo de conteúdo da requisição HTTP é “multipart/form-data”.

Chame POST /v1/face/pattern/verify_n

Parâmetros de entrada

Nome do parâmetro	Tipo	Descrição
sample_1	Stream	Este parâmetro é obrigatório. A imagem principal.
templates_n	Stream	Uma lista de N modelos biométricos. Cada um deles deve ser passado separadamente, mas o nome do parâmetro deve ser templates_n. Também é necessário passar o nome do arquivo no cabeçalho.

Para transferir dados em base64, adicione Content-Transfer-Encoding = base64 aos cabeçalhos da requisição.

Exemplo de requisição

POST localhost/v1/face/pattern/verify_n
Content-Type: multipart/form-data;
boundary=--BOUNDARY--
Content-Length: message body length
--BOUNDARY--
Content-Disposition: form-data; name=”sample_1”
Content_type: image/jpeg
{image byte stream}
--BOUNDARY--
Content-Disposition: form-data; name=”templates_n”; filename=”1.template”
Content_type: application/octet-stream
{biometric template byte stream}
--BOUNDARY--
Content-Disposition: form-data; name=”templates_n”; filename=”2.template”
Content_type: application/octet-stream
{biometric template byte stream}
--BOUNDARY--
Content-Disposition: form-data; name=”templates_n”; filename=”3.template”
Content_type: application/octet-stream
{biometric template byte stream}
--BOUNDARY--

Resposta bem-sucedida

Em caso de sucesso, o método retorna o resultado da comparação 1:N.

Tipo de conteúdo da resposta HTTP: “application / json”.

Parâmetros de saída

Nome do parâmetro	Tipo	Descrição
results	List[JSON]	Uma lista de N resultados de comparação. O N-ésimo resultado contém o resultado da comparação do modelo derivado da imagem principal e do N-ésimo modelo. O resultado possui os seguintes campos:
*filename	String	Um nome de arquivo para o N-ésimo modelo.
*score	Float	O resultado da comparação do modelo derivado da imagem principal e do N-ésimo modelo.
*decision	String	Solução recomendada com base na pontuação. approved – positivo. Os rostos correspondem. operator_required – é necessária verificação adicional do operador. declined – resultado negativo. Os rostos não correspondem.

Exemplo de resposta

200 OK
Content-Type: application/json
{'results': [
    {'filename': '1.template', 'score': 0.0, 'decision': 'declined'}, 
    {'filename': '2.template', 'score': 1.0, 'decision': 'approved'}, 
    {'filename': '3.template', 'score': 0.21, 'decision': 'declined'}
]}

extract_and_compare_n – extração e comparação 1:N de modelos

Este método também combina os extract e compare_n métodos, mas de outra forma. Ele extrai modelos biométricos da imagem principal e de uma lista de outras imagens e então os compara no modo 1:N.

O tipo de conteúdo da requisição HTTP é “multipart/form-data”.

Chame POST /v1/face/pattern/extract_and_compare_n

Parâmetros de entrada

Nome do parâmetro	Tipo	Descrição
sample_1	Stream	Este parâmetro é obrigatório. A primeira imagem (principal).
samples_n	Stream	Uma lista de N imagens. Cada uma delas deve ser passada separadamente, mas o nome do parâmetro deve ser samples_n. Também é necessário passar o nome do arquivo no cabeçalho.

Para transferir dados em base64, adicione Content-Transfer-Encoding = base64 aos cabeçalhos da requisição.

Exemplo de requisição

POST localhost/v1/face/pattern/extract_and_compare_n
Content-Type: multipart/form-data;
boundary=--BOUNDARY--
Content-Length: message body length
--BOUNDARY--
Content-Disposition: form-data; name=”sample_1”
Content_type: image/jpeg
{image byte stream}
--BOUNDARY--
Content-Disposition: form-data; name=”samples_n”; filename=”1.jpeg”
Content_type: image/jpeg
{image byte stream}
--BOUNDARY--
Content-Disposition: form-data; name=”samples_n”; filename=”2.jpeg”
Content_type: image/jpeg
{image byte stream}
--BOUNDARY--
Content-Disposition: form-data; name=”samples_n”; filename=”3.jpeg”
Content_type: image/jpeg
{image byte stream}
--BOUNDARY--

Resposta bem-sucedida

Em caso de sucesso, o método retorna o resultado da comparação 1:N.

Tipo de conteúdo da resposta HTTP: “application / json”.

Parâmetros de saída

Nome do parâmetro	Tipo	Descrição
results	List[JSON]	Uma lista de N resultados de comparação. O N-ésimo resultado contém o resultado da comparação da imagem principal e da N-ésima imagem. O resultado possui os seguintes campos:
*filename	String	Um nome de arquivo para a N-ésima imagem.
*score	Float	O resultado da comparação da imagem principal e da N-ésima imagem.
*decision	String	Solução recomendada com base na pontuação. approved – positivo. Os rostos correspondem. operator_required – é necessária verificação adicional do operador. declined – resultado negativo. Os rostos não correspondem.

Exemplo de resposta

200 OK
Content-Type: application/json
{'results': [
    {'filename': '1.jpeg', 'score': 0.0, 'decision': 'declined'}, 
    {'filename': '2.jpeg', 'score': 1.0, 'decision': 'approved'}, 
    {'filename': '3.jpeg', 'score': 0.21, 'decision': 'declined'}
]}

Erros do método

Tipo de conteúdo da resposta HTTP: “application / json”.

Códigos de resposta HTTP	O valor do parâmetro “code”	Descrição
400	BPE-002001	Content-Type inválido da requisição HTTP
400	BPE-002002	Método de requisição HTTP inválido
400	BPE-002003	Falha ao ler a amostra biométrica*
400	BPE-002004	Falha ao ler o modelo biométrico
400	BPE-002005	Content-Type inválido da parte multipart da requisição HTTP
400	BPE-003001	Falha ao recuperar o modelo biométrico
400	BPE-003002	A amostra biométrica* não contém rosto
400	BPE-003003	Há mais de uma pessoa presente na amostra biométrica*
500	BPE-001001	Erro interno do bioprocessador
400	BPE-001002	Erro do TFSS. Chame o método health da biometria.

*

Uma amostra biométrica é uma imagem de entrada.

Liveness

health – verificação do status do processador de Liveness

Use este método para verificar se o processador de Liveness está pronto para funcionar.

Chame GET /v1/face/liveness/health

Parâmetros de entrada

• Nenhum.

Exemplo de requisição

GET localhost/v1/face/liveness/health

Resposta bem-sucedida

Em caso de sucesso, o método retorna uma mensagem com os seguintes parâmetros.

Tipo de conteúdo da resposta HTTP: “application/json”.

Parâmetros de saída

Nome do parâmetro	Tipo	Descrição
status	Int	0 – o processador de Liveness está funcionando corretamente. 3 – o processador de Liveness está inoperante.
message	String	Mensagem.

Exemplo de resposta

200 OK
Content-Type: application/json
{“status”: 0, message: “”}

detect – detecção de ataque de apresentação

O detect método foi criado para revelar ataques de apresentação. Ele detecta um rosto em cada imagem ou vídeo (desde 1.2.0), os envia para análise e retorna um resultado.

O método suporta os seguintes tipos de conteúdo:

• image/jpeg ou image/png para uma imagem;

• multipart/form-data para imagens, vídeos e arquivos. Você pode usar payload para adicionar quaisquer parâmetros que afetem a análise.

Para executar o método, chame POST /{version}/face/liveness/detect.

Image

Aceita uma imagem nos formatos JPEG ou PNG. Nenhum payload anexo.

Exemplo de requisição

POST /v1/face/liveness/detect HTTP/1.1
Host: localhost
Content-Type: image/jpeg
Content-Length: [the size of the message body]
[Image byte stream]

Exemplo de resposta bem-sucedida

HTTP/1.1 200 OK
Content-Type: application/json
{
  "passed": false,
  "score": 0.999484062
}

Multipart/form-data

Aceita a requisição multipart/form-data.

• Cada arquivo de mídia deve ter um nome único, por exemplo, media_key1, media_key2.

• O payload os parâmetros devem ser um JSON colocado no payload campo.

Os IDs temporários serão excluídos assim que você obter o resultado.

Exemplo de requisição

POST /v1/face/liveness/detect HTTP/1.1
Host: localhost
Content-Length: [the size of the message body]
Content-Type: multipart/form-data; boundary=--BOUNDARY--

--BOUNDARY--
Content-Disposition: form-data; name="media_key1"; filename="video.mp4"
Content-Type: multipart/form-data; 

[media file byte stream]
--BOUNDARY--
Content-Disposition: form-data; name="payload"

    {
        "folder:meta_data": {
            "partner_side_folder_id": "partner_side_folder_id_if_needed",
            "person_info": {
                "first_name": "John",
                "middle_name": "Jameson",
                "last_name": "Doe"
            }
        },
        "resolution_endpoint": "https://www.your-custom-endpoint.com",
        "media:meta_data": {
            "media_key1": {
                "foo": "bar2"
            }
        },
        "media:tags": {
            "media_key1": [
                "video_selfie",
                "video_selfie_blank"
            ]
        },
        "analyses": [
          {
            "type": "quality",
            "meta_data": {
              "example1": "some_example1"
            },
            "params": {
                "threshold_spoofing": 0.6,
                "extract_best_shot": false
            }
          }
]
    }
--BOUNDARY--

Exemplo de resposta bem-sucedida

{
    "company_id": null,
    "time_created": 1720180784.769608,
    "folder_id": "folder_id", // ID temporário
    "user_id": null,
    "resolution_endpoint": "https://www.your-custom-endpoint.com",
    "resolution_status": "FINISHED",
    "resolution_comment": "[]",
    "system_resolution": "SUCCESS",
    "resolution_time": null,
    "resolution_author_id": null,
    "resolution_state_hash": null,
    "operator_comment": null,
    "operator_status": null,
    "is_cleared": null,
    "meta_data": {
        "partner_side_folder_id": "partner_side_folder_id_if_needed",
        "person_info": {
            "first_name": "John",
            "middle_name": "Jameson",
            "last_name": "Doe"
        }
    },
    "technical_meta_data": {},
    "time_updated": 1720180787.531983,
    "media": [
        {
            "folder_id": "folder_id", // ID temporário
            "media_id": "video_id", // ID temporário
            "media_type": "VIDEO_FOLDER",
            "info": {
                "thumb": null,
                "video": {
                    "duration": 3.76,
                    "FPS": 22,83,
                    "width": 960,
                    "height": 720,
                    "md5": "8879b4fa9ee7add77aceb8d7d5d7b92d",
                    "size": 6017119,
                    "mime-type": "video/mp4"
                }
            },
            "tags": [
                "video_selfie",
                "video_selfie_blank",
                "orientation_portrait"
            ],
            "original_name": "video-5mb.mp4",
            "original_url": null,
            "company_id": null,
            "technical_meta_data": {},
            "time_created": 1719573752.78253,
            "time_updated": 1720180787.531801,
            "meta_data": {
                "foo4": "bar5"
            },
            "thumb_url": null,
            "folder_time_created": null,
            "video_id": "video_id", // ID temporário
            "video_url": null
        }
    ],
    "analyses": [
        {
            "analyse_id": null,
            "analysis_id": null,
            "folder_id": "folder_id", // ID temporário
            "folder_time_created": null,
            "type": "QUALITY",
            "state": "FINISHED",
            "company_id": null,
            "group_id": null,
            "results_data": null,
            "confs": {
                "threshold_replay": 0.5,
                "extract_best_shot": false,
                "threshold_liveness": 0.5,
                "threshold_spoofing": 0.42
            },
            "error_message": null,
            "error_code": null,
            "resolution_operator": null,
            "technical_meta_data": {},
            "time_created": 1720180784.769944,
            "time_updated": 1720180787.531877,
            "meta_data": {
                "some_key": "some_value"
            },
            "source_media": [
                {
                    "folder_id": "folder_id", // ID temporário
                    "media_id": "video_id", // ID temporário
                    "media_type": "VIDEO_FOLDER",
                    "info": {
                        "thumb": null,
                        "video": {
                            "duration": 3.76,
                            "FPS": 22,83,
                            "width": 960,
                            "height": 720,
                            "md5": "8879b4fa9ee7add77aceb8d7d5d7b92d",
                            "size": 6017119,
                            "mime-type": "video/mp4"
                        }
                    },
                    "tags": [
                        "video_selfie",
                        "video_selfie_blank",
                        "orientation_portrait"
                    ],
                    "original_name": "video-5mb.mp4",
                    "original_url": null,
                    "company_id": null,
                    "technical_meta_data": {},
                    "time_created": 1719573752.78253,
                    "time_updated": 1720180787.531801,
                    "meta_data": {
                        "foo4": "bar5"
                    },
                    "thumb_url": null,
                    "folder_time_created": null,
                    "video_id": "video_id", // ID temporário
                    "video_url": null
                }
            ],
            "results_media": [
                {
                    "company_id": null,
                    "media_association_id": "video_id", // ID temporário
                    "analysis_id": null,
                    "results_data": {
                        "confidence_spoofing": 0.000541269779
                    },
                    "source_media_id": "video_id", // ID temporário
                    "output_images": [],
                    "collection_persons": [],
                    "folder_time_created": null
                }
            ],
            "resolution_status": "SUCCESS",
            "resolution": "SUCCESS"
        }
    ]
}

Multipart/form-data com Melhor captura

Para extrair a melhor captura do seu vídeo ou arquivo, em análises, defina extract_best_shot = true (como mostrado no exemplo de requisição abaixo). Nesse caso, o API Lite analisará seus arquivos e vídeos e, como resposta, retornará a melhor captura. Será uma imagem em base64 em analysis->output_images->image_b64.

Além disso, você pode alterar o limite de Liveness. Em análises, defina o novo limite no threshold_spoofing parâmetro. Se a pontuação resultante for maior que o valor desse parâmetro, a análise terminará com o status DECLINED. Caso contrário, o status será SUCCESS.

Exemplo de requisição

POST /v1/face/liveness/detect HTTP/1.1
Host: localhost
Content-Length: [the size of the message body]
Content-Type: multipart/form-data; boundary=--BOUNDARY--

--BOUNDARY--
Content-Disposition: form-data; name="media_key1"; filename="video.mp4"
Content-Type: multipart/form-data; 

[media file byte stream]
--BOUNDARY--
Content-Disposition: form-data; name="payload"

    {
        "folder:meta_data": {
            "partner_side_folder_id": "partner_side_folder_id_if_needed",
            "person_info": {
                "first_name": "John",
                "middle_name": "Jameson",
                "last_name": "Doe"
            }
        },
        "resolution_endpoint": "https://www.your-custom-endpoint.com",
        "media:meta_data": {
            "media_key1": {
                "foo": "bar2"
            }
        },
        "media:tags": {
            "media_key1": [
                "video_selfie",
                "video_selfie_blank"
            ]
        },
        "analyses": [
          {
            "type": "quality",
            "meta_data": {
              "example1": "some_example1"
            },
            "params": {
                "threshold_spoofing": 0.6,
                "extract_best_shot": true
            }
          }
]
    }
--BOUNDARY--

Exemplo de resposta bem-sucedida

{
    "company_id": null,
    "time_created": 1720177371.120899,
    "folder_id": "folder_id", // ID temporário
    "user_id": null,
    "resolution_endpoint": "https://www.your-custom-endpoint.com",
    "resolution_status": "FINISHED",
    "resolution_comment": "[]",
    "system_resolution": "SUCCESS",
    "resolution_time": null,
    "resolution_author_id": null,
    "resolution_state_hash": null,
    "operator_comment": null,
    "operator_status": null,
    "is_cleared": null,
    "meta_data": {
        "partner_side_folder_id": "partner_side_folder_id_if_needed",
        "person_info": {
            "first_name": "John",
            "middle_name": "Jameson",
            "last_name": "Doe"
        }
    },
    "technical_meta_data": {},
    "time_updated": 1720177375.531137,
    "media": [
        {
            "folder_id": "folder_id", // ID temporário
            "media_id": "media_id", // ID temporário
            "media_type": "VIDEO_FOLDER",
            "info": {
                "thumb": null,
                "video": {
                    "duration": 3.76,
                    "FPS": 22,83,
                    "width": 960,
                    "height": 720,
                    "md5": "8879b4fa9ee7add77aceb8d7d5d7b92d",
                    "size": 6017119,
                    "mime-type": "video/mp4"
                }
            },
            "tags": [
                "video_selfie",
                "video_selfie_blank",
                "orientation_portrait"
            ],
            "original_name": "video-5mb.mp4",
            "original_url": null,
            "company_id": null,
            "technical_meta_data": {},
            "time_created": 1719573752.781861,
            "time_updated": 1720177373.772401,
            "meta_data": {
                "foo4": "bar5"
            },
            "thumb_url": null,
            "folder_time_created": null,
            "video_id": "media_id", // ID temporário
            "video_url": null
        }
    ],
    "analyses": [
        {
            "analyse_id": null,
            "analysis_id": null,
            "folder_id": "folder_id", // ID temporário
            "folder_time_created": null,
            "type": "QUALITY",
            "state": "FINISHED",
            "company_id": null,
            "group_id": null,
            "results_data": null,
            "confs": {
                "threshold_replay": 0.5,
                "extract_best_shot": true,
                "threshold_liveness": 0.5,
                "threshold_spoofing": 0.42
            },
            "error_message": null,
            "error_code": null,
            "resolution_operator": null,
            "technical_meta_data": {},
            "time_created": 1720177371.121241,
            "time_updated": 1720177375.531043,
            "meta_data": {
                "some_key": "some_value"
            },
            "source_media": [
                {
                    "folder_id": "folder_id", // ID temporário
                    "media_id": "media_id", // ID temporário
                    "media_type": "VIDEO_FOLDER",
                    "info": {
                        "thumb": null,
                        "video": {
                            "duration": 3.76,
                            "FPS": 22,83,
                            "width": 960,
                            "height": 720,
                            "md5": "8879b4fa9ee7add77aceb8d7d5d7b92d",
                            "size": 6017119,
                            "mime-type": "video/mp4"
                        }
                    },
                    "tags": [
                        "video_selfie",
                        "video_selfie_blank",
                        "orientation_portrait"
                    ],
                    "original_name": "video-5mb.mp4",
                    "original_url": null,
                    "company_id": null,
                    "technical_meta_data": {},
                    "time_created": 1719573752.781861,
                    "time_updated": 1720177373.772401,
                    "meta_data": {
                        "foo4": "bar5"
                    },
                    "thumb_url": null,
                    "folder_time_created": null,
                    "video_id": "media_id", // ID temporário
                    "video_url": null
                }
            ],
            "results_media": [
                {
                    "company_id": null,
                    "media_association_id": "media_id", // ID temporário
                    "analysis_id": null,
                    "results_data": {
                        "confidence_spoofing": 0.000541269779
                    },
                    "source_media_id": "media_id", // ID temporário
                    "output_images": [
                        {
                            "folder_id": "folder_id", // ID temporário
                            "media_id": "media_id", // ID temporário
                            "media_type": "IMAGE_RESULT_ANALYSIS_SINGLE",
                            "info": {
                                "thumb": null,
                                "original": {
                                    "md5": "e6effeceb94e79b8cb204c6652283b57",
                                    "width": 720,
                                    "height": 960,
                                    "size": 145178,
                                    "mime-type": "image/jpeg"
                                }
                            },
                            "tags": [],
                            "original_name": "<PIL.JpegImagePlugin.JpegImageFile image mode=RGB size=720x960 at 0x766811DF8E90>",
                            "original_url": null,
                            "company_id": null,
                            "technical_meta_data": {},
                            "time_created": 1719573752.781861,
                            "time_updated": 1719573752.781871,
                            "meta_data": null,
                            "folder_time_created": null,
                            "image_b64": "",
                            "media_association_id": "media_id" // ID temporário
                        }
                    ],
                    "collection_persons": [],
                    "folder_time_created": null
                }
            ],
            "resolution_status": "SUCCESS",
            "resolution": "SUCCESS"
        }
    ]
}

O payload campo

{
    "folder:meta_data": {
        "partner_side_folder_id": "partner_side_folder_id_if_needed",
        "person_info": {
            "first_name": "John",
            "middle_name": "Jameson",
            "last_name": "Doe"
        }   },
    "resolution_endpoint": "https://www.your-custom-endpoint.com",
    "media:meta_data": {
        "media_key1": {
            "foo": "bar2",
            "additional_info": "additional_info" // pode afetar a pontuação
        },
        "media_key2": {
            "foo2": "bar3"
        },
        "media_key3": {
            "foo4": "bar5"
        }
    },
    "media:tags": {
        "media_key1": [
            "video_selfie",
            "video_selfie_blank",
            "orientation_portrait"
        ],
        "media_key2": [
            "photo_selfie"
        ],
        "media_key3": [
            "video_selfie",
            "video_selfie_blank",
            "orientation_portrait"
        ]
    },
"analyses": [
    {
      "type": "quality",
      "meta_data": {
        "some_key": "some_value"
      },
      "params": {
      	"threshold_spoofing": 0.42, // afeta a resolução
      	"extract_best_shot":true // a análise retornará a melhor captura
      }
    }
  ]
}

Erros do método

Tipo de conteúdo da resposta HTTP: “application / json”.

Códigos de resposta HTTP	O valor do parâmetro “code”	Descrição
400	LDE-002001	Content-Type inválido da requisição HTTP
400	LDE-002002	Método de requisição HTTP inválido
400	LDE-002004	Falha ao extrair a amostra biométrica*
400	LDE-002005	Content-Type inválido da parte multipart da requisição HTTP
500	LDE-001001	Erro interno do processador de detecção de Liveness
400	LDE-001002	Erro do TFSS. Chame o método health do Liveness.

*

Uma amostra biométrica é uma imagem de entrada.