# Prelude Docs

## Docs

- [Check standalone OTP](https://docs.prelude.so/auth/api-reference/frontend/complete-login-otp.md): Verify the OTP code for standalone/step-up verification. Returns a challenge token.
- [Finalize login](https://docs.prelude.so/auth/api-reference/frontend/finalize-login.md): Finalize a login flow by exchanging a challenge token for session tokens (access + refresh).
- [Get JWKS](https://docs.prelude.so/auth/api-reference/frontend/jwks.md): Retrieve the JSON Web Key Set for verifying access tokens.
- [List identifiers](https://docs.prelude.so/auth/api-reference/frontend/list-identifiers.md): List the identifiers (phone numbers, email addresses) for the authenticated user.
- [List sessions](https://docs.prelude.so/auth/api-reference/frontend/list-sessions.md): List all active sessions for the authenticated user.
- [Login with email and password](https://docs.prelude.so/auth/api-reference/frontend/login-email-password.md): Authenticate a user with their email and password. Returns a challenge token to finalize the login.
- [Initiate OAuth authorization](https://docs.prelude.so/auth/api-reference/frontend/oauth-authorize.md): Start an OAuth authorization flow for the given provider. Returns the authorization URL to redirect the user to.
- [OAuth callback (GET)](https://docs.prelude.so/auth/api-reference/frontend/oauth-callback-get.md): Handle the OAuth provider callback via GET (query parameters). Redirects to the client application with a challenge token or error.
- [OAuth callback (POST)](https://docs.prelude.so/auth/api-reference/frontend/oauth-callback-post.md): Handle the OAuth provider callback via POST (form data). Used by providers like Apple that use form_post response_mode. Redirects to the client application with a challenge token or error.
- [Get password compliancy rules](https://docs.prelude.so/auth/api-reference/frontend/password-compliancy.md): Retrieve the password compliancy requirements for the application.
- [Refresh session](https://docs.prelude.so/auth/api-reference/frontend/refresh-session.md): Spend a refresh token and generate a new access token.
- [Change password](https://docs.prelude.so/auth/api-reference/frontend/reset-password.md): Change the password for the authenticated user. Requires a valid access token with write scope.
- [Retry standalone OTP](https://docs.prelude.so/auth/api-reference/frontend/retry-otp.md): Retry sending the OTP message for standalone/step-up verification.
- [Revoke session](https://docs.prelude.so/auth/api-reference/frontend/revoke-session.md): Revoke a refresh token (logout).
- [Revoke sessions](https://docs.prelude.so/auth/api-reference/frontend/revoke-sessions.md): Revoke sessions for the authenticated user. Use the `target` query parameter to specify which sessions to revoke.
- [SAML Assertion Consumer Service (ACS)](https://docs.prelude.so/auth/api-reference/frontend/saml-acs.md): Endpoint the Identity Provider posts the `SAMLResponse` to (HTTP-POST binding). Both IdP-initiated (no `RelayState`) and SP-initiated (the `RelayState` issued by the [initiate](/session/api-reference/frontend/saml-initiate) endpoints) flows land here. On success, redirects to the connection's redire…
- [Initiate SAML login (explicit connection)](https://docs.prelude.so/auth/api-reference/frontend/saml-initiate.md): Start an SP-initiated SAML SSO flow for an explicit `(provider_id, connection_id)` pair. On success, returns the IdP URL the SDK navigates the user to.
- [Initiate SAML login (resolve by email)](https://docs.prelude.so/auth/api-reference/frontend/saml-initiate-by-email.md): Start an SP-initiated SAML SSO flow, resolving the connection from the email's domain. The domain must match exactly one enabled connection's `email_domain_allowlist`. On success, returns the IdP URL the SDK navigates the user to; the IdP eventually posts a `SAMLResponse` back to the connection's [A…
- [Get SP metadata](https://docs.prelude.so/auth/api-reference/frontend/saml-metadata.md): Returns the Service Provider (SP) metadata XML for the connection. Upload this document (or its URL) to the Identity Provider when configuring the SAML application. Public; no authentication required.
- [Migrate a legacy session](https://docs.prelude.so/auth/api-reference/frontend/session-migration.md): Validate a legacy session token via the customer's configured migration hook, create the user if needed, and return a login challenge token. This endpoint requires a migration configuration to be set up for the application.
- [Create standalone OTP](https://docs.prelude.so/auth/api-reference/frontend/start-login-otp.md): Send an OTP for step-up authentication or standalone verification. Can be initiated with a challenge token (step-up flow) or an identifier (standalone flow).
- [Continue step-up challenge](https://docs.prelude.so/auth/api-reference/frontend/stepup-continue.md): Verify the customer's verification token and advance the challenge to the next step. A valid DPoP proof (`DPoP` header, RFC 9449) is required on every call to this endpoint.
- [Get step-up JWKS](https://docs.prelude.so/auth/api-reference/frontend/stepup-jwks.md): Retrieve the JSON Web Key Set for verifying step-up tokens.
- [Request step-up scope](https://docs.prelude.so/auth/api-reference/frontend/stepup-request.md): Initiate a step-up authentication flow for the given scope.
- [Create claims mapping config](https://docs.prelude.so/auth/api-reference/management/config/claims/create-claims-mapping.md): Create a claims mapping configuration for the application.
- [Delete claims mapping config](https://docs.prelude.so/auth/api-reference/management/config/claims/delete-claims-mapping.md): Delete the claims mapping configuration for the application.
- [Get claims mapping config](https://docs.prelude.so/auth/api-reference/management/config/claims/get-claims-mapping.md): Get the claims mapping configuration for the application.
- [Update claims mapping config](https://docs.prelude.so/auth/api-reference/management/config/claims/update-claims-mapping.md): Update the claims mapping configuration for the application.
- [Create OAuth login config](https://docs.prelude.so/auth/api-reference/management/config/login-oauth/create-login-oauth-config.md): Create an OAuth login configuration for a specific provider.
- [Delete OAuth login config](https://docs.prelude.so/auth/api-reference/management/config/login-oauth/delete-login-oauth-config.md): Delete an OAuth login configuration for a specific provider.
- [List OAuth login configs](https://docs.prelude.so/auth/api-reference/management/config/login-oauth/list-login-oauth-configs.md): List all OAuth login configurations for the application.
- [Update OAuth login config](https://docs.prelude.so/auth/api-reference/management/config/login-oauth/update-login-oauth-config.md): Update an OAuth login configuration for a specific provider.
- [Create OTP login config](https://docs.prelude.so/auth/api-reference/management/config/login-otp/create-login-otp-config.md): Create an OTP login configuration for the application.
- [Delete OTP login config](https://docs.prelude.so/auth/api-reference/management/config/login-otp/delete-login-otp-config.md): Delete an OTP login configuration by its identifier.
- [List OTP login configs](https://docs.prelude.so/auth/api-reference/management/config/login-otp/list-login-otp-configs.md): List all OTP login configurations for the application.
- [Update OTP login config](https://docs.prelude.so/auth/api-reference/management/config/login-otp/update-login-otp-config.md): Update an OTP login configuration by its identifier.
- [Create password login config](https://docs.prelude.so/auth/api-reference/management/config/login-password/create-login-password-config.md): Create a password login configuration for the application.
- [Delete password login config](https://docs.prelude.so/auth/api-reference/management/config/login-password/delete-login-password-config.md): Delete the password login configuration for the application.
- [Get password login config](https://docs.prelude.so/auth/api-reference/management/config/login-password/get-login-password-config.md): Get the password login configuration for the application.
- [Update password login config](https://docs.prelude.so/auth/api-reference/management/config/login-password/update-login-password-config.md): Update the password login configuration for the application.
- [Create SAML connection](https://docs.prelude.so/auth/api-reference/management/config/login-saml/create-saml-connection.md): Create a SAML SSO connection for a provider. Provide exactly one IdP source: `idp_metadata_url`, `idp_metadata_xml`, or an explicit `idp` block. The Service Provider (SP) endpoints in the response are derived from the app domain and the generated connection ID, and are immutable.
- [Delete SAML connection](https://docs.prelude.so/auth/api-reference/management/config/login-saml/delete-saml-connection.md): Delete a SAML connection. Existing `saml:<connection_id>` user identifiers are retained so historical sessions stay auditable.
- [Get SAML connection](https://docs.prelude.so/auth/api-reference/management/config/login-saml/get-saml-connection.md): Get a single SAML SSO connection.
- [Get SAML SP metadata](https://docs.prelude.so/auth/api-reference/management/config/login-saml/get-saml-sp-metadata.md): Return the Service Provider (SP) metadata XML for the connection, ready to upload to the Identity Provider.
- [List SAML connections](https://docs.prelude.so/auth/api-reference/management/config/login-saml/list-saml-connections.md): List all SAML SSO connections configured for the application.
- [Update SAML connection](https://docs.prelude.so/auth/api-reference/management/config/login-saml/update-saml-connection.md): Apply a partial update to a SAML connection. Omitted fields are left unchanged. The IdP `entity_id` is immutable — delete and recreate the connection to rotate it.
- [Create migration config](https://docs.prelude.so/auth/api-reference/management/config/migration/create-migration-config.md): Create a user migration configuration for the application. Only one migration configuration can exist per application — use the update endpoint to change the session validation URL afterwards.
- [Delete migration config](https://docs.prelude.so/auth/api-reference/management/config/migration/delete-migration-config.md): Delete the user migration configuration for the application.
- [Get migration config](https://docs.prelude.so/auth/api-reference/management/config/migration/get-migration-config.md): Get the user migration configuration for the application. The migration configuration lets Prelude Session validate sessions issued by a legacy authentication system while you migrate users over, so end users do not need to sign in again during the cutover.
- [Update migration config](https://docs.prelude.so/auth/api-reference/management/config/migration/update-migration-config.md): Update the user migration configuration for the application.
- [Create scope](https://docs.prelude.so/auth/api-reference/management/config/scopes/create-scope.md): Add a new scope to the application configuration.
- [Delete scope](https://docs.prelude.so/auth/api-reference/management/config/scopes/delete-scope.md): Remove a scope from the application configuration.
- [List scopes](https://docs.prelude.so/auth/api-reference/management/config/scopes/list-scopes.md): List all configured scopes for the application.
- [Create step-up config](https://docs.prelude.so/auth/api-reference/management/config/stepup/create-stepup-config.md): Create a step-up authentication configuration for the application.
- [Delete step-up config](https://docs.prelude.so/auth/api-reference/management/config/stepup/delete-stepup-config.md): Delete the step-up authentication configuration for the application.
- [Get step-up config](https://docs.prelude.so/auth/api-reference/management/config/stepup/get-stepup-config.md): Get the step-up authentication configuration for the application.
- [Update step-up config](https://docs.prelude.so/auth/api-reference/management/config/stepup/update-stepup-config.md): Update the step-up authentication configuration for the application.
- [Create domain](https://docs.prelude.so/auth/api-reference/management/domains/create-domain.md): Create a domain for an application.
- [Delete domain](https://docs.prelude.so/auth/api-reference/management/domains/delete-domain.md): Delete a domain by its identifier.
- [Get domain](https://docs.prelude.so/auth/api-reference/management/domains/get-domain.md): Get a domain by its identifier.
- [List domains](https://docs.prelude.so/auth/api-reference/management/domains/list-domains.md): List all domains for an application.
- [Validate domain](https://docs.prelude.so/auth/api-reference/management/domains/verify-domain.md): Validate a domain by its identifier. This will retry verifying the CNAME record on your domain.
- [Get application mode](https://docs.prelude.so/auth/api-reference/management/mode/get-mode.md): Get the current mode (dev or prod) of the application.
- [Update application mode](https://docs.prelude.so/auth/api-reference/management/mode/update-mode.md): Update the mode (dev or prod) of the application.
- [Add scope to user](https://docs.prelude.so/auth/api-reference/management/users/add-user-scope.md): Add a scope to a user.
- [Create identifier](https://docs.prelude.so/auth/api-reference/management/users/create-identifier.md): Create an identifier for a user.
- [Create user](https://docs.prelude.so/auth/api-reference/management/users/create-user.md): Create a user in the application.
- [Delete identifier](https://docs.prelude.so/auth/api-reference/management/users/delete-identifier.md): Delete an identifier for a user.
- [Delete user](https://docs.prelude.so/auth/api-reference/management/users/delete-user.md): Delete a user by its unique identifier.
- [Get user](https://docs.prelude.so/auth/api-reference/management/users/get-user.md): Get a user by its unique identifier.
- [Invalidate user session](https://docs.prelude.so/auth/api-reference/management/users/invalidate-user-session.md): Invalidate a session of a user by its SessionID.
- [Invalidate user sessions](https://docs.prelude.so/auth/api-reference/management/users/invalidate-user-sessions.md): Invalidate all sessions of a user.
- [List user sessions](https://docs.prelude.so/auth/api-reference/management/users/list-user-sessions.md): List all sessions of a user.
- [List users](https://docs.prelude.so/auth/api-reference/management/users/list-users.md): List all users in the application.
- [Set user password](https://docs.prelude.so/auth/api-reference/management/users/set-user-password.md): Set or update the password of a user.
- [Update user external ID](https://docs.prelude.so/auth/api-reference/management/users/update-external-id.md): Update the external ID of a user. The external ID is the ID of the user in your system.
- [Update user status](https://docs.prelude.so/auth/api-reference/management/users/update-status.md): Update the status (active/inactive) of a user.
- [Update user profile](https://docs.prelude.so/auth/api-reference/management/users/update-user-profile.md): Update the profile of a user.
- [Activate webhook](https://docs.prelude.so/auth/api-reference/management/webhooks/activate-webhook.md): Activate a webhook by its WebhookID.
- [Add webhook event](https://docs.prelude.so/auth/api-reference/management/webhooks/add-webhook-event.md): Add an event to a webhook.
- [Create webhook](https://docs.prelude.so/auth/api-reference/management/webhooks/create-webhook.md): Create a webhook for an app.
- [Deactivate webhook](https://docs.prelude.so/auth/api-reference/management/webhooks/deactivate-webhook.md): Deactivate a webhook by its WebhookID.
- [Delete webhook](https://docs.prelude.so/auth/api-reference/management/webhooks/delete-webhook.md): Delete a webhook by its WebhookID.
- [Delete webhook event](https://docs.prelude.so/auth/api-reference/management/webhooks/delete-webhook-event.md): Delete an event from a webhook.
- [Get webhook](https://docs.prelude.so/auth/api-reference/management/webhooks/get-webhook.md): Get a webhook by its WebhookID.
- [List webhooks](https://docs.prelude.so/auth/api-reference/management/webhooks/list-webhooks.md): List all webhooks for an app.
- [Auth Applications](https://docs.prelude.so/auth/documentation/applications.md): Learn how Prelude Auth applications work.
- [Logged-in Change Password](https://docs.prelude.so/auth/documentation/change-password.md): Let authenticated users change their password using direct step-up, without configuring a delegation hook.
- [Cookies](https://docs.prelude.so/auth/documentation/cookies.md): Learn about the cookies used by Prelude Auth.
- [Custom Claims](https://docs.prelude.so/auth/documentation/custom-claims.md): Configure the claims included in the access tokens issued by Prelude Auth.
- [Domain Names](https://docs.prelude.so/auth/documentation/domain-names.md): Learn about how to manage domain names for your application.
- [Change Password](https://docs.prelude.so/auth/documentation/frontend-sdks/mobile/change-password.md): Implement logged-in change password with the Prelude mobile SDKs.
- [Introduction](https://docs.prelude.so/auth/documentation/frontend-sdks/mobile/introduction.md): Integrate the Prelude Auth SDK into your mobile application.
- [OTP Login](https://docs.prelude.so/auth/documentation/frontend-sdks/mobile/otp.md): Implement OTP-based authentication with the Prelude mobile SDKs.
- [Password](https://docs.prelude.so/auth/documentation/frontend-sdks/mobile/password.md): Implement password-based authentication with the Prelude mobile SDKs.
- [Session Management](https://docs.prelude.so/auth/documentation/frontend-sdks/mobile/session-management.md): Manage access tokens, refresh sessions, and handle logout with the Prelude mobile SDKs.
- [Step-Up Authentication](https://docs.prelude.so/auth/documentation/frontend-sdks/mobile/step-up.md): Implement step-up authentication with the Prelude mobile SDKs.
- [Change Password](https://docs.prelude.so/auth/documentation/frontend-sdks/web/change-password.md): Implement logged-in change password with the Prelude JavaScript SDK.
- [Introduction](https://docs.prelude.so/auth/documentation/frontend-sdks/web/introduction.md): Integrate the Prelude Auth SDK into your web application.
- [OTP Login](https://docs.prelude.so/auth/documentation/frontend-sdks/web/otp.md): Implement OTP-based authentication with the Prelude JavaScript SDK.
- [Password](https://docs.prelude.so/auth/documentation/frontend-sdks/web/password.md): Implement password-based authentication with the Prelude JavaScript SDK.
- [SAML Login](https://docs.prelude.so/auth/documentation/frontend-sdks/web/saml.md): Implement SAML SSO login with the Prelude JavaScript SDK.
- [Enforce SSO Login](https://docs.prelude.so/auth/documentation/frontend-sdks/web/saml-enforce.md): Transparently fall back to SAML when a domain enforces SSO, with the Prelude JavaScript SDK.
- [Session Management](https://docs.prelude.so/auth/documentation/frontend-sdks/web/session-management.md): Manage access tokens, refresh sessions, and handle logout with the Prelude JavaScript SDK.
- [Social Login](https://docs.prelude.so/auth/documentation/frontend-sdks/web/social-login.md): Implement social login with the Prelude JavaScript SDK.
- [Step-Up Authentication](https://docs.prelude.so/auth/documentation/frontend-sdks/web/step-up.md): Implement step-up authentication with the Prelude JavaScript SDK.
- [Integration Guide](https://docs.prelude.so/auth/documentation/integration-guide/introduction.md): Step-by-step guides to integrate Prelude Auth into your application.
- [OTP Login](https://docs.prelude.so/auth/documentation/integration-guide/otp-login.md): Configure OTP-based authentication with Prelude Auth using phone or email.
- [Password Authentication](https://docs.prelude.so/auth/documentation/integration-guide/password-authentication.md): Configure email and password authentication with Prelude Auth.
- [Enforce SSO login](https://docs.prelude.so/auth/documentation/integration-guide/saml/enforce.md): Require allowlisted email domains to authenticate through SAML SSO.
- [Google Workspace](https://docs.prelude.so/auth/documentation/integration-guide/saml/google.md): Configure a Google Workspace custom SAML app for your Auth application.
- [Introduction](https://docs.prelude.so/auth/documentation/integration-guide/saml/introduction.md): Configure SAML 2.0 single sign-on (SSO) for your Auth application.
- [JumpCloud](https://docs.prelude.so/auth/documentation/integration-guide/saml/jumpcloud.md): Configure a JumpCloud SAML application for your Auth application.
- [Okta](https://docs.prelude.so/auth/documentation/integration-guide/saml/okta.md): Configure an Okta SAML application for your Auth application.
- [Apple](https://docs.prelude.so/auth/documentation/integration-guide/social-login/apple.md): Configure Apple OAuth for your Auth application.
- [Facebook](https://docs.prelude.so/auth/documentation/integration-guide/social-login/facebook.md): Configure Facebook OAuth for your Auth application.
- [GitHub](https://docs.prelude.so/auth/documentation/integration-guide/social-login/github.md): Configure GitHub OAuth for your Auth application.
- [Google](https://docs.prelude.so/auth/documentation/integration-guide/social-login/google.md): Configure Google OAuth for your Auth application.
- [Introduction](https://docs.prelude.so/auth/documentation/integration-guide/social-login/introduction.md): Configure social login providers for your Auth application.
- [Microsoft](https://docs.prelude.so/auth/documentation/integration-guide/social-login/microsoft.md): Configure Microsoft OAuth for your Auth application.
- [Okta](https://docs.prelude.so/auth/documentation/integration-guide/social-login/okta.md): Configure Okta OAuth for your Auth application.
- [Introduction to Auth](https://docs.prelude.so/auth/documentation/introduction.md): Manage the full lifecycle of your users' authentication.
- [JSON Web Key Set (JWKS)](https://docs.prelude.so/auth/documentation/jwks.md): Learn about the JWKS used by the Prelude Auth.
- [Migration Guide](https://docs.prelude.so/auth/documentation/migration-guide.md): Migrate users from a legacy authentication provider to the Prelude Auth API.
- [Passkey (WebAuthn)](https://docs.prelude.so/auth/documentation/passkey.md): Use a WebAuthn credential as a step-up factor — verified by Prelude, no delegation hook involved.
- [Register an Identifier](https://docs.prelude.so/auth/documentation/register-identifier.md): Add a phone number or email address to a logged-in user with an OTP challenge.
- [Step-Up Authentication](https://docs.prelude.so/auth/documentation/step-up-authentication.md): Add scoped, multi-step authentication challenges to existing sessions.
- [Custom Steps](https://docs.prelude.so/auth/documentation/step-up-custom-steps.md): Add client-owned verification steps to step-up challenges.
- [Step-Up Hook Reference](https://docs.prelude.so/auth/documentation/step-up-hook.md): API reference for the step-up hook endpoint your backend must implement.
- [Migration Hook Failed](https://docs.prelude.so/auth/documentation/webhooks/events/migration-hook-failed.md)
- [Step-Up Hook Failed](https://docs.prelude.so/auth/documentation/webhooks/events/step-up-hook-failed.md)
- [User Created](https://docs.prelude.so/auth/documentation/webhooks/events/user-created.md)
- [User Deleted](https://docs.prelude.so/auth/documentation/webhooks/events/user-deleted.md)
- [User Identifier Created](https://docs.prelude.so/auth/documentation/webhooks/events/user-identifier-created.md)
- [User Identifier Deleted](https://docs.prelude.so/auth/documentation/webhooks/events/user-identifier-deleted.md)
- [User Passkey Assertion Failed](https://docs.prelude.so/auth/documentation/webhooks/events/user-passkey-assertion-failed.md)
- [User Passkey Deleted](https://docs.prelude.so/auth/documentation/webhooks/events/user-passkey-deleted.md)
- [User Passkey Registered](https://docs.prelude.so/auth/documentation/webhooks/events/user-passkey-registered.md)
- [User Profile Updated](https://docs.prelude.so/auth/documentation/webhooks/events/user-profile-updated.md)
- [User Session Created](https://docs.prelude.so/auth/documentation/webhooks/events/user-session-created.md)
- [User Session Revoked](https://docs.prelude.so/auth/documentation/webhooks/events/user-session-revoked.md)
- [Webhooks](https://docs.prelude.so/auth/documentation/webhooks/introduction.md): Learn about the webhooks used by Prelude Auth.
- [Activation Challenge Request](https://docs.prelude.so/auth/documentation/webhooks/verification-event.md): Handle the activation challenge GET request.
- [KYC Match](https://docs.prelude.so/intel/v2/api-reference/kyc-match.md): Verify identity attributes (name, address, date of birth, email) against the subscriber record held by the end-user's mobile operator.
- [Lookup a phone number](https://docs.prelude.so/intel/v2/api-reference/lookup-a-number.md): Retrieve detailed information about a phone number including carrier data, line type, and portability status.
- [Introduction to Intel](https://docs.prelude.so/intel/v2/documentation/introduction.md): Phone number intelligence API. Retrieve carrier data, line type, portability status, and caller name for any number worldwide.
- [C#](https://docs.prelude.so/introduction/backend-sdks/csharp.md)
- [Go](https://docs.prelude.so/introduction/backend-sdks/go.md)
- [Kotlin/Java](https://docs.prelude.so/introduction/backend-sdks/java.md)
- [Node.js](https://docs.prelude.so/introduction/backend-sdks/node.md)
- [PHP](https://docs.prelude.so/introduction/backend-sdks/php.md)
- [Python](https://docs.prelude.so/introduction/backend-sdks/python.md)
- [Ruby](https://docs.prelude.so/introduction/backend-sdks/ruby.md)
- [Changelog](https://docs.prelude.so/introduction/changelog.md): Changes made to the Prelude platform.
- [Android SDK](https://docs.prelude.so/introduction/frontend-sdks/android.md): Learn how to use our client side Android SDK.
- [Apple SDK](https://docs.prelude.so/introduction/frontend-sdks/apple.md): Learn how to use our client side Apple SDK.
- [Flutter SDK](https://docs.prelude.so/introduction/frontend-sdks/flutter.md): Learn how to use our client side Flutter SDK.
- [Introduction to the Frontend SDKs](https://docs.prelude.so/introduction/frontend-sdks/introduction.md): Learn how to use our Frontend SDKs
- [React Native SDK](https://docs.prelude.so/introduction/frontend-sdks/react-native.md): Learn how to use our client side Expo React Native SDK.
- [Web SDK](https://docs.prelude.so/introduction/frontend-sdks/web.md): Learn how to capture frontend browser signals to integrate them with the verification backend APIs. It allows you to capture certain browser signals that will be reported back to your Prelude account.
- [GitHub](https://docs.prelude.so/introduction/github.md)
- [Welcome to Prelude Docs](https://docs.prelude.so/introduction/welcome-to-prelude.md): Prelude is the authentication infrastructure for developer teams, built on telco intelligence to verify users via phone or email, prevent fraud, and manage authentication across 230+ countries.
- [Get subscription phone number status](https://docs.prelude.so/notify/v2/api-reference/management/subscriptions/get-subscription-phone-number.md): Retrieve the current subscription status for a specific phone number within a subscription configuration.
- [List subscription configurations](https://docs.prelude.so/notify/v2/api-reference/management/subscriptions/list-subscription-configs.md): Retrieve a paginated list of subscription management configurations for your account.
- [List subscription phone number events](https://docs.prelude.so/notify/v2/api-reference/management/subscriptions/list-subscription-phone-number-events.md): Retrieve a paginated list of subscription events (status changes) for a specific phone number within a subscription configuration.
- [List subscription phone numbers](https://docs.prelude.so/notify/v2/api-reference/management/subscriptions/list-subscription-phone-numbers.md): Retrieve a paginated list of phone numbers and their subscription statuses for a specific subscription configuration.
- [Send a message](https://docs.prelude.so/notify/v2/api-reference/send-a-message.md): Send transactional and marketing messages to your users with one simple endpoint, using Prelude Notify API.
- [Reply to an inbound message](https://docs.prelude.so/notify/v2/api-reference/send-a-reply.md): Send a free-form text reply to an inbound WhatsApp message within the 24-hour conversation window.
- [Send bulk messages](https://docs.prelude.so/notify/v2/api-reference/send-bulk-messages.md): Send the same message to multiple recipients in a single request using Prelude Notify API.
- [Introduction to Notify](https://docs.prelude.so/notify/v2/documentation/introduction.md): Create, customize, and send global transactional and marketing messages effortlessly with a single API.
- [Marketing Compliance Rules](https://docs.prelude.so/notify/v2/documentation/marketing-compliance.md): Learn about the compliance rules and regulations that apply to marketing messages in different countries.
- [Message Scheduling](https://docs.prelude.so/notify/v2/documentation/scheduling.md): Schedule messages for future delivery with automatic compliance enforcement for marketing messages.
- [Subscription Management](https://docs.prelude.so/notify/v2/documentation/subscription-management.md): Manage user subscriptions and opt-out preferences for marketing messages with built-in STOP/START/HELP keyword support.
- [Supported Locales](https://docs.prelude.so/notify/v2/documentation/supported-locales.md): List of all supported locales for Notify templates.
- [Webhook for the Notify API](https://docs.prelude.so/notify/v2/documentation/webhook.md): Prelude Notify API can notify your application about events using webhooks. Get notified when your messages are delivered, billed, and when users manage their subscription preferences.
- [2-Way Messaging with WhatsApp](https://docs.prelude.so/notify/v2/documentation/whatsapp.md): Receive inbound WhatsApp messages from your users and reply within a 24-hour conversation window using native WhatsApp quoted replies.
- [Check a code](https://docs.prelude.so/verify/v2/api-reference/check-a-code.md): Check the validity of a verification code.
- [Create or retry a verification](https://docs.prelude.so/verify/v2/api-reference/create-or-retry-a-verification.md): Create a new verification for a specific phone number. If another non-expired verification exists (the request is performed within the verification window), this endpoint will perform a retry instead.
- [Overview](https://docs.prelude.so/verify/v2/api-reference/management/overview.md): Programmatically manage sender IDs, allow lists, and block lists for the Verify API.
- [Add phone number to allow or block list](https://docs.prelude.so/verify/v2/api-reference/management/phone-numbers/add-phone-number.md): Add a phone number to the allow or block list.
- [Delete phone number from allow or block list](https://docs.prelude.so/verify/v2/api-reference/management/phone-numbers/delete-phone-number.md): Remove a phone number from the allow or block list.
- [Get phone numbers allow or block list](https://docs.prelude.so/verify/v2/api-reference/management/phone-numbers/get-phone-numbers.md): Retrieve the list of phone numbers in the allow or block list.
- [Add a sandbox phone number](https://docs.prelude.so/verify/v2/api-reference/management/phone-numbers/sandbox/add-sandbox-phone-number.md): Register a phone number as a sandbox number and associate it with a fixed attempt code. Subsequent verification attempts against this number will not trigger a real SMS/call and will validate against the configured attempt code.
- [Delete a sandbox phone number](https://docs.prelude.so/verify/v2/api-reference/management/phone-numbers/sandbox/delete-sandbox-phone-number.md): Remove a phone number from the sandbox list.
- [Get sandbox phone numbers](https://docs.prelude.so/verify/v2/api-reference/management/phone-numbers/sandbox/get-sandbox-phone-numbers.md): Retrieve the list of sandbox phone numbers for the account. Sandbox numbers are test numbers that bypass the real verification flow and return a fixed attempt code.
- [List available Sender IDs](https://docs.prelude.so/verify/v2/api-reference/management/sender-id/list-sender-ids.md): Retrieve sender IDs list.
- [Submit a sender ID](https://docs.prelude.so/verify/v2/api-reference/management/sender-id/submit-sender-id.md): This endpoint allows you to submit a new sender ID for verification purposes.
- [Message Content](https://docs.prelude.so/verify/v2/documentation/content.md): Learn the various customization options for your verification messages.
- [Email Verification](https://docs.prelude.so/verify/v2/documentation/email-verification.md): Use the Verify API to verify email addresses.
- [Integrating Prelude with Auth0 for Secure and Reliable SMS Verification](https://docs.prelude.so/verify/v2/documentation/integrations/auth0.md): By integrating Prelude's API v2, you gain access to a more robust and customizable SMS verification process, ensuring that verification codes are delivered securely and consistently.
- [Prelude API v2 and Firebase Auth integration](https://docs.prelude.so/verify/v2/documentation/integrations/firebase.md)
- [Integrate Prelude with Supabase for Secure and Reliable SMS Authentication](https://docs.prelude.so/verify/v2/documentation/integrations/supabase.md): When using phone authentication in Supabase, the default SMS delivery service may not always meet your needs in terms of reliability, speed, or cost-efficiency. By integrating Prelude's API v2, you gain access to a more robust and customizable SMS verification process, ensuring that authentication c…
- [Introduction to Verify](https://docs.prelude.so/verify/v2/documentation/introduction.md): Verify phone numbers and emails worldwide using the most appropriate channel depending on your user's context.
- [Verification Lifecycle](https://docs.prelude.so/verify/v2/documentation/lifecycle.md): Understand the verification lifecycle and how it allows you to build a fully-functional verification flow in your application.
- [Prevent Fraud](https://docs.prelude.so/verify/v2/documentation/prevent-fraud.md): Configure your integration to protect your application against fraud like SMS pumping or IRSF fraud with Prelude's machine learning models.
- [Quickstart](https://docs.prelude.so/verify/v2/documentation/quickstart.md): Send and verify a code in 2 minutes and 3 simple steps with our SDKs, available for Node.js, Python, and Go.
- [Custom Sender IDs](https://docs.prelude.so/verify/v2/documentation/sender-id.md): Send verification messages through your branded sender ID.
- [Silent Verification](https://docs.prelude.so/verify/v2/documentation/silent-verification.md): Allow your users to onboard faster without the need for manually entering a verification code.
- [Test Numbers](https://docs.prelude.so/verify/v2/documentation/testing.md): Learn how to confirm that your integration is working properly by simulating verifications without incurring charges using special test numbers.
- [Migrate from V1](https://docs.prelude.so/verify/v2/documentation/v2-migration-guide.md): A guide to help you migrate from V1 to V2 of the Verify API.
- [Webhook for the Verify API](https://docs.prelude.so/verify/v2/documentation/webhook.md): Prelude Verify API can notify your application about events using webhooks. Get notified when your messages are delivered and billed.
- [Connect your WhatsApp Business Account to Prelude](https://docs.prelude.so/verify/v2/documentation/whatsapp.md): Learn how to connect your WhatsApp Business Account to Prelude via Meta’s Embedded Signup so you can send verification messages from your branded WhatsApp number.
- [Dispatch real-time events](https://docs.prelude.so/watch/v2/api-reference/dispatch-events.md): Send custom fraud signals from your application (labels and confidence levels). Events capture product-specific risk patterns and are weighted when scoring traffic. Use without Predict or Feedback if you only need to report product-side abuse (for example account.banned). Feedback is a separate, opt…
- [Predict the outcome of a verification](https://docs.prelude.so/watch/v2/api-reference/predict-outcome.md): At signup, score the user's phone number or email address (target) as legitimate or suspicious. Scoring-only — does not update counters by itself. When using Feedback, call predict before verification.started on the same target (and correlation_id when used) so feedback can warm Watch auth-start cou…
- [Send feedbacks about verifications](https://docs.prelude.so/watch/v2/api-reference/send-feedbacks.md): Optional. Report verification-funnel steps (verification.started, verification.completed) when you run phone verification outside Prelude Verify. Feeds Watch abuse-rate counters for your own flow. Call Predict on the same target before verification.started and reuse metadata.correlation_id so auth-s…
- [Introduction to Watch](https://docs.prelude.so/watch/v2/documentation/introduction.md): Protect your business and users from fraud by analyzing in real-time dozens of digital signals to block suspicious users before KYC, keeping your growth secure from the start.

## OpenAPI Specs

- [session-management](https://docs.prelude.so/api-reference/session-management.yml)
- [session-core](https://docs.prelude.so/api-reference/session-core.yml)
- [v2](https://docs.prelude.so/api-reference/v2.yml)
- [v1](https://docs.prelude.so/api-reference/v1.yml)
- [package](https://docs.prelude.so/package.json)
- [package-lock](https://docs.prelude.so/package-lock.json)
- [gen](https://docs.prelude.so/gen.yaml)
- [.spectral](https://docs.prelude.so/.spectral.yaml)