Identify Person
Header Parameters
x-distinct-id*string
x-publishable-key*string
x-client-bundle-id*string
x-client-locale?string|null
x-client-version?string|null
x-is-backgrounded*"false"
Value in
- "false"
x-is-debug-build*string
Value in
- "true"
- "false"
x-nonce?string|null
x-observer-mode*string
Value in
- "true"
- "false"
x-platform*string
x-platform-brand?string|null
x-platform-device?string|null
x-platform-flavor*string
Value in
- "native"
- "browser"
x-platform-flavor-version?string|null
x-platform-version?string|null
x-preferred-locales?string|null
x-sdk*string
Value in
- "react-native"
- "web"
x-sdk-version*string
x-storefront?string|null
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
distinctId*string
email?string|null
name?string|null
traits?|null
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/sdk/identify" \ -H "x-distinct-id: string" \ -H "x-publishable-key: string" \ -H "x-client-bundle-id: string" \ -H "x-is-backgrounded: false" \ -H "x-is-debug-build: true" \ -H "x-observer-mode: true" \ -H "x-platform: string" \ -H "x-platform-flavor: native" \ -H "x-sdk: react-native" \ -H "x-sdk-version: string" \ -H "Content-Type: application/json" \ -d '{ "distinctId": "string" }'{ "distinctId": "string", "email": "string", "entitlements": { "grants": [ { "expiresAt": "string", "perkId": "string", "source": "subscription", "sourceId": "string", "sourcePersonId": "string", "status": "active" } ] }, "name": "string", "personId": "string", "purchases": { "history": [ { "createdAt": "string", "productId": "string", "providerKey": "string", "purchaseId": "string", "sourcePersonId": "string", "type": "one_time" } ] }, "snapshotContext": { "includedPersonIds": [ "string" ], "migrationJobId": "string", "mode": "persisted" }, "subscriptions": { "current": { "expiresAt": "string", "productId": "string", "status": "none", "subscriptionId": "string" }, "history": [ { "canceledAt": "string", "expiresAt": "string", "isTrial": true, "productId": "string", "sourcePersonId": "string", "startsAt": "string", "status": "active", "subscriptionId": "string" } ] }}{ "_tag": "Api/SdkValidationError", "message": "string"}{ "_tag": "Api/SdkPersonNotFoundError", "message": "string"}{ "_tag": "Api/SdkPersonAlreadyIdentifiedError", "distinctId": "string"}{ "_tag": "Api/AuthenticationError", "cause": "string", "message": "string"}