Last updated
Was this helpful?
Last updated
Was this helpful?
The IdentityManager
is responsible for managing the identity of the current user. It allows to identify the user, update its attributes, and send verification requests.
To access IdentityManager
, you can use the contact
property of the SDK instance.
The anonymousId is a unique identifier for the current user. It is used to track the user before they are identified.
string
The contactId
represents the current user's contact id. This is the unique identifier within Bird CRM that is assigned to the user once they are identified.
string
The isVerified
property indicates whether the user has been identified and verified using a trusted verification method.
boolean
Returns the current contact information.
Promise
<ContactsContactMeResponse
>
The identify method is how you tell Bird CRM who the current visitor is. It includes a unique user ID, and any optional attributes you know about them. There's no need to call identify for anonymous visitors. The SDK automatically assigns them a visitor ID, so tracking events works just fine without having to identify the visitor.
💡 Make sure to call identify as soon as a visitor is identified either as a new user or a returning user. This will ensure that all events are correctly associated with the visitor.
• claim: ContactIdentifierClaim
• contactAttributes?: ContactsVerificationsV2RequestContactAttributes
Promise
<{ accessToken
: res.token
; contactId
: res.contactId
; identifierKeys
: res.identifierKeys
; } | { accessToken
: undefined
| string
; contactId
: string
; }>
To create a new contact with some known identifiers, you can call identify as:
Refreshes the anonymousId for the current user.
Promise
<void
>
To refresh the anonymousId, you can call refreshAnonymousId
as:
Sends a verification request to the current user. The verification request is used to verify the user's identity using a trusted verification method like OTP.
• verificationRequest: OTPVerificationRequest
Promise
<{ expiresAt
: res.expiresAt
; id
: res.id
; }>
expiresAt
id
To send an OTP verification request to the current user, you can call sendVerificationRequest
as:
Updates the current contact information.
• attributes: Record
<string
, any
>
Promise
<ContactsContactMeResponse
>