Yes. XMS is the correct API for this use case. See Getting Started for how to begin.
Not necessarily by default; but Xpansiv can help generate an account and API key for you if you don't already have one. See Authentication for how to generate a key once you have access.
Each installer has its own account and can generate its own API key; this is how the platform is set up today. There is no shared or platform-wide key across installers.
Provide the email address(es) and IP address(es) that need access, and the Xpansiv team will provision the sandbox environment for you. A lead developer will also be assigned as your point of contact for API questions during testing.
Step-by-step information is available on Getting Started.
- Register a facility via
POST /facilities. - Get eligibility and required documents via
GET /facilities/{facility_id}/state_eligibilities. - Upload required documents via
POST /facilities/{facility_id}/documents. - Complete the facility application via
POST /facilities/{facility_id}/complete.
Yes, required documents vary by state. The State Eligibilities endpoint (GET /facilities/{facility_id}/state_eligibilities) returns the authoritative, state-specific list of required documents; don't rely on the single example in the general docs.
They're marked optional specifically so a facility can be created first, with users able to come back and upload meter/panel information afterward. Whether they're ultimately required depends on the specific state application, so treat "optional" as "can be deferred," not "not needed."
A referrer is a partner organization, while the installer is not necessarily a partner. These can be the same company or different companies depending on the deal; they are not interchangeable.
Not always; some fields become required depending on other values or facility conditions, even though they're marked optional by default. For example, hostname is only required if system_leased is true and the facility is located in DC or MD. Don't assume a field marked "not required" is safe to omit in every case — check whether its requirement depends on other fields or the facility's state.
If your system doesn't already capture these, you'll need to source them yourself, for example, by pulling them from a third-party design tool such as Solargraf, and pass them through explicitly when creating the facility.
Yes. This happens on the homeowner-facing side of the integrating partner's application experience, not within the Xpansiv API call itself. The T&Cs are a condensed agreement confirming the information provided is correct and that the applicant has been granted the right to act on the homeowner's behalf to submit the SREC application, with Xpansiv Managed Solutions acting as aggregator.
Confirm the current list of zero-fee/fee-waived states directly with the Xpansiv team, as this affects which facilities can be completed programmatically versus needing manual handling. Note: some states involve extra handling, which may require additional steps outside the standard completion flow. Partners operating mostly outside zero-fee/fee-waived states should plan for a manual or semi-automated fallback.