Magic Links

Login with Magic Link

Send a login email or SMS to the user. The user will receive an email or text with a link to complete their login.

POSThttps://auth.passage.id/v1/apps/{app_id}/login/magic-link

Path parameters

app_id*string

App ID

Body

application/json

User Data

identifier*string

valid email or E164 phone number

languagestring

language of the email or SMS to send (optional)

magic_link_pathstring

path relative to the app's auth_origin (optional)

Response

200400403404500

OK

Body

application/json

magic_link*MagicLink (object)

Request

JavaScriptCurl

const response = await fetch('https://auth.passage.id/v1/apps/{app_id}/login/magic-link', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "identifier": "text"
    }),
});
const data = await response.json();

Response

{
  "magic_link": {
    "id": "text"
  }
}

Register with Magic Link

Create a user and send an registration email or SMS to the user. The user will receive an email or text with a link to complete their registration.

POSThttps://auth.passage.id/v1/apps/{app_id}/register/magic-link

Path parameters

app_id*string

App ID

Body

application/json

User Data

identifier*string

valid email or E164 phone number

languagestring

language of the email or SMS to send (optional)

magic_link_pathstring

path relative to the app's auth_origin (optional)

Response

201400403404500

Created

Body

application/json

magic_link*MagicLink (object)

Request

JavaScriptCurl

const response = await fetch('https://auth.passage.id/v1/apps/{app_id}/register/magic-link', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "identifier": "text"
    }),
});
const data = await response.json();

Response

{
  "magic_link": {
    "id": "text"
  }
}

Magic Link Status

Check if a magic link has been activated yet or not. Once the magic link has been activated, this endpoint will return an authentication token for the user. This endpoint can be used to initiate a login on one device and then poll and wait for the login to complete on another device.

POSThttps://auth.passage.id/v1/apps/{app_id}/magic-link/status

Path parameters

app_id*string

App ID

Body

application/json

Magic Link ID

id*string

Response

200400401404500

OK

Body

application/json

auth_result*AuthResult (object)

Request

JavaScriptCurl

const response = await fetch('https://auth.passage.id/v1/apps/{app_id}/magic-link/status', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text"
    }),
});
const data = await response.json();

Response

{
  "auth_result": {
    "auth_token": "text",
    "redirect_url": "text",
    "refresh_token": "text"
  }
}

Authenticate Magic Link

Authenticate a magic link for a user. This endpoint checks that the magic link is valid, then returns an authentication token for the user.

PATCHhttps://auth.passage.id/v1/apps/{app_id}/magic-link/activate

Path parameters

app_id*string

App ID

Body

application/json

User Data

magic_link*string

Response

200400401403404500

OK

Body

application/json

auth_result*AuthResult (object)

Request

JavaScriptCurl

const response = await fetch('https://auth.passage.id/v1/apps/{app_id}/magic-link/activate', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "magic_link": "text"
    }),
});
const data = await response.json();

Response

{
  "auth_result": {
    "auth_token": "text",
    "redirect_url": "text",
    "refresh_token": "text"
  }
}