Overview

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

---

Introduction

---

By Client is a channel that provides complete freedom for clients to leverage the IDCloud platform’s identity validation solutions. It aims to offer a wide range of possibilities in using IDCloud platform capabilities, delivering a solution that can be integrated with your back-end and allowing clients to control the user experience with their own front-end (for this, see Capture Standard) or through our SDKs.

Available Flows

---

By Client is an integration method for Unico IDCloud that allows clients to integrate as they see fit, combining or not combining capabilities as needed. This integration method provides the necessary resources for performing Proof of Life, Fraud Profile Detection, Identity Verification, and Document Capture and Reuse validation.

You can combine capabilities as desired and use them in various cases; however, API Keys configured with the desired capabilities are required.

o request specific capabilities for an API Key, please contact your integration project manager or Unico’s support team for assistance with the configuration.

See below for all possible capability combinations in By Client:

---

01.

Liveness

02.

Liveness + Identity Verification

03.

Liveness + Validation (1:1)

04.

Liveness + Identity Verification + Fraud Profile Detection

05.

Liveness + Identity Verification + Risk Scoring

06.

Liveness + Identity Verification + Document Capture and reuse

07.

Liveness + Identity Verification + Fraud Profile Detection + Risk Scoring

08.

Liveness + Identity Verification + Fraud Profile Detection + Document Capture and reuse

09.

Liveness + Identity Verification + Risk Scoring + Document Capture and reuse

10.

Liveness + Identity Verification + Fraud Profile Detection + Risk Scoring + Document Capture and reuse

• You can also use the above capabilities without the Liveness Detection if you already have a Liveness provider in your operation. I

• f you use the Identity Verification capability, regardless of any other combinations, it’s also possible to retrieve the Serpro similarity result (click here to learn more).

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 might operate with both Identity Verification and Fraud Profile Detection capabilities.

• When creating the process, the response for Identity Verification will be synchronous and included in the API response.

• Fraud Profile Detection, however, will operate asynchronously, requiring a wait for processing and then a separate GET request to obtain the final result.

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

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
}

Fraud Profile Detection:

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

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.