Overview

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

---

Introduction

---

by Client is a channel that provides clients with complete freedom to leverage the identity validation solutions offered by the IDCloud platform.

Its purpose is to offer a wide range of possibilities for using IDCloud platform capabilities, providing a solution that can be integrated into your back-end and allowing flexibility for clients who wish to control user experiences with their own front-end (read about the Capture Standard for more information) or through our SDKs.

by Client is an integration method for Unico IDCloud that allows clients to integrate however they see fit, combining platform capabilities as needed. This integration method provides the necessary resources to perform Liveness, Identity Verification, Behavior Alert, Risk Score, Document Capture and Reuse.

You can combine the capabilities as desired for even the most distinct use cases. However, you must have API Keys configured with the desired capabilities for proper usage.

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

Synchronous and Asynchronous Capabilities

---

In by Client, there are capabilities with synchronous responses (meaning the response is provided immediately upon process creation) and asynchronous capabilities (where data processing requires that you "retrieve" the result through a GET method on the REST API).

In your operation, you can combine capabilities as you see fit, but each capability has its own communication method. For example:

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

• When creating the process, the response from the Identity Verification and Behavior Alert capabilities will be synchronous, within the same API response for process creation.

• On the other hand, 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 are 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"
}

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"
  }
}

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.

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"
        ]
  }
}

---

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.