Last Update: Spetember 10th 2018
\nThe FundAmerica platform is a RESTful API that uses JSON as its response type for everything. It also makes heavy use of different HTTP verbs (GET,POST,PATCH,DELETE) and HTTP error messages where applicable.
To view an example of creating an offering, accepting it for investment, making investments and closing the offering, see Investment Quick Start Guide
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4746294","collectionId":"58ed4e93-a4dc-4fda-b41e-ad406f947a65","publishedId":"RWaHxohz","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-08-11T15:11:13.000Z"},"item":[{"name":"Support","item":[],"id":"4f05fe18-4a48-4e4c-8c8b-b02805d09be3","description":"Please report any issues immediately by contacting developer support directly at tech-support@fundamerica.com and we will deal with them promptly. Additionally questions, comments, suggestions or feature requests are welcome.
\nThere is a developer newsletter directly related to the API which will include new feature announcements, updates, tips and tricks, and upcoming maintenance schedules. It is strongly recommended that all developers sign up to receive this newsletter by clicking here
\n","event":[{"listen":"prerequest","script":{"id":"188a6597-ce7d-4665-b6ad-3d9bc3e11ba3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bafec865-ae97-4268-a184-98c25b1df854","type":"text/javascript","exec":[""]}}],"_postman_id":"4f05fe18-4a48-4e4c-8c8b-b02805d09be3"},{"name":"Invest Now Users","item":[],"id":"2aefc217-7b41-4cab-8b55-25784fe39802","description":"If you're using our Invest Now products and wish to further customize or better integrate it, please see our Invest Now Developers Guide for more information.
\n","event":[{"listen":"prerequest","script":{"id":"ef649b8a-14f2-49a1-b943-4fe8b5619d62","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d38bf797-c035-4367-a437-4ed82ea440a3","type":"text/javascript","exec":[""]}}],"_postman_id":"2aefc217-7b41-4cab-8b55-25784fe39802"},{"name":"Changelog","item":[],"id":"1570f501-9ed9-4b16-aeff-3dc562abf127","description":"For a list of recent changes and news, check out our changelog
\n","event":[{"listen":"prerequest","script":{"id":"61d138e1-118d-4faa-bd91-51722080b987","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c7842da2-a328-4a5d-ab16-7678e484653b","type":"text/javascript","exec":[""]}}],"_postman_id":"1570f501-9ed9-4b16-aeff-3dc562abf127"},{"name":"Time Zone","item":[],"id":"625161ba-0b20-4678-8694-5e9ea094e757","description":"New accounts will default to the 'Eastern Time' time zone. You can update this value under Account Settings when logged in.
\n","event":[{"listen":"prerequest","script":{"id":"c7ab8555-1d62-4dbe-a1af-f3d2618b6148","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"124ace85-2d8c-4512-8226-1d80101af368","type":"text/javascript","exec":[""]}}],"_postman_id":"625161ba-0b20-4678-8694-5e9ea094e757"},{"name":"API Keys","item":[],"id":"bf347fc3-9b7a-4a02-a666-101493696af5","description":"In order to authenticate with our API, you'll need to get an API key. Your API key can be found after logging in to your account at https://my.fundamerica.com and navigating to Account Settings and then \"API keys\".
\n","event":[{"listen":"prerequest","script":{"id":"25fee690-8997-4dec-9480-bb5c69422e9e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"72fa6a4e-4a4f-4f50-8e04-f4d69caeaa26","type":"text/javascript","exec":[""]}}],"_postman_id":"bf347fc3-9b7a-4a02-a666-101493696af5"},{"name":"Test vs Production","item":[],"id":"846172d2-5e8d-44d5-aee8-8d4ddc884b03","description":"There are two separate environments for testing and production:
\nThe API examples throughout this documentation will reference the production calls except where they are explcitly testing related. Remember to point to sandbox.fundamerica.com for all calls when testing.
\nIf you have multiple test environments (e.g. staging, QA, etc.) create a new account for each environment. This is the easiest way to keep data segregated and test multiple endpoints.
\nKeep in mind that there is no billing or approval necessary in the sandbox environment. No objects created on the sandbox are ever reviewed by customer service.
\nSince objects created on the sandbox are not reviewed by customer service, certain objects that undergo manual state changes (e.g. accepting an offering's escrow account or marking an investment as \"received\") require special test calls to change the state. (See Test Mode Endpoint Reference)
\n","event":[{"listen":"prerequest","script":{"id":"5955e338-f438-49a9-84bb-2517ebb9865a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"844dd31e-e4cc-4409-9f97-575dfd66a766","type":"text/javascript","exec":[""]}}],"_postman_id":"846172d2-5e8d-44d5-aee8-8d4ddc884b03"},{"name":"Authentication","item":[],"id":"2f632a70-2073-441c-a6d7-cfc5f4bcb39c","description":"HTTP authentication is used for all requests. Your API key should be used as your username with the password left blank. Only make requests over HTTPS.
\n","event":[{"listen":"prerequest","script":{"id":"f9258a44-ac9f-4503-8c38-80ad37eb3996","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"503bf818-5abc-427a-90b2-8ac56ee76685","type":"text/javascript","exec":[""]}}],"_postman_id":"2f632a70-2073-441c-a6d7-cfc5f4bcb39c"},{"name":"API Versions","item":[],"id":"b6d87336-6cc4-4e54-838e-fe18fcc85c16","description":"The API does not have a strict version, but rather a rolling version. New features are added regularly and occasionally features are deprecated and removed. At the time a new account is created, an API version date is set to the sign up date.
\nThe API version date will dictate certain behavior in the API. For instance, API response values that have been deprecated prior to the API version date will not appear in API responses. Additionally, certain changes may be mandatory for the current version of the API that may still be optional for older versions.
\nThe version date can be set in one of two ways:
\n_version parameter with your API requests either asa querystring or form value.curl https://apps.fundamerica.com/api/example_objects?_version=2015-02-27 \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:\nNote: If you are implmenting a white label or other system that allows multiple FundAmerica accounts and API keys to be used, it's important to make sure that everyone is using the same version. Using the querystring method is the simplest way to accomodate this without having your account users set a default to match whatever you have developed against.
\n","event":[{"listen":"prerequest","script":{"id":"9ed46db2-5932-499a-b839-60031f2e8bc5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"260e2961-3221-4468-b082-db59e2255b0d","type":"text/javascript","exec":[""]}}],"_postman_id":"b6d87336-6cc4-4e54-838e-fe18fcc85c16"},{"name":"Deprecated Features","item":[],"id":"52f6018c-7c29-4810-8aac-e4f339dc5641","description":"Due to changes in statute, policy, technology, or just plain correction of early oversights, certain features of the API will be deprecated and ultimately removed from time to time.
\nIn general, deprecation notices will be announced in the changelog via the newsletter. Additionally, deprecation warnings will be included in API responses if certain fields have been deprecated. A deprecated_keys field will be included in any response containing keys that are set to be removed.
{\n \"object\":\"example_object\",\n \"id\":\"XXXXXXXXXXXXXXXXXXXXXX\",\n \"url\":\"https://apps.fundamerica.com/api/example_objects/XXXXXXXXXXXXXXXXXXXXXX\",\n \"name\":\"OBJECT NEW NAME\",\n \"old_key\":\"No one uses this anymore.\",\n \"deprecated_keys\":[\"old_key\"]\n}\nIf you notice these in your responses, please adjust your code not to rely on these keys as they will be removed at some point in the future.
\nCrowdfunding has a lot of moving parts and many of our services are subject to changes in law, policy, judicial review, etc. We do not always have control over these changes and when they must be implemented. While we strive not to break existing implementations, there may be times where this simply isn't an option. As a result, it is prudent for developers to check out the changelog from time to time or, more conveniently, sign up for the newsletter to receive updates on API changes.
\nDeprecated keys will be removed from the documentation examples to avoid confusing new developers.
\n","event":[{"listen":"prerequest","script":{"id":"293cd011-4619-4dcf-8e3d-9af811eb14c8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2e50e2d8-79b7-4ab7-934c-9bfdcf277d46","type":"text/javascript","exec":[""]}}],"_postman_id":"52f6018c-7c29-4810-8aac-e4f339dc5641"},{"name":"Errors","item":[],"id":"275bc702-a86d-402f-85c6-0deadc880a70","description":"An HTTP status of 200 means everything processed as expected. The 4xx and 5xx error codes means something went wrong. The most common errors you'll see are as follows:
401: Authentication error. Your API key is incorrect.403: Not authorized. You don't have permission to take action on a particular resource. It may not be owned by your account or it may be in a state where your action cannot be taken (e.g. attempting to cancel an invested investment)404: Resource was not found.422: This usually means you are missing or have supplied invalid parameters for a request.500: Internal server error. Something went wrong. This is a bug. Please report it to support immediately.{\n \"status_message\":\"API key is invalid.\"\n}\n{\n \"status_message\": \"Not Authorized.\"\n}\n{\n \"status_message\": \"Resource not found.\"\n}\n{\n \"offering\":{\n \"name\":[\"is already in use\"]\n },\n \"entity\":{}\n}\nThe details of an error are listed with the object type as the key and a value of another object keyed by the attribute name followed by an array of errors on the field. In instances where multiple objects may be modified in a request (almost universally an entity) multiple object keys will be listed.
\nNote: Sometimes there is an error not related to any particular attribute of an object. Those errors will be keyed under base. For instance, if there was an error processing ACH on an investment, it would be listed as an error under base.
All examples in this document are in the form of cURL commands. You can use the the Postman documentation to change the language of requests.
\ncURL is a popular tool used for executing HTTP requests and returning the subsequent responses which makes it suitable for interacting with a RESTful API. More information can be found at the cURL homepage and the Wikipedia page.
\n","event":[{"listen":"prerequest","script":{"id":"787dfaad-aca3-4481-9913-d479c9f93fe4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"de2f1bcc-3572-48ca-b3f2-11c7a80ac713","type":"text/javascript","exec":[""]}}],"_postman_id":"9a78997f-c1ac-406d-ada1-6f71534d4a9f"},{"name":"Resources and Action Overview","item":[],"id":"b847b6cb-4e6e-4bac-8266-5adf42c47eea","description":"Resources are represented as JSON objects and have predictable endpoints for each action. Let's take an example object called \"Example Object.\"
\ncurl https://apps.fundamerica.com/api/example_objects \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-X POST \\\n-d name=\"OBJECT NAME\"\ncurl https://apps.fundamerica.com/api/example_objects/XXXXXXXXXXXXXXXXXXXXXX \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:\ncurl https://apps.fundamerica.com/api/example_objects/XXXXXXXXXXXXXXXXXXXXXX \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-X PATCH \\\n-d name=\"OBJECT NEW NAME\"\ncurl https://apps.fundamerica.com/api/example_objects/XXXXXXXXXXXXXXXXXXXXXX \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-X DELETE\n{\n \"object\":\"example_object\",\n \"id\":\"XXXXXXXXXXXXXXXXXXXXXX\",\n \"url\":\"https://apps.fundamerica.com/api/example_objects/XXXXXXXXXXXXXXXXXXXXXX\",\n \"name\":\"OBJECT NEW NAME\"\n}\nThese attributes are the same for every object and will not be repeated in the rest of this documentation.
\nobject: The type of object.id: The object's unique ID.url: The URL of this particular object.curl https://apps.fundamerica.com/api/example_objects \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:\n{\n \"object\":\"resource_list\",\n \"total_resources\":1,\n \"more\":false,\n \"page\":1,\n \"per\":25,\n \"resources\":[\n {\n \"object\":\"example_object\",\n \"id\":\"XXXXXXXXXXXXXXXXXXXXXX\",\n \"url\":\"https://apps.fundamerica.com/api/example_objects/XXXXXXXXXXXXXXXXXXXXXX\",\n \"name\":\"https://apps.fundamerica.com/api/offerings/OBJECT NAME\"\n }\n ]\n}\ntotal_resources: The total number of resources.more: Whether or not there are additional pages.page: The current page.per: The number of resources per page.resources: The list of resources.The query strings page and per can be sent to a list action to change which page is being viewed and how many resources are included in a page.
A complete list of API endpoints can be found at API Endpoint Reference.
\n","event":[{"listen":"prerequest","script":{"id":"fe611cf4-10cb-42b4-ac5d-37abe384912a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b1645519-7450-4f6d-9952-0edd92e2d62b","type":"text/javascript","exec":[""]}}],"_postman_id":"b847b6cb-4e6e-4bac-8266-5adf42c47eea"},{"name":"Special Request Options","item":[],"id":"28d6b8b9-bc93-41c4-a1c9-ab7068df2623","description":"On index methods that return more than one object, you may wish to sort them by a particular attribute. Most non-url attributes are sortable. This can be done by passing a _sort[<attribute_name>]=1 or _sort[<attribute_name>]=-1 with the request as either a query string or a post parameter. A value of 1 will sort the objects by the attribute in ascending order and a value of -1 will sort the objects by the attribute in descending order.
Many objects contain references to other objects. For instance an offering many contain an issuer entity. Instead of making a second GET request if you wanted to also get the information for the issuer, you could expand the issuer. Any object that returns <attribute_name>_url with a URL pointing to another API URL can be expanded by passing _expand[<attribute_name>]=1 with the request as either a query string or a post parameter.
So, if _expand[entity]=1 was passed to an offering request, the response would include an entity parameter with the same data as GET entity_url would provide.
Sometimes you only want to bring back a subset of data, especially on certain API requests that return a lot of data. You can hide attributes you do not wish to see by passing a _hide[<attribute_name>]=1 with the request as either a query string or a post parameter.
There is a lot of manual approval required in securities, particularly with escrow. Additionally, some actions execute asynchronously like processing background checks. You have two options, you can regularly poll a particular object for changes or use webhooks.
\nWhen configuring up an API key, you can provide an optional webhook URL and when certain actions take place, you will receive a notification message from our system. The notification will POST to the URL you provided (you should use HTTPS in production) with a parameter of data containing a JSON message about what changed.
{\n \"object\":\"investment\",\n \"id\":\"LckF85F4R8Soe3Why-NZzw\",\n \"url\":\"https://apps.fundamerica.com/api/investments/LckF85F4R8Soe3Why-NZzw\",\n \"webhook_id\":\"R38DyKhFS_Ke6OhtzjMvcQ\",\n \"signature\":\"b8a2f282649eebbfac85be3a959942b9\",\n \"action\":\"update\",\n \"changes\":[\"status\"]\n}\nwebhook_id: Each webook has a unique ID. If you want to prevent replay attacks, it is good practice to only execute a particular ID once.signature: An MD5 hex digest of the webhook_id combined with your API key.action: May be set to create or update. If create it means the object was newly created.changes: The attributes that changed.The actual changes are not sent so once you receive a webhook, you need to request the current state of the object.
\nThe signature is an MD5 hex digest of the webhook_id combined with the verification key found in your Webhook Configuration settings. Here is an example in Ruby of how to generate a signature for validation:
webhook = JSON.parse(params[:data])\nwebhook_id = webhook['webhook_id']\nexpected_signature = Digest::MD5.hexdigest(webhook_id + webhook_verification_key)\nif expected_signature == webhook['signature']\n # Process webhook...\nend\nIn addition to configuring a webhook_url for your API key, you can also specify an Error Report Email. If there are issues sending webhook requests, you will be notified via this email address if it is provided.
Our platform will make ten attempts, one every minute, to send a webhook. If the HTTP response has a status of anything but a 200 or cannot send the request for any other reason (e.g. DNS problems, unable to reach host, etc.) it will send an email message informing you about the error and containing the webhook information.
\nIt's possible to test and debug webhooks by checking your webhook logs. This will give you a list of all webhooks that would have been sent. Even if you haven't configured a webhook_url, webhooks still appear in the log and as such can be used for testing purposes or even playback in the future if there was an error.
https://apps.fundamerica.com/api/webhook_logs (GET)\nThe data field is exactly the JSON that would have been sent to your webhook_url.
Custodial entities are those such as IRAs and trusts where there is a custodian and a beneficiary.
\n","urlObject":{"path":["entities"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"eaf64af0-a452-42ea-983b-f082f9fb0fe1","name":"Create a new custodial entity","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n \"city\" : \"Los Angeles\",\n \"country\" : \"US\",\n \"email\" : \"custodial@example.com\",\n \"name\" : \"James Trust\",\n \"phone\" : \"12025552051\",\n \"postal_code\" : \"90005\",\n \"region\" : \"CA\",\n \"street_address_1\" : \"90 Wilshere Drive\",\n \"tax_id_number\" : \"999999998\",\n \"type\" : \"custodial\",\n \"region_formed_in\" : \"NY\",\n \"contact_name\" : \"Jame's Trusts Custodian\"\n}\n"},"url":"{{env}}/entities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Disposition, Content-Type, X-FA-Public-Key, X-FA-User-Session-Token, X-Requested-With","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, DELETE","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Access-Control-Expose-Headers","value":"Cache-Control, Content-Disposition, Content-Type, X-FA-Session-Expires-At","name":"Access-Control-Expose-Headers","description":"Lets a server whitelist headers that browsers are allowed to access."},{"key":"Access-Control-Max-Age","value":"86400","name":"Access-Control-Max-Age","description":"Indicates how long the results of a preflight request can be cached in seconds."},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"433","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 20:38:47 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx","name":"Server","description":"A name for the server"},{"key":"Status","value":"200 OK","name":"Status","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Request-Id","value":"35e18723-5e06-4116-82e5-15627ac0d533","name":"X-Request-Id","description":"Custom header"},{"key":"X-Runtime","value":"0.032483","name":"X-Runtime","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\"object\":\"entity\",\"id\":\"oe60CJSgTNW70AzS8HgftQ\",\"url\":\"https://sandbox.fundamerica.com/api/entities/oe60CJSgTNW70AzS8HgftQ\",\"broker_dealer_customer\":false,\"building_name\":null,\"created_at\":\"2018-07-06T20:38:47.243Z\",\"city\":\"Los Angeles\",\"contact_name\":\"Jame's Trusts Custodian\",\"country\":\"US\",\"date_of_birth\":null,\"email\":\"custodial@example.com\",\"name\":\"James Trust\",\"phone\":\"12025552051\",\"platform_investor_url\":\"https://sandbox.fundamerica.com/api/entities/oe60CJSgTNW70AzS8HgftQ/platform_investor\",\"postal_code\":\"90005\",\"region\":\"CA\",\"region_formed_in\":\"NY\",\"street_address_1\":\"90 Wilshere Drive\",\"street_address_2\":null,\"street_name\":null,\"street_number\":null,\"street_type\":null,\"tax_id_number\":\"999999998\",\"type\":\"custodial\",\"unit_number\":null,\"updated_at\":\"2018-07-06T20:38:47.243Z\"}"}],"_postman_id":"cdbc0c2b-bf5a-4913-b8b8-8b9c53d3435b"},{"name":"Create new Great Britian Entity","id":"59e7735f-e332-4eac-afe7-23d875a2ac01","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"Entities represent either a person or a company. They are used in multiple places throughout the fundraising process. Entities can be an investor or an issuer and more generally speaking anyone related to an offering that is eligible for a background check.
\nEntities can have an investor_suitability_status set for them. This status is set based on receival and accepetance/denial of related investor suitability questionnaires. More details on investor_suitability_status and related investor suitability questionannares can be found in the Broker Dealer Services section.
GET https://apps.fundamerica.com/api/entities\nPOST https://apps.fundamerica.com/api/entities\nGET https://apps.fundamerica.com/api/entities/:id\nPATCH https://apps.fundamerica.com/api/entities/:id\ncity: City of entity's address. Required.country: Country of entity's address.date_of_birth: Entity's date of birth. Required if type is person.email: Entity's contact email. Required.contact_name: Required if type is company.name: Entity's legal name. Required.phone: Entity's contact phone number. Required.postal_code: Postal or ZIP Code code of entity's address. Required.region: State or region of entity's address. Required.region_formed_in: The state where the company was formed. Required if type is company and country is US.street_address_1: Street address line 1. Required.street_address_2: Street address line 2. Optional.tax_id_number: SSN or FEIN in US, or other tax ID number if non-US for entity. Required.type: Must be person, company or custodial. Required.investor_suitability_status: It can be one of four values:null: No investor suitability questionnaire has been filled out.pending: Investor suitability questionnaire is being reviewed.accepted: Your Broker-Dealer has accepted the investor suitability questionnaire. See Broker Dealer Services for more information.denied: Your Broker-Dealer has denied the investor suitability questionnaire. See Broker Dealer Services for more information.For entities being used as actual issuers, associated persons and investors, it is possible that they may be contacted by customer service (e.g. there is a problem on an AML review or an investment) for more information or a correction in their information. If entity information is updated by FundAmerica customer service, a webhook will be created letting your system know that information has been updated on the entity.
\nOther API calls that accept entities can accept them in one of two ways:
\nWhen creating entities from Great Britian (country code \"GB\"), there are additional fields to use. If background checks will be run on these entities, it's highly recommend to fill in the following fields to speed up verification.
\nbuilding_name: Building name of entity's address. Required if street_number is omitted.county: County of entity's address.street_name: Street name of entity's address. Required.street_number: Street number of entity's address. Required if building_name is omitted.street_type: Street type of entity's address. e.g. \"Way\".unit_number: Unit number of entity's address.In this example \"Danny Documentation\" is added as a parent entity for \"FA Documentation\" a company entity that was created earlier
\n","urlObject":{"path":["entity_relationships"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"506ee534-d0ec-4b05-9f7b-13816b5a5f0f","name":"Create new entity relationship","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"child_entity_id\" : \"R-ycs0c1RVOsfR16vlz9mg\",\n\t\"description\" : \"Also a major stockholder\",\n\t\"parent_entity_id\" : \"pBLbZwoIRUqSxzWYPgg6tw\",\n\t\"parent_title\" : \"Authorized Person\"\n}"},"url":"{{env}}/entity_relationships"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Disposition, Content-Type, X-FA-Public-Key, X-FA-User-Session-Token, X-Requested-With","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, DELETE","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Access-Control-Expose-Headers","value":"Cache-Control, Content-Disposition, Content-Type, X-FA-Session-Expires-At","name":"Access-Control-Expose-Headers","description":"Lets a server whitelist headers that browsers are allowed to access."},{"key":"Access-Control-Max-Age","value":"86400","name":"Access-Control-Max-Age","description":"Indicates how long the results of a preflight request can be cached in seconds."},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"288","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 22:44:42 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx","name":"Server","description":"A name for the server"},{"key":"Status","value":"200 OK","name":"Status","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Request-Id","value":"a8f1d1d4-e9f1-4a32-917b-e5be61b13c19","name":"X-Request-Id","description":"Custom header"},{"key":"X-Runtime","value":"0.045894","name":"X-Runtime","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\"object\":\"entity_relationship\",\"id\":\"imfK4IeETP-tRtufpRd1EQ\",\"url\":\"https://sandbox.fundamerica.com/api/entity_relationships/imfK4IeETP-tRtufpRd1EQ\",\"child_entity_url\":\"https://sandbox.fundamerica.com/api/entities/R-ycs0c1RVOsfR16vlz9mg\",\"created_at\":\"2018-07-06T22:44:42.451Z\",\"description\":\"Also a major stockholder\",\"parent_entity_url\":\"https://sandbox.fundamerica.com/api/entities/pBLbZwoIRUqSxzWYPgg6tw\",\"parent_title\":\"Authorized Person\",\"updated_at\":\"2018-07-06T22:44:42.451Z\"}"}],"_postman_id":"2afb4b9a-a142-4ef3-a968-efb091081cc2"},{"name":"Get respective child entities for a specific entity","id":"a2583ff7-5792-4e15-8285-f1f0d281d8aa","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"In this example it is checked to see the respective children entities of \"Danny Documentation\".
\n","urlObject":{"path":["entities",":id","child_entities"],"host":["{{env}}"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"e8e620dc-6657-4def-9257-f6dc33485cb2","name":"Get respective child entities for a specific entity","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{env}}/entities/{{parent-entity-id}}/child_entities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Disposition, Content-Type, X-FA-Public-Key, X-FA-User-Session-Token, X-Requested-With","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, DELETE","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Access-Control-Expose-Headers","value":"Cache-Control, Content-Disposition, Content-Type, X-FA-Session-Expires-At","name":"Access-Control-Expose-Headers","description":"Lets a server whitelist headers that browsers are allowed to access."},{"key":"Access-Control-Max-Age","value":"86400","name":"Access-Control-Max-Age","description":"Indicates how long the results of a preflight request can be cached in seconds."},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"512","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 22:47:54 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx","name":"Server","description":"A name for the server"},{"key":"Status","value":"200 OK","name":"Status","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Request-Id","value":"d02644a0-1e6b-484f-8c2c-6386a561af5e","name":"X-Request-Id","description":"Custom header"},{"key":"X-Runtime","value":"0.026881","name":"X-Runtime","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\"object\":\"resource_list\",\"total_resources\":1,\"page\":1,\"per\":25,\"more\":false,\"resources\":[{\"object\":\"entity\",\"id\":\"R-ycs0c1RVOsfR16vlz9mg\",\"url\":\"https://sandbox.fundamerica.com/api/entities/R-ycs0c1RVOsfR16vlz9mg\",\"broker_dealer_customer\":false,\"building_name\":null,\"created_at\":\"2018-07-06T17:52:58.895Z\",\"city\":\"Las Vegas\",\"contact_name\":\"Danny Documentation\",\"country\":\"US\",\"date_of_birth\":null,\"email\":\"whatsupdoc@fundamerica.com\",\"executive_name\":\"Danny Documentation\",\"investor_suitability_status\":null,\"kyc_status\":null,\"name\":\"FA Documentation\",\"phone\":\"1 (555) 555-5555\",\"platform_investor_url\":\"https://sandbox.fundamerica.com/api/entities/R-ycs0c1RVOsfR16vlz9mg/platform_investor\",\"postal_code\":\"89128\",\"region\":\"NV\",\"region_formed_in\":\"NV\",\"street_address_1\":\"123 Road Ave\",\"street_address_2\":\"555\",\"street_name\":null,\"street_number\":null,\"street_type\":null,\"tax_id_number\":\"123123123\",\"type\":\"company\",\"unit_number\":null,\"updated_at\":\"2018-07-06T17:58:37.517Z\"}]}"}],"_postman_id":"a2583ff7-5792-4e15-8285-f1f0d281d8aa"},{"name":"Get respective parent entities for a specific entity","id":"3cda9ba5-d1de-4b2b-99a9-cbda60ccd003","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{env}}/entities/:id/parent_entities","description":"In this example it is checked to see if \"Danny Documentation\" is a parent entity of \"FA Documentation\".
\n","urlObject":{"path":["entities",":id","parent_entities"],"host":["{{env}}"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"66d7339a-3509-4f65-b750-0ebf89d318d1","name":"Get respective parent entities for a specific entity","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{env}}/entities/{{child-entity-id}}/parent_entities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Disposition, Content-Type, X-FA-Public-Key, X-FA-User-Session-Token, X-Requested-With","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, DELETE","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Access-Control-Expose-Headers","value":"Cache-Control, Content-Disposition, Content-Type, X-FA-Session-Expires-At","name":"Access-Control-Expose-Headers","description":"Lets a server whitelist headers that browsers are allowed to access."},{"key":"Access-Control-Max-Age","value":"86400","name":"Access-Control-Max-Age","description":"Indicates how long the results of a preflight request can be cached in seconds."},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"509","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 22:54:39 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx","name":"Server","description":"A name for the server"},{"key":"Status","value":"200 OK","name":"Status","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Request-Id","value":"a889bf1d-c771-4418-b1af-376b4b8b4b11","name":"X-Request-Id","description":"Custom header"},{"key":"X-Runtime","value":"0.034888","name":"X-Runtime","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\"object\":\"resource_list\",\"total_resources\":1,\"page\":1,\"per\":25,\"more\":false,\"resources\":[{\"object\":\"entity\",\"id\":\"pBLbZwoIRUqSxzWYPgg6tw\",\"url\":\"https://sandbox.fundamerica.com/api/entities/pBLbZwoIRUqSxzWYPgg6tw\",\"broker_dealer_customer\":false,\"building_name\":null,\"created_at\":\"2018-07-06T17:57:54.549Z\",\"city\":\"Las Vegas\",\"contact_name\":null,\"country\":\"US\",\"date_of_birth\":\"1987-07-18\",\"email\":\"whastupdoc@fundamerica.com\",\"executive_name\":null,\"investor_suitability_status\":null,\"kyc_status\":null,\"name\":\"Danny Documentation\",\"phone\":\"1 (222) 222-2222\",\"platform_investor_url\":\"https://sandbox.fundamerica.com/api/entities/pBLbZwoIRUqSxzWYPgg6tw/platform_investor\",\"postal_code\":\"89128\",\"region\":\"NV\",\"region_formed_in\":null,\"street_address_1\":\"321 Road Ave\",\"street_address_2\":\"321\",\"street_name\":null,\"street_number\":null,\"street_type\":null,\"tax_id_number\":\"321321321\",\"type\":\"person\",\"unit_number\":null,\"updated_at\":\"2018-07-06T17:57:54.549Z\"}]}"}],"_postman_id":"3cda9ba5-d1de-4b2b-99a9-cbda60ccd003"},{"name":"Get all entity relationships","id":"c9c47ac9-8921-491e-beec-c052945213b9","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"Changed parent_id
When dealing with company entities, it generally makes sense to have a parent/child relationship with either another company or a person or a mix of each. For instance, an actual issuer LLC may have multiple owners or executives subject to AML. In order to prevent the need for manual intervention, it is a good idea to create relationships between entities.
\nThe parent in the relationship is an entity with some kind of authority over the child. For instance an owner, a stockholder, an executive, a manager, etc. would all be the parent. Both a person and a company can act as a parent in the relationship, however only companies can be the child. For the purposes of complete AML it's important that any chain of parents ends with a person.
\nAdditionally, an ACH Authorization can only be used by the entity it was created in association with. However, many funding platforms allow a person to invest as a company. Child entities can use their parents' ACH authorizations to invest.
\nGET https://apps.fundamerica.com/api/entities/:id/child_entities\nGET https://apps.fundamerica.com/api/entities/:id/parent_entities\nGET https://apps.fundamerica.com/api/entities/:id/relationships_as_child\nGET https://apps.fundamerica.com/api/entities/:id/relationships_as_parent\nGET https://apps.fundamerica.com/api/entity_relationships\nPOST https://apps.fundamerica.com/api/entity_relationships\nGET https://apps.fundamerica.com/api/entity_relationships/:id\nPATCH https://apps.fundamerica.com/api/entity_relationships/:id\nDELETE https://apps.fundamerica.com/api/entity_relationships/:id\nchild_entity_id: The ID of the entity that is the child in the relationship.description: An optional description about the relationship. This can be useful for adding special instrutions or notes that customer service might use when resolving AML.parent_entity_id: The ID of the entity that is the parent in the relationship. The parent should have some kind of responsibility over the child entity like a manager, a director, an executive or a shareholder.parent_title: An optional title for the parent entity in relation to the child entity. In general, it's good practice to include this.Note: It is required for non-person entities to have at least one associated person entity as a parent entity
\n","event":[{"listen":"prerequest","script":{"id":"d9d4bcc9-0ac5-49b3-b81d-97b7b40d7d90","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d30ce491-1f28-41c6-916e-43bf374de020","type":"text/javascript","exec":[""]}}],"_postman_id":"c47913f9-b1e6-48f1-9057-8cea9f5c00d9"},{"name":"Entity Documents","item":[{"name":"Create entity documents","id":"c9548417-d09e-4bcf-947a-2cfe58de174a","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"There are a number of instances where providing documentation on a particular entity to FundAmerica is important. The most common instances are when there is an AML exception and documentation is necessary to verify the investor's identity. Arbitrary documents can be attached to an entity. This can be done preemptively (e.g. your portal always collects trust documents from trust entities) or as needed during the AML process.
\nSince this API allows for the transmission of binary data (the file itself), the POST method must be sent as multipart/form-data just as you would if uploading a file from an HTML form.
Files cannot be deleted once uploaded, nor can they be modified via the API.
\nGET https://apps.fundamerica.com/api/entities/:id/entity_documents\nPOST https://apps.fundamerica.com/api/entity_documents\nGET https://apps.fundamerica.com/api/entity_documents/:id\ncontent_type: If you want to force a particular content type, you can override it with this parameter. This will be preferred over the content type set in the body of the HTTP request.description: An optional description about the file.entity_id: The entity to be associated with the document.file: The file.purpose: This must be set to kyc.title: The document's title.A cash blotter tracks the transactions of an investor's ledger.
\nGET https://apps.fundamerica.com/api/entities/:id/cash_blotter\n###Response Attributes
\nbalance: The total balance after this transaction cleared.credit: Amount credited to the escrow ledger.debit: Amount debited from the escrow ledger.description: A description of the ledger entry.investment_payments: Related investment payments.Updated previously created offering to accept investors from all US states.
\n","urlObject":{"path":["offerings","{{offering-id-2}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"4ed9ddca-2ccd-4bc0-86be-6d559e5e3baf","name":"Update Offering","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"us_states_only\" : []\n}"},"url":"{{env}}/offerings/{{offering-id-2}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Disposition, Content-Type, X-FA-Public-Key, X-FA-User-Session-Token, X-Requested-With","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, DELETE","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Access-Control-Expose-Headers","value":"Cache-Control, Content-Disposition, Content-Type, X-FA-Session-Expires-At","name":"Access-Control-Expose-Headers","description":"Lets a server whitelist headers that browsers are allowed to access."},{"key":"Access-Control-Max-Age","value":"86400","name":"Access-Control-Max-Age","description":"Indicates how long the results of a preflight request can be cached in seconds."},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"997","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 09 Jul 2018 20:45:37 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx","name":"Server","description":"A name for the server"},{"key":"Status","value":"200 OK","name":"Status","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Request-Id","value":"21c78970-7a51-4fa3-ae3a-8e6d02a6ad8b","name":"X-Request-Id","description":"Custom header"},{"key":"X-Runtime","value":"0.048801","name":"X-Runtime","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\"object\":\"offering\",\"id\":\"wQQmJTFQShin7DSiZEuNZA\",\"url\":\"https://sandbox.fundamerica.com/api/offerings/wQQmJTFQShin7DSiZEuNZA\",\"accept_investments\":false,\"accredited_investors\":true,\"ach_deposit_amount\":\"0.0\",\"ach_deposit_max_percent\":null,\"ach_deposit_release_at\":null,\"ach_limit\":\"1000000.0\",\"amount\":\"5000000.0\",\"can_disburse\":false,\"check_mailing_address\":null,\"check_mailing_instructions\":null,\"closed_at\":null,\"created_at\":\"2018-07-09T20:28:20.254Z\",\"delay_aml_until_funds_received\":false,\"description\":\"A really big deal\",\"eb5\":false,\"entity_url\":\"https://sandbox.fundamerica.com/api/entities/R-ycs0c1RVOsfR16vlz9mg\",\"escrow_closes_at\":\"2020-10-10T00:00:00.000Z\",\"escrow_status\":\"no_escrow\",\"escrow_term_days\":0,\"funds_disbursable\":\"0.0\",\"funds_in_escrow\":\"0.0\",\"funds_invested\":\"0.0\",\"funds_received\":\"0.0\",\"funds_refunded\":\"0.0\",\"funds_transfer_methods\":[\"ach\",\"check\",\"credit_card\",\"wire\"],\"funds_unavailable\":\"0.0\",\"investment_increment_amount\":null,\"max_amount\":\"5500000.0\",\"max_investment_amount\":\"25000.0\",\"min_amount\":\"4500000.0\",\"min_investment_amount\":\"1000.0\",\"minimum_met\":false,\"name\":\"Big Deal\",\"non_accredited_investors\":false,\"non_us_investors\":true,\"opened_at\":null,\"payment_reference\":\"\\u003cINVESTOR NAME\\u003e - Big Deal\",\"regulatory_exemption\":\"506c\",\"regulatory_exemption_details\":null,\"security_url\":\"https://sandbox.fundamerica.com/api/securities/VxODUvnRQj2hPiTqJQ0fwQ\",\"type\":\"equity\",\"updated_at\":\"2018-07-09T20:43:26.942Z\",\"us_investors\":true,\"us_states_only\":[],\"use_broker_dealer_service\":false,\"wire_details\":{\"account_number\":\"200000147849\",\"bank_address\":\"4350 La Jolla Village Drive\\nSuite 140\\nSan Diego, CA 92122\",\"bank_name\":\"BofI Federal Bank\",\"bank_phone\":\"(844) 678-2726\",\"beneficiary_address\":\"3455 Peachtree Road, NE\\n5th Floor\\nAtlanta, GA 30326\",\"beneficiary_name\":\"Jumpstart Securities, LLC\",\"intermediary_bank_address\":\"San Francisco, CA 94104\",\"intermediary_bank_name\":\"Pacific Coast Bankers' Bank\",\"routing_number\":\"122287251\",\"swift_code\":\"PCBBUS66\"}}"}],"_postman_id":"f7df64b5-7e64-43a5-948a-e1b38d6dc00c"},{"name":"Update Offering in test mode (sandbox only)","id":"c062c9ce-afd7-4dcb-8126-8a9d71f089bb","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"Updating offering in test mode to set accept_investments to true. This is a quick way to start accepting and testing Investments when working on the FundAmerica sandbox without having to go through the trouble of creating an escrow agreement, signing it, creating an escrow service application and then using the test mode API to accept it.
Virtually every activity in the FundAmerica platform revolves around offerings. Escrow payments, background checks and documents all require an offering to be attached to.
\nGET https://apps.fundamerica.com/api/offerings\nPOST https://apps.fundamerica.com/api/offerings\nGET https://apps.fundamerica.com/api/offerings/:id\nPATCH https://apps.fundamerica.com/api/offerings/:id\nPATCH https://apps.fundamerica.com/api/test_mode/offerings/:id\nAside from an offering's name, most of the details for an offering don't matter for all services except escrow payments. Offerings act merely as \"buckets\" for associating data, however in the case of escrow payments, it gets more complex. (See Escrow Payments.)
\nOfferings can be created with an entity as the issuer. This can be added for the sake of running background checks or, in the case of our escrow service, it is required.
\nNote: The issuer entity must be the actual issuer on the offering. A common mistake amongst portal operators is using their entity as the issuer. If you attempt to open escrow with the wrong issuer (meaning an entity that does not match what is listed in the PPM) your application will be denied.
\nIf you're using a serial issuer you must provide the entity information for the project company and not the parent. It is, however, good practice to use Entity Relationships to properly associate the issuer with its parent.
\naccredited_investors: Whether accredited investors should be allowed to invest in this offering. (Enforced in Invest Now.)amount: The target amount to raise in USD of the offering.description: An optional description of the offering.entity_id: The issuer.escrow_closes_at: The time that the escrow is expected to close and the offering will no longer accept investments.investment_increment_amount: The lowest possible increment for an investment. If set to 1000, then all investments must divide evenly by 1000. This differs from min_investment_amount in that some offerings have a high minimum (e.g. 50000) but once past the minimum, the increments are smaller (so in the case of 10000, the next investment amount would be 60000). (Leave blank if there is no increment.)max_amount: If an offering allows for oversubscription, this is the maximum amount in USD.max_investment_amount: The maximum investment amount allowed by an investor. (Leave blank if there is no max.)min_amount: If an offering can be partially closed, this is the minimum amount in USD.min_investment_amount: The minimum investment amount allowed by an investor. (Leave blank if there is no min.)name: The name of the offering. The offering name can appear in certain documents (like escrow agreements) and will also appear in certain error messages. Because it will be used for virtually all interactions with customer service, it is important that is human readable and not something like a UUID. If your own system doesn't keep offering names unique, keep in mind that you'll need to add some kind of prefix or suffix to keep the name unique with FundAmerica.non_accredited_investors: Whether non-accredited investors should be allowed to invest in this offering. (Enforced in Invest Now.)non_us_investors: Set to true to allow non-US investors. (Default is false.)regulatory_exemption: This is the regulatory exemption the offering is filed under. In most respects, this value is only important for Invest Now offerings because many portal providers manage this data at their own. The only value that affects functionality is selecting 506c as it is the only kind of offering where the confirm_accreditation parameter for investments is allowed.506c: 506(c) (default)506b: 506(b)reg_a_t1: Reg A, Tier 1reg_a_t2: Reg A, Tier 2reg_s: Reg S4a6: 4(a)(6)us_state: US State Exemptionsother: Othertype: The value can be debt or equity depending on the type of offering. The default is equity.us_investors: Set to true to allow US investors. (Default is true.)us_states_only: An array of states to restrict US investors to. (Leave blank for all states.)accept_investments: Whether or not an offering can accept investments. This is false by default and true once an escrow service application has been accepted.closed_at: The time the offering was closed or cancelled.escrow_status:no_escrow: Escrow is not being used for this offering.pending: Escrow is pending review.opened: Escrow is open and investments will be accepted.closed: Escrow has been closed and investments will no longer be accepted.cancelled: Escrow has been cancelled and investments will no longer be accepted.funds_in_escrow: The total amount of funds in escrow for the offering.funds_invested: The total amount of funds invested in offering.funds_received: The total amount of funds received for the offering.funds_refunded: The total amount of funds refunded by the offering..opened_at: The time that an offering was opened for taking investments. This only matters for offerings using the escrow service.use_broker_dealer_service: Whether or not Broker Dealer Services are being used for this offering.When working on the FundAmerica sanbox close offering requests can be updated by the user to close the offering
\n","urlObject":{"path":["test_mode","cancel_offering_requests",":id"],"host":["{{env}}"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"926d72f0-a205-4a9f-8d55-78d2fb781420","name":"Accept/Deny Cancel Offering Requests in Test Mode","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"status\" : \"accepted\"\n}\n"},"url":{"raw":"{{env}}/test_mode/cancel_offering_requests/:id","host":["{{env}}"],"path":["test_mode","cancel_offering_requests",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"object\": \"cancel_offering_request\",\n \"id\": \"VbyEaymPQMK07y2tbkVYlA\",\n \"url\": \"https://apps.fundamerica.com/api/close_offering_requests/VbyEaymPQMK07y2tbkVYlA\",\n \"offering_url\": \"https://apps.fundamerica.com/api/offerings/XOxZSJvcQFSsaLDKUsxxpg\",\n \"comment\": \"Please cancel this. Thanks.\",\n \"created_at\": \"2014-11-02T04:03:08.758Z\",\n \"partial\": true,\n \"status\": \"accepted\",\n \"updated_at\": \"2014-11-02T04:03:08.758Z\"\n}"}],"_postman_id":"bf8f635e-ff70-441e-85bd-c9c99ae8cdbb"},{"name":"Accept/Deny Close Offering Requests in Test Mode Copy","id":"6ee14e33-82f7-461d-af13-86547f93e40e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"When working on the FundAmerica sanbox close offering requests can be updated by the user to close the offering
\n","urlObject":{"path":["test_mode","close_offering_requests",":id"],"host":["{{env}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"d29be7d1-16e5-47b3-92a2-d7f82667997c","name":"Accept/Deny Close Offering Requests in Test Mode","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"status\" : \"accepted\"\n}\n"},"url":{"raw":"{{env}}/test_mode/close_offering_requests/:id","host":["{{env}}"],"path":["test_mode","close_offering_requests",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"object\":\"close_offering_request\",\n \"id\":\"VbyEaymPQMK07y2tbkVYlA\",\n \"url\":\"https://apps.fundamerica.com/api/close_offering_requests/VbyEaymPQMK07y2tbkVYlA\",\n \"offering_url\":\"https://apps.fundamerica.com/api/offerings/XOxZSJvcQFSsaLDKUsxxpg\",\n \"comment\":\"Please close this partially. Thanks.\",\n \"created_at\":\"2014-11-02T04:03:08.758Z\",\n \"partial\":true,\n \"status\":\"accepted\",\n \"updated_at\":\"2014-11-02T04:03:08.758Z\"\n}"}],"_postman_id":"6ee14e33-82f7-461d-af13-86547f93e40e"}],"id":"72ff465e-9229-4de5-9ef9-d2ba8671f02e","description":"This simply requests that an offering be cancelled and all investors receieve refunds. When confirmed, funds in escrow will be refunded and the offering will no longer be able to accept investments.
\nThe only special case is that only one request to cancel can exist at a time. Attempts to create more will result in errors. If a request to close the offering is being reviewed a request to cancel cannot be made. Finally, if an offering has been partially closed, it cannot be cancelled.
\ncomment: An optional comment giving special instructions to customer service.offering_id: The offering you wish to cancel.status: it can be one of three values:pending: Being reviewedconfirmed: The offering was cancelled as a result.This requests that an offering be closed or partially closed. When accepted, funds in escrow will be transferred to the issuer minus any fees.
Close requests are reviewed by FundAmerica and either accepted or denied.
comment: An optional comment giving special instructions to customer service.offering_id: The offering you wish to close.status: It can be one of three values:pending: Being reviewed.accepted: Funds will be dispersed to the issuer and, in the case of a non-partial close, the offering will be closed and no further investments allowed.denied: There was a problem with the request or it didn't meet the prerequisites for a close.An escrow agreement is a document that must be electronically signed by the issuer and sets forth the terms of the escrow account, the fees to be charged and a lot of other legally relevant information.
\nCreating an escrow agreement will provide you with a link to send to the issuer so that they can sign the document digitally. Additionally, if you wish to embed this document in your own interface, use body_html and the Electronic Signatures API.
GET https://apps.fundamerica.com/api/escrow_agreements\nPOST https://apps.fundamerica.com/api/escrow_agreements\nGET https://apps.fundamerica.com/api/escrow_agreements/:id\noffering_id: The offering related to the escrow agreement.archived_pdf_url: Once the document has been signed, an archived PDF copy can be found at this location.body_html: The body HTML of the document. If you wish to embed the document in your own interface for signature collection, use this. Even if you have provided a full HTML document, this is ONLY the content inside the <body>. The only exception is that if <style> directives exist in the <head>, they will be included in the body for formatting purposes.electronic_signatures: See Electronic Signatures for more details.signed: Whether or not the document has been signed.signing_links: A list of available signatures, their signing links and when those links expire (defaults to one day from the time of creation). In the case of an escrow agreement, there will only be an \"issuer_signature.\"Note: A return_url query string can be added to the signing URL and the signer will be redirected to the return_url when the document is signed.
Tech services agreements must also be signed before escrow can be opened for an account. Unlike the Escrow Agreement it may be signed by either the issuer or the platform operator, depending on who is taking financial responsibility for the fees being charged through FundAmerica's system. If you are operating a platform where you are billing your issuers directly, rather than having them pay FundAmerica's fees, you should sign this document. Other than the endpoints, it operates identically to Escrow Agreement.
\nCreating a tech services agreement will provide you with a link to send to the responsible party so that they can sign the document digitally. Additionally, if you wish to embed this document in your own interface, use body_html and the Electronic Signatures API.
GET https://apps.fundamerica.com/api/tech_services_agreements\nPOST https://apps.fundamerica.com/api/tech_services_agreements\nGET https://apps.fundamerica.com/api/tech_services_agreements/:id\noffering_id: The offering telated to the tech services agreement.archived_pdf_url: Once the document has been signed, an archived PDF copy can be found at this location.body_html: The body HTML of the document. If you wish to embed the document in your own interface for signature collection, use this. Even if you have provided a full HTML document, this is ONLY the content inside the <body>. The only exception is that if <style> directives exist in the <head>, they will be included in the body for formatting purposes.electronic_signatures: See Electronic Signatures for more details.signed: Whether or not the document has been signed.signing_links: A list of available signatures, their signing links and when those links expire (defaults to one day from the time of creation). In the case of an escrow agreement, there will only be an \"issuer_signature.\"Note: A return_url query string can be added to the signing URL amd the signer will be redirected to the return_url when the document is signed.
Registered Transfer Agent agreements must be signed if you plan on using FundAmerica Stock Transfer as your registered transfer agent. Other than the endpoints, it operates identically to Escrow Agreements.
\nCreating an RTA agreement will provide you with a link to send to the responsible party so that they can sign the document digitally. Additionally, if you wish to embed this document in your own interface, use body_html and the Electronic Signatures API.
GET https://apps.fundamerica.com/api/rta_agreements\nPOST https://apps.fundamerica.com/api/rta_agreements\nGET https://apps.fundamerica.com/api/rta_agreements/:id\noffering_id: The offering related to the RTA agreement.archived_pdf_url: Once the document has been signed, an archived PDF copy can be found at this location.body_html: The body HTML of the document. If you wish to embed the document in your own interface for signature collection, use this. Even if you have provided a full HTML document, this is ONLY the content inside the <body>. The only exception is that if <style> directives exist in the <head>, they will be included in the body for formatting purposes.electronic_signatures: See Electronic Signatures for more details.signed: Whether or not the document has been signed.signing_links: A list of available signatures, their signing links and when those links expire (defaults to one day from the time of creation). In the case of an escrow agreement, there will only be an \"issuer_signature.\"Note: A return_url query string can be added to the signing URL and the signer will be redirected to the return_url when the document is signed.
An escrow service application is a request to open an escrow account. It provides customer service with all the data that is necessary to open an account. In addition to the request attributes it accepts, it will return errors if the offering is lacking required information.
\nAlso note that the credit card on file will be charged when an application is submitted.
\nGET https://apps.fundamerica.com/api/escrow_service_applications\nPOST https://apps.fundamerica.com/api/escrow_service_applications\nGET https://apps.fundamerica.com/api/escrow_service_applications/:id\noffering_id: The related offering.escrow_agreement_id: A signed escrow agreement.ppm_password: An optional login password for viewing the PPMppm_url: A link to information about the offering. It can be the offering URL on your portal or a PDF containing the PPM. It just needs to be information that customer service can review regarding the offering.ppm_username: An optional username for viewing the PPM.Note: The PPM URL will often require a login on your platform in order to view an offering's contents. This can be handled in a number of ways:
\nppm_username and ppm_password.ppm_urlIt's important to make sure FundAmerica has access to the offering as soon as possible. If customer service has to reach out to you for more information it can greatly delay the escrow service application approval process.
\ndenial_message: If your application is denied, this will list the reason why. Typically, this is either due to a problem with the PPM or a mismatch of information between the PPM and what was provided to the API (e.g. different amounts listed, incorrect issuer, etc.).status: It can be one of three values:pending: Being reviewedaccepted: The escrow account has been opened and your offering can now accept investments.denied: There was a problem with the application that customer service was unable to resolve.Handling escrow payments is easily the most complex process in the entire system. It requires a number of different objects to be created with a lot of manual processing in the background. FundAmerica representatives will be reviewing almost every aspect of the process behind-the-scenes.
\nA brief overview of each step and an explanation of the process will be outlined below. Technical details on API calls will follow.
\nWhile there are a lot steps to the process, as you make test calls to the API, if you forget a step in the process, the error messages will generally lead you back in the right direction.
\nHandling escrow payments happens in three steps:
\nOpening an escrow account requires the following steps:
\nThis process sets forth the details of the offering and the issuer. Once the escrow service application has been created, the credit on file will be charged the appropriate amount for services (see your account fee schedule for the details on an escrow application fee, the first escrow monthly administration fee and a background check fee on the issuer) and FundAmerica representatives will verify the offering and issuer information, run a background and AML check on the issuer and review the PPM provided in the application.
\nIf there is a problem or something does not check out, the issuer will be contacted directly to resolve any potential problems.
\nIf everything checks out, the application will be accepted and an escrow account will be opened for the offering. You will now be able to submit investments.
\nMaking investments is the simplest part of the process. It is done by creating investments.
\nAn offering may be closed when the issuer wishes to have funds dispersed to the issuer or an issuer may wish to cancel an offering and refund all investors. This is done by creating a close offering request or a cancel offering request.
\nEither request will result in a customer service follow-up with the issuer to confirm the process. So, if a cancel request comes in, FundAmerica will contact the issuer to confirm that this is what is desired before processing it and refunding the investments.
\n","event":[{"listen":"prerequest","script":{"id":"ababb602-6e81-4406-9cc2-84e29ef0af4a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9954eb6e-3983-44ba-a583-19e74e3682ed","type":"text/javascript","exec":[""]}}],"_postman_id":"d3177609-916b-4ca9-bf35-ef7105f3bfbb"},{"name":"Escrow Disbursements","item":[{"name":"Disbursement Test Mode","item":[{"name":"Update status in Test Mode","id":"ed52c38e-10b6-4cd4-89b7-bb0069d117f5","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"On the sandbox test calls can be made to update the status on a disbursement.
Creating disbursement's with wire will look the same as an ach payment but the payment_method will read wire as this information will be received from the bank_transfer_method_id.
Once an Offering has receieved its minimum amount in funds, you can begin disbursing funds from escrow, either to the issuer or another party.
\nGET https://apps.fundamerica.com/api/disbursements\nPOST https://apps.fundamerica.com/api/disbursements\nGET https://apps.fundamerica.com/api/disbursements/:id\nPATCH https://apps.fundamerica.com/api/disbursements/:id\nDELETE https://apps.fundamerica.com/api/disbursements/:id\nGET https://apps.fundamerica.com/api/offerings/:id/disbursements\nPATCH https://apps.fundamerica.com/api/test_mode/disbursements/:id\namount: The amount to disburse to the named party.bank_transfer_method_id: Must be an ACH bank transfer method. Use if paying via ACH or wire.check_mailing_address: If paying by check, the address to mail the check to.check_payee: If paying by check, the entity to make the check out to.reference: Details about the disbursement.Note: If the disbursement is going to a third party in a manner that needs to be identified, you must use either a check or wire as the method. The reason for this is there is no way to designate any sort of reference in a standard ACH payment. So, for example, if you wanted funds disbursed from escrow directly to another company to purchase property and needed to include a property ID in the reference, you would need to use check or wire. When used on an ACH type, reference is purely for internal purposes.
disbursed_at: When the actual disbursement was made.payment_details: Details about the disbursement when it was paid such as the ACH batch ID or the check number.payment_method: The method that the disbursement was made ach, check or wire.status:pending: Information about the disbursement specifics has been received.disbursed: Funds have transfered.voided: In the event of an error or the cancellation of a distributions, an investor disbursement becomes voided.An escrow ledger tracks the transactions of an offering's escrow.
\nbalance: The total balance after the transaction has cleared.credit: Amount credited to the escrow ledger.debit: Amount debited from the escrow ledger.description: A description of the ledger entry.investment_payments: Related investment paymentsOn the sandbox, test calls can be made to update the status on an investment. Additionally, on the sandbox, test calls can be made to update the status on a trade review.
Investments are made when an investor wants to invest in an offering and send funds for said investment. Investments are probably the single most complex object in the system. It's important to understand all the status settings and payment methods involved. It is important to understand that a non-person investors must have an associated person to create an investment and complete the KYC process.
\nAn AML check is automatically processed on every single investment. FundAmerica customer service will do a follow-up if there are any issues with the background check and may cancel the result if there are problems. The results of this background check are available to your account if you have requested permission and been accepted for processing AML checks on your account. Please see AML and Bad Actors Checks for more information on this process and details on the API calls.
\nWhen an investment is made, customer service will review the details before changing the status type. They may even opt to cancel the investment if there is a problem. If you want to give immediate feedback to your investors, it's important to utilize webhooks for status updates.
\nUpdate: Although the examples below show the use of entity_id, it's better to use Investors instead. This is a fairly new API, so if you have have an older implementation, this is worth having a look at.
Note: An offering must have accept_investments set to true to create investments, otherwise you will receive a 403 error. This is done by having an escrow service application accepted.
GET https://apps.fundamerica.com/api/investments\nPOST https://apps.fundamerica.com/api/investments\nGET https://apps.fundamerica.com/api/investments/:id\nPATCH https://apps.fundamerica.com/api/investments/:id\nDELETE https://apps.fundamerica.com/api/investments/:id\nGET https://apps.fundamerica.com/api/offerings/:id/investments\nPATCH https://apps.fundamerica.com/api/test_mode/investments/:id\nPATCH https://apps.fundamerica.com/api/test_mode/trade_reviews/:id\nach_authorization_id: The ACH authorization used for an ACH payment. Required if payment_method is set to ach. See ACH Authorizations for information on creating ACH authorizations.aml_check_investor: Whether or not to process an AML check on the investor.amount: The amount in USD of the investment. Required.confirm_accreditation: If you want to prevent the investment from clearing until accreditation is confirmed via a service working with FundAmerica, set this to true. If false (the default), confirmation of investor accreditation is presumed to be issuer's responsibility. Even if using your service, without setting this flag to true investments can still clear regardless of the status. This option allows platforms to mix and match how accreditation is performed and cleared.debt_face_value: The face value of a debt investment. This is just an alias for amount since they are one in the same, but for the sake of clarity in some code, you can use debt_face_value instead.debt_par_value: The par value of the debt investment. Must match what is detailed in the subscription agreement. Required if offering type is debt. If left blank, it will be set to the same value as amount.entity_id: The entity making the investment. If entity parameters are provided instead, the entity created or updated will be used. Required.equity_share_count: The number of shares being purchased. Must match what is detailed in the subscription agreement. Required if offering type is equity.investor_id: The investor to use. Can be used in place of entity_id.offering_id: The offering to invest in.payment_method: Must be set to one of three values: ach, check, wire. Required.review_trade: This must be set to true in order to use broker-dealer services. If it is true then Jumpstart Securities is the broker-dealer of record for the investor on this investment. On offerings using the broker-dealer services this value can be manually set to false.subscription_agreement_id: The ID of a Subscription Agreement created using the FundAmerica API. If using our broker-dealer services, it will be required to be provided for the investment before the offering closes. In all other cases it is entirely optional.subscription_agreement_url: A URL containing the signed subscription agreement. (Preferably a PDF.) If using our broker-dealer services, it will be required to be provided for the investment before the offering closes. In all other cases it is entirely optional. See External Subscription Agreements below for more details.aml_exception: true if the background check was questionable for some reason. This could mean anything from the entity appearing on a global watch list to a mistyped tax ID number.amount_in_escrow: The amount of funds in the escrow account in USD.amount_received: The amount of funds received by FundAmerica from the investor in USD.amount_refunded: The amount of funds refunded by FundAmerica from the investor in USD.background_check_url: The background check that was processed on the investor entity.check_mailing_address: Where to mail checks if payment_method is set to check. Additionally, this address should be used for the address on a wire payment if the bank requires an address for the wire.check_mailing_instructions: Additional instructions regarding mailing checks if payment_method is set to check.cleared: true if all funds are available and possible AML exceptions and trade reviews have cleared. This will trigger a webhook when changed.clearing_failures: An array of reasons an investment is not cleared. These only appear after funds are eligible or a disbursement occurs. All investments begin with cleared set to false. Possible values are:accreditation_pendingaml_pendingfunds_not_clearedsubscription_agreement_not_signedtrade_review_pendingequity_share_price: The price per share.payment_reference: A short code that the investor should include with any manually initiated (e.g. check or wire) transfer.status: See next section.trade_review_status: The status of a trade review. It can be set to one of four values:null: The offering either isn't using our broker-dealer services or review_trade has been set to false.pending: The trade review is currently being reviewed by customer service.accepted: The trade review has been accepted and FundAmerica Securities will act as the broker-dealer of record for this investor on this investment.denied: The trade review has been denied and the investment has been cancelled.trade_review_url: Location of the specific trade review object.wire_details: Information that the investor should use when wiring their investment.An investment object has a status field which indicated the status of the investment. There are six possible settings: not_received, received, cancelled, voided, refunded and invested.
not_received: The funds for an investment have not been received and accepted.received: The funds for an investment have been received and accepted. This means customer service has verified the funds, reviewed the subscription agreement and made sure everything looks correct. If there is a problem, customer service will either cancel the investment or contact the issuer and/or investor to resolve the issue. Even in the case of ACH investments, the investment will not be updated as \"received\" until this has occured. Customer service review will generally happen within one business day of receipt of funds.cancelled: The investment has been cancelled. If the previous status was not_received then the investment will be immediately voided. If the previous status was received then a refund will be processed.voided: An investment was cancelled before funds were received.refunded: An investment was cancelled after funds were received and the actual refund has been issued.invested: The offering related to the investment has been closed or partially closed. An investment cannot be cancelled at this point.Certain investment details can be updated once an investment has been created under certain circumstances. These include:
\nach_authorization_idpayment_methodsubscription_agreement_urlInvestments need to be able to cancelled at any time before they are invested by both the issuer and investor. Additionally, if there is a problem with an investment, customer service may cancel an investment.
\nIt's worth noting that changing state via test mode calls will trigger webhooks.
\nSubscription agreements are required for investments where Broker Dealer Services are used. They must be provided before an offering is closed, but can be provided either at the creation of the investment, or updated later.
\nWhen subscription_agreement_url is provided, our system will attempt to download and archive the provided link. This attempt will take place shortly after the investment is created. In the event of a failure, our system will try again once every minute for ten minutes. This way, if your final documents are created asynchronously and aren't ready immediately, our system will get them within a few minutes.
At this point you'll need to update the investment with a different subscription_agreement_url in order to have it try again.
In this example we create an investment with a Joint Investor of type jtwros.
The most obvious API where an investor would be used in place of an entity is Investments. However Holdings, Investor Payments, and Investor Customer Agreement can also use investors.
\n","event":[{"listen":"prerequest","script":{"id":"77e6ca6a-578f-48d7-8dad-708449667d39","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"30dc7e4d-fd06-4a05-bda0-e2add008edd8","type":"text/javascript","exec":[""]}}],"_postman_id":"a0178d9f-4fac-400b-b8c0-911e1ec52e54"},{"name":"Get all investors","id":"d3be6597-251f-4a6d-950b-cf640d48f192","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"Passing a lone entity_id will create an investor with the same type as the entity and a vesting_name equal to the entity's name. The vesting_name for proxy investors is generated automatically and cannot be overridden.
Passing multiple entities and an appropriate type will create a joint investor. jtic (joint tenant in common) or jtwros (joint tenant with rights of survivorship) are appropriate joint types. The vesting_name for joint investors is generated automatically and cannot be overridden.
IRAs, like joint investors, are another example of an investor that didn't map cleanly to an entity or their hierarchical relationships. IRAs have a primary entity, which is always the beneficiary, and a custodian, which is generally the company managing the IRA. To create an IRA you must create two entities: the person investing and the custodian. The custodian must be a company and needs full contact information, including a tax_id_number. While this is not used for AML purposes, it is necessary for tax reporting purposes.
For an example flow, if using Invest Now click \"Invest Now\" and then choose the \"Self-Directed IRA\" option as your investor.
\nIRAs have their own vesting_name. It should generally look something like: \"Example Trust Company FBO John Johnson\" (FBO means For Benefit Of), however the naming is specific to each trust company, so it is not automatically generated and must be provided.
Investors using IRAs should know this information and are generally given paperwork that includes instructions on exactly how to fill out this information.
\n","urlObject":{"path":["investors"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"b2e2f0ff-b6c4-4395-bf1d-937a7b51e57a","name":"Create IRA","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"custodian_entity_id\" : \"3HmoHaN3RKmGFK2QPbNvDQ\",\n\t\"primary_entity_id\" : \"pBLbZwoIRUqSxzWYPgg6tw\",\n\t\"type\" : \"ira\",\n\t\"vesting_name\" : \"IRA Trust Company FBO Danny Documentation\"\n}"},"url":"{{env}}/investors"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Disposition, Content-Type, X-FA-Public-Key, X-FA-User-Session-Token, X-Requested-With","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, DELETE","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Access-Control-Expose-Headers","value":"Cache-Control, Content-Disposition, Content-Type, X-FA-Session-Expires-At","name":"Access-Control-Expose-Headers","description":"Lets a server whitelist headers that browsers are allowed to access."},{"key":"Access-Control-Max-Age","value":"86400","name":"Access-Control-Max-Age","description":"Indicates how long the results of a preflight request can be cached in seconds."},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"354","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 12 Jul 2018 21:21:44 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx","name":"Server","description":"A name for the server"},{"key":"Status","value":"200 OK","name":"Status","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Request-Id","value":"9be9bb12-de76-45a1-a03e-2c850f5a4cc5","name":"X-Request-Id","description":"Custom header"},{"key":"X-Runtime","value":"0.111656","name":"X-Runtime","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\"object\":\"investor\",\"id\":\"6rW-bhslShmJUZmM6e9Y8A\",\"url\":\"https://sandbox.fundamerica.com/api/investors/6rW-bhslShmJUZmM6e9Y8A\",\"accreditation_type\":\"non_accredited\",\"accredited\":false,\"annual_income\":null,\"custodian_entity_url\":\"https://sandbox.fundamerica.com/api/entities/3HmoHaN3RKmGFK2QPbNvDQ\",\"entity_urls\":[\"https://sandbox.fundamerica.com/api/entities/3HmoHaN3RKmGFK2QPbNvDQ\"],\"exempt_from_withholding\":true,\"name\":\"IRA Trust Company FBO Danny Documentation\",\"net_worth\":null,\"primary_entity_url\":\"https://sandbox.fundamerica.com/api/entities/pBLbZwoIRUqSxzWYPgg6tw\",\"type\":\"ira\",\"us_citizen_or_resident\":true,\"vesting_name\":\"IRA Trust Company FBO Danny Documentation\"}"}],"_postman_id":"5a07067c-afe5-46de-b009-fd9c116854bd"},{"name":"Update Investor Information","id":"507b0c23-d236-43c4-943b-530fc7555f76","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"If required accreditation_type can be set to the following types based on the method of accreditation of the investor:
non_accreditedindividual_net_worthindividual_incomebankcorporationbusinessemployee_benefit_plantrustWhen this API was first created, Entities were used directly as the investor. This model was not suitable for joint investors as they are multiple entities, but unlike a trust or company, they cannot be represented in an hierarchical manner as another entity. As such, a separate investor object was introduced to deal with this. Since joint investors have been available, the creation of joint investors has been entirely transparent. However, the investors are being extended to encompass additional investor types, such as IRAs and, in the future, it is likely their functionality will be expanded to meet the needs of different possible investor types.
\nWhen investing using an entity_id, a default investor is created for the entity if one does not already exist and is used for the investment. Simple investors, also known as \"proxy investors,\" are investors with the same type as an entity. When an entity is updated, for instance, when their name is updated, said entity's vesting_name is also updated. For many operations, such as determining address or other contact information, the primary_entity of the investor is delegated to.
Investors, for the most part, are just a collection of entities and a type designation which is used for validation. Sometimes it's a single entity in the case of a simple investor. Sometimes it's multiple entities in the case of a joint investor. IRAs also use multiple entities (the primary and the custodian) but in a different way.
\nIt is recommended that if you're not supporting a legacy system, you explicitly create and track investors and use them for investments instead of entities. In the next version of this API, this will be required. Explicitly creating an investor still requires creation of an entity and then explicitly creating a proxy investor using the entity's id.
GET https://apps.fundamerica.com/api/investors\nPOST https://apps.fundamerica.com/api/investors\nGET https://apps.fundamerica.com/api/investors/:id\nPATCH https://apps.fundamerica.com/api/investors/:id\ncustodian_entity_id: The custodian for an IRA. If the type is ira this is required. For all other types it should not be provided.other_entity_ids: Required when creating joint investors. It must be a single entity ID.primary_entity_id: The primary entitiy for the investor. This is the person or company investing in most cases. For joint investors this entity has special designation as being the the main contact point.type: The investor's type. This can be a proxy type (person, company), a joint type (jtic, jtwros) or an IRA (ira). It is very likely there will be additional types in the future.vesting_name: The vesting name of the investor. This is usually automatically generated, but if type is ira it must be provided.Investment Payments are a way of following the lifecycle of a particular payment toward an investment from receipt to movement to escrow to refund. In practice, there will generally be a one-to-one relationship between investments and their respective payments, however this is not always the case. Everything from investor error to bank limitations on a single wire can cause some investments to require multiple payments.
\nAdditionally, investment payments include details on how and when funds were received, moved to escrow or refunded.
\nNote: If you're interested in the specifics on how and when funds become available, please see our Funds Availability Policy.
\nGET https://apps.fundamerica.com/api/investment_payments\nGET https://apps.fundamerica.com/api/investment_payments/:id \ndisbursed_at: When payment was disbursed from escrow.failure_details: If there was a problem processing a payment, this will indicate the reason for failure.in_escrow_at: When payment was moved to escrow.payment_details: Details about receiving the payment as recorded by customer service. This may be a check number or a wire ID or any information that is deemed relevant.payment_method: The actual method in which the payment was received. This may or may not match the payment_method for the parent investment. A common mismatch is when an investment has a payment_method or wire but the investor does a manual ACH transaction rather than sending a wire.received_at: When payment was received by FundAmerica.refund_details: If the payment was refunded, details about the refund.refund_method: If the payment was refunded, the method that was used.refunded_at: When payment was refunded by FundAmerica.status:received: Payment has been received and is pending transfer to escrow account.in_escrow: Payment is in escrow account.refunded: Payment has been refunded.invested: Payment has been invested.failed: In the event a check bounced or an ACH draw bounced or failed for some other reason, this status will be set. In essence, this is the same as if no funding was ever received. failure_details will explain the nature of the failure.On the sandbox you can use the test mode to update the status of AML Exceptions
\n","event":[{"listen":"prerequest","script":{"id":"44bfbc64-9657-444e-8b13-5ccf58d5f006","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1c4fd925-e9a7-4d0c-a887-e587c161b288","type":"text/javascript","exec":[""]}}],"_postman_id":"7e2baef6-8508-42fc-9f6a-e4993bf20d64"},{"name":"Upate AML Exceptions","id":"7bfca0b7-3c24-4866-a735-34a208dcffba","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"Whenever an investor makes an investment, an identity check is automatically processed on the investor to determine whether the investor's identifying information is correct and if that information is connected with any government watch lists.
\nIn the event the background check shows a problem of some sort, an AML exception is thrown. While funds can be sent to escrow, investments with funds connected to an investor with an outstanding AML exception cannot be cleared, don't count toward the offering's minimum and cannot be disbursed.
\nIn most cases, AML exceptions happen for three main reasons:
\nAML exceptions are generated when there is either discrepency or problem in the identifying data or automatic checks cannot find a record of the investor. Sometimes, especially in the case of businesses, manual checks by customer service can verify enough to clear the exception. However, more often than not, actions are necessary on the part of the investor to provide more data or correct existing data.
\nAML exceptions with a status of contact_issuer require action by the part of the issuer or the portal to give further instructions. The investor entity may need to be updated or entity documents may need to be provided to clear the exception.
Once information has been either added or created, a AML exception should be updated to notify FundAmerica that the exception should be reviewed again. If everything checks out, the status will be set to cleared and the AML exception is no longer an issue for the investment.
Note: In the case of companies or joint accounts, it's possible that a single investment might have multiple AML exceptions.
\nA typical flow looks like this:
\nstatus of pending.clear if the problems can be resolved without further input of sets the status to contact_issuer if more information is required. This update causes a webhook to be created, informing the portal that there is an issue.status to pending by updating the AML exception.status will be set to contact_issuer again and the process will repeat until cleared or the investment is cancelled.GET https://apps.fundamerica.com/api/aml_exceptions\nGET https://apps.fundamerica.com/api/aml_exceptions/:id\nPATCH https://apps.fundamerica.com/api/aml_exceptions/:id\nGET https://apps.fundamerica.com/api/entities/:id/aml_exceptions\nGET https://apps.fundamerica.com/api/investments/:id/aml_exceptions\nPATCH https://apps.fundamerica.com/api/test_mode/aml_exceptions/:id\nach_info_mismatch: true if the investment was created via ACH and the bank account name did not match the investor's name.address_verified: true if the entity's address has been verified. (As of now, this doesn't usually matter, but it may in the future with regionally specific offerings.)dob_verified: true if the entity's date of birth has been verified. This is always null for non-person entities.documentation_required: true if automatic checks aren't enough and actual documentation is required. See Entity Documents.name_verified: true if the entity's name has been verified.pending: FundAmerica is currently reviewing the exceptioncontact_issuer: More information is required from the issuer to clear the exception.cleared: The exception has been cleared. This does not necessarily mean the issue has been resolved however. In cases where identity cannot be established or, something more serious like finding the investor is on the OFAC list, an AML exception may be cleared and the investment cancelled.status_updates: A list of notes from FundAmerica related to the AML exception. This will be blank in many cases but, especially when documents come into play, there may be extra information about specifics of the exception listed here.tin_verified: true if the entity's tax ID number has been verified.watch_lists_cleared: true if the entity does not appear on any government watch lists.Note: A return url query string can be added to the token URL and the signer will be redirected to the return_url when the ACH authorization agreement is signed. The parameter ach_authorization_id will be passed back to return_url if it is provided.
By default, the ACH Authorization form will be filled in the entity information. However, some providers store the account information on their own system for other purposes. In order to prevent the end user from entering information multiple times, you can POST to the URL provided when creating an ACH token. The following fields can be pre-populated:
\nach_authorization[account_type]: Must be checking or savings.ach_authorization[check_type]: Must be business or personal.ach_authorization[account_number]ach_authorization[routing_number]: Must be a valid 9 digit routing number.ach_authorization[name_on_account]ach_authorization[contact_name]ach_authorization[address]ach_authorization[city]ach_authorization[state]ach_authorization[zip_code]ach_authorization[email]If you plan on pre-populating account information, DO NOT use a GET request. The account information can end up in web logs and other unsecure places. Despite being sent via HTTPS, it's still an extremely bad practice to use GET if also opting to pre-populating the form.
\n","event":[{"listen":"prerequest","script":{"id":"ee5c80d7-b072-4e3a-87f1-62efaba0980d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bfd99c41-5c54-4337-9461-ce01ab591326","type":"text/javascript","exec":[""]}}],"_postman_id":"e7c6f410-5b4b-4d42-93be-cff9a04ffea8"},{"name":"Direct API Creation","item":[{"name":"Agreement Text","item":[],"id":"ca6b50ce-4acd-459b-9bca-a951ef779774","description":"You must include the exact introduction text that appears on the hosted form. Failure to do so can lead to your account getting suspended without notice. This text should be copied directly from our API with the following call:
\ncurl https://apps.fundamerica.com/api/ach_authorizations/agreement_html \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:\n{\n \"agreement_html\": \"<p><strong>IMPORTANT: Please read before completing, signing and submitting.</strong></p>\\n\\n<p>Direct Payment via ACH is a transfer of funds from (or to) a bank account for the purposes of making a payment.</p>\\n\\n<p>I (we) hereby authorize FundAmerica Securities, LLC (“FundAmerica”), to electronically initiate credit and debit entries to my (our) account at the financial institution listed below (hereinafter “Bank”), and, if necessary, initiate adjustments for any transactions credited/debited in error.</p>\\n\\n<p>This authority authorizes FundAmerica to credit my (our) account to correct errors and with payments, refunds, reimbursements, and other funds, and to debit my (our) account for exact amount of investments I make, and will remain in effect until such time that FundAmerica is notified by me (us) in writing to cancel it, with such notice provided at least 3 business days in advance, delivered via overnight courier to FundAmerica Securities, LLC, attention Financial Operations Principal, at 3455 Peachtree Road NE, 5th Floor, Atlanta, GA 30326. I agree that the ACH transactions I (we) authorize comply with all applicable law.</p>\"\n}\nAdditionally if you wish to retrieve information about the bank related to the routing number similar to the hosted form you can use the following call:
\ncurl https://apps.fundamerica.com/api/bank_info/123456789 \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:\nNote: The routing number must be 9 digits. Anything else will result in a 404. Additionally, an invalid routing number will result in a 404 error.
{\n \"object\": \"bank_info\",\n \"address\": \"1 Bank Road\",\n \"city\": \"Las Vegas\",\n \"name\": \"Common Bank\",\n \"phone\": \"7025551234\",\n \"routing_number\": \"123456789\",\n \"state\": \"NV\",\n \"zip_code\": \"89102\"\n}\nUsing this is optional, but it does give the user instant feedback as to whether or not the routing number is correct.
\n","event":[{"listen":"prerequest","script":{"id":"0867d017-50cb-4bf1-8674-7211629179b3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c4a5f647-0f7f-4874-be65-2ce97e4e591c","type":"text/javascript","exec":[""]}}],"_postman_id":"ca6b50ce-4acd-459b-9bca-a951ef779774"},{"name":"Create ACH Authorization","id":"15c00406-a1f3-4a9b-a0d2-eaa648b8e6a4","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"Note: A return_url query string can be added to the token URL and the signer will be redirected to the return_url when the ACH authorization agreement is signed. The parameter ach_authorization_id will be passed back to return_url if it is provided.
This is similar to FundAmerica's hosted form, but gives the portal greater flexibility in when integrating. It's also a more involved process. Since the ultimate result must be very similar to the process outlined in the FundAmerica Hosted Form process, it's suggested that you go through that process at least once to get a good idea of what your own process should look like.
\nGET https://apps.fundamerica.com/api/ach_authorizations\nPOST https://apps.fundamerica.com/api/ach_authorizations\nGET https://apps.fundamerica.com/api/ach_authorizations/:id\nDELETE https://apps.fundamerica.com/api/ach_authorizations/:id\nGET https://apps.fundamerica.com/api/ach_authorizations/agreement_html\nGET https://apps.fundamerica.com/api/entities/:id/ach_authorizations\naccount_number: Must be all digits.account_type: Must be checking or savings.address: The address for the bank account. Defaults to the entity's address.check_type: Must be business or personal.city: The city for the bank account. Defaults to the entity's city.contact_name: A contact name if different than the entity. Defaults to the entity's name or the\nentity's contact_name if present.name_on_account: The name on the bank account. Defaults to the entity's name.routing_number: Must be a valid 9 digit routing number.state: The state for the bank account. Defaults to the entity's state.use_for_investor_payments: If set to true the Bank Transfer Method associated with this authorization will automatically by set as the entity's Investor Payment Method.zip_code: The zip code for the bank account. Defaults to the entity's zip code.company: If the signer is representing a company, this is the company's name.email: The email address for the signer. Default's to the entity's email address.ip_address: The IP address of the client filling out the form.literal: The literal signature of the client. This whatever the client chooses to type as their signature. It will typically be their name or some variation of their name.title: If the signer is representing a company, this is their title.user_agent: The user agent header (browser identification) of the client filling out the form.cancelled_at: If the ACH authorization was this is when it happened. A cancelled ACH authorization cannot be used for making an investment and will not show up in any resource lists.name: The name of the ACH authorization. It's the account name with the last four digits of the account number.verified: If set to true it means this ACH authorization has been successfully charged at some point in the life of the ACH authorization.It's important to remember that while an ACH authorization requires far less input on the part of the investor (i.e. they don't have to mail a check or go to their bank for a wire transfer) they are not real time and there is no way of verifying the information provided by the investor before an ACH charge is attempted. These charges occur in batches and not in real time. As such, if there is a failure the related investment payment will be marked as failed and the investor may need to create a new ACH Authorization (if the account number was incorrect).
ACH authorizations can be cancelled and they may be cancelled outside of your platform. For instance, an investor may contact FundAmerica directly and request a cancellation. When an ACH authorization is cancelled or verified, it will trigger a webhook.
\n","event":[{"listen":"prerequest","script":{"id":"69a18083-b951-4500-bf50-5e3628188e3b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6be2f84b-a74a-4ce6-ab9b-8786c1b0a8b2","type":"text/javascript","exec":[""]}}],"_postman_id":"c5a61656-a2d8-4861-8191-cd4635ceb615"}],"id":"43888c9d-943c-4e9e-ab68-af1843a0ccfa","description":"In order for an investor to invest in an offering using ACH, an ACH Authorization must be created. This requires an investor to provide their bank account information to FundAmerica and electronically sign an ACH Authorization Agreement. This can be accomplished in one of two ways:
\nThe hosted form is similar to signing an escrow agreement and is the simpler of the two to integegrate.
\nThe process works like this:
\nAn entity can have multiple ACH authorizations if you choose to support that functionality in your portal.
\nNote: In order to create an ACH authorization, the entity that wishes to use it must exist first. As a result, investments using ACH should always pass entity_id rather than individual entity parameters when creating an investment. The primary reason for this is that an ACH authorization is tied to an entity and another entity cannot use it for investing.
\n","event":[{"listen":"prerequest","script":{"id":"2b02fbc1-dcc4-48f9-a97f-280478617c20","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fc221cef-f763-4241-a6bd-b78ee025694f","type":"text/javascript","exec":[""]}}],"_postman_id":"43888c9d-943c-4e9e-ab68-af1843a0ccfa"},{"name":"Subscription Agreements","item":[{"name":"Subscription Agreement Templates","item":[{"name":"Create Subscription Agreement","id":"8655b9f0-850e-4aea-bf12-3ea77c97822a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"GET https://apps.fundamerica.com/api/subscription_agreement_templates\nPOST https://apps.fundamerica.com/api/subscription_agreement_templates\nGET https://apps.fundamerica.com/api/subscription_agreement_templates/:id\nPATCH https://apps.fundamerica.com/api/subscription_agreement_templates/:id\nGET https://apps.fundamerica.com/api/subscription_agreement_templates/boilerplate_html\nThese templates contain all the content and placeholders (see below) for the actual investor subscription agreements. The template itself is simply an HTML document. Additionally, the issuer's signature is included for automatic signing.
\ndraft_content: The actual HTML content of the subscription agreement. Note that this can be a complete HTML document or simply the content that would go inside the <body> of the document.email_document_to_signers: Defaults to true. If set to false, email's will not be sent when subscription agreements are signed and it is the responsibility of the platform operator to provide emails.issuer_company: The company name of the issuer.issuer_email: The email address of the person signing for the issuer.issuer_literal: The signature literal of the person signing for the issuer. This is usually the same as the issuer_name but some people choose to sign with partial names or initials. (e.g. John Johnson's signature literal is \"J Johnson\")issuer_metadata: A JSON object of any other data you wish to include with the issuer signature for verification purposes. It could include the user's ID on your own system, their IP address or any other data you want to include.issuer_name: The name of the person signing for the issuer.issuer_title: The title of the person signing for the issuer.publish: If set to true, the template will be usable subscription agreements and published_content will be replaced by draft_content.Note: When editing a template in the web portal, we use a WYSIWYG editor and it can mess up special formatting provided by your own HTML templates. If you're going to use subscription agreements via the API, you shouldn't edit them via the web portal for any reason.
\npublished_content: The published content for the template. This is what will actually be used when creating subscription agreements.Note: The publish/draft content feature allows for subscription agreements to be used in a standalone manner with FundAmerica. If you're storing the information on your own system---and many portal implementors do---you can safely just publish on each request and not worry about the publish/draft content distinction.
Subscription agreement templates can be filled with placeholders for arbitrary data. Some of these are system defined and others can be defined for individual documents. Placeholders are always included in a document delimited by a pair of percentage signs.
\nFor example, to include today's date in your template you would use %%TODAY%%.
\nHere are the placeholders that are available by default in subscription agreements:
\n%%DEBT_PAR_VALUE%%: The par value of the debt in a debt offering. This is specified when creating an Investor Subscription Agreement.%%EQUITY_SHARE_COUNT%%: The share/unit count in an equity offering. This is specified when creating an Investor Subscription Agreement.%%ISSUER_SIGNATURE%%: The issuer signature block.%%NOW%%: The current time as January 1, 2015 at 12:00 PM EST.%%NOW_SHORT%%: The current time as 1/1/2015 - 12:00 PM EST%%INVESTOR_SIGNATURES%%: The subscribers signature block.%%TODAY%%: Today's date as January 1, 2015.%%TODAY_SHORT%%: Today's date as 1/1/2015.%%VESTING_AMOUNT%%: The amount being invested by the investor. This is specified when creating an Investor Subscription Agreement.%%VESTING_AS%%: The investor's information (name, address, etc.). This is specified when creating an Investor Subscription Agreement.%%VESTING_AS_EMAIL%%: The investor's email address. This is specified when creating an Investor Subscription Agreement.Dates and times are variable up until the point a document is signed by the subscriber. From then on, %%NOW%% and %%TODAY%% will reflect the time that the document was signed.
You can use any placeholder name you want. When creating the actual Investor Subscription Agreement you can specify the values to be used for said placeholders.
\nNote: Placeholders are not case sensitive. %%TODAY%% is equivalent to %%today%% or %%Today%%. By convention, they are in call caps in the templates to make them easier to spot when creating documents but this is not a requirement.
Once you have a template created for your offering, you can create individual subscription agreements. This is done by providing the vesting information, placeholder information and the template and offering information. Doing so will create a final document that is automatically signed by the issuer and can be signed by a subscriber.
\nGET https://apps.fundamerica.com/api/subscription_agreements\nPOST https://apps.fundamerica.com/api/subscription_agreements\nGET https://apps.fundamerica.com/api/subscription_agreements/:id\ndebt_par_value: If the offering is a debt offering, this is required.equity_share_count: If the offering is an equity offering, this is required.data: A JSON object of key/value pairs that will be used as for placeholder data. It's a good practice, though not required, to have all the values set to strings. They will ultimately be coerced into strings when a document is created, but if you want to avoid surprises, just set them as strings.vesting_amount: The amount of money being invested. This should be formatted appropriately as this is only used to fill in the template and isn't a number that will be validated in any way.vesting_as: The vesting information for the investor. It should include the legal name and address.vesting_as_email: The investor's email address.You may have noticed that the fields here are nearly identical to the template placeholders. That's because they are.
\nThe subscription agreement service is entirely standalone from investments and while they can be used in tandem, they aren't necessary for one another. As such, entity information, the actual investment amounts, equity share counts, etc. aren't linked in any way by our platform. It's up to your system to make sure data is formatted the way you like and that it coincides with investment data.
\nIf your subscription agreement has a vesting_amount of $5,000.00 then the investment you ultimately associate it with should have an amount of 5000.
archived_pdf_url: Once the document has been signed, an archived PDF can be found at this URL.body_html: The body HTML of the document. If you wish to embed the document in your own interface for signature collection, use this. Even if you have provided a full HTML document, this is ONLY the content inside the <body>. The only exception is that if <style> directives exist in the <head>, they will be included in the body for formatting purposes.electronic_signatures: See Electronic Signatures for more details.signed: Whether or not the document has been signed by the subscriber.signing_links: If you wish to have the subscriber sign using FundAmerica's pass through interface, you can use the link here. You can attach a return_url querystring to this link.If you wish to embed the signing of documents into your own interface and not use the signing_links, this can be done via calls to the API. To do this, you must update an electronic signature object.
GET https://apps.fundamerica.com/api/electronic_signatures/external_agreement\nPATCH https://apps.fundamerica.com/api/electronic_signatures/external_agreement\ncompany: The company represented by the signer. Can be blank.email: The signer's email address.ip_address: The signer's IP address. This is not the IP address of your server. It must be the signer's client IP address.literal: The signer's literal signature. It may differ from the signer's name.metadata: And additional data you wish to include for signature verification, such as the user's ID on your local system.name: The signer's name.title: The title of the signer at the company. Must be blank if company is blank.user_agent: The signer's user agent.singable: Whether the signature is signable via the API. Some documents contain multiple signatures, some of which are signed by FundAmerica. These signatures are not open for signing via the API.signed: Whether the signature has been signed.signed_at: When the signature was signed.When implementing your own interface, you may very well already know the name, email, title, and company information for the signer. It's important that the signer can see this information, but not necessary that they are able to alter it for the purpose of the signature. The only attribute that must have direct input by the signer is literal.
Note: Although the documentation here relates to subscription agreements, it can currently be applied to Escrow Agreements as well should you want to embded them into your own portal.
\n","event":[{"listen":"prerequest","script":{"id":"67966fc7-6482-4fe9-9ebb-760e68013c68","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a762fa9c-e8fb-4a66-a807-494b7b4c09eb","type":"text/javascript","exec":[""]}}],"_postman_id":"549f0bb9-6adf-4d8d-a491-a2cd50b83147"},{"name":"Subscription Agreement Bolierplate","item":[],"id":"870e0027-ecb0-41e4-b9df-e4c5ca514a9c","description":"If you want to use our boilerplate as a starting place for your subscription agreements, it can be found at:
\nGET https://apps.fundamerica.com/api/subscription_agreement_templates/boilerplate_html\n{\n \"boilerplate_html\" : \".....a whole lot of legalese...\"\n}\nThe document signing system that is currently used for both Escrow Agreements and ACH Authorizations is also available for subscription agreements.
\nThe steps involved in setting up and using a subscription agreement for an Offering are as follows:
\nNote: The signing system is limited to HTML documents. If you're working from a PDF or Microsoft Office Document, you'll need to convert it to acceptable HTML first. In the event that this is unacceptable, please use our External Subscription Agreements feature, which can be used in conjunction with any other signing service.
\n","event":[{"listen":"prerequest","script":{"id":"256df808-6a87-4d61-928d-7b5a3abae605","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f6183158-0150-4163-b0ec-679cb4eca5f8","type":"text/javascript","exec":[""]}}],"_postman_id":"6c5ffb21-735f-458f-a4c9-bf42be318ac1"},{"name":"Broker Dealer Services","item":[{"name":"Selling Agreements","item":[{"name":"Activating Broker Dealer Services in Test Mode","item":[{"name":"Activate Broker Dealer Services in Test Mode","id":"29a96e59-2905-49c5-80a3-ccb180b4a3d0","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"To activate broker dealer services in test mode without needing to have your selling agreement approved, use the test mode API.
\n","event":[{"listen":"prerequest","script":{"id":"6bb3f1ed-739e-4808-b7d9-c9edc16c3697","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b7778460-7c29-48f8-bacb-b5fdc64a48f2","type":"text/javascript","exec":[""]}}],"_postman_id":"71fe569f-c74d-4086-b795-08595e8c6999"},{"name":"Create Selling Agreement","id":"1e620534-cb7f-4275-8d04-cbe74508907d","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"Selling agreements operate very similarly to Escrow Agreements. When an offering is approved for escrow payments, if there is a selling agreement signed by the issuer, it will also be reviewed by FundAmerica and, if approved and counter-signed, broker-dealer services will be available for the offering.
\nIn general, this approval will happen shortly after an offering is approved for escrow.
\nPOST https://apps.fundamerica.com/api/selling_agreements\nGET https://apps.fundamerica.com/api/selling_agreements/:id\noffering_id: The offering related to the escrow aggrement.archived_pdf_url: Once the document has been signed, an archived PDF copy can be found at this location.signed: Whether or not the document has been signed.signing_links: A list of available signatures, their signing links and when those links expire (defaults to one day from the time of creation). In the case of an escrow agreement, there will only be an \"issuer_signature\".Note: A return_url query string can be added to the signing URL and the signer will be redirected to the return_url when the document is signed.
Rather than copy the form, which has parameters and text that are subject to change, a call can be made to query the contents of the form (the edit action). This will give you a structure on building the form and, in the event the form has already been filled out, it will also include the existing values.
There is a lot of text following, but it's pretty straightforward. Calling the edit action returns JSON with four primary keys:
\nform: This lists all the content in the form. The first keys represent attribute names (the HTTP form parameters) and the object contained.type: The field type. This is mostly important for building HTML forms. Examples include: boolean (should generally be a checkbox), integer, decimal, and email. If blank, the default should be a single line string.label: The human friendly name for this fieldoptions: If there are a group of selectable options, this will be a hash of values and their descriptions. This should be a select tag, or list of radio buttons (or checkboxes if multivalue is true)multivalue: If true the parameter will accept multiple values.action: The form action attribute when creating an HTML form.method: The HTTP method should be used. This will often be a POST or PATCH. It's important to note that some browsers will only GET or POST forms. To be safe you should include a hidden attribute named _method in your forms where HTTP verbs other than GET and POST are not supported. If you find yourself getting a strange 404 when trying to submit a form, it often means you're trying to POST when you should be using a PATCH method.resource: The content of the object to edit.Rather than copy the form, which has parameters and text that are subject to change, a call can be made to query the contents of the form (the edit action). This will give you a structure on building the form and, in the event the form has already been filled out, it will also include the existing values.
There is a lot of text following, but it's pretty straightforward. Calling the edit action returns JSON with four primary keys:
\nform: This lists all the content in the form. The first keys represent attribute names (the HTTP form parameters) and the object contained.type: The field type. This is mostly important for building HTML forms. Examples include: boolean (should generally be a checkbox), integer, decimal, and email. If blank, the default should be a single line string.label: The human friendly name for this fieldoptions: If there are a group of selectable options, this will be a hash of values and their descriptions. This should be a select tag, or list of radio buttons (or checkboxes if multivalue is true)multivalue: If true the parameter will accept multiple values.action: The form action attribute when creating an HTML form.method: The HTTP method should be used. This will often be a POST or PATCH. It's important to note that some browsers will only GET or POST forms. To be safe you should include a hidden attribute named _method in your forms where HTTP verbs other than GET and POST are not supported. If you find yourself getting a strange 404 when trying to submit a form, it often means you're trying to POST when you should be using a PATCH method.resource: The content of the object to edit.After getting the form information, you can build a form which should then be submitted with an equivalent call. You must make the customer_agreement available to the client filling out the form. Generally, including the link to another page, using a frame or a modal all work just fine.
After getting the form information, you can build a form which should then be submitted with an equivalent call. You must make the customer_agreement available to the client filling out the form. Generally, including the link to another page, using a frame or a modal all work just fine.
In order for an investor to invest in an offering using this service and have this service active for the investment, the investor must accept a customer agreement, self attest their accreditation status and provide susbstitute W-9 information. In order for FundAmerica Securities to act as the broker-dealer of record for the investor on a particular investment, this must be filled out.
\nAs with ACH Authorizations, you must present the form information exactly as FundAmerica does on its own form.
\nPATCH https://apps.fundamerica.com/api/entities/:id/customer_agreement\nPATCH https://apps.fundamerica.com/api/investors/:id/customer_agreement\nGET https://apps.fundamerica.com/api/entities/:id/customer_agreement/edit\nGET https://apps.fundamerica.com/api/investors/:id/customer_agreement/edit\nUse the investor endpoints to accept investor customer agreements for different types of investors.
\n","event":[{"listen":"prerequest","script":{"id":"0af768a8-1ae2-4345-84c6-d6b4682fe876","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"89dad4b1-a228-4f4f-8302-5b04308d7995","type":"text/javascript","exec":[""]}}],"_postman_id":"284676c2-02b5-44a9-a9a9-e752a8c2795a"},{"name":"Trade Reviews","item":[{"name":"Get Bank Transfer Methods related to specific Entity","id":"2cc2583f-ff5c-4022-a5d4-1c1e7ea6b0dc","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"Investments made using this service must undergo a trade review wherein FundAmerica Securities must review the investment in accordance with the information provided in the investor suitability questionnaire and either accept or deny the trade. Denying a trade would subsequently cancel in the investment.
\nThe trade_review_status is available as part of an investment. Additionally, a list of trade reviews can be viewed using the following API Endpoint. There is also a test mode API for updating the status of a trade review.
GET https://apps.fundamerica.com/api/trade_reviews\nPATCH https://apps.fundamerica.com/api/test_mode/trade_reviews\nTrade reviews have webhooks.
\n","event":[{"listen":"prerequest","script":{"id":"3f1f1350-ed9a-4b26-a5bb-6e55a6f3ae73","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c93930d8-a19a-4c47-a755-6d9514446e80","type":"text/javascript","exec":[""]}}],"_postman_id":"f883bcc1-5eb0-4cd0-b7cd-d5f13cee41cb"}],"id":"83bdc83e-2d9e-4617-9c54-ef19ead196ee","description":"To use this service, you must also use our escrow service. Remember, while this service requires our escrow service, our escrow service does not require the use of this service.
\nThere is a multistep process for both the issuer and the investor:
\nFor the Issuer
\nFor the Investor
\nreview_trade set to true. The default is false. This indicates that you want FundAmerica to review the trade and require the investor to have accepted the Investor Customer Agreement.Note: Even though this service may be enabled on a particular offering, it is managed on a per investment basis. If you wish to not use this service on a particular investment (e.g. there is no requirement for a particular investor or another broker-dealer is representing said investor) you can set review_trade to false on the investment and said investment will operate like a normal escrow payment without the broker-dealer services enabled.
Below is a list of entities that will return example background checks in the sandbox environment.
\ncurl https://sandbox.fundamerica.com/api/entities \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-d city=\"Artie\" \\\n-d date_of_birth=\"1980-01-01\" \\\n-d email=\"dale.mulford@example.com\" \\\n-d name=\"Dale Mulford\" \\\n-d phone=\"13048540483\" \\\n-d postal_code=\"25008\" \\\n-d region=\"WV\" \\\n-d street_address_1=\"1038 White Oak Creek Rd\" \\\n-d tax_id_number=\"520102674\" \\\n-d type=\"person\"\n\ncurl https://sandbox.fundamerica.com/api/entities \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-d city=\"Grayslake\" \\\n-d date_of_birth=\"1980-01-01\" \\\n-d email=\"linda.carpenter@example.com\" \\\n-d name=\"Linda Carpenter\" \\\n-d phone=\"18478271922\" \\\n-d postal_code=\"60030\" \\\n-d region=\"IL\" \\\n-d street_address_1=\"1331 Wild Indigo Rd\" \\\n-d tax_id_number=\"516322134\" \\\n-d type=\"person\"\n\ncurl https://sandbox.fundamerica.com/api/entities \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-d city=\"Jacksonville\" \\\n-d date_of_birth=\"1953-05-01\" \\\n-d email=\"nancy.lebo@example.com\" \\\n-d name=\"Nancy Lebo\" \\\n-d phone=\"19046548849\" \\\n-d postal_code=\"32209\" \\\n-d region=\"FL\" \\\n-d street_address_1=\"1519 W 5 Th St\" \\\n-d tax_id_number=\"520093807\" \\\n-d type=\"person\"\n\ncurl https://sandbox.fundamerica.com/api/entities \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-d city=\"Kekaha\" \\\n-d date_of_birth=\"1961-02-01\" \\\n-d email=\"james.hall@example.com\" \\\n-d name=\"James Hall\" \\\n-d phone=\"1085551212\" \\\n-d postal_code=\"96752\" \\\n-d region=\"HI\" \\\n-d street_address_1=\"4807 N Wildwood Dr\" \\\n-d tax_id_number=\"577699840\" \\\n-d type=\"person\"\ncurl https://sandbox.fundamerica.com/api/entities \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-d city=\"San Diego\" \\\n-d country=\"US\" \\\n-d email=\"herbert.atiyat@example.com\" \\\n-d contact_name=\"Herbert Atiyat\" \\\n-d name=\"Net Land Sports\" \\\n-d phone=\"13193240031\" \\\n-d postal_code=\"92129\" \\\n-d region=\"CA\" \\\n-d region_formed_in=\"CA\" \\\n-d street_address_1=\"22 Sherwood Hts\" \\\n-d tax_id_number=\"570426249\" \\\n-d type=\"company\"\n\ncurl https://sandbox.fundamerica.com/api/entities \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-d city=\"Saratoga\" \\\n-d country=\"US\" \\\n-d email=\"joseph.avena@example.com\" \\\n-d contact_name=\"Joseph Avena\" \\\n-d name=\"Copper Lantern Bar\" \\\n-d phone=\"17168330032\" \\\n-d postal_code=\"95070\" \\\n-d region=\"CA\" \\\n-d region_formed_in=\"CA\" \\\n-d street_address_1=\"10011 67 Th Rd\" \\\n-d tax_id_number=\"570425503\" \\\n-d type=\"company\"\n\ncurl https://sandbox.fundamerica.com/api/entities \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-d city=\"Fairfax\" \\\n-d country=\"US\" \\\n-d email=\"nancy.babula@example.com\" \\\n-d contact_name=\"Nancy Babula\" \\\n-d name=\"Shield Home Security\" \\\n-d phone=\"17137470033\" \\\n-d postal_code=\"94930\" \\\n-d region=\"CA\" \\\n-d region_formed_in=\"CA\" \\\n-d street_address_1=\"6421 Booth St Apt 6 H\" \\\n-d tax_id_number=\"539164707\" \\\n-d type=\"company\"\n\ncurl https://sandbox.fundamerica.com/api/entities \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-d city=\"St Cloud\" \\\n-d country=\"US\" \\\n-d email=\"barney.stone@example.com\" \\\n-d contact_name=\"Barney Stone\" \\\n-d name=\"IM CRAZY INTERNATIONAL\" \\\n-d phone=\"13202418143\" \\\n-d postal_code=\"56301\" \\\n-d region=\"MN\" \\\n-d region_formed_in=\"MN\" \\\n-d street_address_1=\"123 Happy St\" \\\n-d tax_id_number=\"566689992\" \\\n-d type=\"company\"\nThis service allows you to run background checks on entities to check on the validity of identifying information (e.g. name, tax ID, address, etc.) and to see if the entity is listed on any global watch lists.
\nNote : If you're using our Escrow Payments service then AML checks are processed automattically on every investment.
\nBefore you can create background checks or view background check details in production, you will need to submit your account to a review process. This can be done by going to AML & Bad Actors Checks. If you receive a warning about needing your account reviewed, please follow the instructions and submit the necessary information for approval.
\nThis service is available in test mode even without approval, however you will need to use test data provided below as anything else will return empty responses. The test data is just a bunch of entities that background checks will return results on and can be used for test investments with the expected AML results.
\nBackground checks verify the identity information of an entity as well as whether that entity appears on any global watch lists. Background check responses differ somewhat depending on whether or not the entity is a person or a company.
\nNote: Background checks are limited to US entities as of right now. Support for some international checks is slated for a future release.
\nentity_id: The entity you wish to process a background check on.offering_id: The related offering. Background checks must always be processed with a related offering.cleared: true if background check was successful and entity did not appear on any watch lists.identity_check: Details about the identity check.aml_exception: If true it means that there were issues with the identity check, ranging from an incorrect tax ID to being on listed on a global watch list. This investor needs to be manually reviewed. (If using our escrow service, FundAmerica will follow up appropriately and potentially cancel an associated investment.)details: The details of the background check. (See examples for fields. More documentation coming soon. Contact support if you need further assistance.)risk_indicators: A list of issues or potential issues with the entity. These can be as severe as being on a watch list or as trivial as a person's address being used for business purposes. The existence of a risk indicator doesn't mean there is a problem with the check.type: The type of entity the background check was processed on. Can be person or company. Some attributes in details differ depending on the entity type.Bank transfer methods are non-check payment instructions for investors. They allow ACH or wire information to be specified for the payout.
\nYou might notice that the parameters are very similar to ACH Authorizations. That's because an ACH authorization is nothing but a Bank Transfer Method with an authorization form attached that allows for both debits and credits. Since bare Bank Transfer Methods lack the authorization portion, they can only be used to credit accounts (which is all you need to make a payment).
\nYou can get the appropriate Bank Transfer Method related to an ACH Authorization by doing a GET on the coorsponding ACH Authorization.
\nPOST https://apps.fundamerica.com/api/bank_transfer_methods\nGET https://apps.fundamerica.com/api/bank_transfer_methods/:id\nDELETE https://apps.fundamerica.com/api/bank_transfer_methods/:id\nGET https://apps.fundamerica.com/api/entities/:id/bank_transfer_methods\naccount_number: The bank account number.account_type: Must be set either to checking or savings if the type is ach. Otherwise, it must be left blank.check_type: Must be set to either personal or business if the type is ach. Otherwise, it must be left blank.name_on_account: The name on the bank account.routing_number: The bank's routing number. Must be a valid routing number, even when testing.type: Must be set to ach or wire depending on how the transfer should be initiated.use_for_investor_payments: If set to true this bank transfer method will automatically be set as the entity's Investor Payment Methodaccount_number_short: This will be the last 4 digits of the account number.cancelled_at: If and when the method is cancelled. Cancelled methods will not be used for future transactions. The DELETE will initiate a cancellation.name: A friendly name combining the name_on_account and account_number_short.verified: true if there has ever been a successful transaction using this method.Investor payment methods dictate how an investor is to be paid when a Distribution is distributed. These do not have to be specified, however if they are not, one of three defaults will be used:
\nThis behaviour can be confusing. You can always look at the current default by:
\nGET https://apps.fundamerica.com/api/entities/:id/investor_payment_method\nIf id is null that means the default is being used and you have not specified a method.
If you want complete control and predictability over how your investors are paid, manually specify the payment method.
\nAdditionally, investor payment methods can be specified when creating an ACH Authorization or Bank Transfer Method by setting use_for_investor_payments to true.
GET https://apps.fundamerica.com/api/entities/:id/investor_payment_method\nPOST https://apps.fundamerica.com/api/investor_payment_methods\nGET https://apps.fundamerica.com/api/investor_payment_methods/:id\nPATCH https://apps.fundamerica.com/api/investor_payment_methods/:id\nDELETE https://apps.fundamerica.com/api/investor_payment_methods/:id\nUsing the DELETE will revert investor payment method to the default entity
ach_authorization_id: The ID of the ACH Authorization to be used for payments. When provided, a bank_transfer_method_id will be infered from it.bank_transfer_method_id: The ID of the Bank Transfer Method to be used for payments.check_mailing_address: The address to mail checks to if type is check. If this is not specified, the entity's current address will be used.check_payee: The name to make checks out to if type is check. If this is not specified, the entity's current name will be used.type: Must be set to:ach: If this is selected, either an ach_authorization_id or bank_transfer_method_id must be provided.check: If this is selected, ach_authorization_id and bank_transfer_method_id must be left blank. The entity name and address will be used when mailing the check.Note: While Bank Transfer Methods support ach and wire, only ach is supported by investor payments.
\n","event":[{"listen":"prerequest","script":{"id":"38f2398e-289e-4a10-bd63-b7df9664b0af","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0d14e7c9-0e33-4a5f-8a7b-da8fd7103c52","type":"text/javascript","exec":[""]}}],"_postman_id":"4d984b64-bc00-467b-bfd7-b42dff751a4d"},{"name":"Distributions","item":[{"name":"Distribution Test Mode","item":[{"name":"Update Distribution in Test Mode to recieved","id":"7b310eec-5b4c-4f07-bb72-4baf01f55b94","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api-key}}"},{"key":"password","value":"On the sandbox, test calls can be made to update the status on a distribution.
Make sure when you are updating or creating a distribution that it splits correctly amongst your investors otherwise the system will not let you create a distribution for that amount.
\n","urlObject":{"path":["distributions","hpAnZvcAS-mVd73UYywN0Q"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"5b3dced7-b76e-4068-8410-aad8d7e0b617","name":"Update Distribution","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"authorized_name\" : \"John Johnson\"\n}"},"url":"{{env}}/distributions/hpAnZvcAS-mVd73UYywN0Q"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Disposition, Content-Type, X-FA-Public-Key, X-FA-User-Session-Token, X-Requested-With","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, DELETE","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Access-Control-Expose-Headers","value":"Cache-Control, Content-Disposition, Content-Type, X-FA-Session-Expires-At","name":"Access-Control-Expose-Headers","description":"Lets a server whitelist headers that browsers are allowed to access."},{"key":"Access-Control-Max-Age","value":"86400","name":"Access-Control-Max-Age","description":"Indicates how long the results of a preflight request can be cached in seconds."},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"515","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 16 Jul 2018 20:33:17 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx","name":"Server","description":"A name for the server"},{"key":"Status","value":"200 OK","name":"Status","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Request-Id","value":"1c6ad56d-c9ad-413f-b35e-87457c7a0ca9","name":"X-Request-Id","description":"Custom header"},{"key":"X-Runtime","value":"0.060060","name":"X-Runtime","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\"object\":\"distribution\",\"id\":\"hpAnZvcAS-mVd73UYywN0Q\",\"url\":\"https://sandbox.fundamerica.com/api/distributions/hpAnZvcAS-mVd73UYywN0Q\",\"ach_authorization_url\":\"https://sandbox.fundamerica.com/api/ach_authorizations/fM2e4ma0RjSM-pyi-B1WRQ\",\"amount\":\"50000.0\",\"amount_distributed\":\"0.0\",\"amount_received\":\"0.0\",\"authorized_name\":\"John Johnson\",\"authorized_title\":\"COOO\",\"company_name\":\"FA Documentation\",\"contact_email\":\"whatsupdoc@fundamerica.com\",\"contact_name\":\"Danny Documentation\",\"contact_phone\":\"1 (555) 555-5555\",\"created_at\":\"2018-07-16T20:24:26.347Z\",\"distributed_at\":null,\"dividend_amount\":\"0.0\",\"interest_amount\":\"0.0\",\"offering_url\":\"https://sandbox.fundamerica.com/api/offerings/GIkgnlisRTSnot76Q-zcig\",\"ordinary_income_amount\":\"0.0\",\"other_amount\":\"0.0\",\"other_type\":null,\"payment_method\":\"ach\",\"principal_amount\":\"50000.0\",\"profit_share_amount\":\"0.0\",\"received_at\":null,\"revenue_share_amount\":\"0.0\",\"royalty_amount\":\"0.0\",\"security_url\":\"https://sandbox.fundamerica.com/api/securities/JHwXpMWeRv6I8uxvuhAyCA\",\"status\":\"not_received\",\"updated_at\":\"2018-07-16T20:24:26.347Z\"}"}],"_postman_id":"fa09405c-bfd7-4bd2-945d-f991e78908a4"}],"id":"e314992f-2370-4c16-9bd8-a891ba0a7c53","description":"Distributions are the bulk payments meant to be distributed to your investors. Their lifecycle is similar to Investments themselves in how payment methods are specified and how funds are received. Once funds are received, they will be disbursed to individual investors according to defaults or specific instructions set forth in Investor Payment Methods.
\nBy default, investor payments will be created along with a distribution by percentage of the total amount of securities the investor holds in a particular offering. If you use a different calculation or simply want to create a distribution from scratch without automatic calcuations, set recalculate_investor_payments to false when creating a distribution. From there, you can create investor payments yourself.
Note: Offerings must have accepted close requests before any payments can be made. Also remember to correct any incorrect security information related to the investor with Holdings before processing a distribution. This is mainly important if your implementation wasn't giving accurate debt_par_value or equity_share_count information.
GET https://apps.fundamerica.com/api/distributions\nPOST https://apps.fundamerica.com/api/distributions\nGET https://apps.fundamerica.com/api/distributions/:id\nPATCH https://apps.fundamerica.com/api/distributions/:id\nDELETE https://apps.fundamerica.com/api/distributions/:id\nPATCH https://apps.fundamerica.com/api/test_mode/distributions/:id\nach_authorization_id: If payment_method is set to ach this is the ID of the ACH Authorization to be used to make the payment.authorized_name: The name of the person authorizating the payment.authorized_title: The title of the person authorizating the payment.company_name: The legal name of the company.contact_email: The contact email address for the company.contact_name: The name of the contact person for the company.contact_phone: The contact phone number for the company.dividend_amount: The amount of the payment in USD applied to dividends.interest_amount: The amount of the payment in USD applied to interest.ordinary_income_amount: The amount of the payment in USD applied to ordinary income.other_type: If other is amount greater than 0, this must specify the type of payment.other_amount: The amount of the payment in USD applied to other.payment_method: Must be set to one of three values: ach, check, wire.principal_amount: The amount of the payment in USD applied to the principal.profit_share_amount: The amount of the payment in USD applied to profit sharing.ready: Set to true once you are ready to process a distribution. This should occur after the calculated Investor Payments have been reviewed as correct.recalculate_investor_payments: true by default. Set to false if you do not want the amounts of investor payments calculated when creating a new distribution or if you update the total.revenue_share_amount: The amount of the payment in USD applied to revenue sharing.royalty_amount: The amount of the payment in USD applied to royalities.security_id: The Security to make a distribution on.Note: Many of these values are populated automatically by the security's issuer's values.
\namount_distributed: The total amount in USD paid out to individual investors.amount: The total amount in USD to be paid to investors. This value is set automatically and is a sum of dividend_amount, interest_amount, ordinary_income_amount, other_amount, principal_amount, profit_share_amount, revenue_share_amount and royalty_amount.distributed_at: The timestamp when all funds were released to investors.received_at: The timestamp when all funds were received.status: The current status of the remittance.draft: Amounts and individual Investor Payments can be altered. Once the numbers are correct, set ready to true to submit the distribution and notify FundAmerica to expect a funds from the issuer.not_received: Processing and all funds have not been received.received: All funds have been received.distributed: All funds have been paid to individual investors.voided: Payment has been voided via DELETE. Planned payments can only be voided if no funds have been received.Note: The DELETE call will void a distribution. This is only possible before funds have been received. (status must be not_received)
Investor payments are the actual payments distributed to individual investors. While a distribution is still in draft mode, the details can be altered.
\nGET https://apps.fundamerica.com/api/distributions/:id/investor_payments\nGET https://apps.fundamerica.com/api/entities/:id/investor_payments\nGET https://apps.fundamerica.com/api/holdings/:id/investor_payments\nGET https://apps.fundamerica.com/api/investor_payments\nPOST https://apps.fundamerica.com/api/investor_payments\nGET https://apps.fundamerica.com/api/investor_payments/:id\nPATCH https://apps.fundamerica.com/api/investor_payments/:id\nDELETE https://apps.fundamerica.com/api/investor_payments/:id\nGET https://apps.fundamerica.com/api/investors/:id/investor_payments\namount: The amount to pay the investor.bank_transfer_method_id: Must be an ACH bank transfer method. Use if paying via ACH.check_mailing_address: If paying by check, the address to mail the check to.check_payee: If paying by check, the entity to make the check out to.dividend_amount: The amount of the payment in USD applied to dividends.interest_amount: The amount of the payment in USD applied to interest.ordinary_income_amount: The amount of the payment in USD applied to ordinary income.other_amount: The amount of the payment in USD applied to other.other_type: If other is amount greater than 0, this must specify the type of payment.principal_amount: The amount of the payment in USD applied to the principal.profit_share_amount: The amount of the payment in USD applied to profit sharing.revenue_share_amount: The amount of the payment in USD applied to revenue sharing.royalty_amount: The amount of the payment in USD applied to royalities.Most of the attributes are pretty obvious as they line up with entities. Keep in mind that if an entity changes information after a distribution is created, the information used at the time of the payment creation is what will be used for the investor payment. This is particularly important if mailing checks.
\npaid_at: When the actual payment was made.payment_details: Details about the payment when it was paid such as the ACH batch ID or the check number.payment_method: The method that the payment was made, ach or check.status:pending: Information about the payment specifics has been received.processing: The current payment is being reviewed and queued for payment.paid: Actual payment has been sent to the investor.voided: In the event of an error or the cancellation of a distributions, an investor payment becomes voided.Non-Investor Payments are arbitrary payments in a distribution not related to investors. While a Distribution is still in draft mode, the details can be altered. In many cases, it is easiest to create a distribution without factoring in the amounts for non-investor payments, create the non-investor payments and then update the other_amount on your distribution with the non-investor payment total.
GET https://apps.fundamerica.com/api/distributions/:id/non_investor_payments\nGET https://apps.fundamerica.com/api/non_investor_payments\nPOST https://apps.fundamerica.com/api/non_investor_payments\nGET https://apps.fundamerica.com/api/non_investor_payments/:id\nPATCH https://apps.fundamerica.com/api/non_investor_payments/:id\nDELETE https://apps.fundamerica.com/api/non_investor_payments/:id\namount: The amount to pay the investor.bank_transfer_method_id: Must be an ACH bank transfer method. Use if paying via ACH.check_mailing_address: If paying by check, the address to mail the check to.check_payee: If paying by check, the entity to make the check out to.dividend_amount: The amount of the payment in USD applied to dividends.interest_amount: The amount of the payment in USD applied to interest.ordinary_income_amount: The amount of the payment in USD applied to ordinary income.other_amount: The amount of the payment in USD applied to other.other_type: If other is amount greater than 0, this must specify the type of payment.principal_amount: The amount of the payment in USD applied to the principal.profit_share_amount: The amount of the payment in USD applied to profit sharing.revenue_share_amount: The amount of the payment in USD applied to revenue sharing.royalty_amount: The amount of the payment in USD applied to royalities.paid_at: When the actual payment was made.payment_details: Details about the payment when it was paid such as the ACH batch ID or the check number.payment_method: The method that the payment was made, ach or check.status:pending: Information about the payment specifics has been received.processing: The current payment is being reviewed and queued for payment.paid: Actual payment has been sent to the non-investor.voided: In the event of an error or the cancellation of a distributions, an investor payment becomes voided.The Payment Processing API is used for making payments to investors. Payments include interest, revenue-share, principal, preferred distributions, profit-sharing, dividends, royalties, etc.
\nOnce an offering is closed, whether the close is partial or complete, this service to can be used to make payments directly to your investors via check or ACH transfer.
\nIf you're already familiar with Investments, the flow of payment processing is quite similar.
\nOnce the funds are receieved by FundAmerica and have cleared, they will be distributed to your investors accordingly.
\nA few things to keep in mind:
\ndebt_par_value in the case of debt offerings and equity_share_count in the case of equity offerings. If this wasn't the case, please see Holdings.status of invested before payments can be made on a particular investment.Note: There are some backward compatibility issues with updating securities, if you run into such an issue please contact support
\n","urlObject":{"path":["securities","JHwXpMWeRv6I8uxvuhAyCA"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"c9959615-d824-4f36-91a1-87663aa70e3b","name":"Update Security Equity","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"description\": \"Offering for documentation purposes\",\n\t\"equity_sold_as\" : \"price_per_share\"\n}"},"url":"{{env}}/securities/JHwXpMWeRv6I8uxvuhAyCA"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Disposition, Content-Type, X-FA-Public-Key, X-FA-User-Session-Token, X-Requested-With","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, DELETE","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Access-Control-Expose-Headers","value":"Cache-Control, Content-Disposition, Content-Type, X-FA-Session-Expires-At","name":"Access-Control-Expose-Headers","description":"Lets a server whitelist headers that browsers are allowed to access."},{"key":"Access-Control-Max-Age","value":"86400","name":"Access-Control-Max-Age","description":"Indicates how long the results of a preflight request can be cached in seconds."},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"490","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 16 Jul 2018 20:13:30 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx","name":"Server","description":"A name for the server"},{"key":"Status","value":"200 OK","name":"Status","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Request-Id","value":"59c46b72-4a95-4e4b-91ef-d70b3787154d","name":"X-Request-Id","description":"Custom header"},{"key":"X-Runtime","value":"0.037219","name":"X-Runtime","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\"object\":\"security\",\"id\":\"JHwXpMWeRv6I8uxvuhAyCA\",\"url\":\"https://sandbox.fundamerica.com/api/securities/JHwXpMWeRv6I8uxvuhAyCA\",\"ceremonial_certificates\":false,\"created_at\":\"2018-07-06T17:51:20.949Z\",\"debt_interest_rate\":null,\"debt_maturity_date\":null,\"description\":\"Offering for documentation purposes\",\"entity_url\":\"https://sandbox.fundamerica.com/api/entities/R-ycs0c1RVOsfR16vlz9mg\",\"equity_share_price\":\"1.0\",\"equity_sold_as\":\"price_per_share\",\"holdings_count\":2,\"issuer_must_review_transfer\":false,\"issuer_name\":\"FA Documentation\",\"legends\":null,\"name\":\"FA Documentation\",\"no_partial_transfer\":false,\"no_transfer_to_non_accredited\":false,\"no_transfer_to_non_accredited_days\":null,\"no_transfer_to_non_state_resident\":false,\"non_accredited_must_hold\":false,\"non_accredited_must_hold_days\":null,\"offering_url\":\"https://sandbox.fundamerica.com/api/offerings/GIkgnlisRTSnot76Q-zcig\",\"original_owner_must_hold\":false,\"original_owner_must_hold_days\":null,\"type\":\"equity\",\"updated_at\":\"2018-07-06T17:53:48.636Z\"}"}],"_postman_id":"b5269052-c78f-4281-8427-241724af669e"}],"id":"3d4513bb-5078-457b-be3d-417b3830a6a7","description":"Securities represent the actual security details on what an offering has issued to investors. If you don't plan on using Payment Processing, the actual security information related to an offering doesn't matter.
\nIf a security is associated with an offering, securities will be automatically issued to the investors of investments with a status of invested.
GET https://apps.fundamerica.com/api/securities\nPOST https://apps.fundamerica.com/api/securities\nGET https://apps.fundamerica.com/api/securities/:id\nPATCH https://apps.fundamerica.com/api/securities/:id\ndebt_interest_rate: If type is debt, the interest rate associated with the security. Otherwise, it should be omitted.debt_maturity_date: If type is debt, the maturity date or term associated with the security. Otherwise, it should be omitted.description: An optional description of the security.name: The name of the security.type: Must be set to debt or equity and must match the associated offering's type. If this is omitted, the associated offering's type will be used.Note: While debt securities require some actual information about the nature of the security, equity securities are really nothing more than a name and description.
Holdings represent a security issued to a particular investor and the details of that holding, whether it be a total number of shares of the par value of debt.
\nHoldings are created automatically for an investor when an investment is set to invested and the offering has a security associated with it. Additionally, they may be created manually.
GET https://apps.fundamerica.com/api/entities/:id/holdings\nGET https://apps.fundamerica.com/api/holdings\nPOST https://apps.fundamerica.com/api/holdings\nGET https://apps.fundamerica.com/api/holdings/:id\nPATCH https://apps.fundamerica.com/api/holdings/:id\nGET https://apps.fundamerica.com/api/investors/:id/holdings\nGET https://apps.fundamerica.com/api/securities/:id/holdings\ndebt_par_value: If type is debt, the par value of the debt security issued to the entity. Otherwise, it should be omitted.equity_share_count: If type is equity, the number of shares issued to the entity. Otherwise it should be omitted.type: debt or equity. It will always match the type of the associated security.Billing information related to your account can be found with the billing transactions API calls. You can view items that will be billed to your account by:
\nGET https://apps.fundamerica.com/api/billing_transactions\nGET https://apps.fundamerica.com/api/investments/:id/billing_transactions\nGET https://apps.fundamerica.com/api/offerings/:id/billing_transactions\namount: The amount to be billed.billed_at: The date a billing transaction was charged successfully.description: A description of the item to be billed.We keep track of all outgoing e-mails in the system. You can also resend an e-mail.
\nGET https://apps.fundamerica.com/api/email_logs\nPATCH https://apps.fundamerica.com/api/email_logs/:id/resend\nattachments: List of files included with the e-mail. This will be an array of strings.email_hash: Related (duplicate) e-mails will have the same e-mail hash. This is useful when an e-mail is resent and you want to find the original or resent e-mail.status: Can be either not_sent or sent.Below are a list of all current API calls. If there are no specific examples above, the error responses are mostly self-documenting. DELETE calls don't take parameters. PATCH calls take the same parameters as POST calls.
https://apps.fundamerica.com/api/info (GET)\nhttps://apps.fundamerica.com/api/ach_authorizations (GET)\nhttps://apps.fundamerica.com/api/ach_authorizations (POST)\nhttps://apps.fundamerica.com/api/ach_authorizations/:id (GET)\nhttps://apps.fundamerica.com/api/ach_authorizations/:id (DELETE)\nhttps://apps.fundamerica.com/api/ach_authorizations/agreement_html (GET)\nhttps://apps.fundamerica.com/api/ach_tokens (POST)\nhttps://apps.fundamerica.com/api/background_checks (GET)\nhttps://apps.fundamerica.com/api/background_checks (POST)\nhttps://apps.fundamerica.com/api/bank_info/:routing_number (GET)\nhttps://apps.fundamerica.com/api/bank_transfer_methods (POST)\nhttps://apps.fundamerica.com/api/bank_transfer_methods/:id (GET)\nhttps://apps.fundamerica.com/api/bank_transfer_methods/:id (DELETE)\nhttps://apps.fundamerica.com/api/billing_transactions (GET)\nhttps://apps.fundamerica.com/api/billing_transactions/:id (GET)\nhttps://apps.fundamerica.com/api/background_checks/:id (GET)\nhttps://apps.fundamerica.com/api/cancel_offering_requests (GET)\nhttps://apps.fundamerica.com/api/cancel_offering_requests (POST)\nhttps://apps.fundamerica.com/api/cancel_offering_requests/:id (GET)\nhttps://apps.fundamerica.com/api/close_offering_requests (GET)\nhttps://apps.fundamerica.com/api/close_offering_requests (POST)\nhttps://apps.fundamerica.com/api/close_offering_requests/:id (GET)\nhttps://apps.fundamerica.com/api/disbursements (GET)\nhttps://apps.fundamerica.com/api/disbursements (POST)\nhttps://apps.fundamerica.com/api/disbursements/:id (GET)\nhttps://apps.fundamerica.com/api/disbursements/:id (PATCH)\nhttps://apps.fundamerica.com/api/disbursements/:id (DELETE)\nhttps://apps.fundamerica.com/api/distributions (GET)\nhttps://apps.fundamerica.com/api/distributions (POST)\nhttps://apps.fundamerica.com/api/distributions/:id (GET)\nhttps://apps.fundamerica.com/api/distributions/:id (PATCH)\nhttps://apps.fundamerica.com/api/distributions/:id (DELETE)\nhttps://apps.fundamerica.com/api/distributions/:id/non_investor_payments (GET)\nhttps://apps.fundamerica.com/api/offerings/:id/disbursements (GET)\nhttps://apps.fundamerica.com/api/electronic_signatures/:id (GET)\nhttps://apps.fundamerica.com/api/electronic_signatures/:id (PATCH)\nhttps://apps.fundamerica.com/api/entities (GET)\nhttps://apps.fundamerica.com/api/entities (POST)\nhttps://apps.fundamerica.com/api/entities/:id (GET)\nhttps://apps.fundamerica.com/api/entities/:id (PATCH)\nhttps://apps.fundamerica.com/api/entities/:id (DELETE)\nhttps://apps.fundamerica.com/api/entities/:id/bank_transfer_methods (GET)\nhttps://apps.fundamerica.com/api/entities/:entity_id/ach_authorizations (GET)\nhttps://apps.fundamerica.com/api/entities/:id/cash_blotter (GET)\nhttps://apps.fundamerica.com/api/entities/:id/entity_documents (GET)\nhttps://apps.fundamerica.com/api/entities/:id/investor_payment_method (GET)\nhttps://apps.fundamerica.com/api/entities/:id/investor_suitability (GET)\nhttps://apps.fundamerica.com/api/entities/:id/investor_suitability (PATCH)\nhttps://apps.fundamerica.com/api/entity_documents/:id (GET)\nhttps://apps.fundamerica.com/api/entity_documents (POST)\nhttps://apps.fundamerica.com/api/entity_relationships (GET)\nhttps://apps.fundamerica.com/api/entity_relationships (POST)\nhttps://apps.fundamerica.com/api/entity_relationships/:id (GET)\nhttps://apps.fundamerica.com/api/entity_relationships/:id (PATCH)\nhttps://apps.fundamerica.com/api/entity_relationships/:id (DELETE)\nhttps://apps.fundamerica.com/api/escrow_agreements (GET)\nhttps://apps.fundamerica.com/api/escrow_agreements (POST)\nhttps://apps.fundamerica.com/api/escrow_agreements/:id (GET)\nhttps://apps.fundamerica.com/api/escrow_service_applications (GET)\nhttps://apps.fundamerica.com/api/escrow_service_applications (POST)\nhttps://apps.fundamerica.com/api/escrow_service_applications/:id (GET)\nhttps://apps.fundamerica.com/api/holdings (GET)\nhttps://apps.fundamerica.com/api/holdings (POST)\nhttps://apps.fundamerica.com/api/holdings/:id (GET)\nhttps://apps.fundamerica.com/api/holdings/:id (PATCH)\nhttps://apps.fundamerica.com/api/investors/:id/holdings (GET)\nhttps://apps.fundamerica.com/api/securities/:id/holdings (GET)\nhttps://apps.fundamerica.com/api/entities/:id/holdings (GET)\nhttps://apps.fundamerica.com/api/investment_payments (GET)\nhttps://apps.fundamerica.com/api/investment_payments/:id (GET)\nhttps://apps.fundamerica.com/api/investments (GET)\nhttps://apps.fundamerica.com/api/investments (POST)\nhttps://apps.fundamerica.com/api/investments/:id (GET)\nhttps://apps.fundamerica.com/api/investments/:id (PATCH)\nhttps://apps.fundamerica.com/api/investments/:id (DELETE)\nhttps://apps.fundamerica.com/api/investments/:id/billing_transactions (GET)\nhttps://apps.fundamerica.com/api/investments/:id/investment_payments (GET)\nhttps://apps.fundamerica.com/api/investments/:id/investor_payments (GET)\nhttps://apps.fundamerica.com/api/investor_payment_methods/:id (GET)\nhttps://apps.fundamerica.com/api/investor_payment_methods/:id (PATCH)\nhttps://apps.fundamerica.com/api/investor_payment_methods/:id (DELETE)\nhttps://apps.fundamerica.com/api/investor_payment_methods (POST)\nhttps://apps.fundamerica.com/api/investors (GET)\nhttps://apps.fundamerica.com/api/investors (POST)\nhttps://apps.fundamerica.com/api/investors/:id (GET)\nhttps://apps.fundamerica.com/api/investors/:id (PATCH)\nhttps://apps.fundamerica.com/api/investor_suitbility_tokens (POST)\nhttps://apps.fundamerica.com/api/ledger_entries/:id (GET)\nhttps://apps.fundamerica.com/api/non_investor_payments (GET)\nhttps://apps.fundamerica.com/api/non_investor_payments (POST)\nhttps://apps.fundamerica.com/api/non_investor_payments/:id (GET)\nhttps://apps.fundamerica.com/api/non_investor_payments/:id (PATCH)\nhttps://apps.fundamerica.com/api/non_investor_payments/:id (DELETE)\nhttps://apps.fundamerica.com/api/offerings (GET)\nhttps://apps.fundamerica.com/api/offerings (POST)\nhttps://apps.fundamerica.com/api/offerings/:id (GET)\nhttps://apps.fundamerica.com/api/offerings/:id (PATCH)\nhttps://apps.fundamerica.com/api/offerings/:id (DELETE)\nhttps://apps.fundamerica.com/api/offerings/:id/billing_transactions (GET)\nhttps://apps.fundamerica.com/api/offerings/:id/escrow_ledger (GET)\nhttps://apps.fundamerica.com/api/offerings/:id/investment_payments (GET)\nhttps://apps.fundamerica.com/api/offerings/:id/subscription_agreement_template (GET)\nhttps://apps.fundamerica.com/api/securities (GET)\nhttps://apps.fundamerica.com/api/securities (POST)\nhttps://apps.fundamerica.com/api/securities/:id (GET)\nhttps://apps.fundamerica.com/api/securities/:id (PATCH)\nhttps://apps.fundamerica.com/api/selling_agreements (POST)\nhttps://apps.fundamerica.com/api/selling_agreements/:id (GET)\nhttps://apps.fundamerica.com/api/subscription_agreement_templates (GET)\nhttps://apps.fundamerica.com/api/subscription_agreement_templates (POST)\nhttps://apps.fundamerica.com/api/subscription_agreement_templates/:id (GET)\nhttps://apps.fundamerica.com/api/subscription_agreement_templates/:id (PATCH)\nhttps://apps.fundamerica.com/api/subscription_agreement_templates/:id (DELETE)\nhttps://apps.fundamerica.com/api/subscription_agreement_templates/boilerplate_html (GET)\nhttps://apps.fundamerica.com/api/subscription_agreement (GET)\nhttps://apps.fundamerica.com/api/subscription_agreement (POST)\nhttps://apps.fundamerica.com/api/subscription_agreement/:id (GET)\nhttps://apps.fundamerica.com/api/trade_reviews (GET)\nhttps://apps.fundamerica.com/api/trade_reviews/:id (GET)\nhttps://apps.fundamerica.com/api/webhook_logs (GET)\nhttps://apps.fundamerica.com/api/webhook_logs/:id (GET)\nTest mode calls allow objects created on the sandbox to have their state changed the same way customer service would in production. Additionally, the \"clear_data\" call will initate wiping out all data for an account. These calls are currently undocumented here, but the error messages document their usage entirely.
\nhttps://sandbox.fundamerica.com/api/test_mode/clear_data (POST)\nhttps://sandbox.fundamerica.com/api/test_mode/cancel_offering_requests/:id (PATCH)\nhttps://sandbox.fundamerica.com/api/test_mode/close_offering_requests/:id (PATCH)\nhttps://apps.fundamerica.com/api/test_mode/disbursements/:id (PATCH)\nhttps://apps.fundamerica.com/api/test_mode/distributions/:id (PATCH)\nhttps://sandbox.fundamerica.com/api/test_mode/entities/:id (PATCH)\nhttps://sandbox.fundamerica.com/api/test_mode/escrow_service_applications/:id (PATCH)\nhttps://sandbox.fundamerica.com/api/test_mode/investments/:id (PATCH)\nhttps://sandbox.fundamerica.com/api/test_mode/offerings/:id (PATCH)\nhttps://sandbox.fundamerica.com/api/test_mode/trade_reviews/:id (PATCH)\nIf you want to create an offering an immediately begin testing investments, here are are a list of steps to do it:
\nreceived using the test_mode.It's as simple as that! You can make as many investments as you want and eventually you can close or cancel the offering and review the changes.
\ncurl https://sandbox.fundamerica.com/api/offerings \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-d amount=\"5000000\" \\\n-d description=\"A really big deal.\" \\\n-d max_amount=\"5500000\" \\\n-d min_amount=\"4500000\" \\\n-d name=\"Big Deal\" \\\n-d entity[city]='New York' \\\n-d entity[country]='US' \\\n-d entity[email]='john.johnson@johnson.com' \\\n-d entity[contact_name]='John Johnson' \\\n-d entity[name]='Johnson, Johnson, Johnson and Johnson' \\\n-d entity[phone]='12025551212' \\\n-d entity[postal_code]='10005' \\\n-d entity[region]='NY' \\\n-d entity[region_formed_in]='NY' \\\n-d entity[street_address_1]='60 Wall St.' \\\n-d entity[tax_id_number]='999999999' \\\n-d entity[type]='company'\ncurl https://sandbox.fundamerica.com/api/test_mode/offerings/3E2NEf0nS4OtRrRWM4JngA \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-X PATCH \\\n-d accept_investments=\"true\"\ncurl https://sandbox.fundamerica.com/api/investments \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-d amount=\"5000\" \\\n-d entity[city]='Las Vegas' \\\n-d entity[country]='US' \\\n-d entity[date_of_birth]='1980-01-01' \\\n-d entity[email]='john.investor@example.com' \\\n-d entity[name]='John Q Investor' \\\n-d entity[phone]='17025551212' \\\n-d entity[postal_code]='89123' \\\n-d entity[region]='NV' \\\n-d entity[street_address_1]='555 Some St' \\\n-d entity[tax_id_number]='000000000' \\\n-d equity_share_count=\"10\" \\\n-d offering_id=\"3E2NEf0nS4OtRrRWM4JngA\" \\\n-d payment_method=\"wire\"\nreceived:curl https://sandbox.fundamerica.com/api/test_mode/investments/LckF85F4R8Soe3Why-NZzw \\\n-u XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: \\\n-X PATCH \\\n-d status=\"received\"\nWith the release of Invest Now 2.0, we've improved compatability with dynamic frameworks, such as AngularJS. We've also removed the URL manipulation that was used for knowing what current \"step\" the modal is on. This should help prevent any conflicts that may arise if your website was also using AngularJS or even TurboLinks for Ruby on Rails.
\n","event":[{"listen":"prerequest","script":{"id":"3a6cec7d-ee39-4db6-97fe-2d1ac226c891","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c9fbb395-f375-4529-9484-caf81ac765a9","type":"text/javascript","exec":[""]}}],"_postman_id":"7a19497f-9630-4731-9b46-87e6c85f82de"},{"name":"Styles","item":[],"id":"333374ed-fbd5-4bea-a02d-64b08449676a","description":"While most of the underlying markup and styling for Invest Now has not changed with the release of 2.0, there is one ID that has been removed from the modal. Previously the modal was wrapped in a div with an ID of \"inModal\". Any custom CSS you have will need to be changed from that to read #fa-invest-now-modal.
You can now set a referrer for the investment in one of two ways. You can either set data-fa-invest-now-referrer as an attribute on the button or as a query string in the browser url with ?_fa_referrer=your_referrer.
So using the first option, your button would look like:
\n<input type=\"button\" class=\"btn btn-lg \" value=\"INVEST NOW!\" data-fa-invest-now=\"xxx:xxx\" data-fa-invest-now-referrer=\"your_referrer\" />\nIf you're using the AngularJS framework then you'll need to do a little extra work to make Invest Now work on your website. You'll need to manually bootstrap your application -after- the point where you've included our Invest Now script tag. You'll generally want to include this just before the closing </body> tag of your page.
<script src=\"http://apps.fundamerica.com/cors/js/invest_now.min.js\" id=\"fa-invest-now-launcher\"></script>\n\n<script>\n angular.element(document).ready(function() {\n angular.bootstrap(document.body, ['your-application-name']);\n });\n</script>\nIn the case of using a dynamic website that uses AJAX to load pages without doing a full page reload, you may need to create and dispatch the fa.investnow.bindButtons event in cases where the Invest Now script is already loaded but you dynamically load your Invest Now button on to the page later.
You can read more and see example markup at the bottom of the page.
\n","event":[{"listen":"prerequest","script":{"id":"bee75b80-5f7e-4b4b-8f66-c83d198712b9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"600d006d-8d33-4f61-b1da-cf01097ffbd4","type":"text/javascript","exec":[""]}}],"_postman_id":"82c3f97e-4e12-4186-b4af-3b7959b3d919"},{"name":"Additional Webhook Functionality","item":[],"id":"feeb7599-d0e7-42c7-8e26-a94819c08eb9","description":"The standard functionality of webhooks is to fire when certain objects are updated. The idea behind this being that when building an investment platform, the originating system is creating a new investor or investment therefore doesn't need a webhook telling the system a new object has been created. With Invest Now, because it creates a number of objects without using any host system, it makes sense to inform the host system that new objects have been created for the sake of syncing data.
\nWebhooks can be configured so that investments and entities will fire both when being created and updated. This can be done by going to API Docs & Key and setting Send on Create? to true.
Note: There is no reason to set webhooks to fire on create unless using Invest Now. Save all of our servers the unnecessary traffic and don't enable this feature if you don't need it.
\n","event":[{"listen":"prerequest","script":{"id":"7ae2d6bd-2303-4508-aa47-287ab2dad14c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"94225e00-90ee-40ad-a182-cd41e5844b34","type":"text/javascript","exec":[""]}}],"_postman_id":"feeb7599-d0e7-42c7-8e26-a94819c08eb9"},{"name":"Arbitary Investment Data","item":[],"id":"79dd9fec-bdf0-496a-a62a-761646eda677","description":"A common use case when creating an investment is needing to track who the investment information (both the investment itself and the associatied investor) should be associated with on your system in the event you have your own authentication system. Investments have a data attribute which is just a collection of JSON data. By default, the URL where the investment is made is collected, however, any valid JSON data can be injected into this field.
This means that when a webhook fires informing your system that a new investment has been made, you can read back the data in data to determine who the investment should be associated with.
The simplest way to accomplish this is to attach an data-fa-invest-now-data attribute to your Invest Now button and set the value to valid JSON, like so:
<input type=\"button\" class=\"btn btn-lg \" value=\"INVEST NOW!\" data-fa-invest-now=\"xxx:xxx\" data-fa-invest-now-data='{\"name\":\"John Johnson\",\"id\":\"123ACB\",\"ref\":\"Some Place\"}' />\nThis data will be carried through the Invest Now investment process and sent to the Investment API when the client completes the process. It can be retrieved by using the Investment API. Any JSON included in the attribute will appear in the client_data key of the data object on the investment like so:
{\n \"object\":\"investment\",\n \"id\":\"TdgCeoPCTruVp-D7zpIBpQ\",\n \"data\":{\n \"client_data\":{\n \"name\":\"John Johnson\",\n \"id\":\"123ACB\",\n \"ref\":\"Some Place\"\n },\n \"url\":\"http://www.example.com/invest_now/#/step-1\"\n }\n}\nAdditionally, this can be populated using the fa.investnow.update custom event listener.
The investment process provides four custom events that fire at various points during the investment process:
\nfa.investnow.open will fire when a user clicks on the Invest Now button to open the modal/popup.
fa.investnow.ready fires after the Invest Now script has loaded. If you want to assign some data before the modal has even been opened, this is what you would use.
fa.investnow.close fires whenever the investment modal is closed. There is currently no extra data being passed back on this event.
fa.investnow.success fires when the final step completes and an investment is created. This event will return a field named investment_id containing the ID of the investment object which can be used with the Investment API. Here's an example of capturing a new investment's ID:
document.addEventListener('fa.investnow.success', function(e){\n var InvestorInvestmentID = e.investment_id;\n});\nIn addition to firing events, the Invest Now process also listens for events. These can be used to send data to the investment process.
\nTriggering fa.investnow.update along with valid JSON can be used to populate Arbitrary Investment Data.
First, create the event:
\nvar updateEvent = document.createEvent('Event');\nupdateEvent.initEvent('fa.investnow.update', true, false);\nupdateEvent.detail = {\n \"name\": \"John Johnson\",\n \"id\" : \"123ACB\",\n \"ref\" : \"Some Place\"\n};\nThen dispatch it:
\ndocument.body.dispatchEvent(updateEvent);\nThis gives you more control over what data you'd like to send in to the Invest Now process, and when, over using data-fa-invest-now-data.
Triggering fa.investnow.clearData will clear any data set by update (i.e. client_data is set to null).
Triggering fa.investnow.getData will return the current value of client_data.
There are many instances where your system may have some or all of the investor data as a matter of a sign up or registration process. You may wish to autofill the investor fields with this data to prevent your investor for having to re-enter this data every time. A common use case is to store all data except the investor's TIN and then populate the form, having the investor simply confirm their TIN.
\nThis is made possible by triggering the fa.investnow.autofill event in much the same way fa.investnow.update can be triggered. For example:
var autofillEvent = document.createEvent('Event');\nautofillEvent.initEvent('fa.investnow.autofill', true, false);\nautofillEvent.investor = {\n \"type\": 'company',\n \"name\": 'Johnson, Johnson, Johnson & Johnson',\n \"tax_id_number\": '999999999',\n \"street_address_1\": '800 Third Avenue',\n \"street_address_2\": '22nd Floor',\n \"city\": 'New York',\n \"region\": 'NY',\n \"postal_code\": '10022',\n \"email\": 'john@johnson.com',\n \"phone\": '202.582.9600',\n \"contact_name\": 'John Johnson',\n \"region_formed_in\": 'NY',\n \"amount\": '10000',\n \"payment_method\": 'ach',\n \"financial_adviser_name\": 'Jimmy Johnson'\n };\nautofillEvent.associated_person = {\n \"name\": 'John Johnson',\n \"tax_id_number\": '0000000000',\n \"date_of_birth\": '01/01/1980',\n \"street_address_1\": '800 Third Avenue',\n \"street_address_2\": '22nd Floor',\n \"city\": 'New York',\n \"region\": 'NY',\n \"postal_code\": '10022',\n \"email\": 'john@johnson.com',\n \"phone\": '202.582.9600'\n};\nThen dispatch the fa.investnow.autofill event when the Invest Now script is ready:
document.addEventListener('fa.investnow.ready', function(e){\n document.body.dispatchEvent(autofillEvent);\n});\nor when the modal is opened:
\ndocument.addEventListener('fa.investnow.open', function(e){\n document.body.dispatchEvent(autofillEvent);\n});\nMost of the fields should look familiar if you've looked at the Investments and Investor Entities APIs.
\nThe investor attribute can take all fields that an entity would take. Additionally, it takes a few fields from investments:
amountfinancial_adviser_namepayment_methodRemember, the attributes differ slightly between a person and entites with a different type.
The associated_person attribute is required when the investor's type is company or custodial. Like investor it takes the same entity attributes with the exception of type. The associated person will always be a person.
Finally, joint accounts are also supported as in this example:
\nvar autofillEvent = document.createEvent('Event');\nautofillEvent.initEvent('fa.investnow.autofill', true, false);\nautofillEvent.investor = {\n \"type\": 'person',\n \"name\": 'John Johnson',\n \"tax_id_number\": '0000000000',\n \"date_of_birth\": '01/01/1980',\n \"street_address_1\": '800 Third Avenue',\n \"street_address_2\": '22nd Floor',\n \"city\": 'New York',\n \"region\": 'NY',\n \"postal_code\": '10022',\n \"email\": 'john@johnson.com',\n \"phone\": '202.582.9600'\n \"amount\": '10000',\n \"payment_method\": 'ach',\n \"financial_adviser_name\": 'Jimmy Johnson',\n \"joint_account\": 'true',\n \"joint_type\": 'jtwros',\n \"other_entities\": [\n {\n \"name\": 'Jane Johnson',\n \"tax_id_number\": '111111111',\n \"date_of_birth\": '02/01/1980',\n \"street_address_1\": '800 Third Avenue',\n \"street_address_2\": '22nd Floor',\n \"city\": 'New York',\n \"region\": 'NY',\n \"postal_code\": '10022',\n \"email\": 'jane@johnson.com',\n \"phone\": '202.582.9600'\n }\n ]\n };\nJoint accounts can only consist of people.
\njoint_account: This must be set to true if using a joint account.\njoint_type: This accepts either jtwros or jtic. Consult your lawyer for details.\nother_entities is an array of additional people that are part of the joint account. In general, this is either a married couple or a parent and child, but it is not limited to two people.
Note: This event does nothing once the investor has entered data on their own.
\n","event":[{"listen":"prerequest","script":{"id":"d20b13bb-fcd2-42ed-a899-4b973b334030","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5d89ce96-d544-4484-9dd6-c69cc9359146","type":"text/javascript","exec":[""]}}],"_postman_id":"fc2c8ae7-bdc4-47ce-8936-c4072744b39d"},{"name":"Clearing Investor Data","item":[],"id":"7bbf6afa-5d56-4952-ae04-db1fdef202ff","description":"In some cases you may wish to clear the data an investor has entered before they have completed an investment. So long as they're on a page with our Invest Now script loaded and at the very least the fa.investnow.ready event has occurred, then the fa.investnow.clear event listener will be prepared to clear their data and send the form back to step 1.
Here's an example of how to create your fa.investnow.clear event and then trigger a clear when the Invest Now script is ready:
var clearEvent = document.createEvent('Event');\nclearEvent.initEvent('fa.investnow.clear', true, false);\n\ndocument.addEventListener('fa.investnow.ready', function(e){\n document.body.dispatchEvent(clearEvent);\n});\nNote: It's important to keep in mind when you might attempt to clear an investor's data because Invest Now is designed to allow someone to begin filling out the forms, but stop halfway through, and return later.
\n","event":[{"listen":"prerequest","script":{"id":"8079096d-5a3a-4408-8b06-7250f63092ad","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9ba22fc4-55e4-4979-b963-863e9aaf3c31","type":"text/javascript","exec":[""]}}],"_postman_id":"7bbf6afa-5d56-4952-ae04-db1fdef202ff"},{"name":"Binding Buttons","item":[],"id":"f46054a9-92f1-473b-86e8-3bbd73a74ec7","description":"If you dynamically loaded a button on to the page when the Invest Now script is already loaded, you can create and dispatch the fa.investnow.bindButtons event to bind these buttons to open the Invest Now modal.
var bindButtonsEvent = document.createEvent('Event');\nbindButtonsEvent.initEvent('fa.investnow.clear', true, false);\n\n// Then dispatch this event from some kind\n// of callback after your content is loaded\ndocument.body.dispatchEvent(bindButtonsEvent);\nNote: If you also dynamically load the Invest Now script, then triggering fa.investnow.bindButtons will not be needed.
Sometimes you may have investors that return later that want to invest in the same (or even a different!) offering. We have two methods/events available in Invest Now that allows you to supply existing IDs (investor_id or ach_authorization_id) which will then prepopulate and/or skip certain steps in the invesmest process.
If you have recurring investors, you can help expedite the process some by supplying an existing investor_id to Invest Now using the fa.investnow.setInvestors event. When an investor goes to invest, you can supply their investor_id during the fa.investnow.ready or fa.investnow.open events and they'll be given an option to select who they want to invest as.
Here's an example of how you'd go about doing this:
\nvar setInvestors = document.createEvent('Event');\nsetInvestors.initEvent('fa.investnow.setInvestors', true, false);\n// You can supply multiple investor IDs using a comma separated string, these two are just example IDs\nsetInvestors.ids = 'XoZjVGvbS46QAgbGFHc9iA, CAg7VuK0RuOOp6LBS2IKMA';\n\ndocument.addEventListener('fa.investnow.open', function(e){\n document.body.dispatchEvent(setInvestors);\n});\nThen when the modal has opened, the first selection they get is to invest as that investor (It'll display the name they used and type of investor) or as a new investor.
\n I am investing as:\n\n ◯ John Johnson (Individual)\n ◯ Johnson Family Trust (Trust)\nAlso available is supplying an ach_authorization_id during the fa.investnow.ready or fa.investnow.open events using fa.investnow.setAchAuthorizations. This will allow the investor to use an existing ACH method on file. If your offering allows ACH payments and the ACH option is selected, they will be giving the option to either use that existing payment method or use a different one.
Here's an example of creating and dispatching the event:
\nvar setAchAuthorizations = document.createEvent('Event');\nsetAchAuthorizations.initEvent('fa.investnow.setAchAuthorizations', true, false);\n// You can supply multiple ach authorization IDs using a comma separated string if they have multiple payment methods on file\nsetAchAuthorizations.ids = 'WHSb4Ef3TA2QhkKsibapqg';\n\ndocument.addEventListener('fa.investnow.open', function(e){\n document.body.dispatchEvent(setAchAuthorizations);\n});\nand a rough mockup of how the new field will appear when ACH is selected as the payment method:
\n Fund this investment using the following ACH account:\n\n ◯ John Johnson (********8787)\n ◯ Use a different method.\nWe've recently added new documentation about a feature that was secretly in testing for a while. You can supply investor_ids or ach_authorization_ids in special events now, that will will existing information to use the exact same information that was used on a previous investment. You can read more at Repeat Investors.
\nMost of the functionality below has been added at the request of developers. We're constantly looking to make integration more flexible and better adaptable to your platforms. If you're considering developing your own investment process because Invest Now doesn't quite work the way you need it to, before getting out your flow charts and plan a sprint or two, contact our development team at tech-support@fundamerica.comand request a feature.
\nWhile the primary goal of the Invest Now investment process is to provide an easy way for issuers with little to no technical expertise to get their offering accepting investments via the web as quickly as possible, it's also become quite popular with developers for other reasons.
\nThe first thing to understand about Invest Now is that the process makes use of FundAmerica's APIs with only minor modifications. What this means is that all the objects involved such as Offerings, Investments and Investor Entities are just like anything you'd be using if building your own system. They're also completely accessible via the API.
\nThis gives developers the option to either use Invest Now as a stepping stone to hurry development while they build a custom integration or forego building their own investment process entirely.
\n","event":[{"listen":"prerequest","script":{"id":"7a6dd5e5-52e3-400d-94bc-51ae43bdfe17","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"66d33bbb-0942-4340-8660-a32ba82f0f26","type":"text/javascript","exec":[""]}}],"_postman_id":"15a5ee20-a896-4b00-94e8-5a7488c52cd6"}],"event":[{"listen":"prerequest","script":{"id":"7e5c2c39-1235-4524-8a48-363f773417ea","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d5c587ba-c896-4256-9554-9bd5f9c1b442","type":"text/javascript","exec":[""]}}]}