Skip to main content
POST
/
auth
Initiate authentication
curl --request POST \
  --url https://grid.squads.xyz/api/grid/v1/auth \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-grid-environment: <api-key>' \
  --data '{
  "email": "user@example.com",
  "provider": "privy"
}'
{
  "data": {
    "type": "email",
    "email": "user@example.com",
    "status": "pending_verification",
    "otp_sent": true,
    "created_at": "2023-07-15T14:30:00.000Z",
    "expires_at": "2023-07-15T14:40:00.000Z"
  },
  "metadata": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2023-07-15T14:30:00.000Z"
  }
}
This endpoint is for authenticating an existing user. For new users, use the Create Account endpoint.

Authorizations

Authorization
string
header
required

API key authentication with Bearer token. Include the API key in the Authorization header as 'Bearer YOUR_API_KEY'

x-grid-environment
string
header
required

Environment identifier for the Grid API. Use 'sandbox' for testing on devnet or 'production' for production on mainnet.

Body

application/json
email
string<email>
required

Email address for authentication

Example:

"user@example.com"

provider
string

Optional authentication provider

Example:

"privy"

Response

Authentication initiated successfully

data
object
required

The actual response payload

metadata
object
required
I