Visão Geral

Nesta seção, você encontrará todas as especificações técnicas das APIs REST do by Client

---

Introdução

---

O by Client é um canal que oferece toda a liberdade para o cliente utilizar as soluções de validação de identidade da plataforma IDCloud.

Tem por objetivo, fornecer uma gama de possibilidades no uso das capacidades da plataforma IDCloud oferecendo uma solução que pode ser integrada ao seu back-end e liberdade para clientes que desejam controlar a experiência dos usuários com front-end próprio (para isso leia sobre o Padrão de Captura) ou através dos nossos SDKs.

O by Client é um meio de integração do Unico IDCloud que permite que os clientes se integrem da maneira que quiserem, combinando ou não as capacidades como julgarem necessário. Esse meio de integração fornece os recursos necessários para realizar validação da Prova de vida, , Verificação da Identidade, Alerta de comportamento, Score de risco e Reaproveitamento e captura de documentos.

Você pode combinar as capacidades como quiser e nos casos de uso mais distintos, mas para isso você deverá ter API Keys configuradas com as capacidades que deseja utilizar.

*Também é possível utilizar o by Client para processar sua base de faces. Para isso, entre em contato com o responsável pela sua conta, que irá orientá-lo sobre os procedimentos necessários para essa tratativa.

Para solicitar as capacidades na API Key, contate o responsável pelo seu projeto de integração ou o time de suporte da Unico para realizar essa configuração

Capacidades síncronas e assíncronas

---

No by Client possuímos capacidades onde a resposta é síncrona (ou seja, no momento de criar o processo já devolvemos a resposta) e outras capacidades assíncronas (onde processamos os dados e você necessariamente precisa "buscar" este resultado através de um método GET na API REST.

Em sua operação você poderá combinar as capacidades como bem quiser, porém cada capacidade terá sua comunicação, por exemplo:

• Você pode ter uma operação que utilize as capacidades Verificação de Identidade + Alerta de comportamento + Score de risco;

• Ao criar o processo, a resposta das capacidades Verificação de Identidade e Alerta de comportamento serão síncronas, no próprio response da API de criação de processo;

• Já a capacidade de Score de risco será executada de forma assíncrona, sendo necessário aguardar seu processamento e então realizar uma outra requisição GET para obter o resultado final do processo.

Abaixo veja as capacidades síncronas e assíncronas:

Capacidades síncronas

---

Prova de vida:

Resposta APROVADA

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

Resposta RECUSADA

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

Verificação de Identidade:

Resposta SIM

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

Resposta NÃO

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

Resposta INCONCLUSIVA

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

Alerta de comportamento:

Resposta SIM

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "identityFraudsters": {
    "result": "yes"
  }
}

Resposta INCONCLUSIVA

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "identityFraudsters": {
    "result": "inconclusive"
}

Validação (1:1)

Resposta APROVADA

{
  "biometryToken": {​
    "result": "true"​
  }

Resposta RECUSADA

{
  "biometryToken": {​
    "result": "false"​
  }

Reaproveitamento e captura de documentos:

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "document": {
    "id": "b97c3fd9-d95d-413f-bc0a-75eb87304421",
    "type": "CNH",
    "cpfMatch": false,
    "faceMatch": false,
    "content": {
      "numero": "044589731564",
      "rgNumero": "123456789 SESP PR",
      "nomeCivil": "Homer Simpson",
      "filiacao": [
        "Monasimpson",
        "Monasimpson"
      ],
      "dataNascimento": "1990-05-12T00:00:00Z",
      "dataHabilitacao": "1997-11-18T00:00:00Z",
      "dataExpiracao": "2017-12-07T00:00:00Z",
      "dataEmissao": "2012-12-07T00:00:00Z",
      "localEmissao": "Curitiba PR",
      "categoria": "B",
      "renachNumero": "PR904987581"
    },
    "fileUrls": [
      "https://url-signer-1",
      "https://url-signer-2"
    ]
  }
}

Capacidades assíncronas

---

Verificação de Identidade:

Resposta SIM

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

Resposta NÃO

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

Resposta INCONCLUSIVA

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

Assim como a capacidade Verificação de Identidade é um capacidade "síncrona", ela também pode ser configurada para uso "assíncrono".

Score de risco:

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "score": 50
}

Alerta de comportamento:

Resposta SIM

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "identityFraudsters": {
    "result": "yes"
  }
}

Resposta INCONCLUSIVA

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "identityFraudsters": {
    "result": "inconclusive"
}

Assim como a capacidade Alerta de comportamento é um capacidade "síncrona", ela também pode ser configurada para uso "assíncrono".

---

Dúvidas?​

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