Get identities from a user
Path parameters
userIdstringRequired
The id of the user to get identities for.
Header parameters
Brand-URLstringRequiredExample:
The brand URL of the request. This is used to identify the brand.
YOUR_BRAND_URL
Auth-KeystringRequiredExample:
This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.
YOUR_AUTH_KEY
Responses
200
The request was successful.
application/json
401
The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.
application/json
404
The user was not found in the system.
application/json
get
GET /api/v1/users/{userId}/identities HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*
{
"success": true,
"statusCode": 200,
"message": "The request was successful.",
"data": [
{
"appIntegration": {
"type": "PaymentGateway",
"name": "Stripe",
"domain": "https://stripe.com",
"description": "Stripe payment gateway",
"logoURL": null,
"status": "Active",
"id": "sApKpllz4sAplsmzha"
},
"userId": "sApKpllz4sAplsmzha",
"metadata": "example-metadata",
"lastLoginAt": "2025-09-12T08:18:49.788655Z",
"id": "sApKpllz4sAplsmzha",
"createdDate": "2025-09-12T08:18:49.788655Z"
}
],
"errors": []
}
Last updated
Was this helpful?