Register a new user with phone number and encrypted password. An OTP will be sent to verify the phone number.

Request Body

curl -X POST https://api3.facepos.ie/api/v1/auth/signup \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+353871234567",
    "password": "(encrypted)",
    "market": "IE"
  }'

{
  "success": true,
  "data": {
    "message": "User registered successfully",
    "userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "timestamp": "2025-10-30T12:00:00.000Z"
}

Verify phone number with the OTP code sent during signup.

curl -X POST https://api3.facepos.ie/api/v1/auth/verify-signup \
  -H "Content-Type: application/json" \
  -d '{"phone_number": "+353871234567", "code": "123456"}'

{
  "success": true,
  "message": "Phone number verified successfully"
}

Sign in with phone number and encrypted password. Returns JWT access and refresh tokens.

curl -X POST https://api3.facepos.ie/api/v1/auth/signin \
  -H "Content-Type: application/json" \
  -d '{"phone_number": "+353871234567", "password": "(encrypted)"}'

{
  "success": true,
  "data": {
    "accessToken": "eyJhbGciOiJIUzI1NiIs...",
    "refreshToken": "eyJhbGciOiJIUzI1NiIs...",
    "expiresIn": 3600,
    "user": {
      "uid": 1,
      "phoneno": "+353871234567",
      "name": "John Doe"
    }
  }
}

Initiate passwordless OTP sign-in. Sends a one-time code to the phone number.

curl -X POST https://api3.facepos.ie/api/v1/auth/signin-otp \
  -H "Content-Type: application/json" \
  -d '{"phone_number": "+353871234567"}'

{
  "success": true,
  "data": {
    "session": "AYABeD...",
    "message": "OTP sent successfully"
  }
}

Complete OTP sign-in by verifying the code. Returns JWT tokens on success.

{
  "success": true,
  "data": {
    "accessToken": "eyJhbGciOi...",
    "refreshToken": "eyJhbGciOi...",
    "expiresIn": 3600
  }
}

Resend OTP code for signup verification or password reset.

Request a password reset. Sends an OTP to the registered phone number.

Reset password using the OTP received from forgot-password.

Change password by providing the current and new passwords. Requires authentication.

Verify if a JWT access token is still valid and not expired.

Obtain a new access token using a valid refresh token.

Permanently delete a user account from Cognito and the database.

Retrieve the authenticated user's profile information.

curl -X GET https://api3.facepos.ie/api/v1/profile \
  -H "Authorization: Bearer {access_token}"

{
  "success": true,
  "data": {
    "uid": 1,
    "phoneno": "+353871234567",
    "name": "John Doe",
    "email": "john@example.com",
    "profileImage": "https://...",
    "market": "IE"
  }
}

Update the authenticated user's profile. Supports partial updates — only send fields you want to change.

Retrieve merchants associated with the authenticated user.

{
  "success": true,
  "data": [{
    "uid": 1,
    "businessname": "Coffee Shop",
    "businesstypeid": 3,
    "phoneno": "+353871234567",
    "email": "shop@example.com",
    "status": "active"
  }]
}

Create a new merchant business profile.

Update an existing merchant profile by ID.

Delete a merchant profile by ID.

Get transactions for the authenticated user with enriched data including merchant and customer details.

Query Parameters

{
  "success": true,
  "data": [{
    "uid": 123,
    "amount": "25.50",
    "currency": "EUR",
    "status": "completed",
    "merchantname": "Coffee Shop",
    "sendername": "John Doe",
    "created_at": "2025-10-30T12:00:00.000Z"
  }],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 56
  }
}

Get transactions for a specific merchant. Supports filtering by transaction type.

Get historical transaction data for the authenticated user.

Get transaction count statistics. No authentication required.

{
  "success": true,
  "data": {
    "total": 1250,
    "completed": 1100,
    "pending": 100,
    "failed": 50
  }
}

Get public transaction data with enriched details. No authentication required.

Get raw transaction data directly from the database. No authentication required.

Get customer payment details with optional filters for merchant, status, and date range.

Delete a customer payment detail record.

Create a new refund request for a completed transaction.

List all refunds for the authenticated user or merchant.

Get details of a specific refund by ID.

Update a refund status or details.

Get the list of payees for the authenticated user.

Add a new payee. Supports both FacePOS users (by phone) and external payees (by IBAN).

Get payees associated with a specific merchant.

List bank accounts linked to the authenticated merchant.

Add a new bank account to a merchant profile.

Update an existing merchant bank account.

Remove a bank account from a merchant profile.

List app versions with optional filters for platform and version number.

Register a new app version for update tracking.

Generate unique receipt identifiers for transactions.

List all appointments with optional date and status filters.

Create a new appointment in Google Calendar.

Get a specific appointment by ID.

Update an existing appointment.

Delete an appointment.

Check API server health, database connectivity, and service status.

{
  "success": true,
  "data": {
    "timestamp": "2025-10-30T12:00:00.000Z",
    "version": "1.0.0",
    "environment": "production",
    "uptime": 86400,
    "database": {
      "status": "healthy",
      "responseTime": "15ms"
    }
  }
}

Query any database table with pagination and filters. Administrative endpoint.