Gestão de Sessão

Ao criar uma sessão de autenticação, basta utilizar o link gerado para iniciar o fluxo de cadastro do usuário. Isso pode ser feito através do envio do link ou do uso dele diretamente em seu website, com ferramentas como iframe.

Objeto de retorno

O objeto de retorno da criação e resgate de uma auth_session contém as seguintes informações:

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": "fc0aaa39-1c21-1bc1-a5a1-39a7ca01121b",
    "token_expiration_date": "2025-12-10T11:37:15.12-03:00",
  }

Esse objeto é retornado no enpoint de resgate da sessão:

GET https://api.caas.qitech.app/auth_session_manager/auth_session/{id}

Descrição do campos de resposta:

nome	tipo	descrição
id	string	Id da sessão.
status	string	Status da sessão.
expiration_date	date	Data de expiração da sessão. Após essa data, a sessão é invalidada.
settings	object	Objeto de configuração da sessão.
auth_session_hash	string	Hash de identificação da sessão.
step	string	Etapa atual do usuário.
auth_session_url	string	Url capaz de coletar as informações do cadastro.
token	string	Token de autenticação da sessão.
token_expiration_date	date	Data de expiração do token temporário de autenticação. Padrão definido para 2 horas após a geração da sessão.

Status

Possíveis status:

• pending
• completed
• expired

Autenticação do fluxo web

Para garantir mais segurança para a aplicação, retornamos um token temporário para a página web. É possível resgatar o token, ou gerar um novo através do endpoint:

POST https://api.caas.qitech.app/auth_session_manager/auth_session/{id}/token

Request Body

  {}

Response Body

  {
    "id": "12345678",
    "token": "e7e99a40-0b26-4bb9-a068-9fa4886eeef3",
    "token_expiration_date": "2025-12-10T13:37:15.12-03:00",
  }

Assim, caso o token tenha expirado, é possível seguir com a sessão de autenticação gerando um novo token.

Comunicação com a página web

A página web poderá ser integrada através de uma ferramenta chamada iframe. Da seguinte maneira:

<iframe id="iframe" src="" href="{auth_session_url}"></iframe>

Caso o link seja chamado dessa maneira, a página web irá enviar mensagens de retorno para a página que a requisitou. As possíveis mensagens de retorno são:

• success
• canceled
• invalid_token
• expired

Que podem ser acessadas da seeguinte maneira:

window.addEventListener("message", (event) => {
            if (event.data === "canceled") {
              //close iframe
            }
            if (event.data === "invalid_token") {
              //close iframe
            }
            if (event.data === "success") {
              //close iframe
            }  
            if (event.data === "expired") {
              //close iframe
            }
        });

Finalização do fluxo

Recuperação de um cadastro - GET

Este serviço está diretamente integrado com o servico de análise de pessoa física. Portanto, a coleta dos resultados da sessão de autenticação é realizada diretamente da API de Análise Cadastral

Através do endpoint:

GET https://api.caas.qitech.app/onboarding/natural_person/12345678

Em que o id será o mesmo definido no processo de criação da sessão de autenticação.

Recuperação de um cadastro - Webhook

É possível configurar um webhook para receber a informação de finalização da análise cadastral e seu status de análise. Para mais informações, consulte o módulo de webhook para análise cadastral (Webhook).