find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/favcrm-io:favcrm-io-member-session-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: FavCRM Public SDK Member Session API
  version: 0.2.0
  summary: Customer-facing v6 APIs for public FavCRM integrations.
  description: 'Curated public SDK contract for building storefront, booking, member,

    content, event, commerce, offer, and survey integrations. Provider

    callbacks, generated platform docs, MCP/OAuth discovery, health checks, and

    internal developer routes are intentionally excluded.'
servers:
- url: https://api.favcrm.io
  description: Production v6 API domain
- url: https://api.favoredapp.co
  description: Legacy production domain that can proxy v6 routes
- url: http://localhost:18778
  description: Local development gateway
tags:
- name: Member Session
paths:
  /v6/customer-portal/auth/login-channel:
    get:
      tags:
      - Member Session
      summary: Get tenant login channel
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: getV6CustomerPortalAuthLoginChannel
      x-operation-id-source: derived
  /v6/customer-portal/auth/otp:
    post:
      tags:
      - Member Session
      summary: Request customer OTP
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OtpRequest'
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: postV6CustomerPortalAuthOtp
      x-operation-id-source: derived
  /v6/customer-portal/auth/otp/verify:
    post:
      tags:
      - Member Session
      summary: Verify customer OTP
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OtpVerifyRequest'
      responses:
        '200':
          $ref: '#/components/responses/Success'
        '403':
          description: '`REGISTRATION_REQUIRED` — the OTP is correct but the identifier belongs to an unregistered WhatsApp contact. No token is issued; pass `details.registrationTicket` to `POST /auth/register`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationRequiredError'
        '409':
          description: '`REGISTRATION_REVIEW_REQUIRED` — several unregistered records match the phone; the customer must contact the merchant.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: postV6CustomerPortalAuthOtpVerify
      x-operation-id-source: derived
  /v6/customer-portal/auth/register:
    post:
      tags:
      - Member Session
      summary: Register customer/member
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterMemberRequest'
      responses:
        '200':
          $ref: '#/components/responses/Success'
        '409':
          description: '`PHONE_VERIFICATION_REQUIRED` — the phone belongs to an unregistered WhatsApp contact and `registrationTicket` is missing, invalid, expired or for another phone. Verify the phone via OTP to obtain a ticket, then resubmit.

            `REGISTRATION_REVIEW_REQUIRED` — several unregistered records match the phone; the customer must contact the merchant.

            `ALREADY_EXISTS` — the phone belongs to a registered member.

            '
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/PhoneVerificationRequiredError'
                - $ref: '#/components/schemas/ErrorResponse'
      operationId: postV6CustomerPortalAuthRegister
      x-operation-id-source: derived
  /v6/customer-portal/auth/validate-token:
    post:
      tags:
      - Member Session
      summary: Validate customer token
      security:
      - customerBearer: []
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: postV6CustomerPortalAuthValidateToken
      x-operation-id-source: derived
  /v6/customer-portal/auth/refresh:
    post:
      tags:
      - Member Session
      summary: Refresh customer token
      security:
      - customerBearer: []
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: postV6CustomerPortalAuthRefresh
      x-operation-id-source: derived
  /v6/customer-portal/auth/logout:
    post:
      tags:
      - Member Session
      summary: Logout customer
      security:
      - customerBearer: []
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: postV6CustomerPortalAuthLogout
      x-operation-id-source: derived
  /v6/customer-portal/auth/registration-form:
    get:
      tags:
      - Member Session
      summary: Get tenant registration form fields
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: getV6CustomerPortalAuthRegistrationForm
      x-operation-id-source: derived
components:
  parameters:
    CompanyIdHeader:
      name: X-Company-Id
      in: header
      required: false
      schema:
        type: string
      description: Tenant id. May be omitted when tenant context is resolved by storefront domain.
  schemas:
    RegistrationRequiredError:
      allOf:
      - $ref: '#/components/schemas/ErrorResponse'
      - type: object
        properties:
          error:
            type: object
            properties:
              code:
                type: string
                const: REGISTRATION_REQUIRED
              details:
                $ref: '#/components/schemas/RegistrationRequiredDetails'
    RegisterMemberRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
        lastName:
          type: string
        phone:
          type: string
        email:
          type: string
          format: email
        source:
          type: string
        registrationTicket:
          type: string
          description: Single-use ticket from a `REGISTRATION_REQUIRED` OTP verify response. Required when the phone belongs to an unregistered WhatsApp contact; the existing contact record is upgraded in place.
    PhoneVerificationRequiredError:
      allOf:
      - $ref: '#/components/schemas/ErrorResponse'
      - type: object
        properties:
          error:
            type: object
            properties:
              code:
                type: string
                const: PHONE_VERIFICATION_REQUIRED
              details:
                type: object
                required:
                - phone
                properties:
                  phone:
                    type: string
    OtpVerifyRequest:
      type: object
      required:
      - code
      properties:
        phone:
          type: string
        email:
          type: string
          format: email
        code:
          type: string
    ErrorResponse:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
              additionalProperties: true
    SuccessResponse:
      type: object
      required:
      - success
      - data
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          additionalProperties: true
    RegistrationRequiredDetails:
      type: object
      required:
      - name
      - phone
      - expiresIn
      properties:
        registrationTicket:
          type: string
          description: Single-use ticket for `POST /auth/register`. Only issued for phone identifiers.
        name:
          type:
          - string
          - 'null'
        phone:
          type:
          - string
          - 'null'
        expiresIn:
          type: integer
          description: Ticket lifetime in seconds (900).
    OtpRequest:
      type: object
      properties:
        phone:
          type: string
        email:
          type: string
          format: email
  responses:
    Success:
      description: Standard success response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SuccessResponse'
  securitySchemes:
    customerBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT