Xtrempay Api Documentation

Request Login Challenge

Testing

Cloud Mock

https://mock.apidog.com/m1/918700-0-default

GET

/v1/auth/biometric/challenge

Maintainer:Xtrempay Devs

Request Login Challenge
Purpose:
When a user taps “Login with biometrics” on their phone:

The backend issues a challenge (random string).

The device signs this challenge using its private key (stored securely on-device).

Then the device sends back the signed payload, and the backend verifies it using the stored public key.

Request

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://mock.apidog.com/m1/918700-0-default/v1/auth/biometric/challenge?email=paul@xtrempay.com&deviceId={{$string.uuid}}'

Responses

🟢200Success

application/json

Body

Example

{
    "timestamp": "2025-07-12T14:32:07.821591",
    "status": 200,
    "success": true,
    "message": "challenge generated.",
    "data": {
        "challengeId": "670b4d77-7ea4-4f76-adc6-71b958bdbea4",
        "challenge": "ff26c5d09de94042b02c5f76a636d09b"
    }
}

🟠400Invalid input

Modified at 2026-01-25 21:08:01

Xtrempay Api Guide