Unico IDCloud - DevCenter
Página inicialAutenticaçãoAPIsSDKs
Portuguese (Brazil)
Portuguese (Brazil)
  • Introdução
  • SOBRE O IDCLOUD
    • Unico IDCloud
    • Capacidades
    • Meios de Integração
    • Capacidades e Meios de Integração
  • INTEGRAÇÃO
    • Guia de início rápido
    • Autenticação
      • Criando uma Conta de Serviço
      • Preparando para fazer uma requisição autenticada à API
      • Recursos adicionais
        • Exemplo em Javascript
        • Erros de autenticação
        • Postman Collection
    • Integração by Unico
      • Visão Geral
      • API
        • API Reference
          • Criação do Processo
            • Criação de processos separados por flows
          • Consultar Resultado do Processo
          • Obter Selfie do Usuário
          • Obter Conjunto Probatório
            • Especificação do conjunto probatório
          • Obter Documento Assinado
          • Obter Conjunto Probatório do Documento Assinado
        • Erros
      • Controlando a experiência
        • Redirecionando o usuário
        • SDK
        • QR Code
        • Personalizações
      • Recursos adicionais
        • Postman Collection
        • PoCs disponíveis
    • Integração by Client
      • Visão Geral
      • API
        • API Reference
          • Prova de vida + Verificação de Identidade + Alerta de comportamento
          • Prova de vida + Verificação de Identidade + Alerta de comportamento + Score de risco
          • Prova de vida + Validação 1:1 + Alerta de comportamento
          • Reaproveitamento e captura de documentos
        • Cenários de response
        • Erros
        • Recursos adicionais
          • Postman Collection
      • Padrão de captura (sem SDK)
    • Webhook
    • SDK
      • Visão Geral
      • Política de atualizações
      • Integração SDKs
        • SDK Android
          • Guia de instalação
          • Guia de uso e integração
            • Captura de Selfie
            • Captura de documento
          • Guia de tratamento de erros
          • Personalização Android
          • Solução de problemas
          • Release notes
        • SDK iOS
          • Guia de instalação
          • Guia de uso e integração
            • Captura de Selfie
            • Captura de documento
          • Guia de tratamento de erros
          • Personalização iOS
          • Solução de problemas
          • Release notes
        • SDK Flutter
          • Guia de instalação
          • Guia de uso e integração
            • Captura de Selfie
            • Captura de documento
          • Guia de tratamento de erros
          • Personalização Flutter
          • Solução de problemas
          • Release notes
        • SDK Web
          • Guia de instalação
          • Guia de uso e integração
            • Captura de Selfie
            • Captura de documento
            • Acessibilidade
          • Guia de tratamento de erros
          • Personalização Web
          • Release notes
      • Recursos adicionais
        • PoCs disponíveis
        • Melhores práticas de implementação da SDK
  • help & faq
    • Glossário
    • FAQs
      • FAQ IDCloud
      • FAQ Autenticação
      • FAQ SDK
    • Central de ajuda
Fornecido por GitBook

Institucional

  • Sobre nós

Copyright © 2024 unico. All rights reserved

Nesta página

Isto foi útil?

Exportar como PDF
  1. INTEGRAÇÃO
  2. Integração by Client
  3. API
  4. API Reference

Prova de vida

Nesta seção, você encontrará as particularidades de criar um processo que tenha somente a Prova de vida como capacidade

Atualizado há 2 meses

Isto foi útil?


Introdução


Nesta seção, você encontrará a documentação detalhada sobre o funcionamento do endpoint relacionado à capacidade Prova de vida, utilizada de forma isolada.

Trata-se de uma capacidade síncrona, ou seja, toda a integração ocorre utilizando um único endpoint.

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 exclusivamente para a capacidade Prova de Vida, garantindo acesso dedicado e seguro ao recurso.

Fale com o responsável do seu projeto para obter a API Key com esta configuração.

Antes de começar


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 .

Endpoints:

  • UAT: ;

  • Produção: .


Criação do Processo


Pontos Importantes:

  • Para utilizar a capacidade Prova de vida, é indispensável o uso dos nossos SDKs;

  • Caso ocorra algum erro no processamento da biometria, a requisição retornará um status code = 200 e o processo retornará um status = 5, como no exemplo abaixo:

      {
      "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
      "status": 5
      }

Dicas:

  • Para este caso de uso, não há a necessidade de Consultar o Resultado do Processo, visto que a resposta é síncrona;

  • 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 cenários que pode receber no response, consulte a seção Cenários de response;


Para mais informações sobre os erros possíveis para este endpoint, consulte a seção .

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da .

aqui
https://api.id.uat.unico.app
https://api.id.unico.app
Erros
​
Central de Ajuda
  • Introdução
  • Antes de começar
  • Criação do Processo
  • POSTCriar Processo

Criar Processo

post

Endpoint para criar um novo processo de prova de vida isolada no by Client.

Parâmetros de cabeçalho
AuthorizationstringObrigatório

Access-token válido.

APIKEYstringObrigatório

APIKEY válida com a capacidade prova de vida habilitada.

Corpo
subsidiaryIdstringOpcional

o ID da filial onde o processo será criado. Caso haja somente uma filial associada a conta de serviço, não há a necessidade de passar este parâmetro. Caso haja separação de processos por filial, você receberá os IDs das filiais do time Unico.

Example: 35d734c4-7fbb-4b2f-a1dc-7e1575514819
imageBase64stringObrigatório

Arquivo encrypted gerado pelo SDK.

Example: /9j/4AAQSkZJR...
Respostas
200
Processo criado com sucesso (Usuário ao vivo).
application/json
400
Payload inválido.
application/json
500
Erro inesperado (Erro interno ou problema de parâmetro).
application/json
post
POST /processes/v1 HTTP/1.1
Host: api.id.uat.unico.app
Authorization: text
APIKEY: text
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "subject": {
    "code": "12345678909",
    "name": "Luke Skywalker",
    "email": "luke@unico.io",
    "phone": "551972557070"
  },
  "subsidiaryId": "35d734c4-7fbb-4b2f-a1dc-7e1575514819",
  "imageBase64": "/9j/4AAQSkZJR..."
}
{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "liveness": 1
}