创建会话

认证会话对象是一个表示用户认证流程的实体。通过此元素，您可以管理注册信息收集过程。

认证会话对象定义

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

会话的所有信息交换均使用以下对象定义

名称	类型	描述
id	string	会话标识符。此编号对每个会话必须唯一（必填）
document_number	string	被注册个人的 CPF，含点和连字符，符合标准格式。（必填）
settings	对象	包含认证会话自定义配置的对象。如未发送，将使用公司默认配置。如发送，则会完整替换默认配置：所发送对象中缺少的字段不会从默认配置中继承。

settings 对象

settings 对象包含 steps 字段，该字段定义认证步骤的顺序及其各自的配置：可接受的步骤包括：

device_scan
face_recognition
personal_document

此外还接受以下字段：

名称	类型	描述
session_expiration_time_in_minutes	integer	会话过期时间。超过此时间后，会话将不再有效。
token_expiration_seconds	integer	会话令牌的过期时间（秒）。（必须在 1 到 172800 之间，最大 48 小时。默认值为 1800）
open_mode	string	定义会话的打开方式，用于完成流程的消息和按钮。（必须为 "iframe" 或 "link"）。
finish_screen	对象	自定义会话完成时向用户显示的页面的标题和消息。可选。参见 finish_screen。

finish_screen

finish_screen 对象用于替换网页最终页面的默认文本。两个字段均为可选，但发送该对象时必须至少包含其中一个字段。

名称	类型	描述
title	string	最终页面的标题。长度为 1 到 100 个字符。
message	string	显示在标题下方的消息。长度为 1 到 500 个字符。

行为说明：

文本以纯文本形式显示：不会解析 HTML、格式或换行。
缺少的字段将保留对应的默认文本。未发送 finish_screen 时，最终页面显示默认文本。
关闭按钮和关闭消息仍由 open_mode 决定。

device_scan

device_scan 步骤表示执行设备信息收集。
无附加配置

face_recognition

face_recognition 步骤表示通过面部生物识别执行活体证明流程的收集。
无附加配置

personal_document

personal_document 步骤表示执行用于文件读取的 OCR 收集流程。

名称	类型	描述
document_templates	array	在注册流程中可收集的文件列表。（必填）
show_success_screen	boolean	定义文件捕获流程中是否存在成功画面。默认值 `true`。
show_introduction_screen	boolean	定义文件捕获流程中是否存在简介画面。默认值 `true`。

可接受的 document_templates 类型：

名称	类型	描述
cnh	string	分两步捕获物理驾驶证正面和背面（合拢状态）
rg	string	分两步捕获物理身份证正面和背面（合拢状态）
cnh_digital	string	上传数字版驾驶证（pdf）
passport	string	分两步上传护照正面和背面（合拢状态）。
rne	string	分两步上传外国人国家注册证正面和背面（合拢状态）。
crnm	string	分两步上传国家移民注册卡正面和背面（合拢状态）。
ctps	string	分两步上传工作和社会保障手册正面和背面（合拢状态）。
others	string	分两步上传任何无需验证的文件正面和背面（合拢状态）。

发送 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",
  }

要创建会话，只需将 Auth Session 类型的对象发送到以下端点：

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

认证会话对象定义​

settings 对象​

finish_screen​

device_scan​

face_recognition​

personal_document​

发送 Auth Session​