Getting Started with auth.hawaiian.gg API

Welcome to the auth.hawaiian.gg API!
This guide will walk you through the basics of authenticating, making your first request, and understanding responses.

---

1. Overview

The Hawaiian.gg API allows developers to integrate authentication and user identity verification directly into their apps.
The primary flow:

1. Obtain an access token via authentication.
2. Send the token to the /verify endpoint.
3. Receive structured identity information.

---

2. Base URL

Environment	Base URL
Production	https://auth.hawaiian.gg/api
Sandbox	N/A

---

3. Verify Endpoint

Method	URL
GET	https://auth.hawaiian.gg/api/auth/@users/verify

Description
Validates a provided token and returns structured identity data.
This is the most common endpoint for confirming user sessions.

---

4. Example Request

curl -X POST "https://auth.hawaiian.gg/api/auth/@users/verify" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

5. Example Response

{
  "status": "success",
  "user": {
    "id": "1234567890",
    "name": "Verified Hawaii",
    "email": "verified@example.com",
    "picture": "https://example.com/avatar.jpg"
  }
}

---

6. Error Codes

Status Code	Meaning
401	Unauthorized – Missing or invalid token
403	Forbidden – Token does not have required scopes
500	Internal Server Error – An error occurred on the server