### Fetch Quiz Questions - cURL Example

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This cURL command demonstrates how to make a request to the quiz endpoint. It includes the necessary JSON payload and assumes the use of a Bearer Token for authorization.

```shell
curl --location 'https://apih.tshield.com.br/api/quiz' \
--data '{
  "number": "{{queryNumber}}"
}'
```

--------------------------------

### Liveness 3D Session Creation Response (json)

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Example JSON response after successfully creating a Liveness 3D session. It contains the session token, a base64 encoded QR code image, and the URL for the liveness capture.

```json
{
  "success": true,
  "data": {
    "token": "c63f7ecc-e550-429d-b25d-127fea82b4d6",
    "qr_code": "/9j/4AAQSkZJRgABAQEAYABgAAD/",
    "url": "https://livenessh.tshield.com.br/3D/c63f7ecc-e550-429d-b25d-127fea82b4d6/create-query/true"
  }
}
```

--------------------------------

### GET /api/quiz

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Retrieves a list of quiz questions and their corresponding options. This endpoint is useful for presenting a quiz to a user.

```APIDOC
## GET /api/quiz

### Description
Retrieves a list of quiz questions and their corresponding options. This endpoint is useful for presenting a quiz to a user.

### Method
GET

### Endpoint
https://apih.tshield.com.br/api/quiz

### Parameters
#### Query Parameters
- **number** (string) - Required - The identifier for the quiz.

### Request Example
```bash
curl --location 'https://apih.tshield.com.br/api/quiz' \
--header 'Authorization: Bearer {{authToken}}' \
--data '{ \
  "number": "{{queryNumber}}" \
}'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the quiz data.
  - **quiz_id** (int) - The unique identifier for the quiz.
  - **questions** (list) - A list of quiz questions.
    - **question_id** (int) - The unique identifier for the question.
    - **question** (string) - The text of the question.
    - **question_time** (int) - The time allocated for answering the question in seconds.
    - **options** (list) - A list of possible answers for the question.
      - **option_id** (int) - The unique identifier for the option.
      - **option** (string) - The text of the answer option.

#### Response Example
```json
{
  "success": true,
  "data": {
    "quiz_id": 1234,
    "questions": [
      {
        "question_id": 1,
        "question": "QUAL A SUA IDADE?",
        "question_time": 15,
        "options": [
          {
            "option_id": 3,
            "option": "39 ANOS"
          },
          {
            "option_id": 5,
            "option": "38 ANOS"
          }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### Submit Quiz Answers - cURL Example

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This cURL command demonstrates how to submit quiz answers to the result endpoint. It includes the JSON payload with answers and assumes the use of a Bearer Token for authorization.

```shell
curl --location 'https://apih.tshield.com.br/api/quiz/result' \
--data '{
  "number": "{{queryNumber}}",
  "answers": [
    {
      "question_id": 13,
      "option_id": 1,
      "time_taken": 10
    },
    {
      "question_id": 10,
      "option_id": 6,
      "time_taken": 10
    },
    {
      "question_id": 2,
      "option_id": 11,
      "time_taken": 10
    }
  ]
}'
```

--------------------------------

### Liveness 3D Details Response (json)

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Example JSON response containing the detailed results of a Liveness 3D analysis. It includes the original token, expiration date, capture URL, creation date, and the crucial `facetec_session_id` and `query_number`.

```json
{
  "success": true,
  "data": {
    "token": "c63f7ecc-e550-429d-b25d-127fea82b4d6",
    "expiration_date": "2022-09-28T17:56:23.75",
    "url": "https://livenessh.tshield.com.br/3D/c63f7ecc-e550-429d-b25d-127fea82b4d6/create-query/true",
    "create_date": "2022-09-28T15:56:24.227",
    "facetec_session_id": "b0cb557d-1842-4a22-bf37-191a899d0f00",
    "query_number": "25c16b4d-32b2-4b1a-9e67-25d6e19846c6"
  }
}
```

--------------------------------

### Analysis - Get Analysis Details

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Retrieves detailed information about a specific analysis using its unique identifier.

```APIDOC
## GET /analysis-details/{analysis_id}

### Description
Retrieves detailed information about a specific analysis.

### Method
GET

### Endpoint
/analysis-details/{analysis_id}

### Parameters
#### Path Parameters
- **analysis_id** (string) - Required - The unique identifier of the analysis.

### Response
#### Success Response (200)
- **analysis_id** (string) - The unique identifier of the analysis.
- **status** (string) - The current status of the analysis.
- **score** (number) - The calculated score for the analysis (if available).
- **results** (object) - A detailed breakdown of the analysis results.

#### Response Example
```json
{
  "analysis_id": "analysis_abc123",
  "status": "COMPLETED",
  "score": 85.5,
  "results": {
    "risk_assessment": {
      "level": "LOW",
      "details": "..."
    },
    "credit_check": {
      "status": "APPROVED",
      "details": "..."
    }
  }
}
```
```

--------------------------------

### Analysis - Create Link (Pre-defined Model)

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This endpoint allows the creation of a link for capturing selfie and document images within T-Shield's white-label environment. It can also be used to send data directly for analysis creation if your company has its own data collection application or website. This specific example demonstrates creating a link using a pre-defined analysis model.

```APIDOC
## POST /create-link

### Description
Creates a link for data capture (selfie, document) or initiates an analysis by sending data directly. This example uses a pre-defined analysis model.

### Method
POST

### Endpoint
/create-link

### Parameters
#### Request Body
- **client_validation_id** (integer) - Required - The ID of the pre-defined analysis model created in the T-Shield panel.

### Request Example
```json
{
  "client_validation_id": 1234
}
```

### Response
#### Success Response (200)
- **link** (string) - The generated URL for data capture.
- **analysis_id** (string) - The unique identifier for the created analysis.

#### Response Example
```json
{
  "link": "https://tshield.com.br/capture/abcdef12345",
  "analysis_id": "analysis_xyz789"
}
```
```

--------------------------------

### Analysis - Get Analysis Details by CPF

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Retrieves detailed information about an analysis associated with a specific CPF (Cadastro de Pessoas Físicas).

```APIDOC
## GET /analysis-details-cpf/{cpf}

### Description
Retrieves detailed information about an analysis associated with a specific CPF.

### Method
GET

### Endpoint
/analysis-details-cpf/{cpf}

### Parameters
#### Path Parameters
- **cpf** (string) - Required - The CPF of the individual.

### Response
#### Success Response (200)
- **analysis_id** (string) - The unique identifier of the analysis.
- **status** (string) - The current status of the analysis.
- **score** (number) - The calculated score for the analysis (if available).
- **results** (object) - A detailed breakdown of the analysis results.

#### Response Example
```json
{
  "analysis_id": "analysis_xyz789",
  "status": "COMPLETED",
  "score": 78.2,
  "results": {
    "kyc_check": {
      "status": "VERIFIED",
      "details": "..."
    }
  }
}
```
```

--------------------------------

### GET /api/query/{{queryNumber}}/contract-pdf

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This endpoint is used to search for a contract PDF file when a contract has been previously signed. It requires an authorization token.

```APIDOC
## GET /api/query/{{queryNumber}}/contract-pdf

### Description
Retrieves the PDF file for a previously signed contract.

### Method
GET

### Endpoint
https://apih.tshield.com.br/api/query/{{queryNumber}}/contract-pdf

### Parameters
#### Query Parameters
- **queryNumber** (string) - Required - The number used to query for the contract.

#### Headers
- **Authorization** (string) - Required - Bearer Token

### Request Example
```bash
curl --location -g 'https://apih.tshield.com.br/api/query/{{queryNumber}}/contract-pdf' \
--header 'Authorization: Bearer {{authToken}}'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **data** (string) - A URL to the contract PDF file.

#### Response Example
```json
{
  "success": true,
  "data": "https://tshieldpublico.blob.core.windows.net/temporary/03aa7fda-2dfa-489e-84a7-47efd41234.pdf"
}
```
```

--------------------------------

### GET /api/token/{token}/facetec-session-id

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This endpoint is used to retrieve the result of the 3D liveness check.  It requires a token to identify the liveness session.

```APIDOC
## GET /api/token/{token}/facetec-session-id

### Description
This endpoint is used to retrieve the result of the 3D liveness check.

### Method
GET

### Endpoint
/api/token/{token}/facetec-session-id

### Parameters
#### Path Parameters
- **token** (string) - The liveness token.

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```curl
--location -g 'https://apih.tshield.com.br/api/token/{{queryNumber}}/facetec-session-id'
```

### Response
#### Success Response (200)
- **token** (string) - The identification number of the 3D liveness.
- **expiration_date** (datetime) - The expiration date and time of the liveness token.
- **url** (string) - URL of the 3D liveness link.
- **create_date** (string) - The creation date and time of the liveness token.
- **facetec_session_id** (string) - The identification number of the liveness validation.
- **query_number** (string) - The identification number of the analysis.

#### Response Example
```json
{
  "success": true,
  "data": {
    "token": "c63f7ecc-e550-429d-b25d-127fea82b4d6",
    "expiration_date": "2022-09-28T17:56:23.75",
    "url": "https://livenessh.tshield.com.br/3D/c63f7ecc-e550-429d-b25d-127fea82b4d6/create-query/true",
    "create_date": "2022-09-28T15:56:24.227",
    "facetec_session_id": "b0cb557d-1842-4a22-bf37-191a899d0f00",
    "query_number": "25c16b4d-32b2-4b1a-9e67-25d6e19846c6"
  }
}
```
```

--------------------------------

### Webhook Response JSON Example

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This JSON snippet represents a sample webhook payload sent by T-Shield upon analysis completion, containing fields such as ID, number, token, creation date, CPF, validation type, scores for id_check, credit, risk, and kyc, as well as status and logs. It depends on the analysis configuration and specific services selected. Limitations include null scores in some cases and reliance on accurate source data for scores.

```json
{
   "id":90000,
   "number":"ef8bef91-ac47-4348-b3a2-e749d3ace803",
   "token":"33be402d-cadd-48e8-995b-2ed760367ee8",
   "create_date":"2022-06-24T10:56:27.72",
   "cpf":"32586413822",
   "clientvalidation":"Modelo de Análise",
   "score":null,
   "id_check":{
      "status_process":{
         "id":9,
         "description":"Aprovado"
      },
      "score":90.0
   },
   "credit":{
      "status_process":{
         "id":9,
         "description":"Aprovado"
      },
      "score":100.0
   },
   "risk":{
      "status_process":{
         "id":9,
         "description":"Aprovado"
      },
      "score":100.0
   },
   "kyc":{
      "status_process":{
         "id":3,
         "description":"Concluído"
      }
   },
   "emails_confirmation":[
      {
         "confirmed":true,
         "email":"diegopassos1@gmail.com",
         "sent_date":"2022-06-24T10:56:28.903",
         "confirmed_date":"2022-06-24T10:58:23.77"
      }
   ],
   "log":[
   ],
   "status":{
      "id":9,
      "status":"Aprovado",
      "date":"2022-06-24T11:02:01.093",
      "user":112258,
      "description":"Aprovação automática"
   }
}
```

--------------------------------

### GET Contract PDF - cURL

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This cURL command retrieves the PDF of a previously signed contract. It requires the contract query number and an authorization token. The response includes a success status and a URL to the PDF file.

```curl
curl --location -g 'https://apih.tshield.com.br/api/query/{{queryNumber}}/contract-pdf'
```

--------------------------------

### GET Contract PDF Response - JSON

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This JSON object represents a successful response when retrieving a contract PDF. It indicates success and provides a temporary URL to the generated PDF file.

```json
{
  "success": true,
  "data": "https://tshieldpublico.blob.core.windows.net/temporary/03aa7fda-2dfa-489e-84a7-47efd41234.pdf"
}
```

--------------------------------

### Retrieve Liveness 3D Details (curl)

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Fetches the results of a Liveness 3D analysis using the session token obtained from the creation endpoint. This GET request retrieves details like session IDs and analysis numbers, which are needed to determine the completion of the liveness check.

```curl
curl --location -g 'https://apih.tshield.com.br/api/token/{{queryNumber}}/facetec-session-id'
```

--------------------------------

### API Endpoints Overview

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This section outlines the available API endpoints for T-Shield, including their HTTP methods, URLs, and a brief description of their purpose.

```APIDOC
## API Endpoints

This document provides details on various T-Shield API endpoints for integrating with client systems, covering functionalities like login, creating links and analyses, and retrieving specific data.

### Login API

*   **Method:** POST
*   **Endpoint:** `/api/login`
*   **Description:** Call to authenticate with the API.

### Create Link API

*   **Method:** POST
*   **Endpoint:** `/api/query/external/token`
*   **Description:** Call to create the token and link for image collection.

### Create Analysis - Individual API

*   **Method:** POST
*   **Endpoint:** `/api/query`
*   **Description:** Call to create a new analysis for individuals.

### Create Analysis - Company API

*   **Method:** POST
*   **Endpoint:** `/api/query/company`
*   **Description:** Call to create a new analysis for companies.

### Face ID - Transactional API

*   **Method:** POST
*   **Endpoint:** `/api/consultas/face-id`
*   **Description:** Call for transactional identity validation.

### Antifraud Web API

*   **Method:** POST
*   **Endpoint:** `/api/consultas/antifraude-web`
*   **Description:** Call used to perform antifraud web analysis transactionally.

### Analysis Details API

*   **Method:** GET
*   **Endpoint:** `/api/query/number/{number}`
*   **Description:** Call to retrieve the details of an analysis.

### Analysis Details by CPF API

*   **Method:** GET
*   **Endpoint:** `/api/query/cpf/{cpf}`
*   **Description:** Call to retrieve the details of the last analysis performed for a specific CPF.

### Create Quiz API

*   **Method:** POST
*   **Endpoint:** `/api/quiz`
*   **Description:** Call to create the Quiz and receive the questionnaire.

### Quiz Result API

*   **Method:** POST
*   **Endpoint:** `/api/quiz/result`
*   **Description:** Call to submit answers and obtain the Quiz result.

### Liveness 3D API

*   **Method:** POST
*   **Endpoint:** `/api/token/liveness`
*   **Description:** Call to create a 3D liveness link.

### Liveness 3D - Details API

*   **Method:** GET
*   **Endpoint:** `/api/token/{{queryNumber}}/facetec-session-id`
*   **Description:** Call used to obtain the result of the 3D liveness.

**Note:** For applications developed in Java, it is necessary to configure considering UTF-8 encoding.
```

--------------------------------

### Dynamic Analysis Model Selection in JSON

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Demonstrates how to structure a JSON object for dynamic analysis model selection. The object includes a parameter_list with id and value fields to determine the analysis model based on predefined business rules.

```json
{
  "parameter_list": [
    {
      "id": 1234,
      "value": 1400
    }
  ]
}
```

--------------------------------

### Create Liveness 3D Session (curl)

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Initiates a 3D liveness session by sending a POST request to the API. This call returns a unique token and a URL for the liveness capture, which should be embedded in an iframe or web view. Authorization is required via a Bearer Token.

```curl
curl --location --request POST 'https://apih.tshield.com.br/api/token/liveness'
```

--------------------------------

### Dynamic Analysis Model Selection

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Allows dynamic selection of the analysis model when creating a new link or analysis based on predefined rules.

```APIDOC
## Dynamic Analysis Model Selection

It is also possible to perform the choice of the analysis model when creating a new link and/or analysis dynamically.

Within the Dashboard, it will be possible to create rules based on values and IDs for the choice of which analysis model to perform. According to your company's business rules, this decision can be made by purchase value, quantity of items, or even about a specific product.

### Parameters and Comparisons

| Parameter           | Comparisons                   |
|---------------------|-------------------------------|
| Id                  | Contains in a list of Ids     |
| Id                  | Does not contain in a list of Ids |
| Sum of values       | Equals to...                  |
| Sum of values       | Is greater than...            |
| Sum of values       | Is less than...               |
| Quantity of items   | Is equal to...                |
| Quantity of items   | Is greater than...            |
| Quantity of items   | Is less than...               |
| Sum of values by Id | Is equal to...                |
| Sum of values by Id | Is greater than...            |
| Sum of values by Id | Is less than...               |
| Compare Text        | Is equal to...                |
| Compare Text        | Is different from...          |
| Compare Text        | Contains...                   |

### Request Body Structure

Unlike the link and/or analysis with a predefined choice of analysis model, for dynamic choice, it is necessary to send a list of objects containing `_id_` (the identifier number of your product or service) and `_value_` (the total or unit value), so that, according to the registered rules, it is identified which model will be used for the analysis.

For the case of choosing the `_Compare Text_` parameter, the fields `_id_` and `_value_` will be of type string.

### Request Example

```json
{
  "parameter_list": [
    {
      "id": 1234,
      "value": 1400
    }
  ]
}
```
```

--------------------------------

### POST /api/token/liveness

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This endpoint is used to create a 3D liveness link. It returns a token and a URL to complete the 3D liveness check, which must be loaded within an IFrame or Web View.

```APIDOC
## POST /api/token/liveness

### Description
This endpoint is used to create a 3D liveness link.

### Method
POST

### Endpoint
/api/token/liveness

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```curl
--location --request POST 'https://apih.tshield.com.br/api/token/liveness'
```

### Response
#### Success Response (200)
- **token** (string) - The identification number of the 3D liveness.
- **qr_code** (string) - Base64 encoded image of the QR code for the liveness link.
- **url** (string) - URL of the 3D liveness link.

#### Response Example
```json
{
  "success": true,
  "data": {
    "token": "c63f7ecc-e550-429d-b25d-127fea82b4d6",
    "qr_code": "/9j/4AAQSkZJRgABAQEAYABgAAD/...",
    "url": "https://livenessh.tshield.com.br/3D/c63f7ecc-e550-429d-b25d-127fea82b4d6/create-query/true"
  }
}
```
```

--------------------------------

### Analysis - Create Analysis (Physical Person)

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Initiates a risk, credit, or KYC analysis for an individual (Pessoa Física). This endpoint requires specific data related to the individual to perform the analysis.

```APIDOC
## POST /create-analysis-pf

### Description
Initiates a risk, credit, or KYC analysis for an individual (Pessoa Física).

### Method
POST

### Endpoint
/create-analysis-pf

### Parameters
#### Request Body
- **client_validation_id** (integer) - Required - The ID of the analysis type configured in the T-Shield panel.
- **cpf** (string) - Required - The individual's CPF (Cadastro de Pessoas Físicas).
- **full_name** (string) - Required - The individual's full name.
- **mother_name** (string) - Optional - The individual's mother's name.
- **birth_date** (string) - Optional - The individual's date of birth (YYYY-MM-DD).

### Request Example
```json
{
  "client_validation_id": 5678,
  "cpf": "12345678900",
  "full_name": "Fulano de Tal",
  "mother_name": "Ciclana da Silva",
  "birth_date": "1990-05-15"
}
```

### Response
#### Success Response (200)
- **analysis_id** (string) - The unique identifier for the created analysis.
- **status** (string) - The initial status of the analysis (e.g., "PENDING").

#### Response Example
```json
{
  "analysis_id": "analysis_abc123",
  "status": "PENDING"
}
```
```

--------------------------------

### Authentication - Login

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

To access the API, you need to perform the T-Shield environment configuration. After registering the company and users, access data for API services will be sent, including Login, Password, and Company. Upon login, a JWT authentication token will be provided, which must be included in the header of subsequent calls.

```APIDOC
## POST /login

### Description
Authenticates a user and returns a JWT token for subsequent API calls.

### Method
POST

### Endpoint
/login

### Parameters
#### Request Body
- **login** (string) - Required - The user's login credential.
- **senha** (string) - Required - The user's password.
- **empresa** (string) - Required - The company identifier.

### Request Example
```json
{
  "login": "user@example.com",
  "senha": "your_password",
  "empresa": "your_company_id"
}
```

### Response
#### Success Response (200)
- **token** (string) - The JWT authentication token.

#### Response Example
```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```
```

--------------------------------

### Analysis - Create Analysis (Legal Entity)

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Initiates a risk, credit, or KYC analysis for a legal entity (Pessoa Jurídica). This endpoint requires specific data related to the company to perform the analysis.

```APIDOC
## POST /create-analysis-pj

### Description
Initiates a risk, credit, or KYC analysis for a legal entity (Pessoa Jurídica).

### Method
POST

### Endpoint
/create-analysis-pj

### Parameters
#### Request Body
- **client_validation_id** (integer) - Required - The ID of the analysis type configured in the T-Shield panel.
- **cnpj** (string) - Required - The company's CNPJ (Cadastro Nacional da Pessoa Jurídica).
- **company_name** (string) - Required - The legal name of the company.
- **fantasy_name** (string) - Optional - The trade name of the company.

### Request Example
```json
{
  "client_validation_id": 9012,
  "cnpj": "11223344000155",
  "company_name": "Empresa Exemplo S.A.",
  "fantasy_name": "Exemplo Ltda."
}
```

### Response
#### Success Response (200)
- **analysis_id** (string) - The unique identifier for the created analysis.
- **status** (string) - The initial status of the analysis (e.g., "PENDING").

#### Response Example
```json
{
  "analysis_id": "analysis_def456",
  "status": "PENDING"
}
```
```

--------------------------------

### Fetch Quiz Questions - JSON Request

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This snippet shows the JSON structure for requesting quiz questions. It requires a query number as input and returns a list of questions with their respective options.

```json
{
  "number": "{{queryNumber}}"
}
```

--------------------------------

### Incluir Device ID JavaScript na Aplicação Web

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Este snippet demonstra como incorporar o script JavaScript fornecido pela T-Shield em sua aplicação web para coletar dados do dispositivo. Ele inclui a inclusão do arquivo de script e uma chamada de exemplo para a função DeviceID.send. Certifique-se de ter o arquivo 'deviceid.prod.min.js' no caminho correto.

```html
<script src="js/deviceid.prod.min.js" type="text/javascript"></script>
<script>
    DeviceID.send('ABc7DEdssf', '98765432100');
</script>
```

--------------------------------

### POST /api/quiz

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This endpoint creates a quiz to aid in the final user identity validation. It requires a pre-existing analysis number.

```APIDOC
## POST /api/quiz

### Description
Creates a quiz for user identity validation. This requires a prior analysis to be created, and the quiz will be linked to the CPF number provided during that analysis. Question configuration must be done on the T-Shield portal.

### Method
POST

### Endpoint
https://apih.tshield.com.br/api/quiz

### Parameters
#### Request Body
- **number** (string) - Required - The analysis number created previously. The quiz will be generated based on the CPF number provided during the analysis creation.

### Request Example
```json
{
  "number": "{{analysisNumber}}"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **data** (object) - Contains details about the created quiz.
  - **id** (string) - The unique identifier for the created quiz.
  - **analysisId** (string) - The identifier of the associated analysis.

#### Response Example
```json
{
  "success": true,
  "data": {
    "id": "quiz-12345",
    "analysisId": "analysis-abcde"
  }
}
```
```

--------------------------------

### Submit Quiz Answers - JSON Request

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This snippet shows the JSON structure for submitting quiz answers. It includes the query number, a list of answers with question IDs, option IDs, and time taken for each answer.

```json
{
  "number": "{{queryNumber}}",
  "answers": [
    {
      "question_id": 13,
      "option_id": 1,
      "time_taken": 10
    },
    {
      "question_id": 10,
      "option_id": 6,
      "time_taken": 10
    },
    {
      "question_id": 2,
      "option_id": 11,
      "time_taken": 10
    }
  ]
}
```

--------------------------------

### Create Link with Predefined Client Validation ID (JSON)

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

This JSON payload is used to create a link for capturing selfie and document images via a predefined analysis model in the POST /Criar Link endpoint. It requires the client_validation_id configured in the control panel, which is unique to the environment. The input specifies the model ID; outputs include the generated link, though limitations apply to production vs. testing environments.

```json
{
  "client_validation_id": 1234
}
```

--------------------------------

### POST /api/quiz/result

Source: https://documenter.getpostman.com/view/1143068/UVeJKQeT/index

Submits the user's quiz answers and returns the calculated score and risk assessment. This endpoint is crucial for evaluating user responses.

```APIDOC
## POST /api/quiz/result

### Description
Submits the user's quiz answers and returns the calculated score and risk assessment. This endpoint is crucial for evaluating user responses.

### Method
POST

### Endpoint
https://apih.tshield.com.br/api/quiz/result

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **number** (string) - Required - The identifier for the quiz analysis.
- **answers** (list) - Required - A list of the user's answers.
  - **question_id** (int) - Required - The identifier of the question.
  - **option_id** (int) - Required - The identifier of the selected option.
  - **time_taken** (int) - Required - The time in seconds the user took to answer.

### Request Example
```bash
curl --location 'https://apih.tshield.com.br/api/quiz/result' \
--header 'Authorization: Bearer {{authToken}}' \
--data '{ 
  "number": "{{queryNumber}}",
  "answers": [
    {
      "question_id": 13,
      "option_id": 1,
      "time_taken": 10
    },
    {
      "question_id": 10,
      "option_id": 6,
      "time_taken": 10
    }
  ]
}'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the quiz result details.
  - **result** (number) - The score achieved by the user.
  - **risk** (string) - A description of the risk associated with the user's operation.
  - **query_status** (int) - The status code of the quiz query.

#### Response Example
```json
{
  "success": true,
  "data": {
    "result": "100,00",
    "risk": "Baixo",
    "query_status": 0
  }
}
```
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.