Overview
The RapidSOS Account registry is a multifunctional tool used for both accounting. Your organization is fully responsible for maintaining records - including inserts, updates, and deletions.
All payload formats must match the specifications below; failure to do so may result in improper accounting.
At any time an update occurs for a URI, all variables need to be sent again
Best Practice is to automatically update end users within the RapidSOS Account Registry when they begin or terminate service.
Commercial / Residential Accounting
{
uri": "client-id://1234",
"data": {
"Client_Name": "RapidSOS", ---- string
"Client_Type": "Enterprise" or "Residential", ---- string
"Client_City": "New York", ---- string
"Client_State": "NY", ---- string, 2 letter state abbreviation
"Client_Zip_Code": "10016", ---- string, 5 digit code
"Client_Permit_Number": "12345", ---- string, alphanumeric, alpha, numeric
"Client_Permit_Expiration": "10/13/2044", ---- string, MM/DD/YYYY formt
}
If your organization is providing services to Commercial or Residential clients, please use the below example to guide you through your development.
NOTES:
- The character limit for a URI is 100
- Your organization is responsible for updating the end users and removing them if service is cancelled
- Permit Number and Expiration
- Some jurisdictions require permit numbers to dispatch. If a residential client has an alarm, they should have their permit number available once they register the alarm with their jurisdiction. If your end user does not have this, they can contact their local city hall to register and provide this number.
- If there is a jurisdiction that requires permits to dispatch and a permit is not on file - dispatch may be denied per ordinance. RapidSOS does not keep a running list of which areas actively require permit numbers. Best practice is to require residential end users to provide this.
- Some jurisdictions require permit numbers to dispatch. If a residential client has an alarm, they should have their permit number available once they register the alarm with their jurisdiction. If your end user does not have this, they can contact their local city hall to register and provide this number.