- Authentication
- Create a passwordless authentication
Authentication
Create a passwordless authentication
Generate a temporary token that lets a taxpayer or firm user access Remitian from your application without a password.
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
Query Parameters
Unique identifier of the user, returned when the taxpayer or firm user was created.
API key of your Client Application.
Body
When true (default), the token is invalidated after its first successful use; when false, the token can be reused until it expires
Token validity in minutes (default 15, maximum 1440 = 24 hours)
1 <= x <= 1440By 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
201
400
401
403
404
Created
The authentication token for the passwordless authentication session
The current status of the passwordless authentication
Pending, Confirmed, Cancelled The next step in the passwordless authentication flow
None, Confirmation, CompleteAuthentication, CompleteRegistration The UTC datetime when this authentication session expires (ISO 8601 format)
Whether the token is invalidated after its first successful use
Whether confirming this token skips both the MFA prompt and the requirement that the user have two-factor authentication set up
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
}'