Reaproveitamento e captura de documentos
Nesta seção, você encontrará as particularidades de criar um processo que tenha o Reaproveitamento e captura de documentos como capacidade
Atualizado
Isto foi útil?
Nesta seção, você encontrará as particularidades de criar um processo que tenha o Reaproveitamento e captura de documentos como capacidade
Atualizado
Isto foi útil?
Nesta seção, você encontrará a documentação detalhada sobre o funcionamento dos endpoints relacionados à capacidade Reaproveitamento e captura de documentos. O uso do Reaproveitamento exige que haja um processo de Verificação de Identidade anterior e este deve obtido a resposta "SIM" OU um Score de risco igual ou maior que +50, do contrário será necessário capturar o documento do usuário.
Trata-se de uma capacidade síncrona que exige o consumo de dois endpoints, detalhados nesta documentação, para sua utilização completa.
As capacidades da plataforma Unico IDCloud via by Client são gerenciadas por meio de API Keys - utilizadas como um parâmetro no header das requisições -, que definem o escopo de acesso. Como pré-requisito, é necessário possuir uma API Key configurada excluvisamente para a capacidade Reaproveitamento e captura de documentos, garantindo acesso dedicado e seguro ao recurso.
Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.
Você pode ver mais sobre como gerar um access-token .
Pontos Importantes:
Para utilizar a capacidade de Reaproveitamento e captura de documentos, deve-se utilizar a capacidade Verificação de Identidade anteriormente, pois é necessário utilizar o processId obtido da Verificação de Identidade no parâmetro document.authProcessId
:
O processo precisar ser de uma biometria válida, ser utilizado em até 24h a partir de sua finalização;
É possível reutilizar uma autenticação biométrica realizada previamente pelo mesmo usuário em um prazo de até 24 horas. Dentro desse intervalo, a prova de autenticação do ID pode ser utilizada em diferentes processos de verificação de documentos (ex: RG e CNH), sem a necessidade de uma nova biometria.
Caso não consigamos extrair algum campo do documento, ele não é listado no retorno da API;
Ao utilizar a funcionalidade Reaproveitamento e Captura de Documentos, é obrigatório
informar ao usuário, na interface, sobre o reaproveitamento, conforme previsto em contrato.
Caso ocorra algum erro no processamento, o processo retornará um status = 5
, como no exemplo abaixo:
Conteúdo retornado no document.content baseado no document.type:
Dicas:
Para implementar suas regras de negócio, sempre valide os status finais dos processos (3
,5
). Para validar a resposta das capacidades IDCloud, só considere o status
= 3
para sua tomada de decisão;
Para mais informações sobre os erros possíveis para este endpoint, consulte a seção .
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da .
Endpoint para criar um novo processo de documentos no by Client.
Access-token válido.
APIKEY válida com a capacidade reaproveitamento e captura de documentos habiitada.
Informações do usuário.
Informações sobre o documento que será capturado.
Informações do processo obtidas com sucesso.
Endpoint para buscar os documentos de um usuário para serem reaproveitados no by Client.
Valor do identificador do usuário (ex: Valor do CPF). Deve conter 11 caracteres e ser enviado sem pontos ou traços.
12345678909
Tipo do documento (exemplo: BR_CPF).
BR_CPF
Access-token válido.
APIKEY válida com a capacidade reaproveitamento e captura de documentos habilitada.
Type: CNH
Content: Carteira Nacional de Habilitação
String numero;
String rgNumero;
String cpfNumero;
String nomeCivil;
List string filiacao;
Datetime dataNascimento;
Datetime data_habilitacao;
Datetime data_expiracao;
Datetime data_emissao;
String local_emissao;
String categoria;
String renachNumero.