Neighborly Software API
Sandbox Environment
The Neighborly Software API provides a sandbox environment to support developers during onboarding, testing, and integration.
What Is the Sandbox?
The sandbox is a fully isolated environment that mirrors production functionality, allowing you to safely develop and test your application integrations without affecting live data.
- Contains dummy/test data for simulation
- Accessible via standard API calls
- Also accessible via the Neighborly Portal login interface
- Supports most common onboarding and testing scenarios
Who Has Access?
Access to the sandbox environment is provisioned to:
- Registered developers via the Developer Portal
- Tenant administrators associated with test tenants
If you're unsure about access, contact your account manager or reach out to support.
What Data Is Included?
The sandbox includes pre-populated test datasets that allow developers to:
- Test authentication and authorization flows
- Simulate application and funding processes
- Validate read/write operations
- Experiment with action-executing endpoints (e.g., draws, loans)
No real customer or production data is present in the sandbox.
Differences from Production
The sandbox is designed to behave almost identically to production.
Key notes:
- Rate limits and error handling are the same, but distinct for the sandbox
- Usage does not count toward monthly limits for your production environment
- Data is fixed or periodically refreshed
- Responses and schema are production-mirroring
Last modified on