Fluxo comum

Os serviços de validação que trabalham por referência compartilham o mesmo início: obter o Token, dispor de uma operação e enviar os assets para o armazenamento. Só depois o serviço concreto é invocado com as chaves obtidas.

Esta página reúne esse início para não repeti-lo em cada serviço. Cada etapa aponta para a página que documenta seu contrato.

Diagrama

As etapas

1. Obter o Token de consumer. Um único Token autentica todas as chamadas seguintes e vale uma hora. Ele é emitido em nome da plataforma e para um consumer específico. Ver Autenticação.

2. Criar a operação. A operação agrupa os assets da sessão e define uma expiração para eles. Ela é criada com POST /operationque devolve o operationId e seu expiresAt. Convém criá-la quando a captura começa, e não antes, porque o relógio da expiração começa nesse momento. Ver Create Operation.

3. Enviar cada asset. Uma chamada por captura, declarando o contexto correspondente. Cada envio devolve a fileKey com a qual depois se referencia o asset. Ver Save Asset, e Armazenamento para os contextos disponíveis e o formato da chave.

4. Invocar o serviço de validação. São enviadas as fileKeys tal como as devolveu POST /storage, com o operationId no cabeçalho operation-id. A chave não é composta nem interpretada: adicionar o contexto por conta própria a deixa duplicada e o asset não é resolvido. Se precisar recuperar as chaves de uma operação, elas estão em Get File Keys.

Quais serviços seguem este Fluxo

Os serviços de validação de identidade admitem por padrão os dois modos de asset, conteúdo em linha e referência por chave, e este Fluxo é o do modo por referência. As exceções são explícitas:

Serviço	Modos admitidos
Form OCR	Somente conteúdo em linha
Voice Enrollment e Voice Authentication	Somente conteúdo em linha, sem campo source
Document Validation	Somente referência, sem campo source

Os serviços exclusivamente on-line não passam pelas etapas 2 e 3: o conteúdo viaja na própria chamada e não levam cabeçalho operation-id.