1. Authentication
  2. Create a passwordless authentication
POST
/v1/auth/users/{userId}/passwordless-authentications
curl --request POST \
     --url https://public-api.sandbox.remitian.com/v1/auth/users/{userId}/passwordless-authentications \
     --header 'Authorization: Bearer <token>' \
     --header 'x-api-key: <x_api_key>' \
     --header 'Content-Type: application/json' \
     --data '{
  "oneTimeUse": true,
  "expirationMinutes": 1,
  "skipMfaCode": true
}'

​
Authorizations

bearerAuth
required
string
Access token from POST /v1/auth/token, sent as `Authorization: Bearer {accessToken}`.

​
Query Parameters

userId
required
string

Unique identifier of the user, returned when the taxpayer or firm user was created.

x-api-key
required
string

API key of your Client Application.

​
Body

application/json
oneTimeUse
boolean

When true (default), the token is invalidated after its first successful use; when false, the token can be reused until it expires

expirationMinutes
integer

Token validity in minutes (default 15, maximum 1440 = 24 hours)

Required range: 1 <= x <= 1440
skipMfaCode
boolean

By default, confirming this token requires the user to already have two-factor authentication set up, and prompts for the MFA code; users without 2FA are rejected. When true, confirmation skips both the prompt and that requirement, even for users with 2FA enabled. Defaults to false. Intended for trusted server-initiated widget flows only. Pair with oneTimeUse: true and a short expirationMinutes.

​
Response

application/json
  • 201

  • 400

  • 401

  • 403

  • 404

Created

token
required
string

The authentication token for the passwordless authentication session

status
required
string

The current status of the passwordless authentication

Available options: Pending, Confirmed, Cancelled
nextStep
required
string

The next step in the passwordless authentication flow

Available options: None, Confirmation, CompleteAuthentication, CompleteRegistration
expiresAtUtc
required
string

The UTC datetime when this authentication session expires (ISO 8601 format)

oneTimeUse
required
boolean

Whether the token is invalidated after its first successful use

skipMfaCode
required
boolean

Whether confirming this token skips both the MFA prompt and the requirement that the user have two-factor authentication set up