Pular para o conteúdo principal

Workflow

O Workflow do SantoiD orquestra automaticamente a extração de campos estratégicos combinando tipificação e OCR, selecionando sempre os dados com maior confiabilidade.

Documentação Relacionada

Endpoint Principal​

POST https://api.santoid.com.br/api/v1/workflow

Criação de Workflow​

{
    "track": "seu-track-id",
    "maxFiles": 10, // Opcional
    "deadLineInput": 300 // Opcional (segundos)
}

Parâmetros​

CampoTipoObrigatórioDescrição
trackstringSimID da track configurada com seus workflows
maxFilesintegerNãoLimite de documentos por lote (usa padrão da track se omitido)
deadLineInputintegerNãoTempo máximo de coleta em segundos (padrão: configuração da track)
Comportamento do Workflow ID
  • Multi-documentos: Aceita envios simultâneos de vários arquivos
  • Fechamento Automático quando:
    • Atingir maxFiles ou
    • Expirar deadLineInput

Fluxo Completo​

  1. Criação

    POST /api/v1/workflow
    • Retorna workflowId único

  2. Alimentação (envio de documentos)

    POST /api/v1/typification-async/predict
    • Um arquivo por requisição
    • Envios paralelos permitidos

  3. Resultado via Webhook

    • Estrutura unificada com os melhores campos (maiores scores)

Exemplos Práticos​

Recursos Complementares

Diagrama de Fluxo​

Caso de Uso: Captura de Dados Prioritários​

  1. Envia CNH + RG + Comprovante
  2. Workflow identifica:
    • CPF mais legível (CNH: score 98%)
    • Endereço mais completo (Comprovante: score 95%)
  3. Retorno unificado com os melhores valores
Boas Práticas
  • Configure maxFiles conforme seu caso de uso
  • Monitore deadLineInput para evitar timeout
  • Valide webhooks para receber resultados