Solicitação única

Visão geral e benefícios

Na versão 6.0.1, foi introduzido um novo recurso que permite enviar todos os dados necessários e receber o resultado da análise em uma única solicitação.

Antes da versão 6.0.1, interagir com a API exigia várias solicitações: era necessário criar uma pasta e enviar mídia para ela, iniciar análises (veja Liveness, Biometria e Lista de bloqueio), e então consultar os resultados ou usar webhooks para notificações quando o resultado estivesse pronto. Esse fluxo ainda é suportado, então, se for necessário enviar solicitações separadas, é possível continuar usando os métodos existentes listados acima.

No entanto, o novo modo de operação da API simplifica significativamente o processo ao permitir enviar uma única solicitação e receber a resposta de forma síncrona. Os principais benefícios são:

• Uma única solicitação para tudo – todos os dados são enviados em um único pacote, eliminando o risco de perda de dados.

• Resposta síncrona – não há necessidade de polling ou webhooks para recuperar os resultados.

• Alto desempenho – oferece suporte a até 36 análises por minuto por instância.

Uso

Para usar este método, chame POST /api/folders/. No cabeçalho X-Forensic-Access-Token, informe seu token de acesso. Adicione arquivos de mídia ao corpo da solicitação e defina as tags e os metadados, se necessário, na parte do payload.

Exemplo de requisição

{
  // (bloco opcional) metadados da pasta, se necessário
  "folder:meta_data": {
    "partner_side_folder_id": "00000000-0000-0000-0000-000000000000",
    "person_info": {
      "first_name": "John",
      "middle_name": "Jameson",
      "last_name": "Doe"
    }
  },
  // (bloco opcional) metadados da pasta, se necessário
  "media:meta_data": {
    "video1": {
      "foo": "bar"
    }
  },
  "media:tags": {
    "video1": [
      "video_selfie",
      "video_selfie_eyes",
      "orientation_portrait"
    ]
  },
  "analyses": [
    {
      "type": "quality",
      // (bloco opcional) metadados da pasta, se necessário
      "meta_data": {
        "example1": "some_example1"
      },
      // parâmetros adicionais
      "params": {
        "threshold_spoofing": 0.5,
        "extract_best_shot": false
      }
    }
  ]
}

Exemplo de resposta

{
  "company_id": "00000000-0000-0000-0000-000000000000",
  "time_created": 1744017549.366616,
  "folder_id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "resolution_endpoint": null,
  "resolution_status": "FINISHED",
  "resolution_comment": "[]",
  "system_resolution": "SUCCESS",
  ...
  // metadados da pasta, se você os adicionou
  "meta_data": {
    "partner_side_folder_id": "00000000-0000-0000-0000-000000000000",
    "person_info": {
      "first_name": "John",
      "middle_name": "Jameson",
      "last_name": "Doe"
    }
  },
  "media": [
    {
      "company_id": "00000000-0000-0000-0000-000000000000",
      "folder_id": "00000000-0000-0000-0000-000000000000",
      "folder_time_created": 1744017549.366616,
      "original_name": "00000000-0000-0000-0000-000000000000.mp4",
      "original_url": null,
      "media_id": "00000000-0000-0000-0000-000000000000",
      "media_type": "VIDEO_FOLDER",
      "tags": "video1": [
		"video_selfie",
		"video_selfie_eyes",
		"orientation_portrait"
	]
      "info": {},
      "time_created": 1744017549.368665,
      "time_updated": 1744017549.36867,
	  // metadados da mídia, se você os adicionou
      "meta_data": {
        "foo": "bar"
      },
      "thumb_url": null,
      "image_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "time_updated": 1744017549.366629,
  "analyses": [
    {
      "company_id": "00000000-0000-0000-0000-000000000000",
      "group_id": "00000000-0000-0000-0000-000000000000",
      "folder_id": "00000000-0000-0000-0000-000000000000",
      "folder_time_created": 1744017549.366616,
      "analysis_id": "00000000-0000-0000-0000-000000000000",
      "state": "FINISHED",
      "resolution_operator": null,
      "results_media": [
        {
         ...
        }
      ],
      "results_data": null,
	  // metadados da análise, se você os adicionou
      "meta_data": {
        "example1": "some_example1"
      },
      "time_created": 1744017549.369485,
      "time_updated": 1744017550.659305,
      "error_code": null,
      "error_message": null,
      "source_media": [
        {
	 ...
        }
      ],
      "type": "QUALITY",
      "analyse_id": "00000000-0000-0000-0000-000000000000",
      "resolution_status": "SUCCESS",
      "resolution": "SUCCESS"
    }
  ]
}

Você recebe os resultados da análise.

Pronto.