Verify a magic link token

POST /api/login/verify

Verifies a token received in the magic link email. This is for the UI, not to be used programmatically.

Body

The token verification parameters

token string Required

Token to verify

Responses

200

OK
Hide response attributes Show response attributes object
- account_id string
  
  ID of the account the user is associated to
- email string
  
  Authenticated User's email
- role string
  
  Authenticated user's role
- token string
  
  JWT session token
- user_id string
  
  ID of the User
- user_name string
  
  Name of the user
400

Bad Request
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code
401

Unauthorized
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code

POST /api/login/verify

curl \
 -X POST http://localhost:4000/api/login/verify \
 -d '{"token":"abcdefghijk"}'

Request examples

{
  "token": "abcdefghijk"
}

Response examples (200)

{
  "role": "customer_read_only",
  "email": "joe@example.com",
  "token": "SFMyNTY.g2gDbQAAACQyZDc3NDhkMy1jNzAyLTQ0ZTItODI3NS1jMDVhM2Y2NWY1ZGVuBgDRctrbiQFiAAFRgA.n3giyccj8XtTKgQDVO24xz8GkyIOEURO1FgwTeEgl5Y",
  "user_id": "33b964ce-b1fa-47fa-a97d-0c8c0c56ed6c",
  "user_name": "Joe Smith",
  "account_id": "0e0c22e9-334b-4a86-bafb-63055a0300dd"
}

Response examples (200)

{
  "role": "customer_read_only",
  "email": "joe@example.com",
  "token": "SFMyNTY.g2gDbQAAACQyZDc3NDhkMy1jNzAyLTQ0ZTItODI3NS1jMDVhM2Y2NWY1ZGVuBgDRctrbiQFiAAFRgA.n3giyccj8XtTKgQDVO24xz8GkyIOEURO1FgwTeEgl5Y",
  "user_id": "33b964ce-b1fa-47fa-a97d-0c8c0c56ed6c",
  "user_name": "Joe Smith",
  "account_id": "0e0c22e9-334b-4a86-bafb-63055a0300dd"
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}