Criação de Sessão

O objeto de sessão de autenticação é uma entidade que representa o fluxo de autenticação do usuário. Através desse elemento, você poderá gerenciar o processo de coleta das informações de cadastro.

Definição do Objeto Sessão de Autenticação

Request Body

{
  "id": "12345678",
  "document_number": "111.111.111-11",
  "settings": {
    "steps": [
      {
        "step": "device_scan"
      },
      {
        "step":"face_recognition",
      },
      {
        "step":"personal_document",
        "show_success_screen": true,
        "show_introduction_screen": true,
        "document_templates":[
            "rg",
            "cnh",
            "cnh_digital"
        ]
      }
    ],
    "session_expiration_time_in_minutes": 120,
    "token_expiration_seconds": 3600,
    "open_mode": "iframe",
    "finish_screen": {
      "title": "Tudo certo!",
      "message": "Recebemos suas informações e daremos continuidade à sua solicitação."
    }
  }
}

Todas as trocas de informação de uma sessão utilizam a seguinte definição para este objeto

nome	tipo	descrição
id	string	Identificador da sessão. É essencial que este número seja único para cada sessão (obrigatório)
document_number	string	CPF do indivíduo sendo cadastrado, com pontos e hífens, de acordo com a padronização. (obrigatório)
settings	objeto	Objeto com as configurações personalizadas da sessão de autenticação. Caso não seja enviada, será utilizada a configuração padrão da empresa. Quando enviada, substitui a configuração padrão por inteiro: campos ausentes no objeto enviado não são herdados da configuração padrão.

Objeto settings

O objeto settings contém o campo steps que contempla a sequência das etapas de autenticação e suas respectivas configurações: Os possíveis steps aceitos são:

device_scan
face_recognition
personal_document

Além disso são aceitos os seguintes campos:

nome	tipo	descrição
session_expiration_time_in_minutes	integer	Data de expiração da sessão. Após essa data, a sessão não será válida.
token_expiration_seconds	interger	Tempos de expiração do token de sessão em segundos. (deve esstar entre 1 e 172800, máximo de 48 horas. O valor padrão é 1800)
open_mode	string	Define o modo de abertura da sessão, para a mensagem e botões do fuxo de finalização. (deve ser: "iframe" ou "link").
finish_screen	objeto	Personaliza o título e a mensagem da tela exibida ao usuário ao concluir a sessão. Opcional. Veja finish_screen.

finish_screen

O objeto finish_screen substitui os textos padrão da tela final da página web. Os dois campos são opcionais, mas o objeto, quando enviado, deve conter pelo menos um deles.

nome	tipo	descrição
title	string	Título da tela final. Entre 1 e 100 caracteres.
message	string	Mensagem exibida abaixo do título. Entre 1 e 500 caracteres.

Comportamento:

Os textos são exibidos como texto simples: HTML, formatação e quebras de linha não são interpretados.
Um campo ausente mantém o texto padrão correspondente. Sem finish_screen, a tela final exibe os textos padrão.
O botão e a mensagem de fechamento continuam definidos por open_mode.

device_scan

O step de device_scan indica a execução da coleta das informações do dispositivo.
Não possui configurações adicionais

face_recognition

O step de face_recognition indica a execução da coleta do fluxo de prova de vida através da biometria facial.
Não possui configurações adicionais

personal_document

O step de personal_document indica a execução da coleta do fluxo de OCR para leitura de documentos.

nome	tipo	descrição
document_templates	array	Lista de documentos que podem ser coletados no fluxo de cadastro. (obrigatório)
show_success_screen	boolean	Define a existência da tela de sucesso no fluxo de captura de documentos. Valor padrão `true`.
show_introduction_screen	boolean	Define a existência da tela de introdução no fluxo de captura de documentos. Valor padrão `true`.

Possíveis document_templates aceitos:

Nome	Tipo	Descrição
cnh	string	Captura de CNH física FRENTE e VERSO (fechada), em duas etapas
rg	string	Captura de RG físico FRENTE e VERSO (fechado), em duas etapas
cnh_digital	string	Envio de CNH digital (pdf)
passport	string	Envio de Passapore FRENTE e VERSO (fechada), em duas etapas.
rne	string	Envio de Registro Nacional de Estrangeiros FRENTE e VERSO (fechada), em duas etapas.
crnm	string	Envio de Carteira de Registro Nacional Migratório FRENTE e VERSO (fechada), em duas etapas.
ctps	string	Envio de Carteira de Trabalho e Previdência Social FRENTE e VERSO (fechada), em duas etapas.
others	string	Envio de qualquer documento isento de validação FRENTE e VERSO (fechada), em duas etapas.

Enviar um Auth Session

Request Body

  {
    "id": "12345",
    ...
  }

Response Body

  {
    "id": "12345678",
    "status": "pending",
    "expiration_date": "2025-12-11T11:37:15.12-03:00",
    "settings": {
      ...
    },
    "auth_session_hash": "1cFL1vM",
    "step": "device_scan",
    "auth_session_url": "https://auth-session.production.caas.qitech.app/s/1cFL1vM/t/fc0bae39-1c41-4bc2-a5a1-39a7ca01121b",
    "token": "fc0bae39-1c41-4bc2-a5a1-39a7ca01121b",
    "token_expiration_date": "2025-12-10T11:37:15.12-03:00",
  }

Para realizar a criação de uma sessão, basta enviar um objeto do tipo Auth Session ao seguinte endpoint:

POST https://api.caas.qitech.app/auth_session_manager/auth_session

Definição do Objeto Sessão de Autenticação​

Objeto settings​

finish_screen​

device_scan​

face_recognition​

personal_document​

Enviar um Auth Session​