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

Connect user information

Even if the user doesn't enter it directly, you can safely fetch the necessary information from Toss. For example, when sending a parcel, even if the user doesn't individually enter their name, mobile phone number, address, and so on, you can fetch the information stored in Toss right away after consent.

Please be sure to check

  • Fetching user information is a separate feature from Toss Loginand can be used without Toss Login.

  • To the user Consent to provide personal information to third partiesOnly after receiving it is the information delivered.

  • The exposure timing can be up to 5can be registered.

  • It can be used without a separate server, and SDK v2.7.0 or later.


1. Access Fetching User Information

Please go to the Fetching User Information menu in the console.

  • How to access: Apps in Toss console → Select workspace → Select mini-app → Left menu 'Fetch User Information'

When you first access it, an empty screen with no registered information will appear. Register Please press the button to start setup.


Set when to request consent to provide information to the user. Please write the title according to the situation where user information is needed within the service.

Consent screen title

This is the title shown on the consent screen. After the entered text, "Would you like to fetch the necessary information when " is automatically added. For example, send a parcelif you enter "Would you like to fetch the necessary information when sending a parcel?" is displayed to the user.

User information to fetch

Please select the user information to fetch at that time. The selectable items are as follows. User information is fetched from the information in the Toss app → Settings → My Info · Address Management.

Item
Description
Notes

Name

User name

Gender

User gender

Korean national/Foreigner

Whether the user is a Korean national or a foreigner

Date of birth

User date of birth

Mobile phone number

User mobile phone number

Address

User home address

Because it is not required when signing up for Toss, there may be no value, and in that case it is passed as null.

Email address

User email address

Because it is not required when signing up for Toss, there may be no value, and in that case it is passed as null.

Add exposure timing

If there are multiple points in the service where user information is needed, Add exposure timing you can add a timing with the button. Maximum 5can be registered. You can set different user information to fetch for each timing. For example, when shipping a parcel, you can request name, mobile phone number, and address; when verifying identity, you can request only name and date of birth.


The consent statement shown to the user is Consent to provide personal information to third parties automatically generated in the form of View You can preview the full consent statement content by pressing the button.


4. Set up callback (optional)

If a user withdraws from the mini-app, the withdrawal event is delivered to the registered callback URL. After receiving the event, please destroy that user's information.

Callbacks are optional. To use a callback, set the toggle to ONto.

Callback URL

Please enter the URL that will receive withdrawal events.

HTTP method

Select the HTTP method to use when calling the callback GET or POST Choose one.

Basic Auth header

This is the authentication information included in the HTTP header when calling the callback. Authorization: Basic {entered value} is delivered in the form of

Callback test

Before saving the settings, Test Please use the button to check whether the callback is working properly. You can save only after the test succeeds.


5. Registration complete and copy the code

Once registration is complete, for each exposure timing cud_a unique code starting withconsentedUserDataKey) is generated. This code is used in the SDK to fetch user information. Please click the copy icon to copy the code.

After registration, you can see the exposure timing, user information to fetch, and code at a glance on the consent statement information screen. Edit You can change the settings with the button.


6. Revoke

The consent statement you agreed to can be revoked at the path below. Individual revocation is possible.

  • How to revoke: Toss app → Settings → Terms and Privacy Policy Consent → Mini-app name


Integrate development

User information >

You can fetch user information through the SDK.