Multi Factor Authentications

Fluid Commerce APIs (1.0)

The Fluid Commerce APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.

Download OpenAPI description
swagger.json
swagger.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Admins

Operations

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Commerce Orders

Operations

Companies

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Labels

Operations

Multi Factor Authentications

Operations

List MFA records for a specific user

Request

Query
multi_factorable_idstringrequired

ID of the associated model

pageinteger

Page number for pagination

per_pageinteger

Number of records per page

search_querystring

Search term for filtering by verification channel

sort_bystring

Column to sort by (created_at, verification_channel, authenticated)

sort_directionstring

Sort direction (asc, desc)

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/multi_factor_authentications?multi_factorable_id=string&page=0&per_page=0&search_query=string&sort_by=string&sort_direction=string'

Responses

MFA records retrieved successfully

Bodyapplication/json
multi_factor_authenticationsArray of objects(MultiFactorAuthentication)required
multi_factor_authentications[].​uuidstringrequired
multi_factor_authentications[].​verification_channelstringrequired
multi_factor_authentications[].​authenticatedbooleanrequired
Default false
multi_factor_authentications[].​created_atstring(date-time)required
multi_factor_authentications[].​verification_codestring or null
multi_factor_authentications[].​verification_code_expires_atstring or null(date-time)
metaobjectrequired
meta.​request_idstringrequired
meta.​timestampstringrequired
meta.​paginationobjectrequired
meta.​pagination.​total_countintegerrequired
meta.​pagination.​current_pageintegerrequired
meta.​pagination.​per_pageintegerrequired
Response
application/json
{
  "multi_factor_authentications": [
    { … }
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "string",
    "pagination": { … }
  }
}

Multi-Factor Authentications

Operations

creates a multi-factor authentication

Request

Bodyapplication/json
multi_factor_authenticationobjectrequired
multi_factor_authentication.​multi_factorable_typestringnon-emptyrequired
multi_factor_authentication.​multi_factorable_idinteger or stringrequired
Any of:
integer
multi_factor_authentication.​verification_channelstringnon-emptyrequired
multi_factor_authentication.​is_invitationboolean
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/multi_factor_authentications \
  -H 'Content-Type: application/json' \
  -d '{
    "multi_factor_authentication": {
      "multi_factorable_type": "string",
      "multi_factorable_id": 0,
      "verification_channel": "string",
      "is_invitation": true
    }
  }'

Responses

multi-factor authentication created

Bodyapplication/json
multi_factor_authenticationobject(MultiFactorAuthentication)
metaobject
Response
application/json
{
  "multi_factor_authentication": {
    "uuid": "string",
    "verification_channel": "test@example.com",
    "verification_code_expires_at": "2025-02-17T08:00:01Z",
    "authenticated": "false"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

shows a multi-factor authentication

Request

Path
uuidstringrequired
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/multi_factor_authentications/{uuid}'

Responses

multi-factor authentication shown

Bodyapplication/json
multi_factor_authenticationobject(MultiFactorAuthentication)
metaobject
Response
application/json
{
  "multi_factor_authentication": {
    "uuid": "string",
    "multi_factorable_type": "string",
    "multi_factorable_id": 0,
    "verification_channel": "string",
    "verification_code_expires_at": "2019-08-24T14:15:22Z",
    "authenticated": false,
    "authentication_token": "string",
    "authentication_token_expires_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

authenticates a multi-factor authentication

Request

Path
uuidstringrequired
Bodyapplication/json
uuidstringnon-emptyrequired
multi_factor_authenticationobjectrequired
multi_factor_authentication.​verification_codestringnon-emptyrequired
curl -i -X PUT \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/multi_factor_authentications/{uuid}' \
  -H 'Content-Type: application/json' \
  -d '{
    "uuid": "string",
    "multi_factor_authentication": {
      "verification_code": "string"
    }
  }'

Responses

multi-factor authentication authenticated

Bodyapplication/json
multi_factor_authenticationobject(MultiFactorAuthentication)required
multi_factor_authentication.​uuidstringrequired
multi_factor_authentication.​authenticatedbooleanrequired
Default false
multi_factor_authentication.​authentication_tokenstring or null
multi_factor_authentication.​authentication_token_expires_atstring or null(date-time)
metaobject
Response
application/json
{
  "multi_factor_authentication": {
    "uuid": "string",
    "authenticated": false,
    "authentication_token": "string",
    "authentication_token_expires_at": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

destroys a multi-factor authentication

Request

Path
uuidstringrequired
curl -i -X DELETE \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/multi_factor_authentications/{uuid}'

Responses

multi-factor authentication destroyed

Bodyapplication/json
uuidstring
Example: "mfa_13m8dhnortslzwqhvqoj9drga9e8eise"
metaobject
Response
application/json
{
  "uuid": "mfa_13m8dhnortslzwqhvqoj9drga9e8eise",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Notifications

Operations

Onboarding

Operations

Order Fulfillments

Operations

Orders

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Settings

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhooks

Operations