Ctrlk
To the Oz WebsiteOz API ReferenceContact Us
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Registro de alterações

Alterações da API

6.6.4 – 4 de ago. de 2026

  • Modelos atualizados.

  • GET /api/healthcheck/ agora contém o status de licença/faturamento.

  • Nginx agora pode verificar a validade de X-Forensic-Access-Token para requisições de arquivos estáticos.

  • A análise DOCUMENTS não retorna mais resultados vazios results_data para a função CLIENT.

  • Para a Instant API, um container rejeitado por uma session_token agora salva seus artefatos sob o client company_id do token em vez da empresa padrão.

  • Best shot original e thumb agora retornam mime-type: image/jpeg em vez de image/png.

  • O contador do Prometheus não perde mais métricas na reinicialização do worker do gunicorn.

  • Melhorias internas.

  • Segurança aprimorada.

6.6.3.1 – 23 de jul. de 2026

  • Correção de bug.

6.6.3 – 2 de jul. de 2026

  • Implementado rastreamento de transações para dar suporte ao faturamento de clientes on-premises no modo full API.

6.6.2 – 24 de jun. de 2026

  • Implementado rastreamento de transações para dar suporte ao faturamento de clientes on-premises (Instant API).

  • Desempenho otimizado de GET /api/folders/, GET /api/folders/{folder_id}/media/, e GET /api/folders/{folder_id}/analyses/ endpoints.

  • Coleta de logs expandida para OLAP.

  • O /api/authorize/session_token/ endpoint agora suporta POST junto com GET.

  • Eficiência de recursos do TFSS aprimorada.

  • Desempenho da análise biométrica aprimorado em até 16% (gesto único) e até 39% (múltiplos gestos).

  • Adicionado o cabeçalho de requisição opcional X-Forensic-Company-Id a GET /api/authorize/session_token/. Em implantações multi-tenant da Instant API, use este cabeçalho para passar um tenant company_id (UUID) ao obter um token de sessão. O valor é incorporado ao token e usado para atribuir transações ao tenant correto em faturamento e análise.

  • media_association_id em output_images para best_shot e action_shot agora reflete corretamente o ID da mídia de origem da qual o frame foi extraído.

  • preview_url para mídia de vídeo agora inclui o _preview sufixo, em conformidade com o comportamento do shotset.

6.6.1 – 9 de jun. de 2026

  • A API agora pode processar um container OzCapsula que contenha outros containers OzCapsula dentro. Isso se aplica apenas ao fluxo de integração do Mobile SDK.

  • Agora oferecemos suporte a OpenTelemetry.

  • Agora é possível obter o action shot em tamanho original da API para a análise Liveness. No payload, defina extract_action_shot como 1 ou true. Em uma resposta da API, verifique analyses[].results_media[].output_images[]. O action shot tem original_name = ResultImageActionShot.jpegO template padrão do relatório foi alterado de acordo e está incluído na imagem da API.

  • Processamento do shotset otimizado.

  • Para evitar sobrecarga no TFSS, agora é possível gerenciar o número de requisições concorrentes que a API envia ao TFSS. Consulte Configuração da API para detalhes.

  • Não ocultamos mais por padrão o melhor shot em base64 da resposta. O melhor shot pode ser encontrado em analyses[].results_media[].output_images[].image_b64.

  • As requisições OzCapsula agora incluem a analyses[] seção na resposta mesmo quando a requisição é recusada com um decline_reason, então integrações que dependem de analyses[] (por exemplo, usando o on_complete callback no Web SDK) funcionam corretamente.

  • expire_date em /api/authorize/auth na resposta não é mais afetado pelo fuso horário definido na API.

  • Por padrão, todos os erros relacionados ao OzCapsula agora retornam a mensagem de erro "Invalid request data". Os códigos de erro permanecem inalterados.

  • Para o S3, agora salvamos múltiplos engine_response.json arquivos para um único arquivo de mídia: um para cada análise aplicada (nomeação: {analysis_id}_{source_media_id}_engine_response.json).

  • GET /api/collections/{collection_id}/persons/ não retorna mais um 500 Internal Server Error para formatos legados de caminho de imagem; um caminho inválido agora gera um erro significativo sem stack trace.

  • Resolvido um AttributeError que poderia ter ocorrido em caso de falha na serialização JSON.

  • Segurança aprimorada.

6.6.0.1 – 6 de jun. de 2026

  • Dependências internas atualizadas.

6.6.0 – 19 de mai. de 2026

  • Modelos atualizados.

  • A API não retorna mais um erro 500 ao visualizar detalhes da análise ou imprimir relatórios na função CLIENT no Web UI.

6.5.0 – 12 de abr. de 2026

  • Alterações incompatíveis: esta versão não oferece suporte ao Celery.

  • Alterações incompatíveis: Renomeado o oz_instant_save_artifacts_s3 parâmetro de configuração para OZ_INSTANT_SAVING_ARTIFACTS_ENABLED. Se usar este parâmetro, renomeie-o manualmente.

  • Adicionada integração com OLAP.

  • Desempenho aprimorado sob alta carga.

  • Aumentado o tamanho total do anexo (OZ_ATTACHMENT_MAX_SIZE) de 10 MB para 24 MB.

  • Resolvido o problema com o processamento inadequado de POST /api/folders/{{folder_id}}/media/request que podia resultar em respostas incompletas com arquivos de mídia ausentes.

  • Adicionado tratamento seguro de fuso horário para registros do banco de dados para garantir timestamps consistentes independentemente do fuso horário usado.

  • OzCapsula agora retorna códigos de erro específicos para diferentes tipos de dano no container em vez de um erro genérico "Invalid Data Container".

  • Erros da API resolvidos no modo multi-storage.

  • Definir OZ_STATIC_S3_BUCKET_URL como uma string vazia não leva mais ao erro de configuração incorreta do S3.

  • Enviar um container sem mídia não causa mais um erro 500.

  • Corrigido o bug em que a Instant API podia salvar artefatos no armazenamento local quando a persistência estava desativada.

  • Corrigido o bug em que a Instant API poderia criar um registro no banco de dados ao processar um container inválido.

  • Corrigido o bug com time_created e time_updated que poderiam parecer incorretos.

  • Segurança aprimorada.

12 de fev. de 2026

Alterações incompatíveis: se usar S3, defina OZ_STATIC_S3_BUCKET_URL="None" para evitar a quebra da conexão com o S3. Isso foi corrigido na 6.5.0.

  • Agora é possível adicionar container à pasta existente usando o POST api/folders/{folder_id}/media método.

  • Desempenho aprimorado do COLLECTION análise.

  • Agora é possível cortar um vídeo se ele estiver muito longo. Defina o OZ_FFMPEG_VIDEO_CROPPING_ENABLED parâmetro para true para ativar o corte automático de vídeos com duração maior que OZ_VIDEO_DURATION_MAX. Se um vídeo for cortado, os registros correspondentes serão adicionados aos logs.

  • Se um container não puder ser processado (erro 14), agora salvamos os dados do pedido correspondente para facilitar a investigação.

  • Se um container for considerado inválido, os logs da API agora incluem o correspondente folder_id para simplificar a busca.

  • Correção da exclusão de pastas nas configurações local-local e local-s3 para remover corretamente os arquivos estáticos.

24 de dez. de 2025

Implementado um novo formato de dados proprietário: OzCapsula Data Container.

  • A Instant API agora pode salvar payloads estáticos e JSON no S3. Para ativar essa funcionalidade, defina oz_instant_save_artifacts_s3 como true.

  • Resolvido o problema com rejeições falsas ocasionais ao usar vídeos recebidos do Web SDK.

  • O COLLECTION a análise agora ignora imagens marcadas com photo_id_back.

  • Melhorias internas.

6.4.0 – 24 de nov. de 2025

Somente para SaaS.

  • API atualizada para oferecer suporte a recursos futuros.

6.3.5 – 3 de nov. de 2025

  • Corrigidos bugs que podiam fazer com que a GET /api/folders/ requisição retornasse resultados incorretos.

6.3.4 – 20 de out. de 2025

  • API atualizada para oferecer suporte a recursos futuros.

  • Bugs corrigidos.

6.3.3 – 29 de set. de 2025

  • Resolvido um problema com POST /api/instant/folders/ e POST /api/folders/ retornando “500 Internal Server Error” quando o vídeo enviado está corrompido. Agora o sistema retorna “400 Bad Request”.

  • API atualizada para oferecer suporte a recursos futuros.

6.3.0 – 5 de ago. de 2025

API 6 atualizada para atender aos requisitos regulatórios do Cazaquistão: adicionada a funcionalidade de extrair action shots de vídeos de uma pessoa executando gestos.

  • Agora é possível remover direitos de administrador de um usuário CLIENT ADMIN e alterar sua função para CLIENT via PATCH /api/users/{{user_id}}.

  • Agora é possível gerar um service token para um usuário com a função OPERATOR.

  • Segurança aprimorada.

6.2.5 – 18 de jun. de 2025

  • Atualizações de otimização e desempenho.

6.2.3 – 2 de jun. de 2025

  • Agora é possível executar análises em paralelo entre si. Para ativar esse recurso, adicione o OZ_ANALYSE_PARALLELED_CHECK_MEDIA_ENABLED parâmetro para config.py e defina-o como true (o valor padrão é false).

  • Para o modo instantâneo, a autorização pode ser desativada. Adicione o OZ_AUTHORIZE_DISABLED_STATELESS parâmetro para config.py e defina-o como true (o valor padrão é false) para usar a Instant API sem autorização.

  • Corrigido o problema com vídeos MP4 que às vezes não podiam ser reproduzidos após o download do SDK.

  • Agora retornamos o erro correto para as requisições não autorizadas.

  • Corrigido o bug do erro 500 “espontâneo” que era causado por poucos frames no vídeo. Adicionada a verificação do número de frames e mensagens de erro mais descritivas.

  • Atualizações de desempenho, segurança e instalação.

6.0.1 – 30 de abr. de 2025

Observe: esta versão não oferece suporte aos requisitos regulatórios do Cazaquistão.

  • Armazenamento e banco de dados otimizados.

  • Implementado o modo de requisição única que envolve criar uma pasta e executar análises em uma única requisição, anexando uma parte da análise no payload.

  • Implementado o modo de análise instantânea sem armazenar nenhum dado localmente ou no banco de dados. Esse modo pode ser usado com ou sem outros componentes da API.

  • Agora é possível combinar sistemas em funcionamento com base em método assíncrono ou worker do celery (processamento local, processamento com celery). Adicionados mecanismos de armazenamento S3 para cada uma das combinações.

  • Segurança aprimorada.

  • Não oferecemos mais suporte a arquivos RAR.

  • Não oferecemos mais suporte ao Active Directory. Essa funcionalidade será retornada nas próximas versões.

  • Mecânicas aprimoradas para calcular o tempo de análise.

  • Substituídos os is_admin e is_service sinalizadores da função CLIENT por novas funções: CLIENT ADMIN e CLIENT SERVICE, respectivamente. Defina as funções em user_type.

  • Para emitir um service token para um usuário via {{host}}/api/authorize/service_token/, esse usuário deve ter a função CLIENT SERVICE. Também é possível criar um token para outro usuário com essa função: chame {{host}}/api/authorize/service_token/{user_id}.

  • Removidos atributos de COLLECTION e pessoa de COLLECTION.analysis.

  • Não armazenamos mais objetos separados para cada frame em SHOTS_SET. Se quiser salvar uma imagem do seu vídeo, considere ativar best shot.

  • Não oferecemos mais suporte ao Podman para instalação.

  • Referência da API atualizada: Oz API 6.0.

  • Endpoints e parâmetros alterados:

Endpoint ou parâmetro obsoleto
Substituição

PATCH users/{{user_id}}/ para alterar a senha do usuário

POST /api/users/{{user_id}}/change-password

DELETE images|media/<media_id> para excluir uma imagem de uma pessoa da COLLECTION

DELETE collections/<collection_id>/persons/<person_id>/images/<media_id>/

image_id, video_id, e shots_set_id

media_id

analyse_id

analysis_id

can_start_analyse_biometry

can_start_analysis_biometry

can_start_analyse_collection

can_start_analysis_collection

can_start_analyse_documents

can_start_analysis_documents

can_start_analyse_quality

can_start_analysis_quality

expire_date em {{host}}/api/authorize/auth e {{host}}/api/authorize/refresh

access_token.exp do payload

session_id em {{host}}/api/authorize/auth e {{host}}/api/authorize/refresh

token_id

5.3.1 – 24 de dez. de 2024

  • Eficiência de recursos da análise biométrica baseada em servidor aprimorada.

5.3.0 – 27 de nov. de 2024

  • A API agora pode extrair action shots de vídeos de uma pessoa executando gestos. Isso é feito para cumprir os novos requisitos regulatórios do Cazaquistão para identificação biométrica.

  • Criado um novo template de relatório que também atende aos requisitos mencionados acima.

  • Se action shots estiverem ativados, as miniaturas do relatório são geradas a partir deles.

5.2.0 – 6 de set. de 2024

  • Atualizada a coleção do Postman. Consulte a nova coleção aqui e em https://apidoc.ozforensics.com/.

  • Adicionado o novo método para verificar as configurações de fuso horário: GET {{host}}/api/config

  • Adicionados parâmetros ao GET {{host}}/api/event_sessions método:

    • time_created

    • time_created.min

    • time_created.max

    • time_updated

    • time_updated.min

    • time_updated.max

    • session_id

    • session_id.exclude

    • sorting

    • offset

    • limit

    • total_omit

  • Se você criar uma pasta usando SHOT_SET, o vídeo correspondente estará em media.video_url.

  • Corrigido o bug que impedia CLIENT ADMIN de alterar senhas de usuários da própria empresa.

5.1.1 – 16 de jul. de 2024

  • Atualizações de segurança.

5.1.0 – 20 de mar. de 2024

  • Face Identification 1:N agora está disponível, aumentando significativamente a capacidade de processamento de dados da Oz API para encontrar correspondências. Até mesmo bases enormes de faces (contendo milhões de fotos ou mais) não são mais um problema.

  • A análise Liveness (QUALITY) agora ignora fotos marcadas com photo_id, photo_id_front, ou photo_id_back, evitando que essas fotos causem o erro de análise relacionado a tags.

5.0.1 – 16 de julho de 2024

  • Atualizações de segurança.

5.0.0 – 17 de nov. de 2023

  • Agora é possível aplicar a análise Liveness (QUALITY) a uma única imagem.

  • Corrigido o bug em que a análise Liveness podia terminar com o resultado SUCCESS sem nenhuma mídia enviada.

  • O valor padrão de extract_best_shot parâmetro agora é True.

  • Arquivos RAR não têm mais suporte.

  • Por padrão, analyses.results_media.results_data agora contêm o confidence_spoofing parâmetro. No entanto, se forem necessários os três parâmetros para compatibilidade com versões anteriores, é possível alterar a resposta de volta para três parâmetros: confidence_replay, confidence_liveness, e confidence_spoofing.

  • Atualizado o modelo padrão do relatório em PDF.

  • O nome do relatório em PDF agora contém folder_id.

4.0.8-patch1 – 16 de julho de 2024

  • Atualizações de segurança.

4.0.8 – 22 de maio de 2023

  • Configurada a rotação automática dos logs.

  • Adicionado o comando de CLI para exclusão de usuário.

  • Agora é possível desativar a geração da pré-visualização do vídeo.

  • O token de acesso ADMIN agora é válido por 5 anos.

  • Adicionado o identificador da pasta folder_id ao nome do relatório.

  • Corrigidos bugs e otimizado o funcionamento da API.

4.0.2 – 13 de set. de 2022

  • Para o vídeo fatiado, o sistema agora exclui os quadros desnecessários.

  • Adicionados novos métodos: GET e POST em media/<media_id>/snapshot/.

  • Substituído o modelo padrão do relatório.

  • A pré-visualização do shot set agora preserva a proporção das imagens.

  • ADMIN e OPERATOR recebem system_company como a empresa à qual pertencem.

  • Adicionado o company_id atributo a User, Folder, Analyse, Media.

  • Adicionado o Analysis group_id atributo.

  • Adicionado o system_resolution atributo a Folder e Analysis.

  • A análise resolution_status agora retorna o system_resolution valor.

  • Removido o método PATCH para coleções.

  • Adicionado o resolution_status filtro para Folder Analyses [LIST] e analyse.resolution_status filtro para Folder [LIST].

  • Adicionado o log de auditoria para Folder, User, Company.

  • Melhorado o algoritmo de exclusão de empresa.

  • Refatorada a lógica de processamento da lista negra.

  • Corrigidos alguns bugs.

3.33.0

  • Os módulos Photo Expert e KYC agora foram removidos.

  • O endpoint para a alteração de senha do usuário agora é POST users/user_id/change-password em vez de PATCH.

3.32.1

  • Fornecido log para o app Celery.

3.32.0

  • Adicionados filtros aos parâmetros da requisição Folder [LIST]: analyse.time_created, analyse.results_data para a análise Documents, results_data para a análise Biometry, results_media_results_data para a análise QUALITY. Para habilitar os filtros, defina o with_results_media_filter parâmetro de consulta como True.

3.31.0

  • Adicionado um novo atributo para usuários – is_active (padrão True). Se is_active == False, qualquer operação de usuário é bloqueada.

  • Adicionado um novo código de exceção (1401 com código de status 401) para as ações dos usuários bloqueados.

3.30.0

  • Adicionada a pré-visualização de conjuntos de capturas.

  • Agora é possível salvar um arquivo de conjunto de capturas em um disco (com os original_local_path, original_url atributos).

  • Um novo atributo original_info é adicionado para armazenar md5, tamanho e tipo MIME de um conjunto de capturas

  • Corrigido ReportInfo para conjuntos de capturas.

3.29.0

  • Adicionada verificação de integridade em GET api/healthcheck.

3.28.1

  • Corrigida a URL da miniatura do conjunto de capturas.

3.28.0

  • Agora, o primeiro quadro do conjunto de capturas torna-se a URL da miniatura desse conjunto de capturas.

3.27.0

  • Modificada a política de tentativas – a contagem máxima padrão de tentativas de análise foi aumentada para 3 e a configuração de jitter foi introduzida.

  • Alterado o algoritmo de callback.

  • Refatoradas e documentadas as ferramentas de linha de comando.

  • Módulos refatorados.

3.25.0

  • Alterado o endpoint e o método de exclusão de informações pessoais de delete_pi como /pi e de POST para DELETE, respectivamente.

3.23.1

  • Melhorado o algoritmo de exclusão de informações pessoais.

  • Agora é proibido adicionar mídia a pastas limpas.

3.23.0

  • Alterado o nome do endpoint authorize/restore de auth como auth_restore.

  • Adicionada uma nova tag – video_selfie_oneshot.

  • Adicionada a configuração de validação de senha (OZ_PASSWORD_POLICY).

  • Adicionado auth, rest_unauthorized, rps_with_token throttling (use OZ_THROTTLING_RATES na configuração. Desativado por padrão).

  • As permissões do usuário agora são usadas para acessar arquivos estáticos (OZ_USE_PERMISSIONS_FOR_STATIC na configuração, false por padrão).

  • Adicionado um novo endpoint de pasta – /delete_pi. Ele limpa todas as informações pessoais de uma pasta e as análises relacionadas a essa pasta.

3.22.2

  • Corrigido um bug sem erro ao tentar sincronizar coleções vazias.

  • Se pessoas forem enviadas, a requisição TFSS de análise da coleção é enviada.

3.22.0

  • Adicionado o fields_to_check parâmetro para a análise de documentos (por padrão, todos os campos são verificados).

  • Adicionado o double_page_spread parâmetro para a análise de documentos (True por padrão).

3.21.3

  • Corrigida a sincronização de coleções.

3.21.0

  • O token de autorização agora pode ser atualizado por expire_token.

3.20.1

  • Adicionado suporte a application/x-gzip.

3.20.0

  • Renomeado shots_set.images para shots_set.frames.

3.18.0

  • Adicionada a API de sessões de usuário.

  • Agora os usuários podem alterar o proprietário de uma pasta (limitado pelas permissões).

  • Alteradas as regras de dependências.

  • Alterada a política de prorrogação do access_token para corrigir o bug de prorrogação antes de verificar a permissão de expiração.

3.16.0

  • Mover oz_collection_binding (funcionalidade de sincronização de coleção) para oz_core.

3.15.3

  • Simplificada a funcionalidade de shots sets. Um arquivo mantém um conjunto de capturas.

3.15.2

  • Melhorado o reconhecimento dos lados do documento para a versão Docker.

3.15.1

  • Movida a verificação da tag de orientação para Liveness na análise de QUALITY.

3.15.0

  • Adicionado um modelo de relatório padrão para ADMIN e OPERATOR.

3.14.0

  • Atualizado o modelo biométrico.

3.13.2

  • Um novo objeto ShotsSet não é criado se não houver fotos para ele.

  • Atualizado o formato de troca de dados para o módulo de reconhecimento de documentos.

3.13.1

  • Não é possível excluir uma Collection se houver análises associadas a Collection Persons.

3.13.0

  • Adicionadas marcas de tempo à análise: time_task_send_to_broker, time_task_received, time_task_finished.

3.12.0

  • Adicionado um novo mecanismo de autorização. Agora é possível conectar-se ao Active Directory via LDAP (é necessário configurar as definições).

3.11.0

  • Um novo tipo de mídia em pastas – "shots_set".

  • Não é possível excluir uma CollectionPerson se houver análises associadas a ela.

3.10.0

  • Renomeado o campo da pasta resolution_suggest como operator_status.

  • Adicionado um campo de texto da pasta operator_comment.

  • Os campos da pasta operator_status e operator_comment podem ser editados somente por ADMIN, OPERATOR, CLIENT SERVICE, CLIENT OPERATOR e CLIENT ADMIN.

  • Somente ADMIN e CLIENT ADMIN podem excluir pasta, mídia da pasta, modelo de relatório, anexos do modelo de relatório, relatórios e análises (dentro da sua empresa).

3.9.0

  • Corrigido um erro de exclusão: quando o autor do relatório é excluído, seus relatórios também são excluídos.

3.8.1

  • CLIENT agora pode visualizar apenas seu próprio perfil.

3.8.0

  • CLIENT OPERATOR agora pode editar apenas seu próprio perfil.

  • CLIENT não pode mais excluir suas próprias pastas, mídias, relatórios ou análises.

  • CLIENT SERVICE agora pode criar Collection Person e ler relatórios dentro da sua empresa.

3.7.1

  • CLIENT, CLIENT ADMIN e CLIENT OPERATOR têm acesso de leitura aos perfis de usuários apenas em sua empresa.

  • O teste A/B agora está disponível.

  • Adicionado suporte ao cabeçalho de data de expiração.

  • Adicionado suporte à vinculação do módulo de reconhecimento de documentos Standalone/Dockered.

3.7.0

  • Adicionado um novo papel de CLIENT OPERATOR (como CLIENT ADMIN sem permissões para gerenciamento de empresa e conta).

  • CLIENT ADMIN e CLIENT OPERATOR podem alterar o status da análise.

  • Somente ADMIN e CLIENT ADMIN (para sua empresa) podem, a partir de agora, criar, atualizar e excluir operações para os modelos Collection e CollectionPerson.

  • Adicionada uma verificação das permissões do usuário para o modelo de relatório ao criar um relatório de pasta.

  • A criação de Collection agora retorna o código de status 201 em vez de 200.

AnteriorColeções do Oz API no PostmanPróximoOz API Lite (obsoleto)

Atualizado

Isto foi útil?