Identify
Public API endpoints for the Identify Extension
Public API endpoints by provider:
Custom providers or implementations can also be added by arrangement.
AWS Cognito
Project id
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
Strategy
email
Strategy
awsCognito
GET /v1/user HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"result": 1,
"message": "OK",
"data": {
"data": {
"username": "burger1111111",
"email": "[email protected]",
"custom:terms_optin1": "1",
"custom:terms_optin2": "1",
"nickname": "burger1111111",
"userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
"loginHistory": [
1633435562,
1633435763
]
},
"custom:terms_optin2": "1",
"custom:terms_optin1": "1",
"updatedAt": "1633430188",
"nickname": "burger1111111",
"email": "[email protected]",
"devices": [
{
"deviceId": "16713b2d-3848-42c7-aeb0-f9714beac892",
"lastLogin": 1633435763,
"signUp": 1633435560,
"userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
"timeStamp": 1633435760,
"signature": "41C96E76084CDAAC46268995187AF3827258CCA3"
},
{
"deviceId": "a055da77-dcfe-4969-ae49-32c501f14e8a"
}
]
}
}
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
email
awsCognito
{"email":"[email protected]","password":"bID>idfsf23!"}
POST /v1/user HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Content-Type: application/json
Accept: */*
Content-Length: 154
{
"projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7",
"strategy": "email",
"provider": "awsCognito",
"data": {
"email": "[email protected]",
"password": "bID>idfsf23!"
}
}
{
"result": 1,
"message": "User is Correctly Created",
"data": {
"data": {},
"result": 1,
"message": "User is Correctly Created"
}
}
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
email
awsCognito
{"email":"[email protected]","nickname":"testUserCognito"}
PUT /v1/user HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 157
{
"projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7",
"strategy": "email",
"provider": "awsCognito",
"data": {
"email": "[email protected]",
"nickname": "testUserCognito"
}
}
{
"result": 1,
"message": "User is Correctly Created",
"data": {
"email": "[email protected]",
"username": "Baratrum1112323445",
"externalId": "42da3617-268b-4459-b460-3efda3db5513",
"projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7"
}
}
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
email
awsCognito
{"password":"bID>idfsf23!!","previousPassword":"bID>idfsf23!"}
PUT /v1/user/change-password HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 165
{
"projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7",
"strategy": "email",
"provider": "awsCognito",
"data": {
"password": "bID>idfsf23!!",
"previousPassword": "bID>idfsf23!"
}
}
{
"result": 1,
"message": "password has been updated",
"data": {
"deviceId": "789f64dc-750d-4260-afef-7937062048e3",
"timeStamp": 1614788250,
"signature": "C4B23C2801C19B76C3DE7432B86B818D1D63C7C6",
"externalId": "6432a1c6a7dd85071d79a3ccb651a095ca1abb139189492fc0e53fb427c1a036",
"userId": "99b5e0ae-60b8-4667-8741-f4e1486d2b3a",
"accessToken": "jwtAccessToken",
"profileToken": "jwtProfileToken",
"refreshToken": "jwtRefreshToken",
"signUp": 1614788100
}
}
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
email
awsCognito
{"email":"[email protected]!"}
PUT /v1/user/forgot-password HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129
{
"projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7",
"strategy": "email",
"provider": "awsCognito",
"data": {
"email": "[email protected]!"
}
}
{
"result": 1,
"message": "please check your email",
"data": {}
}
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
email
awsCognito
{"email":"[email protected]","confirmationCode":"671848","password":"bID>idfsf23!"}
POST /v1/user/confirm-forgot-password HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182
{
"projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7",
"strategy": "email",
"provider": "awsCognito",
"data": {
"email": "[email protected]",
"confirmationCode": "671848",
"password": "bID>idfsf23!"
}
}
{
"result": 1,
"message": "please check your email",
"data": {}
}
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
email
awsCognito
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
stringstring
POST /v1/user/refresh HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 175
{
"projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7",
"strategy": "email",
"provider": "awsCognito",
"deviceId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7",
"refreshToken": "stringstring"
}
{
"result": 1,
"message": "please check your email",
"data": {}
}
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
email
awsCognito
POST /v1/user/logout HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 95
{
"projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7",
"strategy": "email",
"provider": "awsCognito"
}
{
"result": 1,
"message": "please check your email",
"data": {}
}
this method logins user
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
email
awsCognito
{"email":"[email protected]","password":"bID>idfsf23!"}
PUT /v1/user/login HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Content-Type: application/json
Accept: */*
Content-Length: 154
{
"projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7",
"strategy": "email",
"provider": "awsCognito",
"data": {
"email": "[email protected]",
"password": "bID>idfsf23!"
}
}
{
"result": 1,
"message": "OK",
"data": {
"deviceId": "789f64dc-750d-4260-afef-7937062048e3",
"timeStamp": 1614788250,
"signature": "C4B23C2801C19B76C3DE7432B86B818D1D63C7C6",
"externalId": "6432a1c6a7dd85071d79a3ccb651a095ca1abb139189492fc0e53fb427c1a036",
"userId": "99b5e0ae-60b8-4667-8741-f4e1486d2b3a",
"accessToken": "jwtAccessToken",
"profileToken": "jwtProfileToken",
"refreshToken": "jwtRefreshToken",
"signUp": 1614788100
}
}
Project id
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
Strategy
email
Strategy
awsCognito
device id
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
GET /v1/user/check HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"result": 1,
"message": "OK",
"data": {
"data": {
"username": "burger1111111",
"email": "[email protected]",
"custom:terms_optin1": "1",
"custom:terms_optin2": "1",
"nickname": "burger1111111",
"userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
"loginHistory": [
1633435562,
1633435763
]
},
"custom:terms_optin2": "1",
"custom:terms_optin1": "1",
"updatedAt": "1633430188",
"nickname": "burger1111111",
"email": "[email protected]",
"devices": [
{
"deviceId": "16713b2d-3848-42c7-aeb0-f9714beac892",
"lastLogin": 1633435763,
"signUp": 1633435560,
"userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
"timeStamp": 1633435760,
"signature": "41C96E76084CDAAC46268995187AF3827258CCA3"
},
{
"deviceId": "a055da77-dcfe-4969-ae49-32c501f14e8a"
}
]
}
}
Auth0
Project id
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
Strategy
email
Strategy
authZero
GET /v1/user HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"result": 1,
"message": "OK",
"data": {
"username": "testUserAuthZero",
"appProfile": {
"data": "customUserObjectGoesHere"
},
"loginHistory": [
1633435562,
1633435763
]
}
}
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
email
authZero
{"username":"testUserAuthZero","appProfile":{"data":"customUserObjectGoesHere"}}
PUT /v1/user HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 181
{
"projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7",
"strategy": "email",
"provider": "authZero",
"data": {
"username": "testUserAuthZero",
"appProfile": {
"data": "customUserObjectGoesHere"
}
}
}
{
"result": 1,
"message": "User is Correctly Created",
"data": {
"externalId": "42da3617-268b-4459-b460-3efda3db5513",
"projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7",
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"appProfile": {
"data": "customUserObjectGoesHere"
}
}
}
Project id
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
Strategy
email
Strategy
authZero
device id
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
GET /v1/user/check HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"result": 1,
"message": "OK",
"data": {
"username": "testUserAuthZero",
"appProfile": {
"data": "customUserObjectGoesHere"
},
"loginHistory": [
1633435562,
1633435763
]
}
}
Anonymous
By passing in the appropriate parameters it will register a new user to the anonymous strategy
5d5b0676-ce0f-4058-b2bf-49af49f61cb5
simplified
Possible values: anonymous
{"deviceId":"789f64dc-750d-4260-afef-7937062048e3","additionalId":"12345677865"}
POST /v1/user HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Content-Type: application/json
Accept: */*
Content-Length: 187
{
"projectId": "5d5b0676-ce0f-4058-b2bf-49af49f61cb5",
"strategy": "simplified",
"provider": "anonymous",
"data": {
"deviceId": "789f64dc-750d-4260-afef-7937062048e3",
"additionalId": "12345677865"
}
}
{
"result": 1,
"message": "User is Correctly Created",
"data": {
"deviceId": "789f64dc-750d-4260-afef-7937062048e3",
"timeStamp": 1614788100,
"signature": "3AE9859EFC488CB58EF3590A44395A33C2519991",
"externalId": "6432a1c6a7dd85071d79a3ccb651a095ca1abb139189492fc0e53fb427c1a036",
"userId": "99b5e0ae-60b8-4667-8741-f4e1486d2b3a",
"signUp": 1614788100,
"isNew": true
}
}
this method updates user data fields
5d5b0676-ce0f-4058-b2bf-49af49f61cb5
simplified
Possible values: anonymous
PUT /v1/user/login HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Content-Type: application/json
Accept: */*
Content-Length: 238
{
"projectId": "5d5b0676-ce0f-4058-b2bf-49af49f61cb5",
"strategy": "simplified",
"provider": "anonymous",
"data": {
"externalId": "5cc308b4beeb88f837833d5d8edcb0a94ea3d708723de758ec47944387b04157",
"deviceId": "789f64dc-750d-4260-afef-7937062048e3"
}
}
{
"result": 1,
"message": "OK",
"data": {
"deviceId": "789f64dc-750d-4260-afef-7937062048e3",
"timeStamp": 1614788250,
"signature": "C4B23C2801C19B76C3DE7432B86B818D1D63C7C6",
"externalId": "6432a1c6a7dd85071d79a3ccb651a095ca1abb139189492fc0e53fb427c1a036",
"userId": "99b5e0ae-60b8-4667-8741-f4e1486d2b3a",
"signUp": 1614788100
}
}
NoLogin
M/IC project id
5d5b0676-ce0f-4058-b2bf-49af49f61cb5
unique user identifier
0fdb53e30444b0ace4976d1604766123a574555ee42e4e17974805b186e37be4
authentication strategy
simplified
authentication provider
noLogin
GET /v1/user HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Accept: */*
{
"strategy": "simplified",
"provider": "noLogin",
"projectId": "5d5b0676-ce0f-4058-b2bf-49af49f61cb5",
"externalId": "0fdb53e30444b0ace4976d1604766123a574555ee42e4e17974805b186e37be4",
"data": {
"username": "Harvey",
"loginHistory": [
1
],
"appProfile": {
"events": {
"match_one": {
"score": 123,
"claims": [
"pro",
"lucky_dip"
]
},
"match_x": {
"screen_name": "@seebar",
"avatar": "https://www.google.com/url?sa=i&url=https%3A%2F%2Fwww.digitalspy.com%2Fmovies%2Fa34292276%2Favatar-2-navi-new-sign-language%2F&psig=AOvVaw2k_99ZjdehAGFTh7_3OynI&ust=1633432432837000&source=images&cd=vfe&ved=0CAsQjRxqFwoTCOiYqJLQsPMCFQAAAAAdAAAAABAJ",
"level": 99
}
},
"validation_key": "9c0c036b6678f663ab6a3b6e75d58abe90cfd6697a9dad381711ed98d2866c8decaa1f57ba6f66e64cac642f3be783cfb58affde4c6262f04a638e78ed7306ce"
}
},
"result": 1,
"message": "ok"
}
authentication strategy
simplified
authentication provider
noLogin
M/IC project id
5d5b0676-ce0f-4058-b2bf-49af49f61cb5
POST /v1/user HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Content-Type: application/json
Accept: */*
Content-Length: 126
{
"strategy": "simplified",
"provider": "noLogin",
"projectId": "5d5b0676-ce0f-4058-b2bf-49af49f61cb5",
"data": {
"username": "Harvey"
}
}
{
"data": {
"deviceId": "7f06fd89-4063-4c60-90e8-dcb48c3d6e47",
"timeStamp": 1633433370,
"signature": "ABEA9F45EAAD40D5AB59D174AADAB15D7A216083",
"externalId": "0fdb53e30444b0ace4976d1604766123a574555ee42e4e17974805b186e37be4",
"userId": "14b44577-651b-48c4-b937-abdb68ad7151",
"signup": 1633433370,
"isNew": true,
"username": "Harvey"
},
"result": 1,
"message": "ok"
}
authentication strategy
simplified
authentication provider
noLogin
M/IC project id
5d5b0676-ce0f-4058-b2bf-49af49f61cb5
unique user identifier
0fdb53e30444b0ace4976d1604766123a574555ee42e4e17974805b186e37be4
PUT /v1/user HTTP/1.1
Host: m-id-service-loadtest.monterosa.cloud
Content-Type: application/json
Accept: */*
Content-Length: 722
{
"strategy": "simplified",
"provider": "noLogin",
"projectId": "5d5b0676-ce0f-4058-b2bf-49af49f61cb5",
"externalId": "0fdb53e30444b0ace4976d1604766123a574555ee42e4e17974805b186e37be4",
"data": {
"appProfile": {
"events": {
"match_one": {
"score": 123,
"claims": [
"pro",
"lucky_dip"
]
},
"match_x": {
"screen_name": "@seebar",
"avatar": "https://www.google.com/url?sa=i&url=https%3A%2F%2Fwww.digitalspy.com%2Fmovies%2Fa34292276%2Favatar-2-navi-new-sign-language%2F&psig=AOvVaw2k_99ZjdehAGFTh7_3OynI&ust=1633432432837000&source=images&cd=vfe&ved=0CAsQjRxqFwoTCOiYqJLQsPMCFQAAAAAdAAAAABAJ",
"level": 99
}
},
"validation_key": "9c0c036b6678f663ab6a3b6e75d58abe90cfd6697a9dad381711ed98d2866c8decaa1f57ba6f66e64cac642f3be783cfb58affde4c6262f04a638e78ed7306ce"
}
}
}
{
"strategy": "simplified",
"provider": "noLogin",
"projectId": "5d5b0676-ce0f-4058-b2bf-49af49f61cb5",
"externalId": "0fdb53e30444b0ace4976d1604766123a574555ee42e4e17974805b186e37be4",
"data": {
"username": "Harvey",
"loginHistory": [
1
],
"appProfile": {
"events": {
"match_one": {
"score": 123,
"claims": [
"pro",
"lucky_dip"
]
},
"match_x": {
"screen_name": "@seebar",
"avatar": "https://www.google.com/url?sa=i&url=https%3A%2F%2Fwww.digitalspy.com%2Fmovies%2Fa34292276%2Favatar-2-navi-new-sign-language%2F&psig=AOvVaw2k_99ZjdehAGFTh7_3OynI&ust=1633432432837000&source=images&cd=vfe&ved=0CAsQjRxqFwoTCOiYqJLQsPMCFQAAAAAdAAAAABAJ",
"level": 99
}
},
"validation_key": "9c0c036b6678f663ab6a3b6e75d58abe90cfd6697a9dad381711ed98d2866c8decaa1f57ba6f66e64cac642f3be783cfb58affde4c6262f04a638e78ed7306ce"
}
},
"result": 1,
"message": "ok"
}
Twitter
Project id
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
Strategy
email
authentication provider
twitter
user id
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
twitter issued JWT token
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
GET /v1/user/check/nonstandard HTTP/1.1
Host: m-id-public-api-dev-int24.lvis.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"result": 1,
"message": "OK",
"data": {
"updatedAt": "1633430188",
"nickname": "burger1111111",
"email": "[email protected]",
"devices": [
{
"deviceId": "16713b2d-3848-42c7-aeb0-f9714beac892",
"lastLogin": 1633435763,
"signUp": 1633435560,
"userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
"timeStamp": 1633435760,
"signature": "41C96E76084CDAAC46268995187AF3827258CCA3"
},
{
"deviceId": "a055da77-dcfe-4969-ae49-32c501f14e8a"
}
]
}
}
Google
Project id
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
Strategy
email
google issued JWT token
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
authentication provider
google
user id
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
GET /v1/user/check/nonstandard HTTP/1.1
Host: m-id-public-api-dev-int24.lvis.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"result": 1,
"message": "OK",
"data": {
"updatedAt": "1633430188",
"nickname": "burger1111111",
"email": "[email protected]",
"devices": [
{
"deviceId": "16713b2d-3848-42c7-aeb0-f9714beac892",
"lastLogin": 1633435763,
"signUp": 1633435560,
"userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
"timeStamp": 1633435760,
"signature": "41C96E76084CDAAC46268995187AF3827258CCA3"
},
{
"deviceId": "a055da77-dcfe-4969-ae49-32c501f14e8a"
}
]
}
}
Facebook
Project id
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
Strategy
email
authentication provider
facebook
facebook issued JWT token
81b971d8-4078-40ee-a188-6dd6cbfb650b
user id
a69a31e9-f2e6-4d5f-b080-6138c6a721b7
GET /v1/user/check/nonstandard HTTP/1.1
Host: m-id-public-api-dev-int24.lvis.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"result": 1,
"message": "OK",
"data": {
"updatedAt": "1633430188",
"nickname": "burger1111111",
"email": "[email protected]",
"devices": [
{
"deviceId": "16713b2d-3848-42c7-aeb0-f9714beac892",
"lastLogin": 1633435763,
"signUp": 1633435560,
"userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
"timeStamp": 1633435760,
"signature": "41C96E76084CDAAC46268995187AF3827258CCA3"
},
{
"deviceId": "a055da77-dcfe-4969-ae49-32c501f14e8a"
}
]
}
}
Was this helpful?