Pular para o conteúdo principal

API de Captura

Markdown
Métodos para iniciar uma sessão
MétodoDescrição
prepareSelfieCamera(_:config:)Prepara a câmera de selfie
prepareSelfieCamera(_:config:prepareInfo:)Prepara a câmera de selfie com metadados PrepareInfo
prepareDocumentCamera(_:config:)Prepara a câmera de documento
open(_:webAppToken:)Abre a câmera de selfie preparada, passando o process.webAppToken retornado por Create Process
openDocument(_:delegate:)Abre a câmera de documento preparada com um DocumentEnums
Opções / parâmetros de captura

PrepareInfo — metadados para identificar a sessão do usuário.

CampoTipoObrigatórioDescrição
externalUserIdStringsimIdentificador do usuário no seu sistema. Gerado hash SHA-256 antes da transmissão.
useCaseStringnãoIdentificador do contexto ou fluxo em execução. Transmitido em texto simples.

DocumentEnums — consulte Enums.

Tipos de resultado e campos

SelfieResult — objeto retornado em captura de selfie bem-sucedida.

CampoTipoDescrição
base64StringImagem capturada em Base64
encryptedStringJWT a ser enviado ao backend

SuccessResult — objeto retornado por onSuccess em uma integração com a Unico API.

CampoTipoDescrição
processIdStringIdentificador do processo usado para consultar o resultado da validação via API REST

DocumentResult — objeto retornado em captura de documento bem-sucedida. Mesmos campos que SelfieResult.