Frontend Integration Reference

Signal Face API Documentation

Every route exposed by the current Nest API, including purpose, authentication, request payloads, query parameters, success examples, and common failure responses.

0: Endpoints
/api: Global prefix
Bearer: Auth scheme

Base URL

http://localhost:3005/api

Production deployments should use the same path prefix on the deployed host.

Authentication

Authorization: Bearer <accessToken>

JWT protected routes require the access token returned by login, register, Google auth, reset, or refresh.

Validation

whitelist + forbidNonWhitelisted

Unknown body and query fields are rejected. Numeric query values are transformed where the DTO declares them.

Shared Response Patterns

Validation failure

{
  "statusCode": 400,
  "message": ["Password must be at least 6 characters"],
  "error": "Bad Request"
}

Missing or expired token

{
  "statusCode": 401,
  "message": "No token provided",
  "error": "Unauthorized"
}

Forbidden account or role

{
  "statusCode": 403,
  "message": "This account cannot perform that action",
  "error": "Forbidden"
}

Not found

{
  "statusCode": 404,
  "message": "Resource not found",
  "error": "Not Found"
}