Capture and make sense of driving data with our powerful APIs and SDKs.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Build with Arity.","slug":"build-with-arity"}],"owner":"2966050","collectionId":"21144baf-89fa-4d3e-aad2-5f2822499d1c","publishedId":"TW76E5ZE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-02-09T17:28:44.000Z"},"item":[{"name":"Arity Driving Engine","item":[{"name":"Authentication","item":[{"name":"generateToken (b2b)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.globals.set(\"current-b2b-token\", pm.response.json().access_token);",""],"id":"38ff4cb6-3436-4a0a-b195-b8de9d89b8aa"}}],"id":"53b47d6a-6778-46ce-b7e7-a4ac2c486d75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{clientId}}","type":"text"},{"key":"client_secret","value":"{{clientSecret}}","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"scope","value":"b2b","type":"text"}]},"url":"https://api.arity.com/platform/oauth/v1/token","description":"Generate an access token that you can use for authorization on subsequent API calls. The b2b scope identifies the organization, and is required when calling the Arity platform from your back-end systems.
\n","urlObject":{"protocol":"https","path":["platform","oauth","v1","token"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"53b47d6a-6778-46ce-b7e7-a4ac2c486d75"},{"name":"generateToken (mobile)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.globals.set(\"current-mobile-token\", pm.response.json().access_token);"],"id":"e25c5914-8554-4949-90fb-dd09526cbcc6"}}],"id":"7a9f9eec-1926-45f6-8d44-102e1dbd405f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{clientId}}","type":"text"},{"key":"client_secret","value":"{{clientSecret}}","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"scope","value":"mobile","type":"text"},{"key":"userId","value":"{{userId}}","type":"text"},{"key":"deviceId","value":"{{deviceId}}","type":"text"}]},"url":"https://api.arity.com/platform/oauth/v1/token","description":"Generate an access token that you can use for authorization on subsequent API calls. The mobile scope token identifies your end-user and must be used on the mobile device to initialize the Driving Engine framework.
\n","urlObject":{"protocol":"https","path":["platform","oauth","v1","token"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a9f9eec-1926-45f6-8d44-102e1dbd405f"},{"name":"validateMobileToken","id":"3c0caf55-9146-47d2-bc98-0736c1403ed2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{user-mobile-token}}"}],"url":"https://api.arity.com/registration/v2/users/{{userId}}","description":"Use this endpoint to get a user's details from a userId. By passing the user's mobile scope token for authentication, you can validate the token with a success response form this endpoint. This is the same endpoint as getUserDetails API, but you will typically call that with your b2b token from the back-end.
\n","urlObject":{"protocol":"https","path":["registration","v2","users","{{userId}}"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c0caf55-9146-47d2-bc98-0736c1403ed2"}],"id":"b4bc7821-ab1d-4d3c-9ed6-368a84e59b11","description":"We use Oauth 2.0 tokens to authenticate both your organization, as well as the end-user as the Driving Engine sends their trip data from the mobile device to the Arity platform. The token that identifies your organization is referred to as b2b scope, while the user token is in the mobile scope. It is important that you do not pass your b2b token to the user's device for identification. A b2b token expires after one hour, but you must not share it. It will enable RESTful webservice calls from your back-end to our platform APIs.
\n","event":[{"listen":"prerequest","script":{"id":"fad01a5d-7d3b-4728-9ec7-a8b9173c8e26","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0b338556-074c-41b0-b2fb-ec2ef2373e74","type":"text/javascript","exec":[""]}}],"_postman_id":"b4bc7821-ab1d-4d3c-9ed6-368a84e59b11"},{"name":"Trip Intelligence","item":[{"name":"getTripSummary","id":"302ba319-ddad-4b55-b4c3-c8c8d3e985f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"},{"key":"Content-Type","value":"application/json"},{"key":"userId","value":"{{userId}}"},{"key":"deviceId","value":"{{deviceId}}"}],"url":"https://api.arity.com/drivingBehavior/v3/trips?since=2019-03-25&until=2019-04-30","description":"Get a summary of all trips associated with an end-user during a specified time period.
\n","urlObject":{"protocol":"https","path":["drivingBehavior","v3","trips"],"host":["api","arity","com"],"query":[{"key":"since","value":"2019-03-25"},{"key":"until","value":"2019-04-30"}],"variable":[]}},"response":[],"_postman_id":"302ba319-ddad-4b55-b4c3-c8c8d3e985f9"},{"name":"getTripDetails","id":"aa51f0c1-8d4a-4420-8e54-02f4b6a3fd0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"},{"key":"deviceId","value":"{{deviceId}}"},{"key":"userId","value":"{{userId}}"}],"url":"https://api.arity.com/drivingBehavior/v3/trips/{{tripId}}","description":"Get the details of a single trip, including distance, duration, events (speeding, hard braking, etc.), and GPS trail. Requires a valid tripId at the end of the url. Use the getTripSummary endpoint to retreive tripsIds.
\n","urlObject":{"protocol":"https","path":["drivingBehavior","v3","trips","{{tripId}}"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa51f0c1-8d4a-4420-8e54-02f4b6a3fd0b"},{"name":"getTripDetails GPS trail","id":"b00fa3e2-668c-45af-aeb0-4b07c5433669","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"},{"key":"deviceId","value":"{{deviceId}}"},{"key":"userId","value":"{{userId}}"}],"url":"https://api.arity.com/drivingBehavior/v3/trips/{{tripId}}/geopoints","description":"Get the details of a single trip, including distance, duration, events (speeding, hard braking, etc.), and GPS trail. Requires a valid tripId at the end of the url. Use the getTripSummary endpoint to retreive tripsIds.
\n","urlObject":{"protocol":"https","path":["drivingBehavior","v3","trips","{{tripId}}","geopoints"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b00fa3e2-668c-45af-aeb0-4b07c5433669"},{"name":"rejectTrip","id":"8fc760c7-93b4-49e0-9c2c-3e191196da01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{current-mobile-token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"rejectReasonCode\": \"102\"}"},"url":"https://api.arity.com/drivingBehavior/v3/users/gps-data-user/trips/{{tripId}}","description":"Reject a trip captured for an end-user who was not driving (e.g., the user was a passenger) to remove it from that user's score.
\n","urlObject":{"protocol":"https","path":["drivingBehavior","v3","users","gps-data-user","trips","{{tripId}}"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8fc760c7-93b4-49e0-9c2c-3e191196da01"}],"id":"b373026d-410b-4d60-94ef-2bebf994bd5d","description":"The Trip Intelligence APIs are endpoints which return trip information by user. A trip summary will return all trips for a user for a selected period of time. The tripId values in that response may be used to get more detailed trip information for a specific trip, including a 15 second interval of GPS signals, or trail. If a user denies being the driver for a given tripId, you can optionally call rejectTrip to remove it from scoring.
\n","event":[{"listen":"prerequest","script":{"id":"e44c9f7e-6470-4728-b3a4-7c89cf8b6db0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eb190f7b-60ff-4a9a-9f6e-b8c2216bcddd","type":"text/javascript","exec":[""]}}],"_postman_id":"b373026d-410b-4d60-94ef-2bebf994bd5d"},{"name":"Registration","item":[{"name":"createUser","event":[{"listen":"test","script":{"id":"780b6ae3-e8e3-4bed-86a7-c6b7eac780e7","exec":["pm.globals.set(\"latest-user-id\", pm.response.json().userId);","pm.globals.set(\"latest-device-id\", pm.response.json().devices[0].deviceId);",""],"type":"text/javascript"}}],"id":"145e9950-34e0-40c3-95ea-fa03b6ae47fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"\",\n \"deviceId\": \"\",\n \"products\": [\n \"Driving Behavior\"\n ]\n}"},"url":"https://api.arity.com/registration/v2/users/products","description":"Create an Arity userId needed to track the driving behavior of your mobile app end-user.
\nURL : https://api.arity.com/registration/v2/users/products
URL parameters : none
Method : POST
Auth required : YES - b2b Oauth token
\nData constraints
\nProvide userId of account to be created. Alternatively leave this null and we will return a unique string.\nProvide a deviceId for this user. Alternatively leave this null and we will return a unique string.\nIndicate that your user is enrolled in the Driving Behavior product
\n","urlObject":{"protocol":"https","path":["registration","v2","users","products"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[{"id":"29e1a846-942b-45b1-8da7-37ecbb807ba2","name":"Failure: Products are required","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"\",\n \"deviceId\": \"\",\n \"products\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arity.com/registration/v2/users/products"},"status":"Undefined","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400.07.021\",\n \"message\": \"Products are required\"\n }\n ]\n}"},{"id":"83e963bb-694b-4eff-9c40-5e4bdf6295f6","name":"Success: User Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"\",\n \"deviceId\": \"\",\n \"products\": [\n \"Driving Behavior\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arity.com/registration/v2/users/products"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"userId\": \"e840b72f-240c-40f0-89c4-78a052d92797\",\n \"userActive\": true,\n \"products\": [\n \"Driving Behavior\"\n ],\n \"devices\": [\n {\n \"deviceId\": \"631da073-4de2-4e7b-ae21-2dc585a081b0\"\n }\n ],\n \"additionalParameters\": {\n \"effectiveStartDate\": \"2019-01-01\"\n }\n}"},{"id":"d7628910-0997-4d62-8d1a-fd5438e01ed2","name":"Failure: Products must not be null","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"\",\n \"deviceId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arity.com/registration/v2/users/products"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400.07.000\",\n \"message\": \"products must not be null\"\n }\n ]\n}"}],"_postman_id":"145e9950-34e0-40c3-95ea-fa03b6ae47fd"},{"name":"getUserDetails","id":"6fca2629-befa-49f7-a092-5a92bf4dadce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{current-b2b-token}}"}],"url":"https://api.arity.com/registration/v2/users/{{userId}}","description":"Use this endpoint to get a user's details from a userId. You will get back the userId, userActive status, the products the user is registered to, and a list of device objects with deviceIds and whether they are active or inactive.
\n","urlObject":{"protocol":"https","path":["registration","v2","users","{{userId}}"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6fca2629-befa-49f7-a092-5a92bf4dadce"},{"name":"groupAddUser","id":"40588594-4465-48dd-b678-2944adcdfd22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{current-b2b-token}}"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"{{userId}}\"\n}"},"url":"https://api.arity.com/drivinginsights/v1/orgs/{{orgId}}/groups/{{groupId}}/users","urlObject":{"protocol":"https","path":["drivinginsights","v1","orgs","{{orgId}}","groups","{{groupId}}","users"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"40588594-4465-48dd-b678-2944adcdfd22"},{"name":"groupRemoveUser","id":"d067fc2d-8a3d-4741-a0a0-afb99b7769fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.arity.com/drivinginsights/v1/orgs/{{orgId}}/groups/{{groupId}}/users/{{userId}}","urlObject":{"protocol":"https","path":["drivinginsights","v1","orgs","{{orgId}}","groups","{{groupId}}","users","{{userId}}"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d067fc2d-8a3d-4741-a0a0-afb99b7769fa"},{"name":"groupGet","id":"3969d380-a988-4dc6-bd14-001e0ae1b31d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"}],"url":"https://api.arity.com/drivinginsights/v1/orgs/{{orgId}}/groups/{{groupId}}","urlObject":{"protocol":"https","path":["drivinginsights","v1","orgs","{{orgId}}","groups","{{groupId}}"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3969d380-a988-4dc6-bd14-001e0ae1b31d"},{"name":"getUserActivationStatus","id":"2a1a3776-aede-4fc5-a58d-d06e9febb678","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"},{"key":"cache-control","value":"no-cache"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.arity.com/drivinginsights/v1/orgs/{{orgId}}/users/{{userId}}","urlObject":{"protocol":"https","path":["drivinginsights","v1","orgs","{{orgId}}","users","{{userId}}"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a1a3776-aede-4fc5-a58d-d06e9febb678"},{"name":"Activation Reporting by Date Range","id":"e78b337c-90de-45ba-8db0-f52802d4ec48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.arity.com/reporting-insights/orgs/{{orgId}}/report?fromDate=2019-01-01&endDate=2019-02-01","urlObject":{"protocol":"https","path":["reporting-insights","orgs","{{orgId}}","report"],"host":["api","arity","com"],"query":[{"key":"fromDate","value":"2019-01-01"},{"key":"endDate","value":"2019-02-01"}],"variable":[]}},"response":[],"_postman_id":"e78b337c-90de-45ba-8db0-f52802d4ec48"},{"name":"getGroupForUser","id":"648828ec-afce-407d-9e85-a86930f720db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.arity.com/drivinginsights/v1/orgs/{{orgId}}/users/{{userId}}/group","urlObject":{"protocol":"https","path":["drivinginsights","v1","orgs","{{orgId}}","users","{{userId}}","group"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"648828ec-afce-407d-9e85-a86930f720db"},{"name":"createGroup","event":[{"listen":"test","script":{"id":"03bad2e1-3391-4870-83d0-246d434715f7","exec":[""],"type":"text/javascript"}}],"id":"079b96ef-9598-4eb3-8476-070031be383e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"modelName\": \"{{modelName}}\",\n \"userIds\": [\n \"{{userId}}\"\n ],\n \"groupId\": \"{{groupId}}\"\n}"},"url":"https://api.arity.com/drivinginsights/v1/orgs/{{orgId}}/groups","description":"Create a group and assign one of Arity's scoring models so that any user(s) in the group can be scored according to that model. It is possible to have groups with only one user. In that case we suggest naming the groupId the same as the userId.
\n","urlObject":{"protocol":"https","path":["drivinginsights","v1","orgs","{{orgId}}","groups"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"079b96ef-9598-4eb3-8476-070031be383e"}],"id":"16e19504-620e-488b-a440-6b091fa53eac","description":"Every mobile end-user must be identified with an Arity userId, deviceId, and mobile-scope Oauth token. These registration endpoints are used to create users and obtain these credentials. In order to geenrate a driving score for a user, they must be added to a scoring group. We require a unique group for every user, unless they are part of the same insurance policy. All members of one policy may be in the same group together. This will allow you to generate a group driving score if needed.
\n","event":[{"listen":"prerequest","script":{"id":"9597db8b-9f0d-47a5-9cc1-1a1161ae379d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3afa6717-1026-4a94-8574-37d752f83a62","type":"text/javascript","exec":[""]}}],"_postman_id":"16e19504-620e-488b-a440-6b091fa53eac"},{"name":"Scoring","item":[{"name":"getScoreForUser","id":"bdaf2b78-bd69-4ff3-8435-e714d11a6759","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"}],"url":"https://api.arity.com/drivinginsights/v1/orgs/{{orgId}}/users/{{userId}}/user-score","description":"Get an end-user's driving score. Their score is determined by the scoring model that is assigned to that user's group.
\n","urlObject":{"protocol":"https","path":["drivinginsights","v1","orgs","{{orgId}}","users","{{userId}}","user-score"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bdaf2b78-bd69-4ff3-8435-e714d11a6759"},{"name":"getModelForUser","id":"f47f2cfa-a2ae-43ef-9d62-16a429b9de0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.arity.com/drivinginsights/v1/orgs/{{orgId}}/users/{{userId}}/model","urlObject":{"protocol":"https","path":["drivinginsights","v1","orgs","{{orgId}}","users","{{userId}}","model"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f47f2cfa-a2ae-43ef-9d62-16a429b9de0a"}],"id":"fe28ea8f-b758-447a-854f-f55e7a557115","description":"A driving score between 1-100 is generated for every user that has been assigned to a group. Groups must also have a modelName assignment in order to designate the scoring model to be used. WHen retreiving a driving score, please note that the number of trips is returned in the response object. A score is not valid until after the 50th trip if you are showing ads from the insurance marketplace. The correct modelName for showing ads is \"marketplace\".
\n","event":[{"listen":"prerequest","script":{"id":"354eeecc-9ab7-4a36-a8c9-1fecb3de1f90","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4f83e6ba-e228-4365-a30f-8baeca94e161","type":"text/javascript","exec":[""]}}],"_postman_id":"fe28ea8f-b758-447a-854f-f55e7a557115"},{"name":"Activation","item":[{"name":"generateActivationCode","event":[{"listen":"test","script":{"id":"b0682100-8d5c-45f4-82de-9668900f206a","exec":["pm.globals.set(\"latest-activation-code\", pm.response.json().data.activationCode);"],"type":"text/javascript"}}],"id":"8c6f0b07-b186-4848-8557-e96d7a4a8503","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{current-b2b-token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mobileScopeToken\": \"{{user-mobile-token}}\",\n \"deviceId\": \"{{deviceId}}\"\n}"},"url":"https://api.arity.com/drivinginsights/v1/orgs/:orgId/users/:userId/activation","urlObject":{"protocol":"https","path":["drivinginsights","v1","orgs",":orgId","users",":userId","activation"],"host":["api","arity","com"],"query":[],"variable":[{"id":"bbfb857a-5df2-4571-8fc0-7182f86dd053","type":"string","value":"{{orgId}}","key":"orgId"},{"id":"ce914be3-30c5-466c-896d-23c75935e4d5","type":"string","value":"{{userId}}","key":"userId"}]}},"response":[],"_postman_id":"8c6f0b07-b186-4848-8557-e96d7a4a8503"}],"id":"eaad2a90-4cfd-4556-baed-8a43022812d7","description":"Activiation only applies to customers with our white-label app, Routely. End-users must input their activation code before the app will begine tracking their trips. Routely can be downloaded from the app stores.
\n","event":[{"listen":"prerequest","script":{"id":"3971c35d-e6af-4acc-9ef4-cdbd71f22e93","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3f7189ea-2172-4aec-ba70-37bfba7102a7","type":"text/javascript","exec":[""]}}],"_postman_id":"eaad2a90-4cfd-4556-baed-8a43022812d7"}],"id":"d51102af-7642-404f-844a-fdc9084f9cb8","description":"The Arity Driving Engine enables a mobile app to detect, record, and score your end-user's driving behavior. You will need to obtain credentials for each end user, as well as an OAuth token with a mobile-scope. This collections of APIs covers the user registration, as well as retreiving their score, and detailed data on the trips they take.
\nStep 1: Get your client ID and client secret
\nStep2: Generate a b2b-scope access token
\ngenerateToken method to generate a b2b-scope access token by sending your client ID and client secret. This access token expires every hour and must be passed in the header of all subsequent API calls.Step 3: Create and register new users
\ncreateUser method to create new users (representing your individual end-users) on Arity's platform and register them to the \"Driving Behavior\" product. When you create a new user, you can specify the userId and corresponding deviceId, or leave them blank and let Arity generate them for you.Step 4: Create a group for each user
\ncreateGroup method to create one group for each end-user from step 3. This is necessary because Arity generates driving scores at a group level.Step 5: Generate a mobile-scope access token for each user
\ngenerateToken method and generate a mobile-scope access token by sending your client ID and client secret, along with the userId and deviceId from step 3. The mobile-scope token that is returned is uniquely associated with that user.Get a limited scope token from OAuth-platform API under the test TSP2-Dev App for use with our trip-services API proxy.
\n","urlObject":{"protocol":"https","path":["platform","oauth","v1","token"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6fc0e489-2394-4bca-8842-34452ca0f3f0"},{"name":"Create a Booking","id":"bb157e8e-e345-4f9f-bee0-1ca3a9ae61f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{b2b-access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"expectedEndTimestamp\": 1600120880,\n \"imei\": \"xxxxxxxxxxxxxxx\",\n \"sensorType\": \"obdii\",\n \"startTimestamp\": 1599238881,\n \"userId\": \"xxxxxxxxxxxxxxx\",\n \"vin\": \"xxxxxxxxxxxxxxx\",\n \"bookingId\": \"1234512345\"\n}"},"url":"https://api.arity.com/bookings","description":"Creates a booking
\n","urlObject":{"protocol":"https","path":["bookings"],"host":["api","arity","com"],"query":[],"variable":[]}},"response":[{"id":"2c815b05-573d-49da-a8e0-f7eb1c7421c3","name":"booking created","originalRequest":{"method":"POST","header":[{"description":"(Required) Api version required 4.0 accepted for this openApi spec","key":"X-Api-Version","value":"Passes actualEndTimestamp to end the booking
\n","urlObject":{"protocol":"https","path":["bookings",":bookingId"],"host":["api","arity","com"],"query":[{"disabled":true,"description":{"content":"(Required) end timestamp of the booking
\n","type":"text/plain"},"key":"actualEndTimestamp","value":""}],"variable":[{"id":"defbcb75-ba29-4ae5-8aa2-9ebe92291f0a","description":{"content":"(Required) booking identifier
\n","type":"text/plain"},"type":"string","value":"3","key":"bookingId"}]}},"response":[{"id":"8326528b-fb3a-4e2c-96c9-0424a2b68988","name":"active booking not found","originalRequest":{"method":"PATCH","header":[{"description":"(Required) Api version required 4.0 accepted for this openApi spec","key":"X-Api-Version","value":"By passing in the appropriate options, you can search for\nexisting bookings
\n","urlObject":{"protocol":"https","path":["bookings"],"host":["api","arity","com"],"query":[{"disabled":true,"description":{"content":"optional field to return bookings with vin specified as filter
\n","type":"text/plain"},"key":"vin","value":"optional field to return bookings with userId specified as filter
\n","type":"text/plain"},"key":"userId","value":"By passing in the appropriate options, you can search for\nexisting bookings
\n","urlObject":{"protocol":"https","path":["bookings",":bookingId"],"host":["api","arity","com"],"query":[],"variable":[{"id":"ca1b7e70-6544-4838-aa53-c5ae8d389fb1","type":"string","value":"","key":"bookingId"}]}},"response":[{"id":"e14be457-d61c-4225-a055-d3889a33adb7","name":"bookings matching criteria","originalRequest":{"method":"GET","header":[{"description":"(Required) Api version required 4.0 accepted for this openApi spec","key":"X-Api-Version","value":"Shared Mobility’s Booking API allows customers to send additional booking or “rental” data to pair their vehicle trip history to their users or “drivers.” This documentation includes everything needed to successfully pair users to vehicles for an allotted amount of time. If you have any additional questions around using the Booking API, please contact your Customer Success team.
\nAll requests to Arity require authentication and all applications must be registered with us.
\nStep 1. Client ID and Client Secret
\nGet your Client ID and Client Secret. These have already been created and approved by Arity, and have been sent to you. Contact us if you need help locating them.
\nStep 2. Access token
\nGenerate an access token with the Authorization API. This access token expires every hour and must be passed in the header of all subsequent API calls.
\n\nUse the POST https://api.arity.com/platform/oauth/v1/token endpoint to generate a b2b-scope access token by sending your Client ID and Client Secret. The access_token field in the top level is what you'll use for authorization\n\n{\n \"access_token\": \"GRAB THIS ACCESS TOKEN!\",\n \"token_type\": \"bearer\",\n \"expires_in\": \"xxxx\",\n \"scope\": \"b2b\"\n}\n
\nStep 3. Start Booking
\nRequest body parameters
\n\nUse the POST https://api.arity.com/bookings endpoint to start a new booking.\n\nHere is an example request body
\n{\n \"expectedEndTimestamp\": 1600120880,\n \"imei\": \"xxxxxxxxxxxxxxx\",\n \"sensorType\": \"obdii\",\n \"startTimestamp\": 1599238881,\n \"userId\": \"xxxxxxxxxxxxxxx\",\n \"vin\": \"xxxxxxxxxxxxxxx\",\n \"bookingId\": \"xxxxxxxxxxxxxxx\"\n}\n
\nStep 4. End Booking
\n\nUse the PATCH https://api.arity.com/bookings/:bookingId?actualEndTimestamp=actualEndTimestamp endpoint to end a booking that has already been started. Don't forget to include an actualEndTimestamp as a query parameter so we know what time the booking ended!\n","event":[{"listen":"prerequest","script":{"id":"fbbf1f0d-7295-445a-a0fd-42d4cbbcadce","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e8635f69-c71c-4a54-b8a6-9c60e70cd1aa","type":"text/javascript","exec":[""]}}],"_postman_id":"140d8470-e9a7-4bf1-a5a6-cdbc87fb3de8"},{"name":"PreQualCredit","item":[{"name":"users","item":[{"name":"{user Id}","item":[{"name":"prequal-credit-scores","item":[{"name":"createPrequalCreditScore","id":"325a1272-7f2a-47c0-9eaf-0543843b5f9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"(Required)
\n","key":"orgId","value":"create Prequal Credit Score
\n","urlObject":{"path":["users",":userId","prequal-credit-scores"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"62d32192-c285-44b8-a584-06bf8815b0ed","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","key":"orgId","value":"get Prequal Credit Score
\n","urlObject":{"path":["users",":userId","prequal-credit-scores",":scoreId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"b365734c-aeb0-476f-8eaf-dddbbce09732","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","key":"orgId","value":"Retrieve all of the user data we have on a userID including the enrollmentStatus. Required fields: userID
\n","urlObject":{"path":["users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"92a98c65-8dfc-4140-97ef-a4e117b5ce52","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","key":"orgId","value":"Update a user’s data in PreQual. You cannot update a userID. Required fields: userID
\n","urlObject":{"path":["users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"0a233a3b-4ff1-4450-953c-e7770e29aac6","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","key":"orgId","value":"Update a user’s enrollment status within PreQual. A user’s status can be changed at any time to any of the options. Status options are: accepted, pending, rejected. Required fields: userID, enrollmentStatus
\n","urlObject":{"path":["users",":userId","enrollment"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"status","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","key":"orgId","value":"Create a new user in PreQual Coverage. When you create a user they will receive a default enrollment status of pending. In PreQual, user refers to the driver you are wanting to score. Required fields: userID (we will assign one if you do not provide it) d
\n","urlObject":{"path":["users"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"68add696-7a18-433e-bb88-fca3eea844e4","name":"Internal server error","originalRequest":{"method":"POST","header":[{"description":"(Required) ","key":"orgId","value":"PreQual Credit Quickstart Guide
\nSharing Economy's PreQual Credit API allows customers to request a user's driving credit score. This documentation includes everything needed to successfully create and retrieve a user's score. If you have any additional questions around using the PreQual Credit API, please contact your Customer Success team.
\nAll requests to Arity require authentication and all applications must be registered with us.
\nStep 1. Client ID and Client Secret
\nGet your Client ID and Client Secret. These have already been created and approved by Arity, and have been sent to you. Contact us if you need help locating them.
\nStep 2. Access token
\nGenerate an access token with the Authorization API. This access token expires every hour and must be passed in the header of all subsequent API calls.
\nUse the POST https://api.arity.com/platform/oauth/v1/token endpoint to generate a b2b-scope access token by sending your Client ID and Client Secret. The access_token field in the top level is what you'll use for authorization
\n{ \"access_token\": \"GRAB THIS ACCESS TOKEN!\", \"token_type\": \"bearer\", \"expires_in\": \"xxxx\", \"scope\": \"b2b\" }
\nStep 3. Create a User (one time)
\nRequest body parameters
\n{\n \"userId\": \"d0679ee1-9043-4b6c-983c-a58c6bfcb7d2\", /* A unique identifier assigned to a particular person. Optional. Arity will generate one if it is not provided (Save this)! No special characters. */\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"dateOfBirth\": \"2017-10-31\", /* The calendar date on which a person was born. Required. In YYYY-MM-DD format. */\n \"dateUserActivated\": \"2017-10-31\",\n \"homeZip\": \"60647\",\n \"drivingZip\": \"60647\",\n \"addresses\": [ /* List of address with the following format */\n {\n \"status\": \"string\",\n \"number\": \"string\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"zipCode\": \"string\"\n }\n ],\n \"taxId\": \"123456789\" /* A user's TIN */\n}\nUse the POST https://api.arity.com/users endpoint to create a new user.
\nStep 4. Generate Credit Score
\nRequest body parameters
\n*permissiblePurpose -- *Value of either 'CI' or 'EP'\nUse the POST https://api.arity.com/users/{userID}/prequal-credit-score endpoint to create a credit score. Don't forget to save the scoreID from the response, so you can use it as a query parameter to get your score again!
\nStep 5. Retrieve a previous score
\nUse the GET https://api.arity.com/users/{userID}/prequal-credit-score/{scoreId} endpoint to get a previous credit score.
\nStep 6. Get all info on user
\nUse the GET https://api.arity.com/users/{userID endpoint to get all info Arity has on a given user
\n","_postman_id":"42d723a8-97e5-42a3-857a-a4e766bb6fb1"}]}