{
  "opencollection": "1.0.0",
  "info": {
    "name": "Hifi Account User API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "User",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Generate a terms of service link",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.hifibridge.com/v2/tos-link",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The Terms of Service page must be displayed to the end user. This page can be whitelabeled upon request."
        },
        {
          "info": {
            "name": "Retrieve a terms of service link",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://production.hifibridge.com/v2/tos-link/:signedAgreementId",
            "params": [
              {
                "name": "signedAgreementId",
                "value": "",
                "type": "path",
                "description": "ID of the signed agreement"
              }
            ]
          },
          "docs": "Retrieve the status of a terms of service link"
        },
        {
          "info": {
            "name": "List all users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://production.hifibridge.com/v2/users",
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "If passed, you will get all users under the type."
              },
              {
                "name": "firstName",
                "value": "",
                "type": "query",
                "description": "If passed, you will get all users with the case-insensitive partial match of `firstName`.\n"
              },
              {
                "name": "lastName",
                "value": "",
                "type": "query",
                "description": "If passed, you will get all users with the case-insensitive partial match of `lastName`.\n"
              },
              {
                "name": "businessName",
                "value": "",
                "type": "query",
                "description": "If passed, you will get all users with the case-insensitive partial match of `businessName`.\n"
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "If passed, you will get all users with the case-insensitive partial match of `email`.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "default to 10, maximum to 100"
              },
              {
                "name": "createdBefore",
                "value": "",
                "type": "query",
                "description": "ISO format: YYYY-MM-DD"
              },
              {
                "name": "createdAfter",
                "value": "",
                "type": "query",
                "description": "ISO format: YYYY-MM-DD"
              }
            ]
          },
          "docs": "Get all existing Hifi users"
        },
        {
          "info": {
            "name": "Create a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.hifibridge.com/v2/users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Hifi user (Individual/Business)\n\nHIFI does not provide services to users or businesses from sanctioned and high-risk regions or unsupported US states. See [here](https://docs.hifibridge.com/docs/compliance/regions) for supported regions.\n"
        },
        {
          "info": {
            "name": "Retrieve a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://production.hifibridge.com/v2/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of the user"
              }
            ]
          },
          "docs": "Get an existing Hifi user"
        },
        {
          "info": {
            "name": "Update a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.hifibridge.com/v2/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of the user"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing Hifi user.\n\nHIFI does not provide services to users or businesses from sanctioned and high-risk regions or unsupported US states. See [here](https://docs.hifibridge.com/docs/compliance/regions) for supported regions.\n"
        }
      ]
    }
  ],
  "bundled": true
}