Consultar Foto Facial

Descrição

Consulta se uma pessoa possui uma foto de reconhecimento facial cadastrada no EVO e, quando disponível, retorna uma URL autenticada para acesso à foto.
A consulta pode ser realizada pelo identificador da foto (idPhoto) ou pelo identificador da pessoa, que pode ser um membro, prospect, funcionário ou personal. A URL retornada possui validade de 1 hora.

🚧 Observações
É necessário possuir a permissão Controle de acesso — Consulta na chave de API utilizada.
Ao menos um dos parâmetros idPhoto, idMember, idProspect, idEmployee ou idPersonal deve ser informado.
A consulta respeita o escopo da chave de API. Uma chave de filial permite consultar apenas pessoas pertencentes à própria filial. Chaves de ADM Geral (multifilial) podem realizar consultas sem essa restrição.
A URL retornada é temporária e possui validade de 1 hora.

🔑 Parâmetros de Consulta (Query Params)

Parâmetro	Tipo	Obrigatoriedade	Descrição
`idPhoto`	int32	Condicional	Identificador da foto facial. Pode ser obtido através do `IdRecord` do webhook `FacialPhotoRegistered`.
`idMember`	int32	Condicional	Identificador do membro cuja foto facial será consultada.
`idProspect`	int32	Condicional	Identificador do prospect cuja foto facial será consultada.
`idEmployee`	int32	Condicional	Identificador do funcionário cuja foto facial será consultada.
`idPersonal`	int32	Condicional	Identificador do personal cuja foto facial será consultada.

📤 Estrutura da Resposta

A resposta informa se a pessoa possui uma foto de reconhecimento facial cadastrada e, quando existente, disponibiliza uma URL temporária para acesso à imagem.

Campo	Tipo	Descrição
`hasFacialPhoto`	boolean	Indica se a pessoa possui uma foto facial cadastrada (`true` ou `false`).
`url`	string	URL autenticada para acesso à foto facial, com validade de 1 hora. Retornada vazia quando `hasFacialPhoto` for `false`.
`idMember`	int32	Identificador do membro proprietário da foto, quando a foto pertencer a um membro.
`idProspect`	int32	Identificador do prospect proprietário da foto, quando a foto pertencer a um prospect.
`idEmployee`	int32	Identificador do funcionário proprietário da foto, quando a foto pertencer a um funcionário.
`idPersonal`	int32	Identificador do personal proprietário da foto, quando a foto pertencer a um personal.

OBS. Os campos de identificação permitem determinar a pessoa proprietária da foto, especialmente em consultas realizadas por idPhoto. Apenas o identificador correspondente ao tipo da pessoa será preenchido. Quando hasFacialPhoto for false, os identificadores serão retornados como null.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Get the facial recognition photo of a member, prospect, employee or personal trainer.

Consultar Foto Facial

Descrição

🔑 Parâmetros de Consulta (Query Params)

📤 Estrutura da Resposta

Requisição

Exemplos de Requisição

Respostas

Get the facial recognition photo of a member, prospect, employee or personal trainer.

Consultar Foto Facial#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#

📤 Estrutura da Resposta#

Requisição

Exemplos de Requisição

Respostas

Consultar Foto Facial

Descrição

🔑 Parâmetros de Consulta (Query Params)

📤 Estrutura da Resposta