--- updatedAt: 2026-09-23T20:14:32.000Z agentTools: projectIndex: https://mediroutes-api.readme.io/llms.txt --- # Create Rider Create a new rider/passenger/patient # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "V1", "title": "MediroutesAPI V1" }, "paths": { "/api/v{version}/riders": { "post": { "tags": [ "Riders" ], "summary": "Create Rider", "description": "Create a new rider/passenger/patient", "operationId": "post-rider", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "access token", "required": false, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/RiderRequestModel" }, "responses": { "200": { "description": "Rider Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiderResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiderResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RiderResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RiderResponseModel" } } } }, "403": { "description": "The api key used does not have access to this resource." } }, "x-ai-description": "Creates a new rider under the funding source named in the body (FundingSourceName; resolved from the database when not in the api key's map). The body carries ApiKey plus the rider's demographics, address, and phone.", "x-ai-when-to-use": "A rider does not exist yet and must be added before trips can be booked for them, and you know the funding source by NAME. When you have a funding source ID instead, use POST riders/createRiderUsingFsid.", "x-ai-side-effects": "creates-rider", "x-ai-returns": "The created rider record including its assigned external rider id (client code) and internal MediRoutes rider id - both used by the trip-creation endpoints (singletrip).", "x-ai-required-permission": "tripManagement", "x-ai-display": { "title": "Created Rider", "key": "mediroutes_rider_id", "columns": [ { "field": "last_name", "header": "Last Name" }, { "field": "first_name", "header": "First Name" }, { "field": "date_of_birth", "header": "DOB" }, { "field": "phone", "header": "Phone" }, { "field": "mobile_phone", "header": "Mobile" }, { "field": "space_type", "header": "Space Type" }, { "field": "funding_source_name", "header": "Funding Source" }, { "field": "address.address1", "header": "Address" }, { "field": "address.city", "header": "City" }, { "field": "email", "header": "Email" } ] }, "x-ai-inputs": [ { "name": "rider_id", "label": "Rider Client Code", "control": "text" }, { "name": "space_type", "label": "Space Type", "control": "select", "options": { "operation": "get-allspacetypes", "valueField": "space_type", "labelTemplate": "{space_type} — {space_type_description}", "args": "includeInactive=false" } }, { "name": "funding_source_name", "label": "Funding Source Name", "control": "text" } ] } } }, "servers": [ { "url": "https://api.mediroutes.com" } ], "components": { "requestBodies": { "RiderRequestModel": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiderRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiderRequestModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RiderRequestModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RiderRequestModel" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RiderRequestModel" } } }, "required": true } }, "schemas": { "RiderResponseModel": { "required": [ "rider_id", "first_name", "last_name", "space_type" ], "type": "object", "properties": { "mediroutes_rider_id": { "format": "int32", "description": "The Internal id of Mediroutes Rider, this Id is unique per Transportation provider", "type": "integer" }, "funding_source_id": { "format": "int32", "description": "The ID of the Funding Source of the Customer", "type": "integer" }, "funding_source_name": { "description": "The Name of the Funding Source of the Customer", "type": "string" }, "tp_api_key": { "description": "The Transportation provider API Key", "type": "string" }, "rider_id": { "description": "The unique id of the Customer", "type": "string" }, "first_name": { "description": "The First Name of the Customer", "type": "string" }, "last_name": { "description": "The Last Name of the Customer", "type": "string" }, "middle_name": { "description": "The Middle Name of the Customer", "type": "string" }, "address": { "$ref": "#/components/schemas/Address" }, "phone": { "description": "The Phone Number of the customer", "type": "string" }, "space_type": { "description": "The Space Type of the Customer", "type": "string" }, "home_phone": { "description": "The Home phone number of the customer", "type": "string" }, "mobile_phone": { "description": "The Mobile phone number of the customer", "type": "string" }, "icd_10_codes": { "description": "The ICD10Code of the customer", "type": "string" }, "date_of_birth": { "description": "The DateOfBirth of the Customer", "type": "string" }, "is_male": { "description": "Is Male gender", "type": "boolean" }, "is_Female": { "description": "Is Female gender", "type": "boolean" }, "comments": { "description": "Comments for the rider", "type": "string" }, "private_comments": { "description": "Private comments for the rider", "type": "string" }, "email": { "description": "Email for rider", "type": "string" } } }, "Address": { "type": "object", "properties": { "location_name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "longitude": { "format": "double", "type": "number" }, "latitude": { "format": "double", "type": "number" } } }, "RiderRequestModel": { "required": [ "rider_id", "first_name", "last_name", "space_type" ], "type": "object", "properties": { "funding_source_name": { "description": "The Name of the Funding Source of the Customer", "type": "string" }, "tp_api_key": { "description": "The Transportation provider API Key", "type": "string" }, "rider_id": { "description": "The unique id of the Customer", "type": "string" }, "first_name": { "description": "The First Name of the Customer", "type": "string" }, "last_name": { "description": "The Last Name of the Customer", "type": "string" }, "middle_name": { "description": "The Middle Name of the Customer", "type": "string" }, "address": { "$ref": "#/components/schemas/Address" }, "phone": { "description": "The Phone Number of the customer", "type": "string" }, "space_type": { "description": "The Space Type of the Customer", "type": "string" }, "home_phone": { "description": "The Home phone number of the customer", "type": "string" }, "mobile_phone": { "description": "The Mobile phone number of the customer", "type": "string" }, "icd_10_codes": { "description": "The ICD10Code of the customer", "type": "string" }, "date_of_birth": { "description": "The DateOfBirth of the Customer", "type": "string" }, "is_male": { "description": "Is Male gender", "type": "boolean" }, "is_Female": { "description": "Is Female gender", "type": "boolean" }, "comments": { "description": "Comments for the rider", "type": "string" }, "private_comments": { "description": "Private comments for the rider", "type": "string" }, "email": { "description": "Email for rider", "type": "string" } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```