Verified:GitHub

Platform Auth API Reference

Document platform-auth API endpoints with request schemas and error codes.

Updated Aug 27, 2026

Search Tags:#authentication #error codes #api reference #user session #otp verification #service role key #fetch integration

Ready to run

npx skills add https://github.com/stellarone/evaluate --skill platform-auth-api-reference

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: Platform Auth API Reference
Source: https://github.com/stellarone/evaluate/tree/main/.agents/skills/platform-auth-api
Command: npx skills add https://github.com/stellarone/evaluate --skill platform-auth-api-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It eliminates guesswork when integrating a consumer app with Stellar One’s platform authentication by providing endpoint-level specs, request/response shapes, and concrete error codes.

Core Features & Use Cases

Complete endpoint catalog: Covers login, logout, signup, OTP verification, password reset, OTP resend, profile bootstrapping, user invites, token customization, signup validation, terms acceptance, and health checks.
Typed integration guidance: Documents required authentication modes (none, user JWT, bearer service role key) and the expected request and response payloads.
Operational examples & error handling: Includes a practical login flow example and a structured error-code table so you can implement deterministic failure responses.

Quick Start

Ask the assistant to create the exact fetch calls for login and OTP verification using the endpoints under /api/v1/auth and your PLATFORM_AUTH_URL.

Frequently Asked Questions about Platform Auth API Reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I implement OTP verification for user signup using fetch integration?▼

To implement OTP verification for user signup, you need to call the specific platform-auth endpoints under `/api/v1/auth` using fetch integration. This requires providing the correct authentication headers, request body schemas, and mapping documented error codes to handling logic for deterministic failure responses.

What authentication modes are required for platform-auth API endpoints?▼

Platform-auth API endpoints require specific authentication modes depending on the operation: none, user JWT, or a bearer service role key. You must include the correct authentication headers matching the expected mode to successfully execute your fetch calls.

How does custom access token enrichment work in Stellar One authentication?▼

Custom access token enrichment allows you to append additional claims to the user session token during the profile bootstrap phase. You achieve this by calling the dedicated enrichment endpoint with a valid user JWT and the required request payload schema.

What is the best way to handle platform authentication error codes in a consumer application?▼

The best way to handle platform authentication error codes is to map the structured error-code table to specific handling logic in your consumer application. This approach ensures deterministic failure responses when operations like login, signup, or password reset fail.

Can I reset a user password and resend OTP without an existing user session?▼

Yes, you can reset a user password and resend OTP without an existing user session by calling the respective endpoints with no authentication mode required. You must provide the correct request body schema to trigger the password reset or OTP resend successfully.

Why does my fetch integration fail when calling the profile bootstrap endpoint?▼

Your fetch integration fails when calling the profile bootstrap endpoint if you provide incorrect endpoint paths, invalid authentication headers, or mismatched request body schemas. You must ensure valid user JWT credentials and verify the service health check passes before retrying.