Sign up

Create a new PayPulse user account.

POST /v1/auth/signup

cURL

curl --request POST \
  --url https://api.paypulse.io/v1/auth/signup \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]",
    "name": "Jane Doe",
    "password": "s3cur3P@ssword!"
  }'

201

{
  "message": "Signup successful!",
  "code": 201,
  "data": {
    "username": "Jane Doe",
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer"
  }
}

{
  "error": {
    "code": "USER_ALREADY_EXISTS",
    "message": "User with email '[e-mail]' already exists."
  }
}

{
  "error": {
    "code": "MISSING_FIELDS",
    "message": "Missing key in request body: 'password'"
  }
}

Request body

email · string · required

The user’s email address. Must be unique across all accounts.

name · string · required

The user’s display name.

password · string · required

The user’s password. Stored as a bcrypt hash.

Response

message · string

A human-readable confirmation message. Example: "Signup successful!"

code · number

HTTP status code. 201 on success.

data · object

Hide properties

username · string

The display name provided during signup.

access_token · string

A signed HS256 JWT token valid for 1 hour. Use this as a Bearer token in subsequent requests.

token_type · string

Always "Bearer".

Error responses

Status	Error code	Description
400	INVALID_CREDENTIALS	The provided credentials are malformed or fail validation.
400	INVALID_JSON	The request body is not valid JSON.
400	MISSING_FIELDS	One or more required fields (email, name, password) are absent.
403	USER_ALREADY_EXISTS	An account with the given email address already exists.
502	DEPENDENCY_FAILURE	A downstream dependency (DynamoDB or S3) returned an error.
500	INTERNAL_SERVER_ERROR	An unexpected server-side error occurred.

Error responses follow this structure:

{
  "error": {
    "code": "USER_ALREADY_EXISTS",
    "message": "User with email '[e-mail]' already exists."
  }
}

cURL

curl --request POST \
  --url https://api.paypulse.io/v1/auth/signup \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]",
    "name": "Jane Doe",
    "password": "s3cur3P@ssword!"
  }'

201

{
  "message": "Signup successful!",
  "code": 201,
  "data": {
    "username": "Jane Doe",
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer"
  }
}

{
  "error": {
    "code": "USER_ALREADY_EXISTS",
    "message": "User with email '[e-mail]' already exists."
  }
}

{
  "error": {
    "code": "MISSING_FIELDS",
    "message": "Missing key in request body: 'password'"
  }
}