Sandbox Setup
In order to test making API calls, you will need to have a development app and a SeniorSign sandbox environment.
For development apps, all API endpoints and webhook events (if subscription is requested) are auto-enabled for testing purposes. You should only test the APIs that are approved in your partnership agreement. If there are other APIs you want to use, contact your Partnership Manager.
Create a Development App
- Navigate to the
My Appsarea by clicking your username in the top right-hand corner - In order to access
My Appsyou will need to have 2 factor authentication set up, click here for more details - Click the
+ Create New Appbutton - Complete the form, indicating that this app is for development purposes
Once submitted, your development app will appear in a Pending status. Once your sandbox request is approved (see below), the app status will change to "Approved", and you will be able to view your app's key and secret, required for communicating with the SeniorSign API servers as outlined in the Authentication Overview.
Submit a Sandbox Request
- Navigate to the
My Sandboxesarea by clicking your username in the top right-hand corner - 2 factor authentication is required to access
My Sandboxesalso - Click the
Create Sandboxbutton - Complete the form, indicating the development application you would like to enable on the requested sandbox
Once submitted, your sandbox request will appear in a Pending status, and you should receive an email notification to confirm we received your request. Within two business days, your request will be reviewed and actioned. If approved, you'll receive an email notification to confirm. If not approved, your Partnership Manager will contact you via email to explain what is needed to proceed.
Please note: If you are requesting to onboard a 2nd App to your existing Sandbox, please contact your Partnership Manager.
Accessing your Sandbox Credentials
Once approved, you'll be able to view your sandbox credentials from the My Sandboxes area at any time. You are now provisioned with the necessary credentials & development app keys to start making your first API call – head to this link for more details on making your first API call.
Here you will also find user credentials for testing 3-legged authentication (if applicable) and for accessing the front-end of your SeniorSign sandbox – for more details of how you can leverage front-end access, refer to the Educational Resources page.