{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"704e5876-c41f-4da4-a4c9-a75536bdaa16","name":"CNS Portal DQF API","description":"The url host and credentials (username/password) will be provided by your contact. You may use the credentials to generate an API key (/apikey) that expires after 1 year. All other API operations require the use of that API Key.\n\n**These API Calls operate under terminals, so you can only get/upload drivers under the terminal specified by the API Caller.**\n\nThe general flow of the application is to:\n\n1. Signup a driver\n    \n2. Submit the rest of the application data\n    \n3. Set all of the following previous items:\n    1. Set Previous Addresses\n        \n    2. Set Previous Employers\n        \n    3. Set Previous/Current Licenses\n        \n    4. Set Previous Accidents\n        \n    5. Set Previous Violations\n        \n    6. Set Previous Experiences\n        \n4. Generate the PDFs\n    \n\n**Authentication:**\n\n- `GET API Key`: Retrieves the authentication key required for accessing the API.\n    \n\n**Driver Data Retrieval:**\n\n- `GET Driver List`: Fetches a list of all drivers under a terminal.\n    \n- `GET Driver Detail`: Gets detailed information about a specific driver.\n    \n- `GET Driver Licenses`: Gets all previous/current licenses for a driver.\n    \n- `GET Driver PreviousAddresses`: Gets previous addresses of the driver.\n    \n- `GET Driver PreviousEmployers`: Gets previous employment info of the driver.\n    \n- `GET Driver Accidents`: Gets accidents involving the driver entered in the application.\n    \n- `GET Driver Violations`: Gets violations by the driver entered in the application.\n    \n- `GET Driver Experiences`: Details the driving experience and history of the driver.\n    \n\n**Application Information:**\n\n- `GET Application Detail`: Gets application details on a specific driver.\n    \n- `POST Application Sign Up`: Register a new driver/application and create a portal account.\n    \n- `POST Application Submit`: Submit the application information.\n    \n- `POST Application Set Licenses`: Sets the license information for a driver's application.\n    \n- `POST Application Set Previous Addresses`: Sets the previous addresses for a driver's application.\n    \n- `POST Application Set Previous Employers`: Sets the previous employment details of an application.\n    \n- `POST Application Set Accidents`: Sets accident details for a driver's application.\n    \n- `POST Application Set Violations`: Sets or updates violation details for an application.\n    \n- `POST Application Set Experiences`: Sets experience details for a driver's application.\n    \n- `POST Application Set Negative Drug Result`: Sets the negative drug test result verfied value for an application.\n    \n- `POST Application Generate PDFs`: Generates PDF versions of the application forms and related documents.\n    \n- `POST Driver Bulk Upload`: Allows for bulk uploading of driver data.\n    \n\n**Data Reference Endpoints: (not driver specific)**\n\n- `GET Get Driver's License Types`: Gets a list of driver's license types.\n    \n- `GET Get Endorsement Types`: Gets a list of driver's license endorsement types.\n    \n- `GET Get Restriction Types`: Gets a list of driver's license restriction types.\n    \n- `GET Get AddressYear Types`: Gets a list of address years.\n    \n- `GET Get ExperienceYear Types`: Gets a list of experience years.\n    \n- `GET Get Trailer Types`: Gets a list of trailer types.\n    \n- `GET Get Vehicle Classes`: Gets a list of vehicle classifications.\n    \n- `GET Get Education Types`: Gets a list of education levels.\n    \n- `GET Get Positions`: Gets a list of application positions.\n    \n- `GET Get How Did You Hear Options`: Gets a list of options for the \"How did you hear?\" application question.\n    \n- `GET Get Countries`: Gets a list of available country codes.\n    \n- `GET Get Regions`: Gets a list of region/state code.\n    \n- `GET Get Contact Statuses`: Gets a list of contact statuses.\n    \n- `GET Get Contact Methods`: Gets a list of contact methods.\n    \n- `GET Get Employment Statuses`: Gets a list of employment statuses.\n    \n\n---\n\nThis API collection primarily focuses on managing driver data, driver applications, and provides several reference endpoints for data types used throughout the Driver Qualification system.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"26023582","team":5705634,"collectionId":"704e5876-c41f-4da4-a4c9-a75536bdaa16","publishedId":"2s9YR9YXyy","public":true,"publicUrl":"https://docs.api.cns-portal.com","privateUrl":"https://go.postman.co/documentation/26023582-704e5876-c41f-4da4-a4c9-a75536bdaa16","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/39f9f0c8-b939-46c9-9820-0b73b9947f9a/Q05Tc3F1YXJlLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/39f9f0c8-b939-46c9-9820-0b73b9947f9a/Q05Tc3F1YXJlLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2025-12-05T20:36:40.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/39f9f0c8-b939-46c9-9820-0b73b9947f9a/Q05Tc3F1YXJlLnBuZw==","logoDark":"https://content.pstmn.io/39f9f0c8-b939-46c9-9820-0b73b9947f9a/Q05Tc3F1YXJlLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/01135ab793ae6af5ec30b873ff8bf6542b04e0190c10332e0c0d5047a04c4458","favicon":"https://res.cloudinary.com/postman/image/upload/v1772199473/team/f13b6b2a5e732965de04328f2e3d457b.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.api.cns-portal.com/view/metadata/2s9YR9YXyy"}