UserInfo
Create an object that contains user information
const response = await fetch(/* arguments to fetch the OpenID userinfo endpoint */)
.then(data => data.json())
const userInfo = new UserInfo(response)
// ... or
const userInfo = user.info()
Get an unique identifier about the user.
const identifier = userInfo.id()
Get an unique identifier about the user.
const identifier = userInfo.sub()
Get the user's first name.
const firstName = userInfo.firstName()
Get the user's last name.
const lastName = userInfo.lastName()
Get the user's birth date.
const birthDate = userInfo.birthDate()
// birthDate is a JavaScript Date object
Get the user's unique national identifier (for example their SSN in the US).
const nationalId = userInfo.nationalId()
Get the user's Vulos Identity trust level.
1
indicates that the user has done no KYC verification but has provided basic details.2
indicates that the user has successfully KYC verification.- Anything other than that indicates that the user has done some action to reduce or increase their trust level that hasn't been specified in this document.
if (userInfo.trustLevel() >= 2) {
// allow the user to preform some action limited
// to users that have confirmed their identity
}
Get the user's email verification status.
if (userInfo.isEmailVerified()) {
// allow the user to use that email for some action
}
Get the user's KYC verification status.
if (userInfo.isKycVerified()) {
// allow the user to do some action that requires
// KYC verification or a confirmed identity
}
Get the user's address.
const addressObj = userInfo.address()
Get the user's email address.
const email = userInfo.email()
Check if the user has a specific role in the associated organization to the application.
if (userInfo.hasRole('SuperAdmin')) {
// allow the user to have elevated access
}
Check if the user is in a specific organization by name.
if (userInfo.isInOrganizationWithName('My Organization')) {
// the user is in an organization with name 'My Organization'
}
Check if the user is in a specific organization by id.
You can obtain the organization ID using the Organization API or by checking the URL of the organization's page on the Vulos Identity dashboard.
const organizationId = 100;
if (userInfo.isInOrganizationWithId(organizationId)) {
// the user is in the organization with ID 100
}
Get the user's Ethereum wallet addresses.
for (const walletAddress of userInfo.wallets()) {
// do something with the wallet address
}
Get the user's profile picture.
const profilePictureUrl = userInfo.picture()
Last modified 1yr ago