Skip to content

Commit ffc1a60

Browse files
Varunramgitbook-bot
authored andcommitted
GitBook: [master] 2 pages modified
1 parent 0e6fb3d commit ffc1a60

File tree

2 files changed

+108
-216
lines changed

2 files changed

+108
-216
lines changed

opensolar/api/investors.md

+107-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,112 @@ curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Origin: lo
3737
{% endapi-method-response-example-description %}
3838

3939
```text
40-
40+
{
41+
"U": {
42+
"Index": 325,
43+
"Name": "",
44+
"Description": "",
45+
"Image": "",
46+
"FirstSignedUp": "Tuesday, 31-Mar-20 09:23:16 UTC",
47+
"Address": "",
48+
"City": "",
49+
"ZipCode": "",
50+
"Country": "",
51+
"RecoveryPhone": "",
52+
"Email": "varunram",
53+
"Notification": false,
54+
"StellarWallet": {
55+
"PublicKey": "GB4JNGNMUSXPAMR46DGGTT5N2C6BJJ2PBSWGZNPQAQRAOSHUMF7IIXKO",
56+
"EncryptedSeed": "bdAeWLgKEgxchw9694SxbjZG3ZC08MvnSGtEu5ep4yAsgPzhz6jNzMxsoU+MQGbvTff4BBktGSIld4aaEdo0BQpnPCZv4hMj",
57+
"SeedPwhash": ""
58+
},
59+
"AlgorandWallet": {
60+
"WalletName": "",
61+
"WalletID": ""
62+
},
63+
"Username": "vg",
64+
"Pwhash": "d9290081d361d9323a99180a8a543b82a85517fdb790d41e66956da84bb2de0d287daa3b11a624cdda5f58f2b39da317b671f2142e390e4b2cb3a75eed8eb3e0",
65+
"Kyc": false,
66+
"Admin": false,
67+
"Inspector": false,
68+
"Banned": false,
69+
"Reputation": 0,
70+
"LocalAssets": null,
71+
"RecoveryShares": ["rSkd0PPoljFJDhpVcdXA1NOFFvTMr4mo9Imc5rGq0c4=oCRQMb5NU2Ajp6D_dtlgadXjbSDfwyntcTw2bK_PuYo=ai0AuOg8HLFjrGKqJ3M_CEb7QNEDRLMI317r2MjTP4c=g0iop9V4r79DGoll_yRvk8UlLRa1ZxhX-qirE2SaHLI=", "mjKjKUVSh8vrjsoG_adD8dyZ0dsGDcofj3jID-tLjO4=1OEQRbZvtIkOVGijLr7h8X74XTjb3qzFaIa4uETgRTk=PRcSWv8g6jCINgYneQ7GjKdofDhrQRMlwriLc-kY_YE=oblSn3oW6dgNeHOoDNMeiFlxLb_MeEwxRYcYIsw8HVg=", "8QtD6LVYsaXl1_bb021RUhoj3rkIKMIjBMrnJ3BTo-A=3FYEQ6ArLjAnZ6yfmgVPKIN7i3LCHhDeRjfewozskg4=SDnyGJL8NU4haVZC7-QkiWihIrir_w66jGQjIrGUDiE=ekDw6vsIxTi-TCI99a2j-yYAXub17Og5I5ilp-W6ZxA="],
72+
"PwdResetCode": "",
73+
"SecondaryWallet": {
74+
"PublicKey": "GCXAJK6HJG4WO6Y6WGRVVN6AAKBF7267RT3EYFQPC7IV4M23ASGM4E3U",
75+
"EncryptedSeed": "bdcdULgfDww+mQV69PrBEjxOwu2q+c+JRXJEoP7C4jspmOeT2rHGrdht2V2EWwHxNOrqBAg0GS1kEBBP9y7WUh1ucWK5+OwQ",
76+
"SeedPwhash": ""
77+
},
78+
"EthereumWallet": {
79+
"Address": "0x96654547A297b86A1f761aEB86AAE35D0d7177eE",
80+
"PublicKey": "da243881752432a4aa09405fa2e8c292e1e6450de9bc60d5fad00b279e62a2a166ea1287a4c26018f8ad9aac8a97e9023e9a960df55b1b5df07ebff6416e063c",
81+
"PrivateKey": "a9b0804567e930e72719a442faecb8e9c388c8e059260981afb9fa37491bfc4c"
82+
},
83+
"PendingDocuments": null,
84+
"KYC": {
85+
"PassportPhoto": "",
86+
"IDCardPhoto": "",
87+
"DriversLicense": "",
88+
"PersonalPhoto": ""
89+
},
90+
"StarRating": null,
91+
"GivenStarRating": null,
92+
"TwoFASecret": "",
93+
"AnchorKYC": {
94+
"Name": "",
95+
"Birthday": {
96+
"Month": "",
97+
"Day": "",
98+
"Year": ""
99+
},
100+
"Tax": {
101+
"Country": "",
102+
"Id": ""
103+
},
104+
"Address": {
105+
"Street": "",
106+
"City": "",
107+
"Postal": "",
108+
"Region": "",
109+
"Country": "",
110+
"Phone": ""
111+
},
112+
"PrimaryPhone": "",
113+
"Gender": "",
114+
"DepositIdentifier": "",
115+
"WithdrawIdentifier": "",
116+
"Url": "",
117+
"AccountId": ""
118+
},
119+
"AccessToken": "",
120+
"AccessTokenTimeout": 0,
121+
"Mailbox": null,
122+
"Legal": false,
123+
"ProfileProgress": 0
124+
},
125+
"C": {
126+
"CompanyType": "",
127+
"Name": "",
128+
"LegalName": "",
129+
"AdminEmail": "",
130+
"PhoneNumber": "",
131+
"Address": "",
132+
"Country": "",
133+
"City": "",
134+
"ZipCode": "",
135+
"TaxIDNumber": "",
136+
"Role": ""
137+
},
138+
"Company": false,
139+
"VotingBalance": 0,
140+
"AmountInvested": -1,
141+
"InvestedSolarProjects": null,
142+
"InvestedSolarProjectsIndices": null,
143+
"SeedInvestedSolarProjects": null,
144+
"SeedInvestedSolarProjectsIndices": null
145+
}
41146
```
42147
{% endapi-method-response-example %}
43148
{% endapi-method-response %}
@@ -50,7 +155,7 @@ Validate Investor
50155
{% endapi-method-summary %}
51156

52157
{% api-method-description %}
53-
curl -X GET "http://api2.openx.solar/investor/validate?username=john&token=pmkjMEnyeUpdTyhdHElkBExEKeLIlYft"
158+
curl -X GET "https://api2.openx.solar/investor/validate?username=john&token=pmkjMEnyeUpdTyhdHElkBExEKeLIlYft"
54159
{% endapi-method-description %}
55160

56161
{% api-method-spec %}

opensolar/api/stages.md

+1-214
Original file line numberDiff line numberDiff line change
@@ -1,223 +1,10 @@
11
# Stages
22

33
{% api-method method="get" host="https://api.openx.solar" path="/stages/all" %}
4-
{% api-method-summary %}
5-
All Stages
6-
{% endapi-method-summary %}
7-
8-
{% api-method-description %}
9-
10-
{% endapi-method-description %}
11-
12-
{% api-method-spec %}
13-
{% api-method-request %}
14-
15-
{% api-method-response %}
16-
{% api-method-response-example httpCode=200 %}
17-
{% api-method-response-example-description %}
18-
19-
{% endapi-method-response-example-description %}
20-
21-
```
22-
[
23-
{
24-
"Number": 0,
25-
"FriendlyName": "Handshake",
26-
"Name": "Idea Consolidation",
27-
"Activities": [
28-
"[Originator] proposes project and either secures or agrees to serve as [Solar Developer]. NOTE: Originator is the community leader or catalyst for the project, they may opt to serve as the solar developer themselves, or pass that responsibility off, going forward we will use solar developer to represent the interest of both.",
29-
"[Solar Developer] creates general estimation of project (eg. with an automatic calculation through Google Project Sunroof, PV) ",
30-
"If [Originator]/[Solar Developer] is not landowner [Host] states legal ownership of site (hard proof is optional at this stage)"
31-
],
32-
"StateTrigger": [
33-
"Matching of originator with receiver, and mutual approval/intention of interest."
34-
],
35-
"BreachCondition": null
36-
},
37-
{
38-
"Number": 1,
39-
"FriendlyName": "Engagement",
40-
"Name": "RFP Development",
41-
"Activities": [
42-
"[Solar Developer] Analyse parameters, create financial model (proforma)",
43-
"[Host] & [Solar Developer] engage [Legal] & begin scoping site for planning constraints and opportunities (viability analysis)",
44-
"[Solar Developer] Create RFP (‘Request For Proposal’)",
45-
"Simple: Automatic calculation (eg. Sunroof style)",
46-
"Complex: Public project with 3rd party RFP consultant (independent engineer)",
47-
"[Originator][Solar Developer][Offtaker] Post project for RFP",
48-
"[Beneficiary/Host] Define and select RFP developer.",
49-
"[Investor] First angel investment option (high risk)",
50-
"Allow ‘time banking’ as sweat equity, monetized as tokenized capital or shadow stock"
51-
],
52-
"StateTrigger": [
53-
"Issue an RFP",
54-
"Letter of Intent or MOU between originator and developer"
55-
],
56-
"BreachCondition": null
57-
},
58-
{
59-
"Number": 2,
60-
"FriendlyName": "Quotes",
61-
"Name": "Actions",
62-
"Activities": [
63-
"[Solar Developer][Beneficiary/Offtaker][Legal] PPA model negotiation.",
64-
"[Originator][Beneficiary] Compare quotes from bidders: ",
65-
"[Engineering Procurement and Construction] (labor)",
66-
"[Vendors] (Hardware)",
67-
"[Insurers]",
68-
"[Issuer]",
69-
"[Intermediary Portal]",
70-
"[Originator/Receiver] Begin negotiation with [Utility]",
71-
"[Solar Developer] checks whether site upgrades are necessary.",
72-
"[Solar Developer][Host] Prepare submission for permitting and planning",
73-
"[Investor] Angel incorporation (less risk)"
74-
],
75-
"StateTrigger": [
76-
"Selection of quotes and vendors",
77-
"Necessary identification of entities: Installers and offtaker"
78-
],
79-
"BreachCondition": null
80-
},
81-
{
82-
"Number": 3,
83-
"FriendlyName": "Signing",
84-
"Name": "Contract Execution",
85-
"Activities": [
86-
"[Solar Developer] pays [Legal] for PPA finalization.",
87-
"[Solar Developer][Host] Signs site Lease with landowner.",
88-
"[Solar Developer] OR [Issuer] signs Offering Agreement with [Intermediary Portal].",
89-
"[Solar Developer][Beneficiary] selects and signs contracts with: ",
90-
"[Engineering Procurement and Construction] (labor)",
91-
"[Vendors] (Hardware)",
92-
"[Insurers]",
93-
"[Issuer] OR [Intermediary Portal]",
94-
"[Offtaker] OR [Solar Developer][Engineering, Procurement and Construction] sign vendor/developer EPC Contracts",
95-
"[Solar Developer][Offtaker] signs PPA/Offtake Agreement",
96-
"[Investor] 2nd stage of eligible funding",
97-
"[Solar Developer][Beneficiary] makes downpayment to [Engineering Procurement and Construction] (labor)",
98-
"[Investor] Profile with risk "
99-
],
100-
"StateTrigger": [
101-
"Execution of contracts - Sign!"
102-
],
103-
"BreachCondition": null
104-
},
105-
{
106-
"Number": 4,
107-
"FriendlyName": "The Raise",
108-
"Name": "Finance and Capitalization",
109-
"Activities": [
110-
"[Issuer] engages [Intermediary Portal] to develop Form C or prospectus",
111-
"[Intermediary Portal] lists [Issuer] project",
112-
"[Originator][Solar Developer][Offtaker] market the crowdfunded offering",
113-
"[Investors] Commit capital to the project",
114-
"[Intermediary Portal] closes offering and disburses capital from Escrow account to [Issuers]",
115-
"If [Issuer] is not also [Solar Developer] then [Issuer] passes funds to [Solar Developer] "
116-
],
117-
"StateTrigger": [
118-
"Project account receives funds that cover the raise amount. Raise amount: normally includes both project capital expenditure (i.e. hardware and labor) and ongoing Operation & Management costs"
119-
],
120-
"BreachCondition": null
121-
},
122-
{
123-
"Number": 5,
124-
"FriendlyName": "Construction",
125-
"Name": "Payments and Construction",
126-
"Activities": [
127-
"[Solar Developer] coordinates installation dates and arrangements with [Host][Off-takers]",
128-
"[Solar Developer] OR [Engineering, Procurement and Construction] take delivery of equipment from [Vendor]",
129-
"[Utility] issues conditional interconnection",
130-
"[Solar Developer] schedules installation with [Engineering, Procurement and Construction]",
131-
"[Engineering, Procurement and Construction] completes installation.",
132-
"[Solar Developer] pays [Engineering, Procurement and Construction] for substantial completion of the project.",
133-
"[Insurers] verifies policy, [Solar Developer] pays [Insurers]",
134-
"[Investor] role?"
135-
],
136-
"StateTrigger": [
137-
"Installation reaches substantial completion",
138-
"IoT devices detect energy generation"
139-
],
140-
"BreachCondition": null
141-
},
142-
{
143-
"Number": 6,
144-
"FriendlyName": "Interconnection",
145-
"Name": "Contract Execution",
146-
"Activities": [
147-
"[Solar Developer] coordinates with [Engineering Procurement and Construction] to schedule interconnection dates with [Utility] ",
148-
"[Engineering, Procurement and Construction] submits ‘as-built’ drawings to City/County Inspectors and schedules interconnection with [Utility]",
149-
"[Solar Developer] schedules City/County Building Inspector visit",
150-
"[Utility] visits site for witness test",
151-
"[Utility] places project in service "
152-
],
153-
"StateTrigger": [
154-
"[Utility] places project in service"
155-
],
156-
"BreachCondition": null
157-
},
158-
{
159-
"Number": 7,
160-
"FriendlyName": "Legacy",
161-
"Name": "Operation and Management",
162-
"Activities": [
163-
"[Solar Developer] hires OR becomes [Manager]",
164-
"[Manager] hires [Operations & Maintenance] provider",
165-
"[Manager] sets up billing system and issues monthly bills to [Offtaker] and collects payment on bills",
166-
"[Manager] monitors for breaches of payment or contract, other indentures, force majeure or adverse conditions [see below for Breach Conditions]",
167-
"[Manager] files annual taxes",
168-
"[Manager] handles annual true-up on net-metering payments",
169-
"[Manager] makes annual cash distributions and issues 1099-DIV to [Investors] or coordinates share repurchase from [Investors]",
170-
"If applicable, [Manager] executes flip between [Solar Developer] ownership interest and [Tax equity investor]",
171-
"[Manager] OR [Operations & Maintenance] monitors system performance and coordinates with [Off-takers] to schedule routine maintenance",
172-
"[Manager] OR [Operations & Maintenance] coordinates with [Engineering, Procurement and Construction] to change inverters or purchase replacements from [Vendors] as needed.",
173-
"[Investors] can engage in secondary market (i.e. re-selling its securities). "
174-
],
175-
"StateTrigger": [
176-
"[Investors] reach preferred return rate, or Power Purchase Agreement stipulates ownership flip date or conditions "
177-
],
178-
"BreachCondition": [
179-
"[Offtaker] fails to make $/kWh payments after X period of time due. "
180-
]
181-
},
182-
{
183-
"Number": 8,
184-
"FriendlyName": "Handoff",
185-
"Name": "Ownership Flip",
186-
"Activities": [
187-
"[Beneficiary/Offtakers] Payments accrue to cover the [Investor] principle (i.e. total raised amount)",
188-
"Escrow account (eg. capital account) pays off principle to [Investor]"
189-
],
190-
"StateTrigger": [
191-
"[Beneficiary] (eg. Host, Holding) becomes full legal owner of physical assets",
192-
"[Investors] exit the project"
193-
],
194-
"BreachCondition": null
195-
},
196-
{
197-
"Number": 9,
198-
"FriendlyName": "End of Life",
199-
"Name": "Disposal",
200-
"Activities": [
201-
"[IoT] Solar equipment is generating below a productivity threshold, or shows general malfunction",
202-
"[Beneficiaries][Developers] dispose of the equipment to a recycling program",
203-
"[Developer/Recycler] Certifies equipment is received"
204-
],
205-
"StateTrigger": [
206-
"Project termination",
207-
"Wallet terminations"
208-
],
209-
"BreachCondition": null
210-
}
211-
]
212-
```
213-
{% endapi-method-response-example %}
214-
{% endapi-method-response %}
215-
{% endapi-method-spec %}
216-
{% endapi-method %}
2174

2185
{% api-method method="get" host="https://api.openx.solar" path="/stages" %}
2196
{% api-method-summary %}
220-
Get data associated with a specific stage
7+
2218
{% endapi-method-summary %}
2229

22310
{% api-method-description %}

0 commit comments

Comments
 (0)