The SafeRide Health API allows developers to leverage the powerful SafeRide platform to assist with all of their Non-Emergency Medical Transportation needs.
\nIf you would like access to this API, or have any questions, please fill out a Contact Form.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15419015","collectionId":"6833bb01-6fe2-40bd-a7f4-c409eb4814a3","publishedId":"UyxnFQvS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"286695"},"publishDate":"2023-10-10T18:39:32.000Z"},"item":[{"name":"Authentication","item":[{"name":"V1","item":[{"name":"Get Token","id":"5720cced-6aba-49f4-9b29-778d1dacdaa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientId\": 1234,\n \"clientSecret\": \"example_client_secret\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.saferidehealth.com/v1/token","description":"For the SafeRide Health API V1, a clientId and clientSecret can be used to obtain a Bearer token, which can then be used to access any endpoints under the v1 namespace.
POST Parameters
\n","urlObject":{"protocol":"https","path":["v2","authorize"],"host":["api","saferidehealth","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2824348d-4468-400e-b98b-774ee479a815"},{"name":"Get Access Token","id":"c3149fa0-74df-4523-a0a5-144fe205bb42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"authorizationCode\": \"example_authorization_code\",\n \"clientSecret\": \"example_client_secret\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.saferidehealth.com/v2/token","description":"POST Parameters
\n","urlObject":{"protocol":"https","path":["v2","token"],"host":["api","saferidehealth","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3149fa0-74df-4523-a0a5-144fe205bb42"}],"id":"02f60a45-3678-4aa5-be1f-88dc69a38f20","description":"The SafeRide Health API V2 uses OAuth2 for authentication.
\n","_postman_id":"02f60a45-3678-4aa5-be1f-88dc69a38f20"},{"name":"V3","item":[{"name":"Get Authorization Code","id":"bebe4a65-8add-42eb-9290-9f1c8a12c165","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientId\": \"uT42uTc9dJ\",\n \"scope\": \"member\"\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{gatewayHost}}/v3/authorize","description":"{\n \"clientId\": \"aklsadasdlj\",\n \"scope\": \"ride\"\n}\n\n{\n \"status\": true,\n \"message\": \"Success\",\n \"data\": {\n \"authorizationCode\": \"asfviu3xmoD3Sd4COxrlyVkceZeITg2knmXSnNUNfvgW5kJ9IU8UehEYM4owrek\"\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Scope is required.\",\n \"data\": {},\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\n{\n \"status\" : false,\n \"message\" : \"Scope is invalid.\",\n \"data\": {},\n \"errors\": {},\n \"environment\": \"production\",\n \"httpCode\": 422\n}\n\n{\n \"status\": false,\n \"message\": \"Client ID is required.\",\n \"data\": {},\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\n{\n \"status\" : false,\n \"message\" : \"Client ID is invalid.\",\n \"data\": {},\n \"errors\": {},\n \"environment\": \"production\",\n \"httpCode\": 422\n}\n\n{\n \"authorizationCode\": \"aklsadasdljasdasdasdsadasdasdasdasd\",\n \"clientSecret\": \";asjkfadfadlskfjadsfiewuqwpxm\"\n}\n\n{\n \"status\": true,\n \"message\": \"Success\",\n \"data\": {\n \"accessToken\": \"ljkirH8VrWRfVER3hLGx6qR8z4eFGKVuI8yqdLTQjH3aQzs9pk8umELTGtsleZ0\",\n \"expiry\": 900\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Client Secret is invalid.\",\n \"data\": {},\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nThe SafeRide Health API V2 uses OAuth2 for authentication.
\n","_postman_id":"d7897113-8491-45f7-a104-d8919c17e2ab"}],"id":"1a4bcb22-e335-400e-9346-790abb754a09","description":"This will contain general information about Authentication, and which mechanisms are available in our API.
\nAuthentication is handled differently for each version of the API. See information below:
\n","_postman_id":"1a4bcb22-e335-400e-9346-790abb754a09"},{"name":"Rate Limits","item":[],"id":"2b46f005-3e75-498c-829b-63e7ff52055c","description":"All endpoints are limited to a certain number of requests per minute. Once a limit is reached, all future requests will fail until the limiter resets at the start of the next minute.
\n\n\nFor all v1 endpoints, rate limits are fixed and global. This means that they can not be changed for each client. For v2 endpoints, some limits can be increased and decreased, per client request.
\n
All responses include in their headers helpful information pertaining to the rate limits:
\n{\n \"status\": false,\n \"message\": \"Rate limit exceeded\",\n \"data\": {\n \"limit\": {\n \"limit\": 10,\n \"current\": 11,\n \"remaining\": 0,\n \"resetTime\": 0\n }\n },\n \"errors\": [\n \"ratelimit_exceeded\"\n ],\n \"environment\": \"local\",\n \"httpCode\": 429\n}\n\nRetrieves the list of available ride fulfillment options. Results vary based on whether the ride's transportType is NEMT or ride share:
NEMT
\nThe response is a list of available NEMT companies that can perform the requested ride.
\nRide Share (Uber & Lyft)
\nThe response is a list of available ride sizes.
\nPOST Parameters
\ntransportType Options
{\n \"status\": true,\n \"message\": \"NEMT supply for ride request.\",\n \"httpCode\": 200,\n \"data\": {\n \"requestId\": \"1234abcd\",\n \"expiresIn\": 3600,\n \"companies\": [\n {\n \"id\": 21,\n \"name\": \"Santa Monica Transport\",\n \"rating\": 5,\n \"estimatedCost\": 16.5\n },\n {\n \"id\": 9,\n \"name\": \"Culver City NEMT\",\n \"rating\": 4.7,\n \"estimatedCost\": 19.5\n }\n ]\n },\n \"error\": [],\n \"environment\": \"production\"\n}\n\n{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"location_error\",\n \"fields\": [\n {\n \"apptTime\": \"Please enter an appointment time for today or less than 8 weeks from now\"\n }\n ]\n },\n \"environment\": \"production\"\n}\n\nThis is the final step required to complete booking a ride. This request returns a rideId.
POST Parameters
\nExample Responses
\n{\n \"status\": true,\n \"message\": \"Ride booked\",\n \"httpCode\": 200,\n \"data\": {\n \"rideId\": 12345\n },\n \"errors\": [],\n \"environment\": \"production\"\n}\n\n{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"Invalid_company_id\"\n },\n \"environment\": \"production\"\n}\n\nGets a ride record based on the provided ride_id.
{\n \"status\": true,\n \"message\": \"string\",\n \"httpCode\": 0,\n \"data\": {\n \"rideId\": 0,\n \"status\": \"string\",\n \"confirmationStatus\": \"string\",\n \"location\": {\n \"lat\": \"Unknown Type: double\",\n \"lng\": \"Unknown Type: double\",\n \"etaSeconds\": 0\n },\n \"passenger\": {\n \"phone\": \"(900)555-4321\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"id\": \"1234567\",\n \"patientId\": \"abc123xyz\",\n \"dateOfBirth\": \"2000-01-01\",\n \"notes\": \"Passenger needs an oxygen tank.\"\n },\n \"rideNotes\": \"string\",\n \"appointmentTime\": 0,\n \"pickupTime\": 0,\n \"createdAt\": 0,\n \"updatedAt\": 0,\n \"acceptedAt\": 0,\n \"arrivedAt\": 0,\n \"startedAt\": 0,\n \"completedAt\": 0,\n \"cancelledAt\": 0,\n \"cancelReasonId\": 0,\n \"cancelMessage\": \"string\",\n \"dispatcherManaged\": 0,\n \"pickup\": {\n \"lat\": 37.800583,\n \"lng\": -122.406964,\n \"address\": \"459 Union Street, San Francisco, CA, United States\"\n },\n \"dropoff\": {\n \"lat\": 37.800583,\n \"lng\": -122.406964,\n \"address\": \"459 Union Street, San Francisco, CA, United States\"\n },\n \"company\": {\n \"id\": 21,\n \"name\": \"Santa Monica Transport\",\n \"rating\": 5,\n \"estimatedCost\": 16.5\n },\n \"vehicle\": {\n \"type\": \"AMB\",\n \"licensePlate\": \"12ABC34\"\n },\n \"driver\": {\n \"phone\": \"(800)555-1234\",\n \"firstName\": \"John\",\n \"avatar\": \"https://www.example.com/myavatar.jpeg\"\n },\n \"bookingType\": \"string\",\n \"price\": {\n \"estimatedCost\": 41.55,\n \"finalCost\": 43.24,\n \"cancellationCost\": 20\n },\n \"patientSignature\": \"string\",\n \"odometerReading\": \"string\"\n }\n}\n\ndispatcherManaged options
{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"invalid_ride_id\"\n },\n \"environment\": \"production\"\n}\n\nCancels a given ride and generates a record to track the reason for cancellation.
\nNote that, for multi-leg rides, each leg must be cancelled individually.
\nPOST Parameters
\ncancellationReason Options
Example Responses
\n{\n \"status\": true,\n \"message\": \"Ride cancelled.\",\n \"httpCode\": 200,\n \"data\": {\n \"cancellationCost\": 10\n },\n \"errors\": [],\n \"environment\": \"production\"\n}\n\n{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"Ride_not_found\"\n },\n \"environment\": \"production\"\n}\n\nUpdates the vehicle type for a given ride. This endpoint can also be used for switching ride providers between NEMT, Lyft, and Uber.
\nPOST Parameters
\ntransportType Options
{\n \"status\": true,\n \"message\": \"Ride updated.\",\n \"httpCode\": 200,\n \"data\": [],\n \"errors\": [],\n \"environment\": \"production\"\n}\n\n{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"Ride_not_found\"\n },\n \"environment\": \"production\"\n}\n\nThis endpoint can be used to update either the Pick Up or Drop Off address of a given ride.
\nNote that, for multi-leg rides, each leg will have to be updated individually.
\nPOST Parameters
\n{\n \"status\": true,\n \"message\": \"Ride updated.\",\n \"httpCode\": 200,\n \"data\": {\n \"estimatedCost\": 18.45,\n \"pickupTime\": 1472558808\n },\n \"errors\": [],\n \"environment\": \"production\"\n}\n{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"Ride_not_found\"\n },\n \"environment\": \"production\"\n}\nThis endpoint can be used to update the scheduled date and time for a ride, as well as adding extra time to the expected travel time (see extraTime in table below).
Note that, for multi-leg rides, each leg will have to be updated individually.
\nPOST Parameters
\n{\n \"status\": true,\n \"message\": \"Ride updated.\",\n \"httpCode\": 200,\n \"data\": {\n \"rideStartTime\": 1472558808\n },\n \"errors\": [],\n \"environment\": \"production\"\n}\n\n{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"Ride_not_found\"\n },\n \"environment\": \"production\"\n}\n\nThe ride namespace includes endpoints for booking, managing, and viewing rides in the SafeRide platform.
V1 is deprecated and only accessible for existing clients. New clients should use V2 of the API.
\n","_postman_id":"3d3b44a8-980a-4165-8d75-dc838487a054"},{"name":"V2","item":[{"name":"Rides","item":[{"name":"Get Supply","event":[{"listen":"test","script":{"id":"5fba6520-a6c2-4103-9260-f1b8812bcf64","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","var jsonData = pm.response.json();","pm.globals.set('requestId', jsonData.data.requestId)"],"type":"text/javascript"}}],"id":"819d7810-8e4a-4c94-b432-191a0bf5c127","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{ bearerToken }}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"pickupAddress\": \"100 N Fake Avenue, Los Angeles, California 90034, United States\",\n\t\"dropoffAddress\": \"213 S Unreal Road, Los Angeles, California 90034, United States\",\n\t\"patientId\": \"medi-123456789\",\n\t\"patientFirstName\": \"Jane\",\n\t\"patientLastName\": \"Doe\",\n\t\"patientPhone\": \"1234567890\",\n\t\"patientNotes\": \"This is a custom patient note\",\n\t\"bookingType\": \"tocare\",\n\t\"transportType\": \"AMB\",\n\t\"scheduledTime\": 1654090200,\n\t\"sortResultsBy\" : \"rating\"\n}"},"url":"https://api.saferidehealth.com/v2/ride/supply","description":"Retrieves the list of available ride fulfillment options. Results vary based on whether the ride's transportType is NEMT or ride share:
NEMT
\nThe response is a list of available NEMT companies that can perform the requested ride.
\nRide Share (Uber & Lyft)
\nThe response is a list of available ride sizes.
\nPOST Parameters
\ntransportType Options
{\n \"status\": true,\n \"message\": \"NEMT supply for ride request.\",\n \"httpCode\": 200,\n \"data\": {\n \"requestId\": \"1234abcd\",\n \"expiresIn\": 3600,\n \"companies\": [\n {\n \"id\": 21,\n \"name\": \"Santa Monica Transport\",\n \"rating\": 5,\n \"estimatedCost\": 16.5\n },\n {\n \"id\": 9,\n \"name\": \"Culver City NEMT\",\n \"rating\": 4.7,\n \"estimatedCost\": 19.5\n }\n ]\n },\n \"error\": [],\n \"environment\": \"production\"\n}\n\n{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"location_error\",\n \"fields\": [\n {\n \"apptTime\": \"Please enter an appointment time for today or less than 8 weeks from now\"\n }\n ]\n },\n \"environment\": \"production\"\n}\n\nThis is the final step required to complete booking a ride. This request returns a rideId.
POST Parameters
\nExample Responses
\n{\n \"status\": true,\n \"message\": \"Ride booked\",\n \"httpCode\": 200,\n \"data\": {\n \"rideId\": 12345\n },\n \"errors\": [],\n \"environment\": \"production\"\n}\n\n{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"Invalid_company_id\"\n },\n \"environment\": \"production\"\n}\n\nGets a ride record based on the provided ride_id.
{\n \"status\": true,\n \"message\": \"string\",\n \"httpCode\": 0,\n \"data\": {\n \"rideId\": 0,\n \"status\": \"string\",\n \"confirmationStatus\": \"string\",\n \"location\": {\n \"lat\": \"Unknown Type: double\",\n \"lng\": \"Unknown Type: double\",\n \"etaSeconds\": 0\n },\n \"passenger\": {\n \"phone\": \"(900)555-4321\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"id\": \"1234567\",\n \"patientId\": \"abc123xyz\",\n \"dateOfBirth\": \"2000-01-01\",\n \"notes\": \"Passenger needs an oxygen tank.\"\n },\n \"rideNotes\": \"string\",\n \"appointmentTime\": 0,\n \"pickupTime\": 0,\n \"createdAt\": 0,\n \"updatedAt\": 0,\n \"acceptedAt\": 0,\n \"arrivedAt\": 0,\n \"startedAt\": 0,\n \"completedAt\": 0,\n \"cancelledAt\": 0,\n \"cancelReasonId\": 0,\n \"cancelMessage\": \"string\",\n \"dispatcherManaged\": 0,\n \"pickup\": {\n \"lat\": 37.800583,\n \"lng\": -122.406964,\n \"address\": \"459 Union Street, San Francisco, CA, United States\"\n },\n \"dropoff\": {\n \"lat\": 37.800583,\n \"lng\": -122.406964,\n \"address\": \"459 Union Street, San Francisco, CA, United States\"\n },\n \"company\": {\n \"id\": 21,\n \"name\": \"Santa Monica Transport\",\n \"rating\": 5,\n \"estimatedCost\": 16.5\n },\n \"vehicle\": {\n \"type\": \"AMB\",\n \"licensePlate\": \"12ABC34\"\n },\n \"driver\": {\n \"phone\": \"(800)555-1234\",\n \"firstName\": \"John\",\n \"avatar\": \"https://www.example.com/myavatar.jpeg\"\n },\n \"bookingType\": \"string\",\n \"price\": {\n \"estimatedCost\": 41.55,\n \"finalCost\": 43.24,\n \"cancellationCost\": 20\n },\n \"patientSignature\": \"string\",\n \"odometerReading\": \"string\"\n }\n}\n\ndispatcherManaged options
{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"invalid_ride_id\"\n },\n \"environment\": \"production\"\n}\n\nCancels a given ride and generates a record to track the reason for cancellation.
\nNote that, for multi-leg rides, each leg must be cancelled individually.
\nPOST Parameters
\ncancellationReason Options
Example Responses
\n{\n \"status\": true,\n \"message\": \"Ride cancelled.\",\n \"httpCode\": 200,\n \"data\": {\n \"cancellationCost\": 10\n },\n \"errors\": [],\n \"environment\": \"production\"\n}\n\n{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"Ride_not_found\"\n },\n \"environment\": \"production\"\n}\n\nUpdates the vehicle type for a given ride. This endpoint can also be used for switching ride providers between NEMT, Lyft, and Uber.
\nPOST Parameters
\ntransportType Options
{\n \"status\": true,\n \"message\": \"Ride updated.\",\n \"httpCode\": 200,\n \"data\": [],\n \"errors\": [],\n \"environment\": \"production\"\n}\n\n{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"Ride_not_found\"\n },\n \"environment\": \"production\"\n}\n\nThis endpoint can be used to update either the Pick Up or Drop Off address of a given ride.
\nNote that, for multi-leg rides, each leg will have to be updated individually.
\nPOST Parameters
\n{\n \"status\": true,\n \"message\": \"Ride updated.\",\n \"httpCode\": 200,\n \"data\": {\n \"estimatedCost\": 18.45,\n \"pickupTime\": 1472558808\n },\n \"errors\": [],\n \"environment\": \"production\"\n}\n{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"Ride_not_found\"\n },\n \"environment\": \"production\"\n}\nThis endpoint can be used to update the scheduled date and time for a ride, as well as adding extra time to the expected travel time (see extraTime in table below).
Note that, for multi-leg rides, each leg will have to be updated individually.
\nPOST Parameters
\n{\n \"status\": true,\n \"message\": \"Ride updated.\",\n \"httpCode\": 200,\n \"data\": {\n \"rideStartTime\": 1472558808\n },\n \"errors\": [],\n \"environment\": \"production\"\n}\n\n{\n \"status\": false,\n \"message\": \"Error Message.\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"Error\": \"Ride_not_found\"\n },\n \"environment\": \"production\"\n}\n\nFind Ride by passengerId or clientMemo
POST Parameters
\nExample Responses
\n{\n \"status\": true,\n \"message\": \"Successfully retrieved rides.\",\n \"httpCode\": 200,\n \"data\": {\n \"rideId\": [12345, 12346]\n },\n \"errors\": [],\n \"environment\": \"production\"\n}\n\n{\n \"status\": false,\n \"message\": \"No valid results to return\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"type\": \"no_results\",\n \"message\": \"No valid results to return\"\n },\n \"environment\": \"production\"\n}\n\nThe ride namespace includes endpoints for booking, managing, and viewing rides in the SafeRide platform.
Verifies that a member (patient) is eligible for care through the SafeRide platform. Members who are not eligible will not be able to book new rides. A successful response will also include other details on file about the requested member.
\nPOST Parameters
\nParameter Requirements
\nParameters must satisfy one of the following in order to uniquely identify a patient:
\npatientId AND:dateOfBirth ORpatientFirstName AND patientLastName ORpatientPhonepassengerId ANDdateOfBirth ORpatientFirstName AND patientLastName ORpatientPhonedateOfBirth AND patientFirstName AND patientLastNamedateOfBirth AND patientPhoneExample Responses
\n* 200 - Successful Operation
\n{\n \"status\": true,\n \"message\": \"Successfully retrieved member-eligiblity info.\",\n \"data\": [\n {\n \"subPlanId\": 0,\n \"subPlanName\": \"Self-Funded\",\n \"planId\": 0,\n \"planName\": \"Self-Funded\",\n \"passengerId\": 1234,\n \"patientId\": \"MEDI-1\",\n \"patientFirstName\": \"Jane\",\n \"patientLastName\": \"Doe\",\n \"dateOfBirth\": \"1990-01-01\",\n \"homeAddress\": \"106 Jefferson St 3rd Fl., San Antonio, TX 78205\",\n \"patientPhone\": \"(123) 123-1233\",\n \"patientNotes\": \"Example patient notes.\",\n \"eligibilityStartDate\": \"2000-01-01 00:00:00\",\n \"eligibilityEndDate\": \"2030-01-01 00:00:00\",\n \"isEligible\": 1,\n \"memberDefaultMode\": \"Private\",\n \"memberDefaultMobiltyType\": \"AMB\",\n \"memberDefaultSubMobilityType\": \"No Minibus\",\n \"assistanceNeeds\": [\n \"Crutches\"\n ],\n \"memberRideBenefitRidesPerYear\": 60,\n \"memberRideBenefitRidesPerYearUsage\": 42,\n \"memberRideBenefitRidesPerMonth\": 5,\n \"memberRideBenefitRidesPerMonthUsage\": 2,\n \"memberRideBenefitCostPerYear\": null,\n \"memberRideBenefitCostPerYearUsage\": null\n }\n ],\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n* 400 - Invalid Request Parameters
\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"too_few_required_fields\",\n \"message\": \"Must pass: 1. (patientId or passengerId) + (dateOfBirth or patientPhone or (patientFirstName + patientLastName)) OR 2. dateOfBirth + patientFirstName + patientLastName\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nThe member namespace includes endpoints for accessing patient information, such as their eligibility.
All future clients, and when possible, all current clients, should use Version 2 of the API. See all available endpoints below:
\n","_postman_id":"2c5f3629-1b01-4265-bda0-7dd2672d3fa9"},{"name":"V3","item":[{"name":"Account","item":[{"name":"Funding Sources","id":"12007d1e-f059-49d0-9758-82930ba17b6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.saferidehealth.com/v3/account/fundingSource","description":"{\n \"status\": true,\n \"message\": \"Successfully retrieved available Health Plans\",\n \"data\": [\n {\n \"planId\": 7,\n \"planName\": \"First HealthPlan\",\n \"subPlans\": [\n {\n \"subPlanId\": 51,\n \"subPlanName\": \"Sub Plan Name\",\n \"treatmentsEnabled\": false,\n \"approvedProvidersEnabled\": false,\n \"approvedProvidersBlock\": true,\n \"addNewMembers\": true,\n \"toCareMilesPerRide\": 50,\n \"toCareMilesPerRideBlock\": true,\n \"fromCareMilesPerRide\": 3,\n \"fromCareMilesPerRideBlock\": true,\n \"ridesPerYear\": 0,\n \"ridesPerYearBlock\": false,\n \"costPerYear\": 0,\n \"costPerYearBlock\": false,\n \"ridesPerMonth\": 0,\n \"ridesPerMonthBlock\": false\n },\n {\n \"subPlanId\": 52,\n \"subPlanName\": \"Another SubPlan\",\n \"treatmentsEnabled\": false,\n \"approvedProvidersEnabled\": false,\n \"approvedProvidersBlock\": true,\n \"addNewMembers\": false,\n \"toCareMilesPerRide\": 0,\n \"toCareMilesPerRideBlock\": false,\n \"fromCareMilesPerRide\": 0,\n \"fromCareMilesPerRideBlock\": false,\n \"ridesPerYear\": 0,\n \"ridesPerYearBlock\": false,\n \"costPerYear\": 0,\n \"costPerYearBlock\": false,\n \"ridesPerMonth\": 0,\n \"ridesPerMonthBlock\": false\n }\n ]\n },\n {\n \"planId\": 5,\n \"planName\": \"Plan Second\",\n \"subPlans\": [\n {\n \"subPlanId\": 15,\n \"subPlanName\": \"Sub Plan second\",\n \"treatmentsEnabled\": false,\n \"approvedProvidersEnabled\": false,\n \"approvedProvidersBlock\": true,\n \"addNewMembers\": false,\n \"toCareMilesPerRide\": 456,\n \"toCareMilesPerRideBlock\": false,\n \"fromCareMilesPerRide\": 789,\n \"fromCareMilesPerRideBlock\": true,\n \"ridesPerYear\": 0,\n \"ridesPerYearBlock\": false,\n \"costPerYear\": 0,\n \"costPerYearBlock\": false,\n \"ridesPerMonth\": 0,\n \"ridesPerMonthBlock\": false\n }\n ]\n }\n ],\n \"errors\": [],\n \"environment\": \"local\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"No valid results to return\",\n \"httpCode\": 400,\n \"data\": [],\n \"errors\": {\n \"type\": \"no_results\",\n \"message\": \"No valid results to return\"\n },\n \"environment\": \"production\"\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n{\n \"subPlanId\": 1,\n \"paginationOffset\": 0,\n \"paginationLimit\": 200\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully retrieved available treatments.\",\n \"data\": {\n {\n \"id\": 113831,\n \"name\": \"Acupuncture\",\n \"description\": \"\",\n \"code\": \"\"\n },\n {\n \"id\": 113832,\n \"name\": \"Alcohol Abuse Evaluation to Enter Treatment\",\n \"description\": \"\",\n \"code\": \"\"\n },\n {\n \"id\": 113833,\n \"name\": \"Alcohol Treatment Rehabilitation\",\n \"description\": \"\",\n \"code\": \"\"\n }\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_subplanid_type\",\n \"message\": \"Invalid type for subPlanId\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\nExample:
\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_paginationoffset_format\",\n \"code\": 422,\n \"message\": \"Must be a digit from 0 to 10\"\n },\n {\n \"type\": \"invalid_paginationlimit_format\",\n \"code\": 422,\n \"message\": \"Must be a digit from 0 to 200\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 422\n}\n\n{\n \"userInput\": \"I need a ride to a back appointment\",\n \"subPlanId\": 70\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully retrieved available treatment matches.\",\n \"data\": {\n \"treatment_type\": \"treatments\",\n \"treatment_matches\": [\n {\n \"treatment_id\": 12345,\n \"treatment_name\": \"Physical Therapy\",\n \"rank\": 1\n },\n {\n \"treatment_id\": 67890,\n \"treatment_name\": \"Chiropractic Services\",\n \"rank\": 2\n },\n {\n \"treatment_id\": 67894,\n \"treatment_name\": \"Gym\",\n \"rank\": 3\n }\n ]\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"The subPlanId provided is not associated with this account\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_subplan_id\",\n \"code\": 400,\n \"message\": \"The subPlanId provided is not associated with this account\"\n }\n ],\n \"environment\": \"local\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n{\n \"approvedProviderSearchValue\": \"tylor\",\n \"paginationOffset\": 0,\n \"paginationLimit\": 10\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully retrieved available approved providers.\",\n \"data\": {\n \"total\": 1,\n \"approvedProviders\": [\n {\n \"id\": 10,\n \"name\": \"provider name\",\n \"aliases\": \"provider alias\",\n \"address\": \"provider address\",\n \"phone\": \"1231231234\",\n \"npi\": \"1295765469\"\n }\n ]\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_approvedprovidersearchvalue_type\",\n \"message\": \"Invalid type for approvedProviderSearchValue\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\n{\n \"providerName\": \"John\",\n \"providerAddress\": \"106 Jefferson St\",\n \"providerPhone\": \"1234567890\",\n \"providerSuite\": \"300\"\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully retrieved available approved providers.\",\n \"data\": {\n \"total\": 2,\n \"approvedProviders\": [\n {\n \"id\": 4404342,\n \"name\": \"ROBERT H HANSEN III\",\n \"address\": \"5320 E CENTRAL TEXAS EXPY STE 105 KILLEEN TX 76543\",\n \"phone\": \"1234567890\",\n \"npi_number\": \"1902142870\",\n \"system_id\": \"6DEEF587-994F-4725-8907-CC2D39764A37\"\n },\n {\n \"id\": 4223138,\n \"name\": \"ROBYN A BOLES\",\n \"address\": \"106 S Jefferson Ave STE 101 Mount Pleasant TX 75455\",\n \"phone\": \"9033748040\",\n \"npi_number\": \"1205314705\",\n \"system_id\": \"EA4CC58A-B3E4-49FD-8950-70DCDD91BE80\"\n }\n ]\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_providername_type\",\n \"message\": \"Invalid type for providerName\"\n },\n {\n \"type\": \"invalid_provideraddress_type\",\n \"message\": \"Invalid type for providerAddress\"\n },\n {\n \"type\": \"invalid_providerphone_type\",\n \"message\": \"Invalid type for providerPhone\"\n },\n {\n \"type\": \"invalid_providersuite_type\",\n \"message\": \"Invalid type for providerSuite\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully retrieved available custom fields.\",\n \"data\": {\n \"customFields\": [\n {\n \"id\": 12,\n \"name\": \"Billing Category\",\n \"dependent\": 0,\n \"values\": [\n {\n \"id\": 123,\n \"name\": \"ABA Therapy\"\n },\n {\n \"id\": 456,\n \"name\": \"CD Tx - Methadone\"\n }\n ]\n },\n ]\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Criteria provided returned no results\",\n \"data\": {},\n \"errors\": {\n \"type\": \"no_results\",\n \"message\": \"Criteria provided returned no results\"\n },\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully retrieved available custom field.\",\n \"data\": {\n \"customField\": {\n \"id\": 123,\n \"name\": \"Trip Type\",\n \"dependent\": 1,\n \"values\": [\n {\n \"id\": 1234,\n \"name\": \"GEN\"\n },\n {\n \"id\": 2345,\n \"name\": \"ER\"\n }\n ]\n }\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Criteria provided returned no results\",\n \"data\": {},\n \"errors\": {\n \"type\": \"no_results\",\n \"message\": \"Criteria provided returned no results\"\n },\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\n{\n \"passengerId\": 12345,\n \"treatmentId\": 620,\n \"clientMemo\": \"test client memo\",\n \"startDateSearch\": 1672593892,\n \"endDateSearch\": 1675099492\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully retrieved rides.\",\n \"data\": {\n \"rides\": [\n {\n \"id\": 120384,\n \"tripId\": 59734,\n \"tripRides\": [\n 120383,\n 120384\n ],\n \"recurringId\": null,\n \"recurringRides\": [],\n \"status\": \"Scheduled\",\n \"rideStartTime\": 1676776087,\n \"rideTimezone\": \"America/Chicago\",\n \"bookedAsWillCall\": 0,\n \"cancelReasonId\": null\n },\n {\n \"id\": 120432,\n \"tripId\": 59782,\n \"tripRides\": [\n 120432\n ],\n \"recurringId\": null,\n \"recurringRides\": [],\n \"status\": \"Scheduled\",\n \"rideStartTime\": 1718849287,\n \"rideTimezone\": \"America/Chicago\",\n \"bookedAsWillCall\": 0,\n \"cancelReasonId\": null\n\n },\n {\n \"id\": 120198,\n \"tripId\": 59595,\n \"tripRides\": [\n 120198\n ],\n \"recurringId\": 1761,\n \"recurringRides\": [\n 120192,\n 120193,\n 120194,\n 120195,\n 120196,\n 120197,\n 120198,\n 120199\n ],\n \"status\": \"Cancelled\",\n \"rideStartTime\": 1676776087,\n \"rideTimezone\": \"America/Chicago\",\n \"bookedAsWillCall\": 1,\n \"cancelReasonId\": 5\n\n }\n ]\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_passengerid_type\",\n \"message\": \"Invalid type for passengerId\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\n{\n \"pickup\": {\n \"address\": \"888 East Slauson Avenue, Los Angeles, California 90011, United States\"\n },\n \"dropoff\": {\n \"address\": \"6200 Washington Boulevard, Culver City, California 90232, United States\"\n },\n \"member\": {\n \"passengerId\": 114394\n },\n \"additionalPassengers\": [\n {\n \"ageGroup\": \"child\",\n \"firstName\": \"zia\",\n \"lastName\": \"rehman\",\n \"mobilityType\": \"AMB\",\n \"subMobilityType\":\"No Taxi\",\n \"isAttendant\": 0\n }\n ],\n \"customField\": {\n \"HNO_custom_field\": 1,\n \"Custom field2\": 1\n },\n \"isWillCall\": 0,\n \"pickupTime\": \"1675463481\",\n \"memberMobilityType\": \"AMB\",\n \"sortResultsBy\" : \"rating\",\n \"clientMemo\": \"Zia client Memo\"\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully Book Ride\",\n \"data\": [\n \"requestId\": \"fff7935f21f9a6dbf4ce6871b74dcb12\",\n \"expiresIn\": 3600,\n \"transportProviders\": [\n {\n \"id\": 123,\n \"name\": \"ABC transpoters\",\n \"rating\": 5,\n \"estimatedCost\": 15.2\n },\n {\n \"id\": 234,\n \"name\": \"XYZ transpoters\",\n \"rating\": 4,\n \"estimatedCost\": 19.02\n },\n ]\n ],\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_pickupaddress_type\",\n \"message\": \"Invalid type for pickupAddress\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\n{\n \"requestId\": \"fff7935f21f9a6dbf4ce6871b74dcb12\",\n \"providerTransportId\": \"12\",\n \"tripId\": 12345\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully Book Ride\",\n \"data\": {\n \"rideId\": 1234,\n \"tripId\": 12345,\n \"tripRides\": [\n 1212,\n 1234\n ],\n \"pickupTime\": 1472558808,\n \"createdAt\" : 1472558808\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_requestid_type\",\n \"message\": \"Invalid type for requestId\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n{\n \"status\": true,\n \"message\": \"Ride info provided.\",\n \"data\": {\n \"rideId\": 123123,\n \"status\": \"Scheduled\",\n \"confirmationStatus\": \"unconfirmed\",\n \"driverLocation\": {\n \"lat\": null,\n \"lng\": null,\n \"eta\": null\n },\n \"member\": {\n \"phone\": null,\n \"firstName\": \"bob\",\n \"lastName\": \"bob\",\n \"passengerId\": 1231234,\n \"memberId\": \"123\",\n \"dateOfBirth\": null,\n \"notes\": null\n },\n \"memberMode\": \"Private\",\n \"memberMobilityType\": \"UBR\",\n \"memberSubMobilityType\": \"\",\n \"memberAssistanceNeeds\": \"\",\n \"additionalPassengers\": [],\n \"pickup\": {\n \"pickupAddress\": \"432 Bridget Drive, Converse, Texas 78109, United States\",\n \"pickupLat\": \"29.518435\",\n \"pickupLng\": \"-98.322440\",\n \"pickupApprovedProviderId\": \"\"\n },\n \"dropoff\": {\n \"dropoffAddress\": \"876 Randolph Afb, Randolph AFB, Texas 78150, United States\",\n \"dropoffLat\": \"29.524040\",\n \"dropoffLng\": \"-98.280920\",\n \"dropoffApprovedProviderId\": \"\"\n },\n \"pickupTime\": 0,\n \"appointmentTime\": 0,\n \"rideTimezone\":\"America/Chicago\",\n \"bookedAsWillCall\": 0,\n \"extraTime\": 0,\n \"createdAt\": 1675615975,\n \"updatedAt\": 1675670403,\n \"acceptedAt\": 0,\n \"arrivedAt\": 0,\n \"startedAt\": 0,\n \"completedAt\": 0,\n \"confirmedAt\": 0,\n \"cancelledAt\": 0,\n \"cancelReasonId\": null,\n \"cancelMessage\": \"\",\n \"dispatcherManaged\": 0,\n \"customFields\": [\n {\n \"id\": 123,\n \"name\": \"Custom Field 1\",\n \"dependent\": 0,\n \"values\": [\n {\n \"id\": 12345,\n \"name\": \"option1\"\n },\n {\n \"id\": 23456,\n \"name\": \"option1\"\n },\n {\n \"id\": 34567,\n \"name\": \"option3\"\n }\n ]\n },\n {\n \"id\": 234,\n \"name\": \"Custom field 2\",\n \"dependent\": 0,\n \"values\": [\n {\n \"id\": 23456,\n \"name\": \"option1\"\n },\n {\n \"id\": 34567,\n \"name\": \"option2\"\n },\n {\n \"id\": 45678,\n \"name\": \"option3\"\n }\n ]\n }\n ],\n \"treatmentValue\": null,\n \"clientMemo\": \"\",\n \"clientMeta\": null,\n \"transportProvider\": {\n \"transportProviderId\": 12,\n \"transportProviderName\": null,\n \"transportProviderRating\": 0,\n \"mainlinePhone\": null\n },\n \"vehicle\": {\n \"vehicleMake\": null,\n \"vehicleModel\": null,\n \"vehicleColor\": null,\n \"vehicleLicensePlate\": null,\n \"vehicleType\": \"SDN\"\n },\n \"driver\": {\n \"driverPhone\": null,\n \"driverFirstName\": null,\n \"driverAvatar\": null\n },\n \"bookingType\": \"fromcare\",\n \"price\": {\n \"estimatedCost\": \"55\",\n \"finalCost\": \"0.00\",\n \"cancellationCost\": \"0.00\"\n },\n \"memberSignature\": null,\n \"odometerReading\": null,\n \"updateTimeInProgress\": false\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_rideid_value\",\n \"message\": \"rideId not associated with this account\"\n }\n ],\n \"environment\": \"sandbox\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n401
\n403
\n400
\n422
\n409
\n404
\n{\n \"cancellationReasonId\": 6,\n \"cancellationMessage\": \"my notes here\"\n}\n\ncancellationReasonId Options Table{\n \"status\": true,\n \"message\": \"Successfully cancelled ride.\",\n \"data\": {\n \"cancellationCost\": 20\n },\n \"errors\": [],\n \"environment\": \"sandbox\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_rideid_value\",\n \"message\": \"rideId not associated with this account\"\n }\n ],\n \"environment\": \"sandbox\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n{\n \"addressType\": \"pickup\",\n \"address\": \"6125 washington blvd, Culver City, CA 90025\",\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully updated address.\",\n \"data\": {\n \"rideId\": 1234,\n \"ride\": {\n \"pickup\": {\n \"pickupAddress\": \"432 Bridget Drive, Converse, Texas 78109, United States\",\n \"pickupLat\": \"29.518435\",\n \"pickupLng\": \"-98.322440\",\n \"pickupApprovedProviderId\": \"\"\n },\n \"dropoff\": {\n \"dropoffAddress\": \"876 Randolph Afb, Randolph AFB, Texas 78150, United States\",\n \"dropoffLat\": \"29.524040\",\n \"dropoffLng\": \"-98.280920\",\n \"dropoffApprovedProviderId\": \"\"\n },\n \"pickupTime\": 0,\n \"appointmentTime\": 0,\n \"extraTime\": 0\n }\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_addresstype_type\",\n \"message\": \"Invalid type for addressType\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\n{\n \"isWillCall\": 0,\n \"scheduledTime\": 1677214752,\n \"extraTime\": 2\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully updated ride time\",\n \"data\": {\n \"pickupTime\": 1677214752\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"ineligible_pickup_date\",\n \"message\": \"pickupTime date outside of eligibility date range\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n401
\n403
\n400
\n422
\n409
\n404
\n{\n \"isWillCall\": 0,\n \"scheduledTime\": 1677214752,\n \"extraTime\": 2\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully queued update ride time job\",\n \"data\": [],\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"ineligible_pickup_date\",\n \"message\": \"pickupTime date outside of eligibility date range\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n401
\n403
\n400
\n422
\n409
\n404
\n{\n \"memberMobilityType\": \"AMB\",\n \"memberSubMobilityType\": \"No Minibus\"\n \"memberAssistanceNeeds\": [\"Crutches\"]\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully updated ride.\",\n \"data\": {\n \"estimatedCost\": 42.55\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_rideid_value\",\n \"message\": \"rideId not associated with this account\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\n{\n \"additionalPassengers\": [\n {\n \"ageGroup\": \"adult\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"mobilityType\": \"AMB\",\n \"isAttendant\": true\n }\n ]\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully updated additional passengers.\",\n \"data\": [],\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_addresstype_type\",\n \"message\": \"Invalid type for addressType\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\nExample:
\n","urlObject":{"protocol":"https","path":["v3","rides","{{rideId}}","updateAdditionalPassengers"],"host":["api","saferidehealth","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e1e1d12d-a186-4ce3-b387-8dbf88d32aeb"},{"name":"Search Addresses","id":"a9703713-2baa-4c79-8d0b-3918b5b53484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.saferidehealth.com/v3/rides/addressSearch","description":"{\n \"addresses\" : [\n \"walmart, san antonio\", \n \"6125 washington blvd, culver city\", \n \"345 main\", \n \" 444 main\", \n \"888 main\"\n ]\n}\n\n{\n \"status\": true,\n \"message\": \"Address list.\",\n \"data\": {\n \"walmart, san antonio\": [{\n \"latitude\": 29.258175,\n \"longitude\": -98.540924,\n \"formatted_address\": \"Walmart, 1 Lone Star Pass Building 46, San Antonio, Texas 78264, United States\",\n \"zipcode\": \"78264\",\n \"relevance\": 1\n }, {\n \"latitude\": 29.564014,\n \"longitude\": -98.594742,\n \"formatted_address\": \"Walmart Supercenter, 5555 De Zavala Rd, San Antonio, Texas 78249, United States\",\n \"zipcode\": \"78249\",\n \"relevance\": 0.982963\n }, {\n \"latitude\": 29.487683,\n \"longitude\": -98.537294,\n \"formatted_address\": \"Walmart Supercenter, 1603 Vance Jackson Rd, San Antonio, Texas 78213, United States\",\n \"zipcode\": \"78213\",\n \"relevance\": 0.982963\n }, {\n \"latitude\": 29.443001,\n \"longitude\": -98.642445,\n \"formatted_address\": \"Walmart Supercenter, 8923 W Military Dr, San Antonio, Texas 78245, United States\",\n \"zipcode\": \"78245\",\n \"relevance\": 0.982963\n }, {\n \"latitude\": 29.592067,\n \"longitude\": -98.355786,\n \"formatted_address\": \"Walmart Supercenter, 16503 Nacogdoches Rd, San Antonio, Texas 78247, United States\",\n \"zipcode\": \"78247\",\n \"relevance\": 0.982963\n }],\n \"6125 washington blvd, culver city\": [{\n \"latitude\": 34.03141,\n \"longitude\": -118.378487,\n \"formatted_address\": \"6125 Washington Boulevard, Culver City, California 90232, United States\",\n \"zipcode\": \"90232\",\n \"relevance\": 1\n }],\n \"345 main\": [{\n \"latitude\": 45.18891,\n \"longitude\": -67.27861,\n \"formatted_address\": \"345 Main Street, Calais, Maine 04619, United States\",\n \"zipcode\": \"04619\",\n \"relevance\": 1\n }, {\n \"latitude\": 44.69679,\n \"longitude\": -67.39483,\n \"formatted_address\": \"345 Port Road, Machiasport, Maine 04655, United States\",\n \"zipcode\": \"04655\",\n \"relevance\": 1\n }, {\n \"latitude\": 40.36097,\n \"longitude\": -81.43138,\n \"formatted_address\": \"345 East Main Street, Gnadenhutten, Ohio 44629, United States\",\n \"zipcode\": \"44629\",\n \"relevance\": 1\n }, {\n \"latitude\": 40.15788,\n \"longitude\": -81.57556,\n \"formatted_address\": \"345 Main Street, Kimbolton, Ohio 43749, United States\",\n \"zipcode\": \"43749\",\n \"relevance\": 1\n }, {\n \"latitude\": 40.71096,\n \"longitude\": -81.60284,\n \"formatted_address\": \"345 Main Street Southwest, Brewster, Ohio 44613, United States\",\n \"zipcode\": \"44613\",\n \"relevance\": 1\n }],\n \" 444 main\": [{\n \"latitude\": 44.68335,\n \"longitude\": -67.18237,\n \"formatted_address\": \"444 Number Nine Road, Cutler, Maine 04626, United States\",\n \"zipcode\": \"04626\",\n \"relevance\": 1\n }, {\n \"latitude\": 45.17095,\n \"longitude\": -67.28943,\n \"formatted_address\": \"444 North Street, Calais, Maine 04619, United States\",\n \"zipcode\": \"04619\",\n \"relevance\": 1\n }, {\n \"latitude\": 44.792267,\n \"longitude\": -67.173859,\n \"formatted_address\": \"444 Maine Highway 1, Whiting, Maine 04691, United States\",\n \"zipcode\": \"04691\",\n \"relevance\": 1\n }, {\n \"latitude\": 44.70215,\n \"longitude\": -67.348908,\n \"formatted_address\": \"444 Cutler Road, Machiasport, Maine 04626, United States\",\n \"zipcode\": \"04626\",\n \"relevance\": 1\n }, {\n \"latitude\": 45.123911,\n \"longitude\": -67.333348,\n \"formatted_address\": \"444 Maine Highway 1, Baring, Maine 04694, United States\",\n \"zipcode\": \"04694\",\n \"relevance\": 1\n }],\n \"888 main\": [{\n \"latitude\": 39.539135,\n \"longitude\": -82.39424,\n \"formatted_address\": \"888 East Main Street, Logan, Ohio 43138, United States\",\n \"zipcode\": \"43138\",\n \"relevance\": 1\n }, {\n \"latitude\": 44.816688,\n \"longitude\": -67.06462,\n \"formatted_address\": \"888 County Road, Lubec, Maine 04652, United States\",\n \"zipcode\": \"04652\",\n \"relevance\": 1\n }, {\n \"latitude\": 44.7926,\n \"longitude\": -67.173685,\n \"formatted_address\": \"888 Maine Highway 1, Whiting, Maine 04691, United States\",\n \"zipcode\": \"04691\",\n \"relevance\": 1\n }, {\n \"latitude\": 45.180935,\n \"longitude\": -67.259474,\n \"formatted_address\": \"888 Main Street, Calais, Maine 04619, United States\",\n \"zipcode\": \"04619\",\n \"relevance\": 1\n }, {\n \"latitude\": 44.88214,\n \"longitude\": -67.330437,\n \"formatted_address\": \"888 King Street, Marion Township, Maine 04628, United States\",\n \"zipcode\": \"04628\",\n \"relevance\": 1\n }]\n },\n \"errors\": [],\n \"environment\": \"sandbox\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_address_search_type\",\n \"message\": \"Invalid type for addresses\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\nExample:
\n","urlObject":{"protocol":"https","path":["v3","rides","addressSearch"],"host":["api","saferidehealth","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9703713-2baa-4c79-8d0b-3918b5b53484"},{"name":"Ride Status History","id":"4342350a-33bd-484d-8001-7dc2f83643f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.saferidehealth.com/v3/rides/{{rideId}}/status-history","description":"{\n \"status\": true,\n \"message\": \"Ride status history\",\n \"data\": {\n \"rideId\": 120552,\n \"statusHistory\": [\n {\n \"previousStatus\": \"Scheduled\",\n \"currentStatus\": \"COMPLETED\",\n \"timestamp\": 1688394195,\n \"changedBy\": \"Sandbox HNO\"\n },\n {\n \"previousStatus\": \"Completed\",\n \"currentStatus\": \"COMPLETED\",\n \"timestamp\": 1688394518,\n \"changedBy\": \"Sandbox HNO\"\n },\n {\n \"previousStatus\": \"unconfirmed\",\n \"currentStatus\": \"confirmed\",\n \"timestamp\": 1717140774,\n \"changedBy\": \"Cobalt Test\"\n },\n {\n \"previousStatus\": null,\n \"currentStatus\": \"Scheduled\",\n \"timestamp\": 1717776163,\n \"changedBy\": \"Estela Barrera\"\n }\n ]\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_rideid_value\",\n \"message\": \"rideId not associated with this account\"\n }\n ],\n \"environment\": \"sandbox\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n{\n \"memberId\": \"my-medical-id\",\n \"planId\": 1,\n \"subPlanId\": 1,\n \"memberFirstName\": \"Jane\",\n \"memberLastName\": \"Doe\",\n \"memberDateOfBirth\": \"1990-01-01\",\n \"memberHomeAddress\": \"6200 Washington Boulevard, Culver City, California 90232, United States\",\n \"memberPhone\": \"1234567890\",\n \"memberNotes\": \"Details about patient\",\n \"memberEmail\": \"jane.doe@saferidehealth.com\",\n \"memberDefaultMode\": \"Private\",\n \"memberDefaultMobilityType\": \"AMB\",\n \"memberDefaultSubMobilityType\": \"Wheelchair\",\n \"memberAssistanceNeeds\": [\"Cane\", \"Wheelchair\"],\n \"eligibilityStartDate\": \"2020-01-01\",\n \"eligibilityEndDate\": \"2030-01-01\",\n \"isEligible\": true\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully added new member.\",\n \"data\": {\n \"passengerId\": 12345\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"memberid_required\",\n \"message\": \"memberId is required\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\nBody
\nParameter Requirements
\nIf 'Eligibility API' feature is turned OFF for Hospital Network, parameters must satisfy one of the following in order to uniquely identify a patient:
\nmemberId AND:
memberDateOfBirth OR
memberFirstName AND memberLastName OR
memberPhone
passengerId AND
memberDateOfBirth OR
memberFirstName AND memberLastName OR
memberPhone
memberDateOfBirth AND memberFirstName AND memberLastName
memberDateOfBirth AND memberPhone
If 'Eligibility API' feature is turned ON for Hospital Network, parameters must satisfy one of the following in order to uniquely identify a patient:
\nmemberId
memberId OR
memberDateOfBirth OR
memberFirstName AND memberLastName OR
memberPhone
memberDateOfBirth AND memberFirstName AND memberLastName
memberDateOfBirth AND memberPhone
memberPhone AND memberFirstName AND memberLastName
Example Responses
\n{\n \"status\": true,\n \"message\": \"Successfully found member(s).\",\n \"data\": [\n {\n \"subPlanId\": 0,\n \"subPlanName\": \"Self-Funded\",\n \"benefitsProgram\": \"medicare\",\n \"dSnp\": 1,\n \"planId\": 0,\n \"planName\": \"Self-Funded\",\n \"timezone\": \"America/Los_Angeles\",\n \"passengerId\": 1234,\n \"patientId\": \"MEDI-1\",\n \"memberFirstName\": \"Jane\",\n \"memberLastName\": \"Doe\",\n \"dateOfBirth\": \"1990-01-01\",\n \"homeAddress\": \"106 Jefferson St 3rd Fl., San Antonio, TX 78205\",\n \"memberPhone\": \"(123) 123-1233\",\n \"memberNotes\": \"Example patient notes.\",\n \"eligibilityStartDate\": \"2000-01-01 00:00:00\",\n \"eligibilityEndDate\": \"2030-01-01 00:00:00\",\n \"isEligible\": 1,\n \"memberDefaultMode\": \"Private\",\n \"memberDefaultMobiltyType\": \"AMB\",\n \"memberDefaultSubMobilityType\": \"No Minibus\",\n \"assistanceNeeds\": [\n \"Crutches\"\n ],\n \"memberUpcomingRides\": 1,\n \"memberRideBenefitRidesPerYear\": 60,\n \"memberRideBenefitRidesPerYearUsage\": 42,\n \"memberRideBenefitRidesPerMonth\": 5,\n \"memberRideBenefitRidesPerMonthUsage\": 2,\n \"memberRideBenefitCostPerYear\": null,\n \"memberRideBenefitCostPerYearUsage\": null,\n \"memberIdentifier\": \"U9oqsbClgDwFzlWgzWrzrv9S5Mpikip1+wPw7cB6+1c=\"\n \"phoneType\": \"mobile\",\n \"isFlagged\": false,\n \"isManualSchedule\": false\n }\n ],\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"too_few_required_fields\",\n \"message\": \"Must pass: 1. (memberId or passengerId) + (memberDateOfBirth or memberPhone or (memberFirstName + memberLastName)) OR 2. memberDateOfBirth + memberFirstName + memberLastName\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n401
\n403
\n400
\n422
\n409
\n404
\nBody
\nExample Responses
\n{\n \"status\": true,\n \"message\": \"Successfully retrieved\",\n \"data\": [\n {\n \"memberId\": \"member1\"\n \"memberFirstName\": \"J***\",\n \"memberLastName\": \"D**\",\n \"memberPhone\": \"**1233\",\n }\n ],\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"member_phone_required\",\n \"message\": \"memberPhone value required\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n401
\n403
\n400
\n422
\n409
\n404
\n{\n \"status\": true,\n \"message\": \"Treatments for member.\",\n \"data\": [\n {\n \"id\": 44695,\n \"name\": \"Allergy\",\n \"description\": \"Allergy\",\n \"code\": \"D100\"\n }\n ],\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": true,\n \"message\": \"Approved Providers for member.\",\n \"data\": [\n {\n \"providerId\": 29352,\n \"providerName\": \"John Doe\",\n \"providerAddress\": \"106 Jefferson St 3rd Fl., San Antonio, TX 78205\",\n \"providerNpi\": \"100388978\"\n }\n ],\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\nhttps://api.saferidehealth.com/v3/member/{{passengerId}}/custom-fields/0/10
{\n \"status\": true,\n \"message\": \"Custom fields for passenger id: {{passengerId}}\",\n \"data\": {\n \"Trip Purpose\": [\n \"Allergies\",\n \"Anemia\",\n \"Amputation\"\n ],\n \"TripType\": [\n \"GEN\"\n ],\n \"BillingCategory\": [\n \"Hospital - Outpatient\",\n \"Primary Care Provider\"\n ]\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\nThe above data values may differ greatly due to the flexibility of what can be stored in custom-fields.
\n","urlObject":{"protocol":"https","path":["v3","member","{{passengerId}}","custom-fields","0","10"],"host":["api","saferidehealth","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6eb4254f-7259-4aed-8e54-9fe3b094f496"},{"name":"Get Phone Numbers","id":"d89c18fc-9691-4ee8-9b03-31328b5f3c9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Purpose: Retrieve all phone numbers linked to a passenger, including type and SMS opt-out status.
\n{\n \"status\": true,\n \"message\": \"Successfully retrieved phone numbers.\",\n \"data\": {\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"+15035601180\",\n \"phoneType\": \"mobile\",\n \"isPrimary\": false,\n \"smsOptOut\": false,\n \"isTextable\": true\n },\n {\n \"phoneNumber\": \"+15035601190\",\n \"phoneType\": \"mobile\",\n \"isPrimary\": true,\n \"smsOptOut\": false,\n \"isTextable\": true\n }\n ]\n },\n \"errors\": [],\n \"environment\": \"sandbox\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Not Found\",\n \"data\": {},\n \"errors\": {\n \"type\": \"member_phone_not_found\",\n \"code\": 404,\n \"message\": \"memberPhone not found\"\n },\n \"environment\": \"sandbox\",\n \"httpCode\": 404\n}\n\nPurpose: Retrieve latest passenger's mobility assessment.
\n{\n \"status\": true,\n \"message\": \"Mobility Assessment retrieved successfully\",\n \"data\": {\n \"mobilityLevel\": \"Wheeled Device\",\n \"assistanceDevice\": \"Manual Wheelchair\",\n \"assistanceLevel\": \"Room to Room\",\n \"bariatricFlag\": true,\n \"transferFlag\": true,\n \"minimumTransportType\": \"WCX\"\n \"specialCircumstances\": [\"Service Animal\", \"Intellectually Impaired\"]\n \"memberHeightInInches\": 65,\n \"memberWeightInPounds\": 350\n \"lastUpdated\": \"2025-09-21T19:27:35+00:00\"\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Failed to retrieve mobility assessment.\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"mobility_assessment_not_found\",\n \"code\": 404,\n \"message\": \"Mobility assessment not found\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 404\n}\n\n{\n \"driverAssistanceRequired\": true,\n \"assistanceDevice\": \"Manual Wheelchair\",\n \"transferWithAssistance\": true,\n \"assistanceLevel\": \"Room to Room\",\n \"specialCircumstances\": [\"Service Animal\"],\n \"memberHeightInInches\": 65,\n \"memberWeightInPounds\": 310\n}\n\n{\n \"status\": true,\n \"message\": \"Mobility Assessment stored successfully\",\n \"data\": {\n \"mobilityLevel\": \"Wheeled Device\",\n \"assistanceLevel\": \"Room to Room\",\n \"bariatricFlag\": false,\n \"transferFlag\": true,\n \"minimumTransportType\": \"WCV\",\n \"assistanceDevice\": \"Manual Wheelchair\",\n \"specialCircumstances\": [\n \"Service Animal\"\n ],\n \"memberHeightInInches\": 65,\n \"memberWeightInPounds\": 310\n },\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Unprocessable Content\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"assistance_level_invalid\",\n \"code\": 422,\n \"message\": \"Assistance level has invalid value. Must be one of: Curb to Curb, Door to Door, Room to Room\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 422\n}\n\nPurpose: Update SMS opt-out status and primary status for primary and/or secondary phone numbers linked to a passenger.
\n{\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"+1XXXXXXXXXX\",\n \"smsOptOut\": false,\n \"isPrimary\": true\n },\n {\n \"phoneNumber\": \"+1XXXXXXXXXX\",\n \"smsOptOut\": true,\n \"isPrimary\": false\n }\n ]\n}\n\n{\n \"status\": true,\n \"message\": \"Successfully set sms consent for passenger phone number(s).\",\n \"data\": {\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"+19564560728\",\n \"phoneType\": \"mobile\",\n \"isPrimary\": true,\n \"isTextable\": true,\n \"smsOptOut\": false\n },\n {\n \"phoneNumber\": \"+16616543111\",\n \"phoneType\": \"other\",\n \"isPrimary\": false,\n \"isTextable\": false,\n \"smsOptOut\": true\n }\n ],\n \"warnings\": [\n {\n \"code\": \"non_textable_optin\",\n \"numbers\": [\n \"+16616543111\"\n ],\n \"detail\": \"One or more non-textable numbers were coerced to smsOptOut=true.\"\n }\n ]\n },\n \"errors\": [],\n \"environment\": \"local\",\n \"httpCode\": 200\n}\n\n{\n \"companyId\": 99,\n \"firstName\": \"API\",\n \"lastName\": \"driver\",\n \"mobileNo\": \"1231231212\",\n \"driverAccountStatus\": \"inactive\",\n \"salesforceDriverId\": \"123123112312312122\",\n \"saferideDriver\": false,\n \"activeDates\": [{\n \"startDate\": \"2024-01-01\",\n \"endDate\": \"2024-12-31\"\n }],\n \"healthPlans\": [{\n \"id\": 38,\n \"memberIds\": [\"mem13\"]\n }],\n \"driverLicense\": \"aA1234- @%\"\n}\n\n{\n \"status\": true,\n \"message\": \"Driver MR-9876543210 has been successfully created.\",\n \"data\": {\n \"salesforceDriverId\": \"MR-9876543210\",\n \"id\": 123456, // New driver ID\n \"companyId\": 1234567890\n },\n \"errors\": [],\n \"environment\": \"Production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"unable_to_create\",\n \"message\": \"Failed to create driver\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n401
\n403
\n400
\n422
\n409
\n404
\nExample:
\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"companyid_required\",\n \"code\": 400,\n \"message\": \"Company id is required\"\n },\n {\n \"type\": \"invalid_lastname_type\",\n \"code\": 422,\n \"message\": \"Invalid type for last name\"\n }\n ],\n \"environment\": \"sandbox\",\n \"httpCode\": 400\n}\n\n{\n \"companyId\": 12,\n \"firstName\": \"API\",\n \"lastName\": \"driver\",\n \"mobileNo\": \"1231231515\",\n \"email\": \"a@b.com\",\n \"driverAccountStatus\": \"active\",\n \"salesforceDriverId\": \"123123112312312515\",\n \"saferideDriver\": 0,\n \"activeDates\": [\n {\n \"startDate\": \"2024-01-01\",\n \"endDate\": \"2024-12-31\"\n },\n {\n \"startDate\": \"2024-02-01\",\n \"endDate\": \"2024-02-28\"\n }\n ],\n \"healthPlans\": [\n {\n \"id\": 38,\n \"memberIds\": [\n \"mem13\"\n ]\n }\n ],\n \"driverLicense\": \"aA1234 -#%\"\n}\n\n{\n \"status\": true,\n \"message\": \"Driver updated successfully\",\n \"httpCode\": 201,\n \"data\": {\n \"id\": 1373,\n \"salesforceDriverId\": \"123123112312312777\",\n \"companyId\": 99\n },\n \"errors\": [],\n \"timestamp\": \"2024-03-20T18:11:24.748696Z\",\n \"environment\": \"production\"\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"unable_to_update\",\n \"message\": \"Failed to update driver\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n401
\n403
\n400
\n422
\n409
\n404
\nExample:
\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_firstname_type\",\n \"code\": 422,\n \"message\": \"Invalid type for first name\"\n },\n {\n \"type\": \"lastname_required\",\n \"code\": 400,\n \"message\": \"Last name is required\"\n },\n {\n \"type\": \"healthplans_id_exists\",\n \"code\": 404,\n \"message\": \"Health plans id does not exist\"\n }\n ],\n \"environment\": \"local\",\n \"httpCode\": 400\n}\n\nTo have access to Drivers endpoints, your client id should be authorized for \"cms\" scope. Please use \"cms\" scope in the V3 Get Authorization Code endpoint and obtain an access token
\n","_postman_id":"afad837e-0aa1-4d43-a150-6bad5b3d148c"},{"name":"Vehicles","item":[{"name":"Create Vehicle","id":"937b16db-a64d-4651-8bdf-b3c6e27bdbc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.saferidehealth.com/v3/vehicles","description":"{\n \"companyId\" : 12345,\n \"vehicleType\" : \"5\",\n \"vehicleName\" : \"NAME\",\n \"vehiclePlateNo\" : \"PLATE-123\",\n \"vehicleMake\" : \"Ford\",\n \"vehicleModel\" : \"Transit\",\n \"vehicleColor\" : \"White\",\n \"active\" : 1,\n \"activeDates\" : [\n {\n \"startDate\": \"2024-01-01\",\n \"endDate\": \"2024-06-30\"\n },\n {\n \"startDate\": \"2024-08-01\",\n \"endDate\": \"2024-12-31\"\n }\n ],\n \"salesforceVehicleId\" : \"00f93024afs8900v23r94hjk\",\n \"saferideVehicle\" : 1\n}\n\n{\n \"status\": true,\n \"message\": \"Vehicle 009302489002394 has been successfully created.\",\n \"data\": {\n \"salesforceVehicleId\": \"00f93024afs8900v23r94hjk\",\n \"id\": 12345, // New Vehicle ID\n \"companyId\": 12345\n },\n \"errors\": [],\n \"environment\": \"Production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"vehicleplateno_already_exists\",\n \"message\": \"VehiclePlateNo must be unique. A vehicle with this plate already exists.\"\n },\n {\n \"type\": \"invalid_salesforcevehicleid_unique\",\n \"message\": \"Salesforce vehicle id must be unique\"\n }\n ],\n \"environment\": \"local\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\nExample:
\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_companyid_value\",\n \"code\": 422,\n \"message\": \"Invalid value for company id.\"\n },\n {\n \"type\": \"vehicleplateno_already_exists\",\n \"code\": 409,\n \"message\": \"VehiclePlateNo must be unique. A vehicle with this plate already exists.\"\n },\n {\n \"type\": \"invalid_salesforcevehicleid_unique\",\n \"code\": 409,\n \"message\": \"Salesforce vehicle id must be unique\"\n }\n ],\n \"environment\": \"local\",\n \"httpCode\": 422\n}\n\n{\n \"vehicleName\" : \"NAME\",\n \"vehiclePlateNo\" : \"PLATE-123\",\n \"vehicleMake\" : \"Ford\",\n \"vehicleModel\" : \"Transit\",\n \"vehicleColor\" : \"White\",\n \"active\" : 0,\n \"activeDates\" : [\n {\n \"startDate\": \"2024-01-01\",\n \"endDate\": \"2024-06-30\"\n },\n {\n \"startDate\": \"2024-08-01\",\n \"endDate\": \"2024-12-31\"\n }\n ],\n \"saferideVehicle\" : 1\n}\n\n{\n \"status\": true,\n \"message\": \"Vehicle updated successfully\",\n \"data\": {\n \"salesforceVehicleId\": \"009302489002394\",\n \"id\": 12345\n \"companyId\": 12345\n },\n \"errors\": [],\n \"environment\": \"Production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_update_field_vehicletype\",\n \"message\": \"VehicleType is not an updatable field.\"\n }\n ],\n \"environment\": \"local\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n401
\n403
\n400
\n422
\n409
\n404
\nExample:
\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_update_field_vehicletype\",\n \"code\": 400,\n \"message\": \"VehicleType is not an updatable field.\"\n },\n {\n \"type\": \"invalid_vehiclecolor_type\",\n \"code\": 422,\n \"message\": \"VehicleColor must be a string.\"\n }\n ],\n \"environment\": \"local\",\n \"httpCode\": 400\n}\n\nTo have access to Vehicles endpoints, your client id should be authorized for \"cms\" scope. Please use \"cms\" scope in the V3 Get Authorization Code endpoint and obtain an access token
\n","_postman_id":"3d75bf85-00be-4f15-9601-3128539eaaac"},{"name":"Vehicle Company","item":[{"name":"Create Vehicle Company","id":"32472f96-be11-45ba-b67c-cb5163a6fe02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.saferidehealth.com/v3/vehicleCompany","description":"{\n \"companyName\" : \"ABC Company\",\n \"street1\": \"123 Main Street\",\n \"street2\": \"Suite 100\",\n \"city\": \"Anytown\",\n \"state\": \"CA\",\n \"country\": \"USA\",\n \"zipcode\": \"12345\",\n \"company_status\": \"Active\",\n \"contactNo1\": \"123-456-7890\",\n \"contactNo2\": \"098-765-4321\",\n \"display_contact\": \"business_phone\",\n \"dispatcher_managed\": 1,\n \"management_type\": \"dispatcher\",\n \"npi\": \"1234567890\",\n \"salesforceCompanyId\" : \"23423SADFASDF\",\n \"salesforceUserId\" : \"23423SADFASDF\",\n \"operating_hours\" : {\n \"scheduled\": {\n \"days\" : \"SMTWRFU\",\n \"start_at\" : \"11:00:00\",\n \"end_at\" : \"23:00:00\",\n \"notes\" : \"scheduledsss\" \n },\n \"on-demand\": {\n \"days\" : \"SMRFU\",\n \"start_at\" : \"11:00:00\",\n \"end_at\" : \"23:00:00\",\n \"notes\" : \"on demand\" \n },\n \"after-hours\": {\n \"days\" : \"WRFU\",\n \"start_at\" : \"11:00:00\",\n \"end_at\" : \"23:00:00\",\n \"notes\" : \"after hours\" \n }\n }\n}\n\n{\n \"status\": true,\n \"message\": \"Vehicle Company 987654321 has been successfully created.\",\n \"data\": {\n \"salesforceCompanyId\": \"987654321\",\n \"id\": 12345 // New VC ID\n },\n \"errors\": [],\n \"environment\": \"Production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_state_value\",\n \"message\": \"State must be the full state name. Ex: California\"\n },\n {\n \"type\": \"invalid_country_value\",\n \"message\": \"Country must be united states\"\n },\n {\n \"type\": \"invalid_display_contact_type\",\n \"message\": \"Invalid type for display_contact\"\n },\n {\n \"type\": \"invalid_display_contact_value\",\n \"message\": \"Invalid value for display_contact. Must be driver_phone or business_phone\"\n },\n {\n \"type\": \"salesforce_company_id_already_exists\",\n \"message\": \"Salesforce company id already exists\"\n }\n ],\n \"environment\": \"local\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n401
\n403
\n400
\n422
\n409
\n404
\nExample:
\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_state_value\",\n \"code\": 422,\n \"message\": \"State must be the full state name. Ex: California\"\n },\n {\n \"type\": \"invalid_country_value\",\n \"code\": 422,\n \"message\": \"Country must be United States\"\n },\n {\n \"type\": \"invalid_display_contact_type\",\n \"code\": 422,\n \"message\": \"Invalid type for display_contact\"\n },\n {\n \"type\": \"invalid_display_contact_value\",\n \"code\": 422,\n \"message\": \"Invalid value for display_contact. Must be driver_phone or business_phone\"\n },\n {\n \"type\": \"salesforce_company_id_already_exists\",\n \"code\": 409,\n \"message\": \"Salesforce company id already exists\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 422\n}\n\n{\n \"companyName\" : \"ABC Company\",\n \"street1\": \"123 Main Street\",\n \"street2\": \"Suite 100\",\n \"city\": \"Anytown\",\n \"state\": \"CA\",\n \"country\": \"USA\",\n \"zipcode\": \"12345\",\n \"company_status\": \"Inactive\",\n \"contactNo1\": \"123-456-7890\",\n \"contactNo2\": \"098-765-4321\",\n \"display_contact\": \"business_phone\",\n \"dispatcher_managed\": 1,\n \"management_type\": \"dispatcher\",\n \"npi\": \"1234567890\",\n \"salesforceUserId\": \"123ABC456\",\n \"operating_hours\" : {\n \"scheduled\": {\n \"days\" : \"SMTW\",\n \"end_at\" : \"23:00:00\",\n },\n \"after-hours\": {\n \"start_at\" : \"11:00:00\",\n \"notes\" : \"after hours\" \n }\n }\n}\n\n{\n \"status\": true,\n \"message\": \"Vehicle Company 987654321 has been successfully updated.\",\n \"data\": {\n \"salesforceCompanyId\": \"987654321\",\n \"id\": 12345\n },\n \"errors\": [],\n \"environment\": \"Production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"companyname_already_exists\",\n \"message\": \"Company Name must be unique\"\n }\n ],\n \"environment\": \"local\",\n \"httpCode\": 400\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n401
\n403
\n400
\n422
\n409
\n404
\nExample:
\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"companyname_already_exists\",\n \"code\": 409,\n \"message\": \"Company Name must be unique\"\n },\n {\n \"type\": \"invalid_street1_type\",\n \"code\": 422,\n \"message\": \"Invalid type for street1\"\n }\n ],\n \"environment\": \"local\",\n \"httpCode\": 422\n}\n\nTo have access to Vehicle Company endpoints, your client id should be authorized for \"cms\" scope. Please use \"cms\" scope in the V3 Get Authorization Code endpoint and obtain an access token
\n","_postman_id":"a5b719e0-07e6-46b3-82dd-c74e63aec4ed"},{"name":"Trips","item":[{"name":"Trip Cancel","id":"d79bb6d1-b3c3-4cca-b985-974d448c99d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{gatewayHost}}/v3/trips/{{tripId}}/cancel","description":"### Response\n- **200 - Success**\n``` json\n{\n \"status\": true,\n \"message\": \"Successfully cancelled trip.\",\n \"data\": [],\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Bad Request\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_tripid_value\",\n \"message\": \"tripId not associated with this account\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 400\n}\n\n{\n \"status\": true,\n \"message\": \"Trip info provided.\",\n \"data\": \n [\n {\n \"rideId\": 123123,\n \"status\": \"Scheduled\",\n \"confirmationStatus\": \"unconfirmed\",\n \"driverLocation\": {\n \"lat\": null,\n \"lng\": null,\n \"eta\": null\n },\n \"member\": {\n \"phone\": null,\n \"firstName\": \"bob\",\n \"lastName\": \"bob\",\n \"passengerId\": 1231234,\n \"memberId\": \"123\",\n \"dateOfBirth\": null,\n \"notes\": null\n },\n \"memberMode\": \"Private\",\n \"memberMobilityType\": \"UBR\",\n \"memberSubMobilityType\": \"\",\n \"memberAssistanceNeeds\": \"\",\n \"additionalPassengers\": [],\n \"pickup\": {\n \"pickupAddress\": \"432 Bridget Drive, Converse, Texas 78109, United States\",\n \"pickupLat\": \"29.518435\",\n \"pickupLng\": \"-98.322440\",\n \"pickupApprovedProviderId\": \"\"\n },\n \"dropoff\": {\n \"dropoffAddress\": \"876 Randolph Afb, Randolph AFB, Texas 78150, United States\",\n \"dropoffLat\": \"29.524040\",\n \"dropoffLng\": \"-98.280920\",\n \"dropoffApprovedProviderId\": \"\"\n },\n \"pickupTime\": 0,\n \"appointmentTime\": 0,\n \"rideTimezone\":\"America/Chicago\",\n \"bookedAsWillCall\": 0,\n \"extraTime\": 0,\n \"createdAt\": 1675615975,\n \"updatedAt\": 1675670403,\n \"acceptedAt\": 0,\n \"arrivedAt\": 0,\n \"startedAt\": 0,\n \"completedAt\": 0,\n \"confirmedAt\": 0,\n \"cancelledAt\": 0,\n \"cancelReasonId\": null,\n \"cancelMessage\": \"\",\n \"dispatcherManaged\": 0,\n \"customFields\": [\n {\n \"id\": 123,\n \"name\": \"Custom Field 1\",\n \"dependent\": 0,\n \"values\": [\n {\n \"id\": 12345,\n \"name\": \"option1\"\n },\n {\n \"id\": 23456,\n \"name\": \"option1\"\n },\n {\n \"id\": 34567,\n \"name\": \"option3\"\n }\n ]\n },\n {\n \"id\": 234,\n \"name\": \"Custom field 2\",\n \"dependent\": 0,\n \"values\": [\n {\n \"id\": 23456,\n \"name\": \"option1\"\n },\n {\n \"id\": 34567,\n \"name\": \"option2\"\n },\n {\n \"id\": 45678,\n \"name\": \"option3\"\n }\n ]\n }\n ],\n \"treatmentValue\": null,\n \"clientMemo\": \"\",\n \"clientMeta\": null,\n \"transportProvider\": {\n \"transportProviderId\": 12,\n \"transportProviderName\": null,\n \"transportProviderRating\": 0,\n \"mainlinePhone\": null\n },\n \"vehicle\": {\n \"vehicleMake\": null,\n \"vehicleModel\": null,\n \"vehicleColor\": null,\n \"vehicleLicensePlate\": null,\n \"vehicleType\": \"SDN\"\n },\n \"driver\": {\n \"driverPhone\": null,\n \"driverFirstName\": null,\n \"driverAvatar\": null\n },\n \"bookingType\": \"fromcare\",\n \"price\": {\n \"estimatedCost\": \"55\",\n \"finalCost\": \"0.00\",\n \"cancellationCost\": \"0.00\"\n },\n \"memberSignature\": null,\n \"odometerReading\": null\n },\n {\n \"rideId\": 123125,\n \"status\": \"Scheduled\",\n \"confirmationStatus\": \"unconfirmed\",\n \"driverLocation\": {\n \"lat\": null,\n \"lng\": null,\n \"eta\": null\n },\n \"member\": {\n \"phone\": null,\n \"firstName\": \"steve\",\n \"lastName\": \"steve\",\n \"passengerId\": 1231254,\n \"memberId\": \"126\",\n \"dateOfBirth\": null,\n \"notes\": null\n },\n \"memberMode\": \"Private\",\n \"memberMobilityType\": \"\",\n \"memberSubMobilityType\": \"\",\n \"memberAssistanceNeeds\": \"\",\n \"additionalPassengers\": [],\n \"pickup\": {\n \"pickupAddress\": \"555 Bridget Drive, Converse, Texas 78109, United States\",\n \"pickupLat\": \"29.718435\",\n \"pickupLng\": \"-98.922440\",\n \"pickupApprovedProviderId\": \"\"\n },\n \"dropoff\": {\n \"dropoffAddress\": \"876 Randolph Afb, Randolph AFB, Texas 78150, United States\",\n \"dropoffLat\": \"29.524040\",\n \"dropoffLng\": \"-98.280920\",\n \"dropoffApprovedProviderId\": \"\"\n },\n \"pickupTime\": 0,\n \"appointmentTime\": 0,\n \"rideTimezone\":\"America/Chicago\",\n \"bookedAsWillCall\": 1,\n \"extraTime\": 0,\n \"createdAt\": 1675615975,\n \"updatedAt\": 1675670403,\n \"acceptedAt\": 0,\n \"arrivedAt\": 0,\n \"startedAt\": 0,\n \"completedAt\": 0,\n \"confirmedAt\": 0,\n \"cancelledAt\": 0,\n \"cancelReasonId\": null,\n \"cancelMessage\": \"\",\n \"dispatcherManaged\": 0,\n \"customFields\": [\n {\n \"id\": 123,\n \"name\": \"Custom Field 1\",\n \"dependent\": 0,\n \"values\": [\n {\n \"id\": 12345,\n \"name\": \"option1\"\n },\n {\n \"id\": 23456,\n \"name\": \"option1\"\n },\n {\n \"id\": 34567,\n \"name\": \"option3\"\n }\n ]\n },\n {\n \"id\": 234,\n \"name\": \"Custom field 2\",\n \"dependent\": 0,\n \"values\": [\n {\n \"id\": 23456,\n \"name\": \"option1\"\n },\n {\n \"id\": 34567,\n \"name\": \"option2\"\n },\n {\n \"id\": 45678,\n \"name\": \"option3\"\n }\n ]\n }\n ],\n \"treatmentValue\": null,\n \"clientMemo\": \"\",\n \"clientMeta\": null,\n \"transportProvider\": {\n \"transportProviderId\": 12,\n \"transportProviderName\": null,\n \"transportProviderRating\": 0,\n \"mainlinePhone\": null\n },\n \"vehicle\": {\n \"vehicleMake\": null,\n \"vehicleModel\": null,\n \"vehicleColor\": null,\n \"vehicleLicensePlate\": null,\n \"vehicleType\": \"SDN\"\n },\n \"driver\": {\n \"driverPhone\": null,\n \"driverFirstName\": null,\n \"driverAvatar\": null\n },\n \"bookingType\": \"tocare\",\n \"price\": {\n \"estimatedCost\": \"66\",\n \"finalCost\": \"0.00\",\n \"cancellationCost\": \"0.00\"\n },\n \"memberSignature\": null,\n \"odometerReading\": null,\n \"updateTimeInProgress\": false,\n },\n ],\n \"errors\": [],\n \"environment\": \"production\",\n \"httpCode\": 200\n}\n\n{\n \"status\": false,\n \"message\": \"Unprocessable Content\",\n \"data\": {},\n \"errors\": [\n {\n \"type\": \"invalid_tripid_value\",\n \"message\": \"trip not associated with this account\"\n }\n ],\n \"environment\": \"production\",\n \"httpCode\": 422\n}\n\nIn the event that multiple errors are detected and returned, the top level error code will be the most critical error based on the following hierarchy:
\n401
\n403
\n400
\n422
\n409
\n404
\nqueued, started, completed, failed
\n","type":"text/plain"},"key":"status","value":null},{"description":{"content":"bulk, sync
\n","type":"text/plain"},"key":"type","value":null},{"description":{"content":"Query for jobs after this date
\n","type":"text/plain"},"key":"startDate","value":null},{"description":{"content":"Query for jobs before this date
\n","type":"text/plain"},"key":"endDate","value":null},{"description":{"content":"Query for jobs initiated by this user ID
\n","type":"text/plain"},"key":"user_id","value":null},{"description":{"content":"Query for jobs with this UUID
\n","type":"text/plain"},"key":"uuid","value":null},{"description":{"content":"Pagination - the selected page
\n","type":"text/plain"},"key":"page","value":null},{"description":{"content":"Pagination - how many results per page
\n","type":"text/plain"},"key":"per_page","value":null}],"variable":[]}},"response":[],"_postman_id":"e0bf06fe-7650-48a1-bd4a-25421c277ba2"},{"name":"Bulk Update","id":"a7bdb99c-59e6-4628-b356-469c835b3841","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"company\": {\n \"company_status\": \"active\",\n \"salesforceCompanyId\": \"0015g00000XYZ123\"\n },\n \"drivers\": [\n {\n \"id\": 1234,\n \"driverAccountStatus\": \"active\",\n \"activeDates\": [\n {\n \"startDate\": \"2023-01-01\",\n \"endDate\": \"2023-06-30\"\n },\n {\n \"startDate\": \"2023-07-01\",\n \"endDate\": \"2023-12-31\"\n }\n ],\n \"salesforceDriverId\": \"0055g00000ABC999\"\n },\n {\n \"id\": 5678,\n \"driverAccountStatus\": \"inactive\",\n \"salesforceDriverId\": \"0055g00000XYZ888\"\n }\n ],\n \"vehicles\": [\n {\n \"id\": 4321,\n \"active\": 1,\n \"activeDates\": [\n {\n \"startDate\": \"2022-05-01\",\n \"endDate\": \"2022-12-31\"\n }\n ],\n \"salesforceVehicleId\": \"0055g00000ABC777\"\n },\n {\n \"id\": 8765,\n \"active\": 0,\n \"salesforceVehicleId\": \"0055g00000XYZ666\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.saferidehealth.com/v3/vehicle-company-compliance/{vehicle_company_id}/bulk","urlObject":{"protocol":"https","path":["v3","vehicle-company-compliance","{vehicle_company_id}","bulk"],"host":["api","saferidehealth","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a7bdb99c-59e6-4628-b356-469c835b3841"},{"name":"Sync Update","id":"37225d5a-acff-4c85-aa34-b04f6f320caa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"company\": {\n \"company_status\": \"active\",\n \"salesforceCompanyId\": \"0015g00000XYZ123\"\n },\n \"drivers\": [\n {\n \"id\": 1234,\n \"driverAccountStatus\": \"active\",\n \"activeDates\": [\n {\n \"startDate\": \"2023-01-01\",\n \"endDate\": \"2023-06-30\"\n },\n {\n \"startDate\": \"2023-07-01\",\n \"endDate\": \"2023-12-31\"\n }\n ],\n \"salesforceDriverId\": \"0055g00000ABC999\"\n },\n {\n \"id\": 5678,\n \"driverAccountStatus\": \"inactive\",\n \"salesforceDriverId\": \"0055g00000XYZ888\"\n }\n ],\n \"vehicles\": [\n {\n \"id\": 4321,\n \"active\": 1,\n \"activeDates\": [\n {\n \"startDate\": \"2022-05-01\",\n \"endDate\": \"2022-12-31\"\n }\n ],\n \"salesforceVehicleId\": \"0055g00000ABC777\"\n },\n {\n \"id\": 8765,\n \"active\": 0,\n \"salesforceVehicleId\": \"0055g00000XYZ666\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.saferidehealth.com/v3/vehicle-company-compliance/{vehicle_company_id}/sync","urlObject":{"protocol":"https","path":["v3","vehicle-company-compliance","{vehicle_company_id}","sync"],"host":["api","saferidehealth","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"37225d5a-acff-4c85-aa34-b04f6f320caa"},{"name":"Get Job Input","id":"ff0f54c1-8026-4a89-9b57-b6e511ad63be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.saferidehealth.com/v3/vehicle-company-compliance/{uuid}/input","urlObject":{"protocol":"https","path":["v3","vehicle-company-compliance","{uuid}","input"],"host":["api","saferidehealth","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff0f54c1-8026-4a89-9b57-b6e511ad63be"},{"name":"Get Job Output","id":"34adc6dd-1e42-4f5e-baf9-2ee0bc4e3a5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.saferidehealth.com/v3/vehicle-company-compliance/{uuid}/output","urlObject":{"protocol":"https","path":["v3","vehicle-company-compliance","{uuid}","output"],"host":["api","saferidehealth","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"34adc6dd-1e42-4f5e-baf9-2ee0bc4e3a5c"}],"id":"827b3648-2aaf-4fe6-a15a-6accb14ae2e1","description":"To have access to Vehicle Company Compliance endpoints, your client id should be authorized for \"cms\" scope. Please use \"cms\" scope in the V3 Get Authorization Code endpoint and obtain an access token
\n","_postman_id":"827b3648-2aaf-4fe6-a15a-6accb14ae2e1"}],"id":"1bc5ec89-0dbe-4abe-b8a3-78ca790aeff1","_postman_id":"1bc5ec89-0dbe-4abe-b8a3-78ca790aeff1","description":""},{"name":"Webhooks","item":[],"id":"1fd2a04c-1a7f-4155-a908-0ca5b8d1e6fe","description":"you can use HMAC with the SHA-256 algorithm to encrypt the payload using a secret key. Here is an example code snippet using Node.js crypto library:
\nconst crypto = require('crypto');\nconst key = 'your-secret-key';\nconst payload = { /* Request Payload */ };\nconst signature = crypto.createHmac('sha256', key)\n .update(JSON.stringify(payload))\n .digest('base64');\n\nTo verify the request, you can recreate the signature on the server-side using the same key and payload data and compare it with the signature received in the request. If they match, the request is considered valid.
\n{\n \"event_id\": \"4e24b0f3-678c-4de6-9652-97bd8a897a8e\",\n \"href\": \"https://api.saferidehealth.com/v3/rides/123456\",\n \"event_time\": 1689716251,\n \"event_type\": \"ride.status.updated\",\n \"event\": {}\n}\n\n{\n \"event_id\": \"4e24b0f3-678c-4de6-9652-97bd8a897a8e\",\n \"href\": \"https://api.saferidehealth.com/v3/rides/123456\",\n \"event_time\": 1689716251,\n \"event_type\": \"ride.status.updated\",\n \"event\": {\n \"rideId\": 123456,\n \"clientMemo\": \"client memo\",\n \"status\": \"Scheduled\",\n \"confirmationStatus\": \"unconfirmed\",\n \"dispatcherManaged\": 0,\n \"clientMeta\": []\n }\n}\n\n{\n \"event_id\": \"4e24b0f3-678c-4de6-9652-97bd8a897a8e\",\n \"href\": \"https://api.saferidehealth.com/v3/rides/123456\",\n \"event_time\": 1689716251,\n \"event_type\": \"ride.cost.updated\",\n \"event\": {\n \"rideId\": 123456,\n \"clientMemo\": \"client memo\",\n \"price\": {\n \"estimatedCost\": \"12.30\",\n \"finalCost\": \"12.30\",\n \"cancellationCost\": \"0.0\",\n \"clientMeta\": []\n }\n }\n}\n\n{\n \"event_id\": \"4e24b0f3-678c-4de6-9652-97bd8a897a8e\",\n \"href\": \"https://api.saferidehealth.com/v3/rides/123456\",\n \"event_time\": 1689716251,\n \"event_type\": \"ride.provider.updated\",\n \"event\": {\n \"rideId\": 123456,\n \"memberMobilityType\": \"AMB\",\n \"memberSubMobilityType\": \"No Taxi\",\n \"clientMemo\": \"client memo\",\n \"transportProvider\": {\n \"id\": 123,\n \"name\": \"provider name\",\n \"rating\": 4.3,\n \"mainlinePhone\": \"+11231231234\"\n },\n \"clientMeta\": []\n }\n}\n\n{\n \"event_id\": \"4e24b0f3-678c-4de6-9652-97bd8a897a8e\",\n \"href\": \"https://api.saferidehealth.com/v3/rides/123456\",\n \"event_time\": 1689716251,\n \"event_type\": \"ride.vehicle.updated\",\n \"event\": {\n \"rideId\": 123456,\n \"clientMemo\": \"client memo\",\n \"vehicle\": {\n \"make\": \"Honda\",\n \"model\": \"Accord\",\n \"color\": \"White\",\n \"licensePlate\": \"ABC123\",\n \"type\": \"UBR\"\n },\n \"driver\": {\n \"firstName\": \"Zia\",\n \"phone\": \"+11231231234\",\n \"avatar\": \"https://customavatarlink.com\"\n },\n \"clientMeta\": []\n }\n}\n\n{\n \"event_id\": \"4e24b0f3-678c-4de6-9652-97bd8a897a8e\",\n \"href\": \"https://api.saferidehealth.com/v3/rides/123456\",\n \"event_time\": 1689716251,\n \"event_type\": \"ride.pickuptime.updated\",\n \"event\": {\n \"rideId\": 123456,\n \"pickupTime\": 1686167248,\n \"clientMemo\": \"\",\n \"clientMeta\": []\n }\n}\n\n