Overview

In this section, you will find all the technical specifications for By Client REST APIs

---

Introduction

---

by Client is a channel that offers complete freedom for the client to use the identity validation solutions from the IDCloud platform.

Its goal is to provide a wide range of possibilities for using the capabilities of the IDCloud platform, offering a solution that can be integrated into your back-end and providing freedom for clients who wish to control the user experience with their own front-end (for this, read about the Capture Standard) or through our SDKs.

by Client is an integration method of Unico IDCloud that allows clients to integrate in any way they choose, combining or not combining the capabilities as they deem necessary. This integration method provides the necessary resources to perform Liveness, Identity Verification, Behavioral Alerts, Risk Score, and Document Reuse and Capture.

You can combine capabilities as you wish and for the most distinct use cases, but to do so, you will need to have API Keys configured with the capabilities you wish to use.

*It is also possible to use the by Client feature to process your face database. To do so, please contact your account manager, who will guide you through the necessary procedures for this process.

To request the capabilities in the API Key, contact the person responsible for your integration project or the Unico support team to make this configuration.

Synchronous and Asynchronous Capabilities

---

In by Client, we have capabilities where the response is synchronous (i.e., the response is returned when the process is created) and other capabilities that are asynchronous (where we process the data and you need to "fetch" the result through a GET method in the REST API).

In your operation, you can combine the capabilities as you wish, but each capability will have its own communication method. For example:

• You can have an operation that uses the Identity Verification + Behavioral Alert + Risk Score capabilities;

• When creating the process, the response for the Identity Verification and Behavioral Alert capabilities will be synchronous, provided in the response of the process creation API;

• However, the Risk Score capability will be executed asynchronously, requiring you to wait for its processing and then make another GET request to obtain the final result of the process.

Below, see the synchronous and asynchronous capabilities:

Synchronous Capabilities

---

Liveness:

APPROVED response

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

DENIED response

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

Identity verification:

YES response

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

NO response

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

INCONCLUSIVE response

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

Behavior Alert:

YES response

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

INCONCLUSIVE response

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

Validation (1:1)

APPROVED response

{
    "authenticated": "true"
}

DENIED response

{
    "authenticated": "false"
}

Document Capture and Reuse:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": 3,
  },
  "document": {
    "id": "b97c3fd9-d95d-413f-bc0a-75eb87304421",
    "type": "CNH",
    "cpfMatch": 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"
        ]
  }
}

Asynchronous Capabilities

---

Identity verification:

YES response

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

NO response

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

INCONCLUSIVE response

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

Just like the Identity Verification capability is a "synchronous" capability, it can also be configured for "asynchronous" use.

Risk scoring:

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

Behavior Alert:

YES response

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

INCONCLUSIVE response

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

Just like the Behavior Alert capability is a "synchronous" capability, it can also be configured for "asynchronous" use.

---

Still need help?​

Didn't find something or still need help? If you're already a client or partner, you can reach out through our Help Center.