{
  "opencollection": "1.0.0",
  "info": {
    "name": "Descope Apps Text Message (SMS) API",
    "version": "0.0.1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Text Message (SMS)",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Sign-Up",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/magiclink/signup/sms",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sign-up new end user by sending a magic link via SMS\n\nInitiate a sign-up process by sending a magic link to a new end user. Descope will generate and deliver a clickable magic link to the phone number specified. The clickable magic link is made up of two parts -  the URI you provide in the `URI` field and the magic link token generated by Descope. For example, if `URI=https://app.mycompany.com/magiclink/verify`, the clickable magic link will be `https://app.mycompany.com/magiclink/verify?t=m"
        },
        {
          "info": {
            "name": "Sign-In",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/magiclink/signin/sms",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sign-in existing end user by sending a magic link via SMS\n\nInitiate a sign-in process by sending a magic link to an existing end user. Descope will generate and deliver a clickable magic link as an SMS to the phone number specified. The clickable magic link is made up of two parts - the URI you provide in the `URI` field and the magic link token generated by Descope. For example, if `URI=https://app.mycompany.com/magiclink/verify`, the clickable magic link will be `https://app.mycompany.com/"
        },
        {
          "info": {
            "name": "Sign-In with Auto Sign-up",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/magiclink/signup-in/sms",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sign-in end user (with automatic sign-up) by sending a magic link via SMS\n\nInitiate a process that implements both sign-in and sign-up using a single endpoint. Descope will generate and deliver a clickable magic link as an SMS to the phone number specified. If the phone number is already registered (the end user has already registered) the user will be signed in. If the email address is not registered (the end user is not yet registered) the user will be signed up.\n\nThe clickable magic link "
        },
        {
          "info": {
            "name": "Update Phone Number",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/magiclink/update/phone/sms",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Update phone number of end user by sending magic link via SMS\n\nUpdate the phone number of an existing end user by sending a magic link to the new phone number. Descope will generate and deliver a clickable magic link as an SMS to the new phone number specified. After successfully verifying the magic link token the new phone number will be used to deliver new magic links via SMS.\n\nThe clickable magic link is made up of two parts - the URI you provide in the `URI` field and the magic link toke"
        },
        {
          "info": {
            "name": "Sign-Up",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/otp/signup/sms",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sign-up new end user by sending an OTP code via SMS\nInitiate a sign-up process by sending a One-Time Password (OTP) to a new end user. Descope will generate and deliver the OTP code via SMS to the phone number specified. Sending multiple OTP codes (for example, when an end user tries to sign-up a second or third time) will invalidate any OTP code that has already been sent.\n\nThis endpoint will return an empty response object when it completes successfully. The endpoint will return a failure "
        },
        {
          "info": {
            "name": "Sign-In",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/otp/signin/sms",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sign-in existing end user by sending an OTP code via SMS\nInitiate a sign-in process by sending a One-Time Password (OTP) to an existing end user. Descope will generate and deliver the OTP code to the phone number specified. Sending multiple OTP codes (for example, when an end user tries to sign-in a second or third time) will invalidate any OTP code that has already been sent.\n\nThis endpoint will return an empty response object when it completes successfully. The endpoint will return a failu"
        },
        {
          "info": {
            "name": "Sign-In with Auto Sign-up",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/otp/signup-in/sms",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sign-in end user (with automatic sign-up) by sending an OTP code via SMS\nInitiate a process that implements both sign-in and sign-up using a single endpoint. Descope will generate and deliver the One-Time Password (OTP) to the end user via SMS. If the phone number is already registered (the end user exists) the user will be signed in. If the phone number is not registered (the end user is not yet registered) the user will be signed up. Sending multiple OTP codes (for example, when an end use"
        },
        {
          "info": {
            "name": "Verify OTP Code",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/otp/verify/sms",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Verify the validity of an OTP code via SMS\n\nVerify that the OTP code entered by the end user matches the OTP code that was sent. The Verify OTP code endpoint completes the OTP via SMS flow for:\n- [Sign-Up](/api/otp/sms/sign-up)\n- [Sign-In](/api/otp/sms/sign-in)\n- [Sign-In with Auto Sign-up](/api/otp/sms/sign-in-auto-sign-up)\n- [Update Email](/api/otp/sms/update-phone)\n\nThe response object includes the session JWT `sessionJwt` and refresh JWT `refreshJwt` when it completes successfully, and t"
        },
        {
          "info": {
            "name": "Update Phone",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/otp/update/phone/sms",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Update phone number of Existing User\nUpdate the phone number of an existing end user by sending an OTP code to the new phone number. After successfully verifying the code the new phone number will be used to deliver new OTP messages via SMS. The bearer token requires both the ProjectId and refresh JWT in the format `<Project ID>:<JWT>`, and can therefore only be run for end users who are currently signed-in.\n\nThis endpoint will return an empty response object when it completes successfully.\n"
        }
      ]
    }
  ],
  "bundled": true
}