Identify a device
Gets the identity of the current device. Each device identity is unique across your entire project. Any devices that share the same identity can be safely assumed to be a single physical device. Note that some client SDKs might not need all the parameters and will take care of them automatically for you.
Normally you only want to use this if you don't have the user ID available. For example, if the user can purchase or do an action on your application without being logged in. If you have the user ID available, you nearly always want to use the attach function instead.
Parameters
SDK Specific The parameters may not be similar in all SDKs. The mobile SDKs, for example, take care of most the parameters for you.
Client ID REQUIRED
The string client ID of your project's API key.
Secret
The signed token for this user. Use this if and only if you are following the advanced security guide.
- Default:
undefined
Metadata
A key-value object that will be stored. This is useful if you want to store additional data. This will be available in all webhooks touching this object.
- Default:
undefined
Returns
This function returns a DeviceIdentity object.
SDK Syntax
const { identity, confidence } = await identify({ client_id: `your_app_client_id`,});