Stytch · Schema
api_b2b_otp_v1_b2b_otp_sms_SendRequest
Request type
AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools
Properties
| Name | Type | Description |
|---|---|---|
| organization_id | string | Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organi |
| member_id | string | Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set |
| mfa_phone_number | string | The phone number to send the OTP to. If the Member already has a phone number, this argument is not needed. |
| locale | object | Used to determine which language to use when sending the user this delivery method. Parameter is an [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`. C |
| intermediate_session_token | string | The Intermediate Session Token. This token does not necessarily belong to a specific instance of a Member, but represents a bag of factors that may be converted to a member session. The token can be u |
| session_token | string | A secret token for a given Stytch Session. |
| session_jwt | string | The JSON Web Token (JWT) for a given Stytch Session. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/api_b2b_otp_v1_b2b_otp_sms_SendRequest",
"title": "api_b2b_otp_v1_b2b_otp_sms_SendRequest",
"type": "object",
"properties": {
"organization_id": {
"type": "string",
"description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience."
},
"member_id": {
"type": "string",
"description": "Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member."
},
"mfa_phone_number": {
"type": "string",
"description": "The phone number to send the OTP to. If the Member already has a phone number, this argument is not needed."
},
"locale": {
"$ref": "#/components/schemas/api_b2b_otp_v1_SendRequestLocale",
"description": "Used to determine which language to use when sending the user this delivery method. Parameter is an [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `\"en\"`.\n\nCurrently supported languages are English (`\"en\"`), Spanish (`\"es\"`), French (`\"fr\"`) and Brazilian Portuguese (`\"pt-br\"`); if no value is provided, the copy defaults to English.\n\nRequest support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link\")!\n"
},
"intermediate_session_token": {
"type": "string",
"description": "The Intermediate Session Token. This token does not necessarily belong to a specific instance of a Member, but represents a bag of factors that may be converted to a member session. The token can be used with the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms), [TOTP Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-totp), or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow and log in to the Organization. The token has a default expiry of 10 minutes. It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a specific Organization that allows the factors represented by the intermediate session token; or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member. Intermediate Session Tokens have a default expiry of 10 minutes."
},
"session_token": {
"type": "string",
"description": "A secret token for a given Stytch Session."
},
"session_jwt": {
"type": "string",
"description": "The JSON Web Token (JWT) for a given Stytch Session."
}
},
"description": "Request type",
"required": [
"organization_id",
"member_id"
]
}