For the complete documentation index, see llms.txt. This page is also available as Markdown.

对接用户信息

即使用户不亲自输入,也可以从 Toss 安全地获取所需信息。例如,发送包裹时,姓名、手机号码、地址等无需用户逐一输入,经过同意后即可直接调取保存在 Toss 中的信息。

请务必确认

  • 用户信息获取 与 Toss 登录无关的功能。即使没有 Toss 登录也可以使用。

  • 向用户 个人信息第三方提供同意后才会传递信息。

  • 露出时点最多 5个可注册。

  • 可在无需单独服务器的情况下使用,并且 SDK v2.7.0 及以上可用。


1. 进入获取用户信息

请在控制台中进入获取用户信息菜单。

  • 进入方法: Apps in Toss 控制台 → 选择工作区 → 选择迷你应用 → 左侧菜单 “获取用户信息”

首次进入时,会显示尚未注册信息的空白页面。 注册 请点击按钮开始设置。


2. 设置同意文案露出时点

设置向用户请求信息提供同意的时点。请根据服务内需要用户信息的场景来撰写标题。

同意画面标题

这是显示在同意画面上的标题。在输入的文本后面会自动加上 “需要时要获取所需信息吗?” 。例如, 要发送包裹后输入时,向用户会显示为 “要发送包裹时要获取所需信息吗?”

要获取的用户信息

请选择在该时点要获取的用户信息。可选择的项目如下。用户信息会从 Toss App → 设置 → 我的信息 · 地址管理中的信息中获取。

项目
说明
备注

姓名

用户姓名

性别

用户性别

本国人/外国人

是否为本国人/外国人

出生日期

用户出生日期

手机号码

用户手机号码

地址

用户家庭地址

在注册 Toss 时不是必填项,因此可能没有值,这种情况下会传递为 null。

电子邮件地址

用户电子邮件地址

在注册 Toss 时不是必填项,因此可能没有值,这种情况下会传递为 null。

添加露出时点

如果服务内需要用户信息的时点有多个, 添加露出时点 可以通过按钮添加时点。 5个最多可注册。可为每个时点设置不同的要获取的用户信息。例如,发送包裹时可请求姓名·手机号码·地址,进行本人认证时可只请求姓名·出生日期。


3. 确认同意文案内容

向用户显示的同意文案是 个人信息第三方提供同意 会自动按格式生成。会根据所选用户信息项目自动构成同意文案内容。 查看 点击按钮即可预览同意文案的全部内容。


4. 设置回调(可选)

当用户在迷你应用中注销会员时,已注册的回调 URL 会接收到注销事件。收到事件后,请销毁该用户的信息。

回调是可选项。若要使用回调,请将开关 ON设置为

回调 URL

请输入接收注销事件的 URL。

HTTP 方法

回调调用时使用的 HTTP 方法 GETPOST 中请选择。

Basic Auth 标头

这是回调请求时包含在 HTTP 标头中的认证信息。 以 Authorization: Basic {输入的值} 的形式传递。

回调测试

在保存设置之前, 测试 请点击按钮确认回调是否正常运行。必须测试成功后才能保存。


5. 完成注册并复制代码

注册完成后,每个露出时点都会 cud_作为开头的唯一代码(consentedUserDataKey)会生成。该代码在 SDK 中获取用户信息时使用。请点击复制图标复制代码。

注册后,可在同意文案信息画面一眼查看露出时点、要获取的用户信息和代码。 修改 可通过按钮更改设置。


6. 撤回

已同意的同意文案可在以下路径撤回。可单独撤回。

  • 撤回方法: Toss App → 设置 → 条款及个人信息处理同意 → 迷你应用名称


进行开发对接

用户信息 >

可以通过 SDK 获取用户信息。