{"info":{"_postman_id":"c277a929-9f95-1efa-8980-e268e6f61cb3","name":"Crowd Valley API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Authenticate","item":[{"name":"authenticate","id":"ecfd259c-725f-82f6-a4cb-2899d859bc9a","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/authenticate","description":"Log in as a named User in your network."},"response":[],"_postman_id":"ecfd259c-725f-82f6-a4cb-2899d859bc9a"}],"id":"eee65566-6687-6832-9070-d643e1d5eeae","_postman_id":"eee65566-6687-6832-9070-d643e1d5eeae"},{"name":"Capitalizations","item":[{"name":"capitalizations/{capitalization_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"capitalization_id\", \"10\");"]}}],"id":"31a1c370-e40b-8b31-0973-33ef4348fe50","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/capitalizations/{{capitalization_id}}","description":"Retrieve information about a given Capitalization by specifying the Capitalization's id in the capitalization_id path parameter.\n\n"},"response":[],"_postman_id":"31a1c370-e40b-8b31-0973-33ef4348fe50"},{"name":"capitalizations/{capitalization_id}/changelog","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"capitalization_id\", \"10\");"]}}],"id":"925d9a43-dc61-0161-3548-a61a84522605","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/capitalizations/{{capitalization_id}}/changelog","description":"Retrieve a full audit log of every change made to a given Capitalization by specifying the Capitalization's id in the capitalization_id path parameter."},"response":[],"_postman_id":"925d9a43-dc61-0161-3548-a61a84522605"},{"name":"capitalizations/{capitalization_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"capitalization_id\", \"10\");"]}}],"id":"a631e9d4-4178-918f-816b-a7005b695b6c","request":{"method":"PATCH","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"price_per_share\": \"1.10\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/capitalizations/{{capitalization_id}}","description":"Update a Capitalization.\n\nAll changes to any Capitalization are logged and visible through the Back Office application."},"response":[],"_postman_id":"a631e9d4-4178-918f-816b-a7005b695b6c"}],"id":"2dd1de8e-17ac-2e1f-c351-fc190d3bf5d7","description":"View a Capitalization \nView a Capitalization's Change Log \nUpdate a Capitalization \n","_postman_id":"2dd1de8e-17ac-2e1f-c351-fc190d3bf5d7"},{"name":"Deal Rooms","item":[{"name":"dealrooms/{dealroom_id}/topics","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"dealroom_id\", \"100\");"]}}],"id":"3553b8e2-a79f-0c2a-e984-5b3ae449a03f","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/dealrooms/{{dealroom_id}}/topics","description":"Retrieve a list of forum Topics for the given Deal Room, as specified by the path parameter dealroom_id.\n\nA Deal Room can have multiple Topics and the Topic acts as a category or group of users' Posts in a forum. Topics are always attached to a particular Deal Room, which in turn is associated with a single Offering."},"response":[],"_postman_id":"3553b8e2-a79f-0c2a-e984-5b3ae449a03f"},{"name":"dealrooms/{dealroom_id}/topics","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"dealroom_id\", \"100\");"]}}],"id":"1678d1b9-b138-4b70-aee1-b9e5a8689f61","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"title\" : \"The title of the Topic\",\n    \"body\" : \"The content of the Topic\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/dealrooms/{{dealroom_id}}/topics","description":"Create a new Topic for a given Deal Room by specifying the Deal Room's id in the dealroom_id path parameter.\n\nImplement this function to create a new category or group of users' Posts in a forum. Topics are always attached to a particular Deal Room, which in turn is associated with a single Offering."},"response":[],"_postman_id":"1678d1b9-b138-4b70-aee1-b9e5a8689f61"}],"id":"ada9a589-8a12-1d22-fe45-8fb3f8b37e0b","description":"Retrieve a list of forum Topics for the given Deal Room, as specified by the path parameter dealroom_id.\n\nA Deal Room can have multiple Topics and the Topic acts as a category or group of users' Posts in a forum. Topics are always attached to a particular Deal Room, which in turn is associated with a single Offering.","_postman_id":"ada9a589-8a12-1d22-fe45-8fb3f8b37e0b"},{"name":"Documents","item":[{"name":"documents/{document_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"document_id\", \"1000\");"]}}],"id":"ba27f83d-095b-d95d-6051-c5f88f1f91cd","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/documents/{{document_id}}","description":"View a Document"},"response":[],"_postman_id":"ba27f83d-095b-d95d-6051-c5f88f1f91cd"},{"name":"documents/{document_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"document_id\", \"1000\");"]}}],"id":"b2b4f0e8-b6ef-c74a-cdf7-44c0e38c8a49","request":{"method":"DELETE","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/documents/{{document_id}}","description":"Delete a Document.\n\nThe Document is made inactive and unavailable through the platform. However, documents are kept in the Crowd Valley back-end for audit trail purposes.\n\n"},"response":[],"_postman_id":"b2b4f0e8-b6ef-c74a-cdf7-44c0e38c8a49"}],"id":"e694a8ed-7ce1-622d-0a32-9febfeeb8459","description":"View a Document\nDelete a Document\n","_postman_id":"e694a8ed-7ce1-622d-0a32-9febfeeb8459"},{"name":"Investments","item":[{"name":"investments/{investment_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"payout_id\", \"100\");"]}}],"id":"a29143e3-d718-e35e-41e3-ec25b98d7489","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/payouts/{{payout_id}}","description":"Retrieve information about an Investment.\n\nAccess to this information is determined by the logged-in User's rights to know about the Investment.\n\nThe User who created the Investment can retrieve the Investment's data regardless of its life_cycle_stage.\n\nAdmin Users, i.e. Users who have is_admin set to true, can also see all Investments of any life_cycle_stage.\n\nUsers who are members of the Organization for whose Offering this Investment was made can see all Investments of any life_cycle_stage.\n\nOther Users are only able to retrieve Investments whose life_cycle_stage is Approved or Settled."},"response":[],"_postman_id":"a29143e3-d718-e35e-41e3-ec25b98d7489"},{"name":"investments/{investment_id}/documents","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"investment_id\", \"100\");"]}}],"id":"f346e57e-af3c-b0e3-ac2b-80a6db754b2a","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/investments/{{investment_id}}/documents","description":"Retrieve a list of Documents for the given Investment, as specified by the path parameter investment_id.\n\n"},"response":[],"_postman_id":"f346e57e-af3c-b0e3-ac2b-80a6db754b2a"},{"name":"investments/{investment_id}/documents","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"investment_id\", \"100\");"]}}],"id":"36883d0c-269a-49bb-1c80-f8a8cec2892f","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"file_name\": \"floorplan.png\",\n    \"url\": \"https://yourcdn.yourstoragefacility.com/floorplan.png\",\n    \"file_alias\": \"Floor Plan\",\n    \"file_description\": \"Floor Plan from architect's designs\",\n    \"file_type\": \"image/png\",\n    \"tag\": \"FLOOR_PLAN\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/investments/{{investment_id}}/documents","description":"Add a Document to the given Investment, as specified by the path parameter investment_id.\n\nThe logged-in User must be one of the following in order to have access to attach a Document to an Investment:\n\nThe User who made the Investment\nA member of the Organization for whose Offering this Investment was made\nAn Admin User"},"response":[],"_postman_id":"36883d0c-269a-49bb-1c80-f8a8cec2892f"},{"name":"investments/{investment_id}/payouts","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"investment_id\", \"100\");"]}}],"id":"cb10d7dc-f4f9-f19a-e4ae-5f33e4d5b600","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/investments/{{investment_id}}/payouts","description":"View a list of Payout Schedules for a given Investment, as specified by the path parameter investment_id.\n\n"},"response":[],"_postman_id":"cb10d7dc-f4f9-f19a-e4ae-5f33e4d5b600"},{"name":"investments/{investment_id}/payouts","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"investment_id\", \"100\");"]}}],"id":"67f01159-d1e1-a480-dab0-dd0234e13917","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"payout_amount\" : \"1000\",\n    \"payout_type\" : \"1\",\n    \"minimum_payment\" : \"1000\",\n    \"due_date\" : \"2016-07-20T09:38:55+0000\",\n    \"currency\" : \"GBP\",\n    \"additional_type\" : \"dividend\",\n    \"investment_id\" : \"102\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/investments/{{investment_id}}/payouts","description":"Add a Payout Schedule record to the given Investment, as specified by the path parameter investment_id.\n\n"},"response":[],"_postman_id":"67f01159-d1e1-a480-dab0-dd0234e13917"},{"name":"investments/{investment_id}/generatePaymentSchedule","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"investment_id\", \"100\");"]}}],"id":"1c7e79f1-47ee-8004-04b1-c9fab62a5d7b","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n\t{\n\t    \"payout_amount\" : \"1000\",\n\t    \"payout_type\" : \"1\",\n\t    \"due_date\" : \"2015-07-20T09:38:55+0000\",\n\t    \"currency\" : \"GBP\",\n\t    \"additional_type\" : \"type\"\n\t},\n\t{\n\t    \"payout_amount\" : \"2000\",\n\t    \"payout_type\" : \"1\",\n\t    \"due_date\" : \"2015-07-20T09:38:55+0000\",\n\t    \"currency\" : \"GBP\",\n\t    \"additional_type\" : \"type\"\n\t},\n\t{\n\t    \"payout_amount\" : \"3000\",\n\t    \"payout_type\" : \"1\",\n\t    \"due_date\" : \"2015-07-20T09:38:55+0000\",\n\t    \"currency\" : \"GBP\",\n\t    \"additional_type\" : \"type\"\n\t}\n]"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/investments/{{investment_id}}/payouts","description":"Add multiple Payout Schedule records to the given Investment, as specified by the path parameter investment_id.\n\nImplement this function if you want to create a whole repayment schedule for this User, typically on a P2P lending platform.\n\nThe parameters should be sent in an array, each one specifying the parameters for a given Payout.\n\nThe payout_id returned is the last Payout to be created. If you create Payouts 100-110 then this function will return payout_id : \"100\" in its response."},"response":[],"_postman_id":"1c7e79f1-47ee-8004-04b1-c9fab62a5d7b"}],"id":"3ce550e8-5811-b475-9954-07aa52e6c69b","description":"View an Investment\nView an Investment's Documents\nAdd a Document to an Investment\nView all Payout Schedules for an Investment\nCreate a Payout Schedule for an Investment\nCreate multiple Payout Schedule records for an Investment\n","_postman_id":"3ce550e8-5811-b475-9954-07aa52e6c69b"},{"name":"Offerings","item":[{"name":"offerings","id":"9373fe9b-a7a4-7018-82e3-02e25aa3500f","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings","description":"Retrieve a list of all Offerings.\n\nImplement this function to populate a live Offerings page and/or a historical/closed deals page.\n\nThe number of Offerings that are returned by this function will depend on the type of User who is logged in.\n\nAdmin Users, i.e. Users with is_admin set to true, will see all Offerings including those that are not visible to your end users, because they are not yet Published.\n\nNon-admin Users, i.e. all users created on your front-end by implementing POST /users, will only see Offerings whose life_cycle_stage is Published, Live, Closing or Settled.\n\nVIP Users, i.e. Users who have is_vip set to true, will also see Offerings whose life_cycle_stage is Restricted. So in total they will be able to see all Offerings whose life_cycle_stage is Restricted, Published, Live, Closing or Settled."},"response":[],"_postman_id":"9373fe9b-a7a4-7018-82e3-02e25aa3500f"},{"name":"offerings/{offering_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"5d2b00c6-0ebf-22b1-e846-ca8d7fc1fa0a","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}","description":"Retrieve information about a given Offering by specifying the Offering's id in the offering_id path parameter.\n\nImplement this function to retrieve data to be shown on an Offering's overview page. This is often one of the most important pages of a typical fintech application because it usually shows all the detail that an investor or lender would want to see before making a decision to invest.\n\nAccess to the data about this Offering follows the same rules as GET /offerings:\n\nAdmin Users will be able to retrieve data on any Offering in their network by specifying its id and calling this function.\nVIP Users will be able to retrieve data on any Offering whose life_cycle_stage is Restricted, Published, Live, Closing or Settled\nOther non-Admin and non-VIP Users will be able to retrieve data on any Offering whose life_cycle_stage is Published, Live, Closing or Settled but not Offerings that are Restricted\nNote that the Offering's amount_raised and raised_percent calculations are based on Investments in the Offering with life_cycle_stage of Approved or Settled. Investments with life_cycle_stage of Open will not count towards the Offering's total until they are approved. Investments with life_cycle_stage of Rejected or Withdrawn will never count towards the Offering's total amount_raised."},"response":[],"_postman_id":"5d2b00c6-0ebf-22b1-e846-ca8d7fc1fa0a"},{"name":"offerings/{offering_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"be9fe893-bd45-97af-7f6f-acaa44dc6e1c","request":{"method":"PATCH","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"credit_score\": \"A+\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}","description":"Update an Offering.\n\nAny parameter that is \"Editable\" in the Offering data model can be updated by implementing this method.\n"},"response":[],"_postman_id":"be9fe893-bd45-97af-7f6f-acaa44dc6e1c"},{"name":"offerings/{offering_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"bb34d5de-1e87-a963-ab4d-a5ac28c03aac","request":{"method":"DELETE","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}","description":"Cancel an Offering.\n\nThis updates the Offering's life_cycle_stage to Canceled"},"response":[],"_postman_id":"bb34d5de-1e87-a963-ab4d-a5ac28c03aac"},{"name":"offerings/{offering_id}/investments","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"a9b330bf-6f25-8264-124c-ecf700e700ea","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}/investments","description":"Retrieve a list of public Investments for a given Offering by specifying the Offering's id in the offering_id path parameter.\n\nImplement this function to show a list of Investments that have been made for this Offering. This is typically implemented on an Offering's overview page to show which other lenders or investors have committed to the Offering.\n\nUnless logged in as an Admin User, this function will only show Investments whose life_cycle_stage is Approved or Settled. It will not show Investments whose life_cycle_stage is Open, Rejected or Withdrawn."},"response":[],"_postman_id":"a9b330bf-6f25-8264-124c-ecf700e700ea"},{"name":"offerings/{offering_id}/investments","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"55219d11-8151-7dd9-fd09-47f366a54d7f","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"investment_amount\": \"10000\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}/investments","description":"Make a new Investment for a given Offering by specifying the Offering's id in the offering_id path parameter.\n\nImplement this function to allow Users to make an Investment in an Offering.\n\nInvestments do not have any required parameters. Creating an Investment without an investment_amount will set the new Investment's investment_amount attribute to its default value of 0. In some cases an investment_amount of 0 can be used to represent an 'expression of interest' in an Offering, which can then be updated at a later time by using PATCH /investments/{investment_id}.\n\nSpecify the optional parameter life_cycle_stage = 2 (Approved) in the request body for this function to approve the Investment automatically based on your required business logic. If you do not include the life_cycle_stage parameter then the new Investment's life_cycle_stage will start at its default value of 0 (Open).\n\nSuccessfully creating a new Investment is also subject to the Offering's investment rules, which are defined in the Offering itself. Each of these investment rules is optional: only implement them if they make sense to your platform's operations. Each investment rule is defined by the API Exception that is returned by this function.\n\nIf you do intend to implement investment rules such as these then ensure that you handle the relevant API Exception(s) so that you can expain to the User the reason that they were unable to make an Investment."},"response":[],"_postman_id":"55219d11-8151-7dd9-fd09-47f366a54d7f"},{"name":"offerings/{offering_id}/dealrooms","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"2094f4fa-257c-fa77-f5c6-6cee6d960fb6","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}/dealrooms","description":"Retrieve a list of Deal Rooms for the given Offering, as specified by the path parameter offering_id.\n\nAn Offering can have multiple Deal Rooms and the Deal Room acts as the access-controlled area of an Offering that includes discussion forums, due diligence tasks, and access-restricted documents."},"response":[],"_postman_id":"2094f4fa-257c-fa77-f5c6-6cee6d960fb6"},{"name":"offerings/{offering_id}/dealrooms","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"dd77c831-b67e-2a01-b810-fd8492118c41","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}/dealrooms","description":"Create a new Deal Room for a given Offering by specifying the Offering's id in the offering_id path parameter.\n\nImplement this function to create a new Deal Room, which acts as the access-controlled area of an Offering that includes discussion forums, due diligence tasks, and access-restricted documents.\n\nThis function does not require any body parameters."},"response":[],"_postman_id":"dd77c831-b67e-2a01-b810-fd8492118c41"},{"name":"offerings/{offering_id}/bulletins","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"e892a0d5-7b3a-9778-34b4-e19ebdf35b4a","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}/bulletins","description":"Retrieve a list of Bulletins for a given Offering by specifying the Offering's id in the offering_id path parameter.\n\nImplement this function to show a list of news items, blog posts or similar updates that are represented by the Bulletin object, which is always attached to an Offering. Typically this is used to show a timeline of activities that are related to an Offering during a live fundraising campaign or to show news and updates relating to a historical Offering, in which the logged-in User might have invested."},"response":[],"_postman_id":"e892a0d5-7b3a-9778-34b4-e19ebdf35b4a"},{"name":"offerings/{offering_id}/bulletins","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"46707ce8-e0c5-ab5f-d333-d92baa6a711a","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"title\" : \"News story\",\n    \"body\" : \"Great news about this Offering\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}/bulletins","description":"Create a new Bulletin for a given Offering by specifying the Offering's id in the offering_id path parameter.\n\nImplement this function to create a new news item, blog posts or similar updates that are represented by the Bulletin object, which is always attached to an Offering."},"response":[],"_postman_id":"46707ce8-e0c5-ab5f-d333-d92baa6a711a"},{"name":"offerings/{offering_id}/documents","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"5004150d-3389-d875-4cb5-5f1ebf192a59","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}/documents","description":"Retrieve a list of Documents for the given Offering, as specified by the path parameter offering_id.\n\n"},"response":[],"_postman_id":"5004150d-3389-d875-4cb5-5f1ebf192a59"},{"name":"offerings/{offering_id}/documents","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"organization_id\", \"100\");"]}}],"id":"aebd1f6f-3585-eb7c-4182-37fc7df65ec2","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"file_name\": \"floorplan.png\",\n    \"url\": \"https://yourcdn.yourstoragefacility.com/floorplan.png\",\n    \"file_alias\": \"Floor Plan\",\n    \"file_description\": \"Floor Plan from architect's designs\",\n    \"file_type\": \"image/png\",\n    \"tag\": \"FLOOR_PLAN\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}/documents","description":"Add a Document to the given Offering, as specified by the path parameter offering_id.\n\nWhen displaying Documents on an Offering overview page, you may choose to attach the Document to the Offering itself or to the Offering's Organization.\n\nTypically you would attach a Document to an Organization by calling this function if the Document applies equally to all of the Organization's Offerings. You might attach a Document to an Offering if it only applies to that particular Offering and not any others that may be created later, for instance, as part of a secondary market.\n\nAs an example, it makes sense to attach a Certificate of Incorporation document to the Organization because each Organization only has one such certificate and it is the same document no matter how many Offerings the Organization creates. Conversely, a Loan Agreement document might specify the terms and conditions for a particular loan, as represented by an Offering, and the terms will not necessarily be the same for the next Offering created for this Organization. In that case, it would make sense to attach the document to the Offering."},"response":[],"_postman_id":"aebd1f6f-3585-eb7c-4182-37fc7df65ec2"},{"name":"offerings/{offering_id}/payouts","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"c2e3f380-e2f5-ef23-1640-4d1f3f2ad9c2","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}/documents","description":"View a list of Payout Schedules for a given Offering, as specified by the path parameter offering_id. These schedules are attached directly to the Offering, so they are typically used to show a borrower's repayment schedule, as opposed to the Payouts that are attached to Investments, which typically record a lender's or investor's repayment schedule."},"response":[],"_postman_id":"c2e3f380-e2f5-ef23-1640-4d1f3f2ad9c2"},{"name":"offerings/{offering_id}/payouts","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"48fe7987-abb2-3101-3db5-83d9fb7dcecc","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"payout_amount\" : \"1000\",\n    \"payout_type\" : \"1\",\n    \"minimum_payment\" : \"1000\",\n    \"due_date\" : \"2016-07-20T09:38:55+0000\",\n    \"currency\" : \"GBP\",\n    \"additional_type\" : \"dividend\",\n    \"investment_id\" : \"102\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}/payouts","description":"Add a Payout Schedule record to the given Offering, as specified by the path parameter offering_id."},"response":[],"_postman_id":"48fe7987-abb2-3101-3db5-83d9fb7dcecc"},{"name":"offerings/{offering_id}/generatePaymentSchedule","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"100\");"]}}],"id":"1ff9f91c-60fb-0443-6853-adb0622584f1","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n\t{\n\t    \"payout_amount\" : \"1000\",\n\t    \"payout_type\" : \"1\",\n\t    \"due_date\" : \"2015-07-20T09:38:55+0000\",\n\t    \"currency\" : \"GBP\",\n\t    \"additional_type\" : \"type\"\n\t},\n\t{\n\t    \"payout_amount\" : \"2000\",\n\t    \"payout_type\" : \"1\",\n\t    \"due_date\" : \"2015-07-20T09:38:55+0000\",\n\t    \"currency\" : \"GBP\",\n\t    \"additional_type\" : \"type\"\n\t},\n\t{\n\t    \"payout_amount\" : \"3000\",\n\t    \"payout_type\" : \"1\",\n\t    \"due_date\" : \"2015-07-20T09:38:55+0000\",\n\t    \"currency\" : \"GBP\",\n\t    \"additional_type\" : \"type\"\n\t}\n]"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/offerings/{{offering_id}}/generatePaymentSchedule","description":"Add multiple Payout Schedule records to the given Offering, as specified by the path parameter offering_id.\n\nImplement this function if you want to create a whole repayment schedule for this User, typically on a P2P lending platform.\n\nThe parameters should be sent in an array, each one specifying the parameters for a given Payout.\n\nThe payout_id returned is the last Payout to be created. If you create Payouts 100-110 then this function will return payout_id : \"100\" in its response."},"response":[],"_postman_id":"1ff9f91c-60fb-0443-6853-adb0622584f1"}],"id":"140e18ee-51aa-5a3a-3ac1-d8ca2e2fb0aa","description":"View Offerings (logged in) \nView an Offering (logged in) \nUpdate an Offering\nCancel an Offering\nView all Investments for an Offering\nMake a new Investment for an Offering \nView all Deal Rooms for an Offering\nCreate a new Deal Room for an Offering\nCreate a new Bulletin for an Offering\nView an Offering's Bulletins\nView an Offering's Documents\nAdd a Document to an Offering\nView all Payout Schedules for an Offering\nCreate a Payout Schedule for an Offering\nCreate multiple Payout Schedule items for an Offering\n","_postman_id":"140e18ee-51aa-5a3a-3ac1-d8ca2e2fb0aa"},{"name":"Organizations","item":[{"name":"organizations","id":"2ceb722a-e7cf-e816-6e0d-4b61456de5ea","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/organizations","description":"Create a new Organization. This can be done through the Back Office application or directly through the API from your front-end platform.\n\nEvery Organization requires a User to be its contact_point and by default the User who is logged in when calling POST /organizations is set as the new Organization's contact_point.\n\nThe contact_point can then be adjusted by adding or removing other Users using the /organizations/{organizationID}/members/{userID} endpoint.\n\nThere are no required parameters for this function. You may optionally provide any editable Organization field as a parameter."},"response":[],"_postman_id":"2ceb722a-e7cf-e816-6e0d-4b61456de5ea"},{"name":"organizations","id":"8297839c-420f-8354-6198-6e3735391fed","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/organizations","description":"Retrieve a list of all Organizations in the network.\n\nImplement this to show a list of Organizations that are supporting various deals, or that are umbrella entities for various Users. This will only show Organizations that have visibility set to the default value of Open and life_cycle_stage as Approved or Published.\n\nSince Organizations can represent investors/lenders or fundraisers/borrowers or simply groups of Users, this function can be implemented on many different types of pages.\n\nIn some platforms, an Organization represents the entity that is raising capital on your platform, and so the list of all Organizations will show all such entities (which may be companies, properties, funds, projects, etc.) whether they are currently raising capital (i.e., they have a live Offering), they are not yet raising capital (i.e., they do not have an Offering), or they have completed the capital raising process (i.e., they have an Offering that is Settled).\n\nIn others, an Organization may also represent an Institutional Investor, which may have several individual Users as its representatives. In this case, the GET /organizations function will show a list of all Institutions that are approved to invest on your platform."},"response":[],"_postman_id":"8297839c-420f-8354-6198-6e3735391fed"},{"name":"organizations/{organization_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"organization_id\", \"100\");"]}}],"id":"cfa4f6eb-cd36-a016-d1cb-bed61585148c","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/organizations/{{organization_id}}","description":"Retrieve information about an Organization."},"response":[],"_postman_id":"cfa4f6eb-cd36-a016-d1cb-bed61585148c"},{"name":"organizations/{organization_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"organization_id\", \"100\");"]}}],"id":"857505a9-8d9f-263b-6eb3-deb8b9de46bc","request":{"method":"PATCH","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"brief_desc\" : \"New Brief Description\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/organizations/{{organization_id}}","description":"Update an Organization.\n\nAny parameter that is \"Editable\" in the Organization data model can be updated by implementing this method."},"response":[],"_postman_id":"857505a9-8d9f-263b-6eb3-deb8b9de46bc"},{"name":"organizations/{organization_id}/members/{user_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"organization_id\", \"100\");","postman.setGlobalVariable(\"user_id\", \"1098\");"]}}],"id":"73aa951a-c3b5-b8d3-3a34-73c4b6dc1426","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/organizations/{{organization_id}}/members/{{user_id}}","description":"Add a User to the team of an Organization.\n\nImplement this to add a given User, specified by the path parameter user_id, to the team of the Organization with id equal to the parameter organization_id.\n\nThis function is typically used when setting up an Offering in advance of it going live on your platform. As part of the Offering's overview page, you may wish to show some information about the team behind the Organization that is raising capital through this Offering. This can be implemented by creating custom Organization or custom Offering fields in the case that the team members are not part of your platform. Otherwise you can associate any User with the Organization by calling POST organizations/{organization_id}/members/{user_id}."},"response":[],"_postman_id":"73aa951a-c3b5-b8d3-3a34-73c4b6dc1426"},{"name":"organizations/{organization_id}/members/{user_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"organization_id\", \"100\");","postman.setGlobalVariable(\"user_id\", \"1098\");"]}}],"id":"ea49d92e-91c3-839a-7223-ce7bffca7466","request":{"method":"DELETE","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/organizations/{{organization_id}}/members/{{user_id}}","description":"Remove a User from the team of an Organization.\n\nImplement this to remove a given User, specified by the path parameter user_id, from the team of the Organization with id equal to the parameter organization_id."},"response":[],"_postman_id":"ea49d92e-91c3-839a-7223-ce7bffca7466"},{"name":"organizations/{organization_id}/capitalizations","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"organization_id\", \"100\");"]}}],"id":"20ee3fe8-7715-a683-adff-2a6ced191833","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/organizations/{{organization_id}}/capitalizations","description":"Retrieve a list of Capitalizations for the given Organization, as specified by the path parameter organization_id.\n\nThis function is typically implemented to show an Organization's cap table or shareholder registry."},"response":[],"_postman_id":"20ee3fe8-7715-a683-adff-2a6ced191833"},{"name":"organizations/{organization_id}/capitalizations","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"organization_id\", \"100\");"]}}],"id":"426f8832-5388-c46d-4c6d-e9fc3d29a9a4","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"number_of_shares\": \"100\",\n    \"price_per_share\": \"1\",\n    \"owner_id\" : \"1098\",\n    \"life_cycle_stage\" : \"1\",\n    \"capitalization_type\" : \"0\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/organizations/{{organization_id}}/capitalizations","description":"Create a new Capitalization for the Organization specified by the path parameter organization_id. This can be done through the Back Office application or directly through the API from your front-end platform.\n\nCreate Capitalizations in order to use the share registry features in the Back Office, which allow you to transfer shares from the Organization or individual Users to the investors in an Offering."},"response":[],"_postman_id":"426f8832-5388-c46d-4c6d-e9fc3d29a9a4"},{"name":"organizations/{organization_id}/offerings","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"organization_id\", \"100\");"]}}],"id":"9cf6ff52-d718-b158-e71b-15df5c1cf65e","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/organizations/{{organization_id}}/offerings","description":"Retrieve a list of Offerings for the given Organization, as specified by the path parameter organization_id.\n\nWhen logged in as a normal end User, this function will only return Offerings whose life_cycle_stage is Published, Live, Closing, or Settled.\n\nIf the logged-in User is a VIP User, i.e. the is_vip attribute is set to true, then calling this function will also return Offerings whose life_cycle_stage is Restricted.\n\nIf the logged-in User is an Admin User, i.e. the is_admin attribute is set to true, then this function returns all Offerings of any life_cycle_stage.\n\nThis function is typically implemented in secondary market features, which list secondary Offerings grouped by the original asset (Organization) that raised the capital, for example a fund or a property.\n\nIt may also be implemented on a page that shows an Organization's information, such as a borrower or equity fundraiser, to provide information about upcoming Offerings, currently live Offerings or historical Offerings."},"response":[],"_postman_id":"9cf6ff52-d718-b158-e71b-15df5c1cf65e"},{"name":"organizations/{organization_id}/offerings","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"organization_id\", \"100\");"]}}],"id":"f5965439-3c8e-a5c1-d595-9e2e0cecc4e6","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"funding_goal\" : \"50000\",\n\t\"is_secondary_offering\" : \"1\",\n\t\"primary_offering_id\" : \"1000\",\n\t\"num_of_shares\" : \"50000\",\n\t\"price_per_share\" : \"1\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/organizations/{{organization_id}}/offerings","description":"Create a new Offering for the Organization specified by the path parameter organization_id. This can be done through the Back Office application or directly through the API from your front-end platform."},"response":[],"_postman_id":"f5965439-3c8e-a5c1-d595-9e2e0cecc4e6"},{"name":"organizations/{organization_id}/documents","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"organization_id\", \"100\");"]}}],"id":"5ca11874-d1df-9a88-8f37-9991f0dfc99c","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/organizations/{{organization_id}}/documents","description":"Retrieve a list of Documents for the given Organization, as specified by the path parameter organization_id.\n"},"response":[],"_postman_id":"5ca11874-d1df-9a88-8f37-9991f0dfc99c"},{"name":"organizations/{organization_id}/documents","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"organization_id\", \"100\");"]}}],"id":"e04351cc-e5c0-b13a-ad96-6bdde7c754ce","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"file_name\": \"floorplan.png\",\n    \"url\": \"https://yourcdn.yourstoragefacility.com/floorplan.png\",\n    \"file_alias\": \"Floor Plan\",\n    \"file_description\": \"Floor Plan from architect's designs\",\n    \"file_type\": \"image/png\",\n    \"tag\": \"FLOOR_PLAN\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/organizations/{{organization_id}}/documents","description":"Add a Document to the given Organization, as specified by the path parameter organization_id.\n\nWhen displaying Documents on an Offering overview page, you may choose to attach the Document to the Offering itself or to the Offering's Organization.\n\nTypically you would attach a Document to an Organization by calling this function if the Document applies equally to all of the Organization's Offerings. You might attach a Document to an Offering if it only applies to that particular Offering and not any others that may be created later, for instance, as part of a secondary market.\n\nAs an example, it makes sense to attach a Certificate of Incorporation document to the Organization because each Organization only has one such certificate and it is the same document no matter how many Offerings the Organization creates. Conversely, a Loan Agreement document might specify the terms and conditions for a particular loan, as represented by an Offering, and the terms will not necessarily be the same for the next Offering created for this Organization. In that case, it would make sense to attach the document to the Offering."},"response":[],"_postman_id":"e04351cc-e5c0-b13a-ad96-6bdde7c754ce"}],"id":"ca595a58-416a-5dc1-601b-dbc73c979e05","description":"Create a new Organization\nView Organizations (logged in)\nView an Organization (logged in)\nUpdate an Organization\nAdd a User to an Organization\nRemove a User from an Organization\nView an Organization's Capitalizations \nCreate a new Capitalization \nView an Organization's Offerings\nCreate a new Offering\nView an Organization's Documents\nAdd a Document to an Organization\n","_postman_id":"ca595a58-416a-5dc1-601b-dbc73c979e05"},{"name":"Payouts","item":[{"name":"payouts/{payout_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"payout_id\", \"100\");"]}}],"id":"fb22646d-618a-c102-013b-a4e626b8127f","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/payouts/{{payout_id}}","description":"Information about this Payout Schedule record."},"response":[],"_postman_id":"fb22646d-618a-c102-013b-a4e626b8127f"},{"name":"payouts/{payout_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"payout_id\", \"100\");"]}}],"id":"5fab2262-5884-bdf2-0ec3-4540bbfd781d","request":{"method":"PATCH","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"minimum_payment\": \"1000\"  \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/payouts/{{payout_id}}","description":"Update this Payout Schedule record."},"response":[],"_postman_id":"5fab2262-5884-bdf2-0ec3-4540bbfd781d"},{"name":"payouts/{payout_id}/transactions","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"payout_id\", \"100\");"]}}],"id":"31515d50-a8e6-7258-51e8-6e237c7ef396","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/payouts/{{payout_id}}/transactions","description":"View a list of Transactions that have been associated to this Payout Schedule record.\n\n"},"response":[],"_postman_id":"31515d50-a8e6-7258-51e8-6e237c7ef396"}],"id":"0a8e8c7a-7361-3597-2775-c21e21d52bf8","_postman_id":"0a8e8c7a-7361-3597-2775-c21e21d52bf8"},{"name":"Posts","item":[{"name":"posts/{post_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"post_id\", \"100\");"]}}],"id":"85859869-e0c8-b545-0865-4b9b737dd8d7","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/posts/{{post_id}}","description":"View a given Post in a Deal Room by specifying the Post's id in the post_id path parameter.\n\n"},"response":[],"_postman_id":"85859869-e0c8-b545-0865-4b9b737dd8d7"},{"name":"posts/{post_id}/comments","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"post_id\", \"100\");"]}}],"id":"33372abc-34c6-5cec-e079-14a74a390435","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/posts/{{post_id}}/comments","description":"View all Comments for a given Post in a Deal Room by specifying the Post's id in the post_id path parameter.\n\n"},"response":[],"_postman_id":"33372abc-34c6-5cec-e079-14a74a390435"},{"name":"posts/{post_id}/comments","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"post_id\", \"100\");"]}}],"id":"3113b37b-a112-e21e-7795-6ea44219d534","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"body\" : \"Comment about this post\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/posts/{{post_id}}/comments","description":"Create a new Comment for a given Post in a Deal Room.\n\n"},"response":[],"_postman_id":"3113b37b-a112-e21e-7795-6ea44219d534"}],"id":"970f2af3-d843-1b22-dccf-ccfa86e4c241","description":"View a Post\nView all Comments for a Post\nCreate a new Comment for a Post\n","_postman_id":"970f2af3-d843-1b22-dccf-ccfa86e4c241"},{"name":"Public","item":[{"name":"public/stats","id":"4a2bf0e3-c392-3bf4-3087-53418011d6a6","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{new_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/public/stats","description":"Returns a set of global statistics about your platform's activities.\n\nImplement this to show on your homepage, for example, the total amount raised on your platform."},"response":[],"_postman_id":"4a2bf0e3-c392-3bf4-3087-53418011d6a6"},{"name":"public/users","id":"28181ff0-4203-c3e7-9690-9b76582f29e5","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{new_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/public/users","description":"Returns a list of public Users. Public Users are all Users with visibility set to its default value of Open."},"response":[],"_postman_id":"28181ff0-4203-c3e7-9690-9b76582f29e5"},{"name":"public/organizations","id":"ff6778fc-a04a-1d50-765d-d67d4379c92c","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{new_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/public/organizations","description":"Returns a list of public Organizations. Public Organizations are all Organizations with life_cycle_stage as Approved, Restricted or Published."},"response":[],"_postman_id":"ff6778fc-a04a-1d50-765d-d67d4379c92c"},{"name":"public/organizations/{organization_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"organization_id\", \"100\");"]}}],"id":"3d12bb27-f0c7-4658-5583-9d7a7eed96e1","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{new_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/public/organizations/{{organization_id}}","description":"Returns a an Organization without requiring the User to be logged in. Public Organizations are all Organizations with life_cycle_stage as Approved, Restricted or Published."},"response":[],"_postman_id":"3d12bb27-f0c7-4658-5583-9d7a7eed96e1"},{"name":"public/featuredOfferings","id":"beac09ab-5a40-6e6f-654e-eeceb7d1ec83","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{new_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/public/featuredOfferings","description":"Returns a list of featured Offerings. Featured Offerings are those marked by the is_featured flag being set to true. Offerings can be marked as 'featured' in the Crowd Valley admin portal.\n\nUse Featured Offerings to display a list of Offerings to users who are not logged in to your platform, for instance on a front-end homepage.\n\nFeatured Offerings only retrieves Offerings with life_cycle_stage as Approved, Restricted or Published.\n\nNote that in some regulatory environments there are restrictions related to the marketing of private securities. In those cases you can use GET /offerings, which requires the user to be authenticated in order to retrieve any information about the platform's Offerings."},"response":[],"_postman_id":"beac09ab-5a40-6e6f-654e-eeceb7d1ec83"},{"name":"public/offerings","id":"c77b1866-ec81-580a-5b2d-d7c80b9921be","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{new_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/public/offerings","description":"Returns a list of Offerings.\n\nThis function is similar to the GET /offerings function, although this 'public' endpoint version is available to website visitors of your front-end before they are authenticated.\n\nIf you want to allow your website visitors to see information about all Offerings before logging in then implement this feature on your Offerings list page.\n\nThis function retrieves Offerings whose life_cycle_stage is Published or Settled."},"response":[],"_postman_id":"c77b1866-ec81-580a-5b2d-d7c80b9921be"},{"name":"public/offerings/{offering_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"offering_id\", \"2319\");"]}}],"id":"6ab7cbdd-6949-48ed-04b8-7840092b51d0","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{new_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/public/offerings/{{offering_id}}","description":"Returns information about a given Offering specified by the offering_id path parameter.\n\nThis function is similar to the GET /offerings/{offering_id} function, although this 'public' endpoint version is available to website visitors of your front-end before they are authenticated.\n\nIf you want to allow your website visitors to see information about an Offering before logging in then implement this feature on your Offering overview page.\n\nThis function will only return the Offering if its life_cycle_stage is Published or Settled."},"response":[],"_postman_id":"6ab7cbdd-6949-48ed-04b8-7840092b51d0"},{"name":"public/verifyEmail","id":"fe59bbe7-6cf6-05c5-767b-b383f8056690","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{new_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"user_id\" : \"1234\",\n    \"secret\" : \"Jkt8RBs4AsFnl5FmzR2tZ16B0\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/public/verifyEmail","description":"Validates a User's email address.\n\nThis function requires the parameters user_id and secret, which must be generated by calling POST /users or POST /self/resendVerificationEmail in advance of reaching the page from which POST /public/verifyEmail is called.\n\nSuccessfully calling this function sets the User's email_verified flag to true."},"response":[],"_postman_id":"fe59bbe7-6cf6-05c5-767b-b383f8056690"},{"name":"public/forgotPassword","id":"918db63e-bf11-f319-e8f3-77c8c541efa9","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{new_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"url\" : \"https://www.yoursite.com/password-reset-page\",\n    \"email\" : \"john.doe@test.com\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/public/forgotPassword","description":"Sends an email to a User who has forgotten their password and therefore cannot log in. The email contains a link that the User should click in order to go to your front-end site and create a new password.\n\nThis function takes as a parameter a url, which should be a page on your front-end site, and generates a link that includes the parameters user_id and secret. The parameter user_id is the id of the User in your database with email address equal to the required email parameter of this function.\n\nFor example, if you send as parameters: url = https://www.yoursite.com/password-reset-page and email = john.doe@test.com then Crowd Valley's back-end will send an email to john.doe@test.com with a link such as http://www.mysite.com/reset-password?user_id=1234&secret=73kVx83z9w8wdF41fsJkxjRm1, if your network has a User with email = john.doe@test.com and id = 1234.\n\nYour front-end page http://www.mysite.com/reset-password should then parse the full link to retrieve the parameters: user_id and email and use them to implement POST /{network}/public/resetPassword, which actually resets the User's password to a new value.\n\nThe link in the User's email is only valid for 24 hours. If 24 hours have passed after having received the email, the User must generate a new link by calling this function again."},"response":[],"_postman_id":"918db63e-bf11-f319-e8f3-77c8c541efa9"},{"name":"public/resetPassword","id":"e83c2363-ba77-0b97-15ed-63f27b80d0ae","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{new_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"user_id\" : \"1000\",\n    \"secret\" : \"5vnhfv2Afrz13ZctbJ0PrJrhs\",\n    \"password\" : \"NewPassword123!\",\n    \"password_confirm\" : \"NewPassword123!\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/public/resetPassword","description":"Resets the User's password to a new value defined by the password parameter.\n\nThis function requires the parameters user_id and secret, which must be generated by calling POST /{network}/public/forgotPassword in advance of reaching the page from which POST /{network}/public/resetPassword is called.\n\nThe function also requires a password_confirm parameter, which must be equal to the password parameter."},"response":[],"_postman_id":"e83c2363-ba77-0b97-15ed-63f27b80d0ae"},{"name":"public/newsletterSignUp","id":"dfeb1c48-ba0b-d8c7-cf26-18de2d63654e","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{new_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"email\" : \"john.doe@test.com\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/public/newsletterSignUp","description":"Creates an alert for the admin team that a website visitor or User wishes to subscribe to a newsletter list.\n\nNote that this does not add the email address to any live newsletter list; it should be used simply as an alert for the admin team to add the email address to your preferred marketing newsletter system.\n\nIt requires an email parameter, which should be the website visitor's or User's email address."},"response":[],"_postman_id":"dfeb1c48-ba0b-d8c7-cf26-18de2d63654e"}],"id":"92c973a9-953c-48d5-0e17-2c22ba544258","description":"View Platform Statistics\nView Users (without login)\nView Organizations (without login)\nView an Organization (without login)\nView Featured Offerings (without login) STARTER\nView Offerings (without login)\nView an Offering (without login)\nVerify Email STARTER\nForgot Password STARTER\nReset User Password\nNewsletter Sign Up","_postman_id":"92c973a9-953c-48d5-0e17-2c22ba544258"},{"name":"Self","item":[{"name":"self","id":"bf925ddb-6877-e500-4e60-7ecfa6a2293a","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self","description":"Populate information on an user's private account page."},"response":[],"_postman_id":"bf925ddb-6877-e500-4e60-7ecfa6a2293a"},{"name":"self/stats","id":"cabab2a7-b713-9e24-306e-bf6f49cf647f","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/stats","description":"View some investment statistics about the logged-in User's investment activity.\n\nThis function is typically implemented to show some high-level dashboard statistics for the User to see about their own investments.\n\nThe statistics are calculated based on the User's Investments, Payouts and Transactions."},"response":[],"_postman_id":"cabab2a7-b713-9e24-306e-bf6f49cf647f"},{"name":"self","id":"6fb33afb-d847-7f2a-763c-e5b122f4601c","request":{"method":"PATCH","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"tagline\": \"My tagline\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"bank_accounts\": [\n       {\n          \"id\": \"Unique identifier of the Bank Details record\",\n          \"bank_name\": \"Bank Name\",\n          \"bank_account_number\": \"ABC123456\",\n          \"bank_swift_code\": \"XYZ12345\",\n          \"bank_routing_number\": \"ABC123\",\n          \"bank_address\": \"1000 Main Street\",\n          \"bank_currency\": \"USD\",\n          \"bank_country\": \"US\"\n        }\n    ],\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self","description":"Update the logged-in user's profile information.\n\nAny parameter that is \"Editable\" in the User data model can be updated by implementing this method."},"response":[],"_postman_id":"6fb33afb-d847-7f2a-763c-e5b122f4601c"},{"name":"self/acceptTerms","id":"c3b74ea2-c0b9-38a0-eff1-3068d21fc65c","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/acceptTerms","description":"Accept End User Terms and Conditions. Accepting Terms can be implemented as part of creating a user or as a separate step.\n\nCalling this function sets the logged-in User's term_service_accepted attribute to true."},"response":[],"_postman_id":"c3b74ea2-c0b9-38a0-eff1-3068d21fc65c"},{"name":"self/resendVerificationEmail","id":"9bb79a43-f003-628d-c09f-bd161a65f8e7","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"url\" : \"https://www.yoursite.com/verify-email\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/resendVerificationEmail","description":"Re-sends an email to the logged-in User, which contains the private link that is required for the User to verify their email address.\n\nImplement this function on a holding page on your front-end that a User sees before they have validated their email address. Users should be able to re-send the verification email in case they entered the incorrect email when creating their account or they were unable to find their email.\n\nWhen enabled in the Back Office application, the first verification email is sent as soon as POST /users is called, which creates the User on your platform. By default the User's email_verified attribute is set to false. It can be set to true by implementing POST /public/verifyEmail on the page that you specify in the url attribute of POST /users.\n\nThe secret provided to the User in the verification email has a time limit of 24 hours, so if your User has not been able to verify their email within 24 hours of creating their account, they will need to resend the verification email using this function."},"response":[],"_postman_id":"9bb79a43-f003-628d-c09f-bd161a65f8e7"},{"name":"self/changePassword","id":"f0630e15-f2e2-5c9d-6ac2-3588d99fa9c1","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"current_password\" : \"Password123!\",\n    \"new_password\" : \"NewPassword123!\",\n    \"new_password_confirm\" : \"NewPassword123!\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/changePassword","description":"Change the User's password.\n\nThis function is typically implemented on a My Account or My Profile page on your platform front-end. Users must be able to provide their correct existing password in order to change it to a new password."},"response":[],"_postman_id":"f0630e15-f2e2-5c9d-6ac2-3588d99fa9c1"},{"name":"self/changeEmail","id":"511e39c7-4939-eca9-9424-164aee0f0eb4","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"verify_email_url\" : \"https://www.your-site.com/verify-email\",\n    \"new_email\" : \"newemail@test.com\",\n    \"new_email_confirm\" : \"newemail@test.com\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/changeEmail","description":"Change the User's email.\n\nThis function is typically implemented on a My Account or My Profile page on your platform front-end. Calling this function will reset the User's email_verified flag to false and send a new system email from the Crowd Valley back-end with a new verification link."},"response":[],"_postman_id":"511e39c7-4939-eca9-9424-164aee0f0eb4"},{"name":"self/approveUser","id":"1ba8fe73-7f56-f3a0-458d-c36e093dc5f5","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/approveUser","description":"Mark the logged-in User as Approved as part of the platform's user onboarding process.\n\nCalling this function sets the User's has_been_approved attribute to true.\n\nIn any user onboarding process, platforms have various options to determine when a User should be considered ready to engage fully with their Offerings. Typically, in order of importance, the basic levels are:\n\nterm_service_accepted\nregistration_complete\nhas_been_approved\nIn other words, a User should first accept a platform's terms and conditions, and then complete your registration process, and then be approved either automatically or manually by admin users in the Back Office application.\n\nThen by calling GET /self when the User logs in, you can find out whether the User has passed each step or not. Based on that status, you can either allow them or prevent them from accessing certain pages or features in your front-end application.\n\nIf you require further steps or levels then you can use custom User fields to represent as many additional flags or settings as you require. For instance, if you require a custom is_accredited_investor field then you can simply create this as a custom User field, using PATCH /self, with a value of 1 or 0 as appropriate.\n\nEach step is optional and depends solely on your business and compliance requirements."},"response":[],"_postman_id":"1ba8fe73-7f56-f3a0-458d-c36e093dc5f5"},{"name":"self/markRegistrationComplete","id":"8954f8b2-b1c5-dd09-9281-21f49e05a292","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/markRegistrationComplete","description":"Mark the logged-in User as having completed your registration requirements as part of the platform's user onboarding process.\n\nCalling this function sets the User's registration_complete attribute to true.\n\nFor more about onboarding processes, see the discussion under POST /self/approveUser above."},"response":[],"_postman_id":"8954f8b2-b1c5-dd09-9281-21f49e05a292"},{"name":"self/blockUser","id":"56f04302-a03c-4981-0200-defb4c2e164a","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"user_message\" : \"We have been unable to verify your KYC/AML details. Please contact the admin team for more information.\",\n    \"description\" : \"101 - User was under 18 years of age\",\n    \"expiration_date\" : \"2017-01-01\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/blockUser","description":"Block the logged-in User from the platform.\n\nUsers can be blocked from your platform either manually by an admin user in the Back Office application or automatically by calling this function.\n\nThis automated 'block user' feature is typically implemented during your user onboarding process. For instance, if you require users to pass an accreditation or eligibility test, and the logged-in User fails the test, then they can be blocked from the platform by calling this function.\n\nAs well as calling this function, you should log out the User to ensure that they cannot go back and adjust their responses knowing that they have been blocked.\n\nIf you call this function without any parameters then the User will be blocked without any expiration date. Once blocked without an expiration date, Users will not be able to log in until they have been unblocked manually by an Admin User in the Back Office application.\n\nYou may also provide parameters: user_message, description and expiration_date to block a User until a certain date in the future. User the format: YYYY-MM-DD to specify a date on which the User will be able to log in again.\n\nThe user_message attribute is used to show a custom message to the User if they try to log in whilst they are blocked, for instance: \"We have been unable to verify your KYC/AML details. Please contact the admin team for more information.\"\n\nUse description to record an internal log of the reason for which the User was blocked. For instance, you may have your own list of KYC exceptions and definitions that fit your business and compliance requirements, such as \"101 - User was under 18 years of age\". This log will be recorded against the User in the Back Office admin application."},"response":[],"_postman_id":"56f04302-a03c-4981-0200-defb4c2e164a"},{"name":"self/organizations","id":"21bbabd2-9cde-65a7-b20b-0f0688a80589","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/organizations","description":"A list of the logged-in User's Organizations. This could be used to show for which Organization(s) the User works or for which Organization(s) the User has created Offerings."},"response":[],"_postman_id":"21bbabd2-9cde-65a7-b20b-0f0688a80589"},{"name":"self/offerings","id":"0520f604-f8b9-e70e-e77b-5156035a6bfa","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/offerings","description":"Retrieve all the logged-in User's own Offerings.\n\nIn secondary market implementations, this function can be used to show all Offerings that an investor has listed on the secondary market, since the User will be the author of each secondary Offering on the market even if the User is not part of the Offering's Organization."},"response":[],"_postman_id":"0520f604-f8b9-e70e-e77b-5156035a6bfa"},{"name":"self/investments","id":"004f362a-fc0d-0001-8bd8-599a48384af9","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/investments","description":"Retrieve a list of the User's Investments.\n\nThis function retrieves all investments of any life_cycle_stage made by the logged-in User.\n\nImplement this function to populate a User's investment portfolio or current holdings page."},"response":[],"_postman_id":"004f362a-fc0d-0001-8bd8-599a48384af9"},{"name":"self/payouts","id":"213dccfb-effe-6c5d-f9e5-927f5b362186","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/payouts","description":"Retrieve a list of the User's Payouts.\n\nA Payout is an expected or scheduled payment. It can be used to track loan repayment schedules or dividend payment schedules."},"response":[],"_postman_id":"213dccfb-effe-6c5d-f9e5-927f5b362186"},{"name":"self/wallets","id":"2840d5da-b479-d4e5-f53a-d9705dc4660d","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/wallets","description":"Retrieve a list of the User's internal Wallets. This list does not include wallets provided by third-party payments services.\n\nIn order to see a list of User internal Wallets in the Back Office application, this feature must be enabled by your Crowd Valley support contact.\n\nInternal Wallets can be used to represent real cash, in platforms that use 'front-end' implementations of a payment gateway such as SagePay or Stripe. In this case, you would implement an e-commerce style payments process on your front-end and then when the payments service returns successfully you can update the User's Wallet's balance by creating a Transaction for the Wallet.\n\nInternal Wallets can also be used to record taxes or fees payable, if they should be handled separately from the main investment process. In some jurisdictions, taxes are withheld by the platform operators and therefore it can be useful to keep an audit record of each line item that incurs a future tax repayment.\n\nAlternatively, internal Wallets can be used to keep track of 'credits' or 'bonuses', which may then be used in some way on your platform.\n\nBy default, a User does not have any internal Wallets. In order to see an internal Wallet when implementing this function, you should first implement POST self/wallets in order to create an internal Wallet."},"response":[],"_postman_id":"2840d5da-b479-d4e5-f53a-d9705dc4660d"},{"name":"self/capitalizations","id":"c3b5b529-ac5d-c74f-fa97-c6d7ba92fd36","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/capitalizations","description":"Retrieve a list of the User's Capitalizations.\n\nIf a User owns a Capitalization then this indicates a record of a shareholding or loan part held by the User in an Organization."},"response":[],"_postman_id":"c3b5b529-ac5d-c74f-fa97-c6d7ba92fd36"},{"name":"self/wallets","id":"ec616879-33d6-9729-bc13-816e248de18e","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"currency\" : \"USD\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/wallets","description":"Create a new internal Wallet for the logged-in User.\n\nIf you are using internal Wallets on your platform, you should implement this function at some point before the User is able to add funds to it. Typically POST self/wallets is called\n\nBy default, a User does not have any internal Wallets. In order to see an internal Wallet when implementing this function, you should first implement POST self/wallets in order to create an internal Wallet."},"response":[],"_postman_id":"ec616879-33d6-9729-bc13-816e248de18e"},{"name":"self/wallets/{wallet_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"wallet_id\", \"201\");"]}}],"id":"6e30c09c-2ed9-7d64-d456-f2b335a4a137","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/wallets/{{wallet_id}}","description":"Retrieve a User's internal Wallet.\n\nUsers can have any number of internal Wallets so if you have a platform where Users hold several different Wallets you can specify a wallet_id to return the information for a particular Wallet.\n\nTo get a list of all of the User's internal Wallets, implement GET self/wallets."},"response":[],"_postman_id":"6e30c09c-2ed9-7d64-d456-f2b335a4a137"},{"name":"self/documents","id":"a552fc80-8eab-4a20-3068-1f28e8b215a5","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/documents","description":"Retrieve a list of all the Documents that have been attached to the User's account.\n\nDocuments can be attached to Users, Organizations, Offerings or Investments. If a Document is attached to an Investment and the Investment was created by the logged-in User then it will not appear in this list. Documents returned by implementing GET self/documents are only those that were created by calling POST self/documents.\n\nIf you are implementing a User Profile or Account page that should show all Documents relating to the logged-in User then you should first call GET self/documents to get the User's 'User Documents' and then call GET /investments/{investment_id}/documents for each Investment from the list returned by GET self/investments."},"response":[],"_postman_id":"a552fc80-8eab-4a20-3068-1f28e8b215a5"},{"name":"self/documents","id":"afebeb14-a2b3-6f0a-ce0c-2e139526c02c","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"file_name\": \"utility_bill.jpg\",\n    \"url\": \"https://yourcdn.yourstoragefacility.com/utility_bill.jpg\",\n    \"file_alias\": \"Utility Bill\",\n    \"file_description\": \"Utility Bill from Jan 1st to March 31st\",\n    \"file_type\": \"image/jpg\",\n    \"tag\": \"KYC\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/documents","description":"Add a Document to the User's account.\n\nThis is typically implemented to allow a User to upload a KYC Document such as a Utility Bill that may constitute part of your user onboarding process.\n\nDocuments added by using POST self/documents are considered to be attached to the User specifically as a User, rather than documents such as Loan Agreements or Share Certificates that can be added to the User's account by attaching it to a particular Investment made by the User, by implementing POST investments/{investment_id}/documents."},"response":[],"_postman_id":"afebeb14-a2b3-6f0a-ce0c-2e139526c02c"},{"name":"self/invitations","id":"979d25ee-fd7f-5362-d06b-d3fc29e66750","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/invitations","description":"Retrieve a list of Invitations made by the logged-in User.\n\nInvitations allow Users to invite their external contacts to join the platform."},"response":[],"_postman_id":"979d25ee-fd7f-5362-d06b-d3fc29e66750"},{"name":"self/invitations","id":"8296d1ca-b918-fbc5-48dd-8bea35ba0ea8","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"email\" : \"john.doe@test.com\",\n    \"given_name\" : \"John\",\n    \"family_name\" : \"Doe\",\n    \"organization_name\" : \"JD, Inc\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/invitations","description":"Create a new Invitation to an external contact from the logged-in User.\n\nInvitations allow Users to invite their external contacts to join the platform."},"response":[],"_postman_id":"8296d1ca-b918-fbc5-48dd-8bea35ba0ea8"},{"name":"self/invitations/{invitation_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"invitation_id\", \"98\");"]}}],"id":"9682a778-64ed-0fd5-9e59-a0f96cc05d64","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self/invitations/{{invitation_id}}","description":"Retrieve information about a given Invitation made by the logged-in User.\n\nInvitations allow Users to invite their external contacts to join the platform."},"response":[],"_postman_id":"9682a778-64ed-0fd5-9e59-a0f96cc05d64"},{"name":"self","id":"a991e250-9d70-b27f-046d-9921d554113d","request":{"method":"DELETE","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/self","description":"Delete a User's account.\n\nThis blocks the User and, if enabled, sends a notification to the Admin User team to inform them that the logged-in User wishes to delete their account from the platform.\n\nNo User data are physically deleted from the platform in order to ensure that a full audit trail of the User's activity history remains available, including records of their previous Offerings or Investments."},"response":[],"_postman_id":"a991e250-9d70-b27f-046d-9921d554113d"}],"id":"9a0cdd6e-5fcb-e9eb-9644-cb6cee0489f5","description":"Logged-in user's account information STARTER\nLogged-in User's Investment Statistics\nUpdate the logged-in user's information STARTER\nAccept End User Terms and Conditions\nResend Verification Email STARTER\nChange Password STARTER\nChange Email\nApprove User\nMark Registration Complete\nBlock User\nUser's Organizations\nUser's Offerings\nUser's Investments STARTER\nUser's Payouts\nUser's Internal Wallets\nUser's Capitalizations\nCreate a new internal Wallet for the logged-in User\nRetrieve a given internal Wallet\nUser's Documents STARTER\nAdd a new User Document STARTER\nUser's Invitations\nCreate a new Invitation\nRetrieve an Invitation\nDelete My Account","_postman_id":"9a0cdd6e-5fcb-e9eb-9644-cb6cee0489f5"},{"name":"Topics","item":[{"name":"topics/{topic_id}/posts","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"topic_id\", \"100\");"]}}],"id":"69535da9-0d8d-f1d2-5e72-89f809abadfd","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/topics/{{topic_id}}/posts","description":"View all Posts for a given Topic in a Deal Room by specifying the Topic's id in the topic_id path parameter.\n\n"},"response":[],"_postman_id":"69535da9-0d8d-f1d2-5e72-89f809abadfd"},{"name":"topics/{topic_id}/posts","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"topic_id\", \"100\");"]}}],"id":"e8bb4a28-6b1f-e340-53b8-7ea3ac2283b7","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"body\" : \"The content of the Post\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/topics/{{topic_id}}/posts","description":"Create a new Post for a given Topic in a Deal Room by specifying the Topic's id in the topic_id path parameter.\n\nImplement this function to create a new Post in a forum. Topics are always attached to a particular Deal Room, which in turn is associated with a single Offering. All Posts belong to a Topic and a Topic can have multiple Posts."},"response":[],"_postman_id":"e8bb4a28-6b1f-e340-53b8-7ea3ac2283b7"}],"id":"54a843bb-ec74-40df-93e4-468037837b1b","description":"View all forum Posts for a Topic\nCreate a new forum Post for a Topic\n","_postman_id":"54a843bb-ec74-40df-93e4-468037837b1b"},{"name":"Transactions","item":[{"name":"transactions/{transaction_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"transaction_id\", \"100\");"]}}],"id":"616601e0-aed9-34e1-93d7-6870ba3cadbb","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"My Organization\",\n    \"address\" : { \"building\" : \"One Market Plaza\", \"street_address\" : \"Spear Tower\", \"city\" : \"San Francisco\" },\n    \"visibility\" : \"1\"   \n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/transactions/{{transaction_id}}","description":"Information about this Transaction.\n\n"},"response":[],"_postman_id":"616601e0-aed9-34e1-93d7-6870ba3cadbb"},{"name":"transactions/{transaction_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"transaction_id\", \"100\");"]}}],"id":"93667e29-7969-e904-c5c1-ec39d8fc7a3f","request":{"method":"PATCH","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"payment_status\" : \"2\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/transactions/{{transaction_id}}","description":"Update this Transaction.\n\nAny parameter that is \"Editable\" in the Transaction data model can be updated by implementing this method."},"response":[],"_postman_id":"93667e29-7969-e904-c5c1-ec39d8fc7a3f"}],"id":"8fc868ac-dfda-d3f0-fc92-60bf3d0f8f94","description":"View Payment Transaction\nUpdate Payment Transaction\n","_postman_id":"8fc868ac-dfda-d3f0-fc92-60bf3d0f8f94"},{"name":"Users","item":[{"name":"users","id":"9b96e879-19b4-9ed1-c518-0e0d3aac7eb8","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{new_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"email\" : \"newuser@test.com\",\n    \"password\" : \"Password123!\",\n    \"url\" : \"https://www.yoursite.com/verify-email\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/users","description":"Registers a new User.\n\nImplement this as the first step of your registration process. The required parameters for this function are email, password, and url. All other editable attributes of a User can also be provided as optional parameters, for instance, given_name or family_name.\n\nIf your registration process has several steps then you can ask new Users for their email and password and then update their User record by implementing PATCH /self at a later point.\n\nThe email and password parameters should be provided by the User. The url parameter is used to generate the verification email that is sent to Users automatically by the Back Office application when the User is successfully created.\n\nSpecify a url as a page on your front-end that implements the POST /public/verifyEmail method using the parameters user_id and secret that are generated for the new User by implementing POST /users."},"response":[],"_postman_id":"9b96e879-19b4-9ed1-c518-0e0d3aac7eb8"},{"name":"users","id":"096454cb-0efb-43db-264d-461fbf844d18","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/users","description":"Retrieves a list of Users in your network.\n\nImplement this function to populate a public listing page of your visible Users. Users are returned in this list if they have their visibility attribute set to Open."},"response":[],"_postman_id":"096454cb-0efb-43db-264d-461fbf844d18"},{"name":"users/{user_id}","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"user_id\", \"1000\");"]}}],"id":"257eed40-8636-b0b7-b090-f63835ffc942","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/users/{{user_id}}","description":"Retrieve information about a given User.\n\nImplement this function to populate another User's public profile page. This is the equivalent for viewing another User's profile of calling GET /self for the logged-in User.\n\nThis allows the logged-in User to see information about other Users on your platform. It does not return as much information about other Users as you would see about yourself: it will only show public profile information such as given_name and family_name. It will not show private account information such as birth_date or passport_number."},"response":[],"_postman_id":"257eed40-8636-b0b7-b090-f63835ffc942"},{"name":"users/{user_id}/offerings","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"user_id\", \"1000\");"]}}],"id":"811251e5-9ac2-8055-41be-d79459a4a9a6","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/users/{{user_id}}/offerings","description":"View a given User's public Offerings.\n\nImplement this function to see another User's Offerings. This is the equivalent for viewing another User's profile of calling GET /self/offerings for the logged-in User.\n\nThis allows the logged-in User to see information about other Users on your platform. It does not return as much information about other Users as you would see about yourself: it will only show Offerings whose life_cycle_stage is Published, Closing or Settled. The equivalent function for the logged-in User returns all Offerings."},"response":[],"_postman_id":"811251e5-9ac2-8055-41be-d79459a4a9a6"},{"name":"users/{user_id}/investments","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"user_id\", \"1000\");"]}}],"id":"c60f06c5-eb41-053e-6bc3-091d28ebd608","request":{"method":"GET","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/users/{{user_id}}/investments","description":"View a given User's public Investments.\n\nImplement this function to see another User's history of Investments. This is the equivalent for viewing another User's profile of calling GET /self/investments for the logged-in User.\n\nThis allows the logged-in User to see information about other Users on your platform. It does not return as much information about other Users as you would see about yourself: it will only show Investments whose life_cycle_stage is Settled. The equivalent function for the logged-in User returns all Investments."},"response":[],"_postman_id":"c60f06c5-eb41-053e-6bc3-091d28ebd608"}],"id":"7c0ad3e9-4664-0c4a-10f5-f32438b61c8a","description":"Register a new User\nView Users (logged in)\nView a User (logged in)\nView a User's Offerings\nView a User's Investments\n","_postman_id":"7c0ad3e9-4664-0c4a-10f5-f32438b61c8a"},{"name":"Wallets","item":[{"name":"wallets/{wallet_id}/transactions","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setGlobalVariable(\"wallet_id\", \"10\");"]}}],"id":"417a65c0-b606-ceed-690e-fc7ca9cc1a61","request":{"method":"POST","header":[{"key":"cv-auth","value":"{{logged_in_user_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"transaction_amount\" : \"1000\",\n    \"transaction_description\" : \"Credit bonus\",\n    \"transaction_currency\" : \"USD\",\n    \"payment_status\" : \"1\",\n    \"payment_service\" : \"1\"\n}"},"url":"https://{{endpoint}}.crowdvalley.com/{{version}}/{{network}}/wallets/{{wallet_id}}/transactions","description":"Create a new Transaction associated to a given internal Wallet as specified by the wallet_id path parameter.\n\n"},"response":[],"_postman_id":"417a65c0-b606-ceed-690e-fc7ca9cc1a61"}],"id":"6c644d39-3d82-e2d6-6369-3265c3c9e813","description":"Create a new Wallet Transaction\n","_postman_id":"6c644d39-3d82-e2d6-6369-3265c3c9e813"}]}