Skip to main content
POST
/
api
/
v1
/
users
/
identify
Identify user
curl --request POST \
  --url https://my.learn.ink/api/v1/users/identify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "your_unique_user_id",
  "orgId": "acme",
  "data": {
    "firstName": "Mary",
    "lastName": "Kamau",
    "country": "Kenya",
    "region": "Kisumu",
    "sex": "female",
    "ageBracket": "18-24",
    "userGroups": [
      "field-agents",
      "nairobi-region"
    ]
  }
}
'
{
  "id": "your_unique_user_id",
  "data": {
    "userId": "a_unique_id",
    "registrationStatus": "registered",
    "lastActive": "2025-08-14T15:12:34+00:00",
    "registeredAt": "2025-05-02T09:23:32+00:00",
    "firstName": "Mary",
    "lastName": "Kamau",
    "country": "Kenya",
    "region": "Kisumu",
    "sex": "female",
    "ageBracket": "18-24",
    "userGroups": [
      "field-agents",
      "nairobi-region"
    ],
    "learningPathId": "id1234",
    "learningPathName": "Field Agent Onboarding",
    "learningPathStartDate": "2025-08-12",
    "learningPathDueDate": "2025-08-15",
    "learningPathCompletedAt": "2025-08-14T14:42:46+00:00"
  },
  "token": "a_unique_sign_in_token"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
id
string
required

Your unique identifier for this user.

orgId
string
required

Your LearnInk organisation ID.

data
object

Optional user profile data to create or update.

Response

Success

id
string
required

The user identifier you passed in the request.

data
object
required
token
string
required

A short-lived sign-in token. Use immediately — do not cache.