Skip to main content

Account Registry1.0.0

Building Safety Account Registry API for registering live locations.

Overview

The RapidSOS Account registry is a multifunctional tool for accounting and emergency call direction for our School Safety Solution. 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.

 

School Safety Registration & Accounting

{"uri": "client-id://1234" OR "client-phone://1234567890", (if phone, 10 digit number)
    "data": {
        "Client_Name": "School Name",      ---- string
        "Client_Type": "School",      ---- string
        "Client_Phone": "1234567890",      ---- string, 10 digit number E164 format    
        "Client_ID": "1234",      ---- string
        "Client_City": "New York",       ---- string
        "Client_State": "NY",      ---- string, 2 letter state abbreviation
        "Client_Zip_Code": "10016",      ---- string, 5 digit code
      }

NOTE:

  • Your organization is responsible for updating the end users and removing them if service is cancelled

IMPORTANT SCHOOL SAFETY NOTES:

  • URI:

    • URI can be either a client id OR a telephone number
    • This must match exactly what you are sending within your payload
    • The character limit for a URI is 100

     

About us

We build APIs that share data with first responders to help protect lives.