Fundrise Acknowledgments API

openapi: 3.2.0
info:
  title: Fundrise Connect (External API) Acknowledgments API
  version: 1.0.0
  contact:
    name: Fundrise Connect Support Team
    email: connect@fundrise.com
  description: '### Introduction

    Fundrise is a Fintech company democratizing access to alternative assets through technology.'
  x-logo:
    url: https://d10cq78zmnjvsx.cloudfront.net/interface/logo-hz-color.svg
    backgroundColor: '#FFFFFF'
    altText: Fundrise
    href: .
servers:
- description: Sandbox
  url: https://sandbox.fundrise.com
tags:
- name: Acknowledgments
  description: The Acknowledgments API provides acknowledgments needed to place Investments and Liquidations.
paths:
  /v1/liquidation/acknowledgments:
    get:
      description: The Liquidation acknowledgments API provides access to Fundrise Liquidation acknowledgments required to submit Liquidation requests. The acknowledgments must be displayed to the user and the user must digitally sign the acknowledgments and submit the IDs when liquidating. Digitally signing means the Partner platform must display associated checkboxes for each acknowledgement and require the user to check them to proceed.
      operationId: GetLiquidationAcknowledgments
      security:
      - ClientBearerAuthentication: []
      summary: Get Liquidation Acknowledgments
      tags:
      - Acknowledgments
      parameters:
      - $ref: '#/components/parameters/OfferingIdsQuery'
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AcknowledgmentResponse'
              example:
              - acknowledgmentId: '1'
                acknowledgmentText: I certify that I am authorized to make these elections and that all information provided is true and accurate. I certify that I have read and understand the documentation associated with my fund's offer to repurchase my shares and I agree to be bound by all terms and conditions included therein.
              - acknowledgmentId: '2'
                acknowledgmentText: I agree that Fundrise Advisors, LLC is entitled to act on the instructions of this request, without further inquiry, and these instructions supersede and have priority over all previous instructions in respect to the shares requested for redemption or repurchase.
        '401':
          $ref: '#/components/responses/401'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FundriseConnectError'
              examples:
                LiquidationNotFound:
                  value:
                    referenceId: ed8583b9-6cd9-43ed-ad46-c7c52fff0c34
                    code: '200104'
                    message: Liquidation acknowledgments not found for provided offeringIds
        '500':
          $ref: '#/components/responses/500'
  /v1/offering/{offeringId}/acknowledgments:
    get:
      description: This endpoint provides access to Fundrise Offering acknowledgments required to place Investments. When a user has selected what Offering they would like to invest in from the `GET /v1/offerings` endpoint, the acknowledgments must be displayed to the user and the user must digitally sign the acknowledgments and submit the IDs when investing into the Offering. Digitally signing means the Partner platform must display associated checkboxes for each acknowledgement and require the user to check them to proceed.
      operationId: GetInvestmentAcknowledgments
      security:
      - ClientBearerAuthentication: []
      summary: Get Investment Acknowledgments
      tags:
      - Acknowledgments
      parameters:
      - $ref: '#/components/parameters/OfferingIdPath'
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AcknowledgmentResponse'
              example:
              - acknowledgmentId: '1'
                acknowledgmentText: I have reviewed each Offering Circular and Prospectus, reviewed and agree to each Subscription Agreement, and understand the risks associated with this offering.
              - acknowledgmentId: '2'
                acknowledgmentText: I recognize that my investment is in alternative assets which are fundamentally long-term, illiquid investments; that liquidations, if approved, are paid out quarterly for the eREITs and the funds registered under the Investment Company Act of 1940, and monthly after a minimum 60-day waiting period for the eFund; and, where possible, requests for liquidation may be suspended during periods of financial stress.
        '400':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FundriseConnectError'
              examples:
                LiquidationNotFound:
                  value:
                    referenceId: ed8583b9-6cd9-43ed-ad46-c7c52fff0c34
                    code: '200103'
                    message: offeringIds are required
        '401':
          $ref: '#/components/responses/401'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FundriseConnectError'
              examples:
                LiquidationNotFound:
                  value:
                    referenceId: ed8583b9-6cd9-43ed-ad46-c7c52fff0c34
                    code: '200103'
                    message: Acknowledgments not found for provided offeringIds
        '500':
          $ref: '#/components/responses/500'
components:
  schemas:
    FundriseConnectError:
      title: Error object
      description: Error from Fundrise Connect.
      type: object
      properties:
        referenceId:
          description: A unique reference ID generated for every request that is for error tracing.
          maxLength: 1000
          type: string
        code:
          description: A numeric code mapping to a specific validation error.
          maxLength: 6
          type: string
        message:
          description: A human readable description of the error.
          maxLength: 1000
          type: string
        validationErrors:
          description: A map of field names to an array of form validation error messages
          $ref: '#/components/schemas/FieldErrorMap'
      required:
      - referenceId
    AcknowledgmentResponse:
      title: Acknowledgment
      type: object
      description: A response containing an acknowledgment needed by the End-User to perform an action.
      allOf:
      - $ref: '#/components/schemas/Acknowledgment'
    StringArray:
      type: array
      items:
        type: string
    Identifier:
      title: Identifier
      description: Value for a unique identifier.
      type: string
      format: int64
    FieldErrorMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/StringArray'
    Acknowledgment:
      properties:
        acknowledgmentId:
          $ref: '#/components/schemas/Identifier'
        acknowledgmentText:
          description: The text to be presented for the acknowledgment to be signed.
          maxLength: 1000
          type: string
  parameters:
    OfferingIdPath:
      name: offeringId
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Identifier'
        description: The Offering ID (returned by the <a href="#tag/Offerings/operation/GetOfferings">Get Offerings</a> operation) associated with the request.
    OfferingIdsQuery:
      name: offeringIds
      in: query
      required: true
      schema:
        type: array
        items:
          $ref: '#/components/schemas/Identifier'
        description: The Offering IDs (returned by the <a href="#tag/Offerings/operation/GetOfferings">Get Offerings</a> operation) associated with the request.
  responses:
    '401':
      description: Unauthorized request to server, Invalid access token or Partner credentials
    '500':
      description: Internal Service Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FundriseConnectError'
          examples:
            clientExists:
              value:
                referenceId: ed8583b9-6cd9-43ed-ad46-c7c52fff0c35
                message: Internal service error
  securitySchemes:
    PartnerBasicAuthentication:
      description: PartnerBasicAuthentication is enforced by HTTP Basic Authentication. A Partner username and password will be provided by Fundrise support.  The Partner password should be stored securely. At a minimum, it should be encrypted at-rest and access restricted to services making requests to the Fundrise API. The Partner password should not be exposed to a Client or any of their devices. If the password is compromised please contact Fundrise support.
      type: http
      scheme: basic
    ClientBearerAuthentication:
      description: 'ClientBearerAuthentication is enforced by HTTP Bearer Authentication and requires an OAuth access token.  Since access tokens are scoped to specific Clients, they identify and authenticate the Client in a request.


        Access tokens can be obtained in <a href="#tag/Authentication/operation/GetAccessToken">Get Access Token</a> requests by using the refresh token flow. OAuth refresh token are issued on <a href="#tag/Clients/operation/CreateClient">Client Creation</a> and scoped specifically to that Client. The refresh tokens will not expire and should be stored securely after Client creation. At a minimum, refresh tokens should be encrypted at-rest and access restricted to services making requests to the Fundrise API. Refresh tokens should not be exposed to a Client or any of their devices.'
      type: http
      scheme: bearer