How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Descope Text Message (SMS) API

The Text Message (SMS) API from Descope — 9 operation(s) for text message (sms).

Descope Text Message (SMS) API is one of 16 APIs that Descope publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Text Message (SMS). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 9 paths, and defines 17 schemas. It is described by OpenAPI 3.0.3, at version 0.0.1.

Requests are made against 2 base URLs: https://api.descope.com, {customUrl}.

9 operations 9 paths 17 schemas 9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.0.1
Base URL
https://api.descope.com
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 5

Descope Text Message (SMS) API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (Project ID) (Descope Project ID). It accepts HTTP bearer tokens (Project ID:Refresh JWT) (Descope Project ID:Refresh JWT). It accepts HTTP bearer tokens (ProjectId:AccessKey) (Descope Project ID:Access Key). It accepts HTTP bearer tokens (Project ID:Session JWT) (Descope Project ID:Session JWT). It accepts HTTP bearer tokens (ProjectId:ManagementKey) (Descope Project ID and Management Key). By default, every request must be authenticated.

  • Descope Project ID — Project ID as bearer token.
  • Descope Project ID:Refresh JWT — Project ID:Refresh JWT as bearer token.
  • Descope Project ID:Access Key — Project ID:Access Key as bearer token.
  • Descope Project ID:Session JWT — Project ID:Session JWT as bearer token.
  • Descope Project ID and Management Key — Project ID:Management Key as bearer token.

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 9 POST. Each is listed below with its method, path, parameters, and response codes.

Text Message (SMS) 9
POST
/v1/auth/magiclink/signup/sms
Sign-Up
SignUpMagicLinkSMS body → 200
POST
/v1/auth/magiclink/signin/sms
Sign-In
SignInMagicLinkSMS body → 200
POST
/v1/auth/magiclink/signup-in/sms
Sign-In with Auto Sign-up
SignUpOrInMagicLinkSMS body → 200
POST
/v1/auth/magiclink/update/phone/sms
Update Phone Number
UpdateUserPhoneMagicLinkSMS body → 200
POST
/v1/auth/otp/signup/sms
Sign-Up
SignUpOtpSMS body → 200
POST
/v1/auth/otp/signin/sms
Sign-In
SignInOTPSMS body → 200
POST
/v1/auth/otp/signup-in/sms
Sign-In with Auto Sign-up
SignUpOrInOTPSMS body → 200
POST
/v1/auth/otp/verify/sms
Verify OTP Code
VerifyCodeSMS body → 200
POST
/v1/auth/otp/update/phone/sms
Update Phone
UpdateUserPhoneOTPSMS body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ResponseUser (34 properties), JWTResponse (19 properties), LoginOptions (10 properties), SignUpUser (9 properties). Each schema is shown below with its type and property counts.

PhoneSignUpUserObject
object
4 properties
UpdateUserPhoneMagicLinkRequest
object
9 properties
MagicLinkSignUpPhoneRequest
object
6 properties
PhoneMagicLinkResponse
object
1 property
ResponseUser
object
34 properties
LoginOptions
object
10 properties
UserTenants
object
4 properties
OTPSignInRequest
object
5 properties
JWTResponse
object
NOTE: if you add a new field to this message, also add it to the OptionalJWTResponse message
19 properties
PhoneOperationResponse
object
2 properties
SignupLoginOptions
object
5 properties
OTPSignUpPhoneRequest
object
5 properties
OTPVerifyCodeRequest
object
2 properties
SignUpUser
object
9 properties
MagicLinkSignInRequest
object
6 properties
UpdateUserPhoneOTPRequest
object
8 properties
IDPResponse
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

descope-text-message-sms-api-openapi.yml Raw ↑

Other APIs Descope publishes across the network.

Descope Apps API
Descope Auth API
Descope Custom Attributes API
Descope Default API
Descope Email API
Descope Embedded Link API
Descope Fedcm API
Descope Instant Message (IM) API
Descope Keys API
Descope Mgmt API
Descope Oauth2 API
Descope Scim API
Where this information came from

This is an independent, third-party profile of Descope Text Message (SMS) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.