V2 of the Verikai API Offering
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"22370660","collectionId":"1562c330-8f35-424f-9559-7574fb0a046e","publishedId":"2sA2xfXY8M","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"262262","highlight":"F2AE00"},"publishDate":"2024-03-11T15:58:04.000Z"},"item":[{"name":"Census","item":[{"name":"/census/v2","id":"369dff2e-c2bd-42a4-a121-fd94eca8e63b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"profile_id\": [\n\t\t\n ],\n \"products\": [\"Capture\", \"Capture360\", \"CaptureHealth\"],\n \"filename\": \"\",\n \"report_name\": \"\",\n \"spec_deductible\": \"\",\n \"census\": [\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"gender\": \"\",\n \"dob\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address\": \"\",\n \"zip\": \"\"\n },\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"gender\": \"\",\n \"dob\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address\": \"\",\n \"zip\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.verikai.com/census/v2","description":"The census post endpoint allows for the submission of a group. If the body of a census is left blank then an Amazon S3 presigned url is returned along with a census id for record keeping. The presigned url can be used to directly upload large groups.
\nThe limit for this request is 6mb. If your group size causes the payload to exceed this limit, omit the census attribute and use the returned presigned url to upload the group directly.
\nprofile_id(s) array of strings
An array of profile ids used when submitting the census
\nproducts \"Capture\" | \"Capture360\" | \"CaptureHealth\"[]
An array of string literals
\nfilename string
A user provided filename to apply to the submitted group
\nspec_deductible int
The spec deductible to apply to an MSL submission
\nselected_profiles array of strings
An array of score types used when submitting the census. ie. Capture, Capture360
\nreport_name string
A user provided name to apply to the submitted group
\ncensus array of objects
A group of individuals to be processed
\ncensus_id string
The ID assigned to the group that was submitted. Used to retrieve scores
\nstatus string
The processing status of the census
\nurl string
A Presigned url used to upload a census file directly. Only returned when census body is empty
\nRequests the meta-data about a given census
\nprofile_id string
The profile ID(s) that were used when the census was submitted
\nstatus string
The status of the census
\ncensus object
The census object
\nerrors array
A list of errors returned when trying to process the census
date_created string
The date the census was processed
spec_deductible string
If the census was ran using an MSL profile, the deductible it was submitted with
medrx_status string
The status of the MedRx report, if one was ordered
\n(Required)
\n","type":"text/plain"},"type":"any","value":"capture object
Requests the scores associated with a submitted census. The following objects are only returned if the submitted census was associated with the score type
\ncapture360 object
This object returns all configured Capture360 scores with its associated metadata.
\ncaptureHealth object
This object returns all configured CaptureHealth scores with its associated metadata.
\nThe census scores post endpoint for requesting premium scores (Capture360 or CaptureHealth). Medical claims data for the group (MedRx) will be ordered as part of this process
\nscores \"Capture360\" | \"CaptureHealth\"[]
An array of string literals
\nRequests the scenario results associated with a submitted census. The reponse is an object containing an array of objects with the key \"scenarios\".
\nRequests the individual Capture scores associated with a submitted census.
\nThe response is an object that contains the key \"capture\" which holds an array of score objects which in turn holds all the configured scores as seen below.
\n","urlObject":{"path":["v2",":census_id","individuals"],"host":["https://api.verikai.com"],"query":[{"disabled":true,"key":null,"value":""}],"variable":[{"type":"any","value":"","key":"census_id"}]}},"response":[{"id":"4afcaf21-d6b5-4d33-878e-ad96cacac41c","name":"200 response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.verikai.com/v2/:census_id/individuals","host":["https://api.verikai.com"],"path":["v2",":census_id","individuals"],"query":[{"key":null,"value":"","type":"text","disabled":true}],"variable":[{"key":"census_id","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8917edc2-7812-4239-ac05-385ce986a5c6"}],"id":"336c512b-e7b8-4f34-b2da-406f050a42be","description":"The Census object and it's associated actions
\nhttps://api.verikai.com/census/v2
\n","_postman_id":"336c512b-e7b8-4f34-b2da-406f050a42be"},{"name":"MedRx","item":[{"name":"/medrx/v2/:census_id/medrx-match-rate","id":"e23542c0-0326-416a-a661-8b208341e8f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.verikai.com/medrx/v2/:census_id/medrx-match-rate","description":"This endpoint retrieves the match rate for Medrx based on the provided census ID.
\nMethod: GET
URL: https://api.verikai.com/medrx/v2/:census_id/medrx-match-rate
The response will include the match rate for Medrx based on the provided census ID.
\n{\n \"census_member_count\": 31,\n \"members_matched_with_content\": 23\n}\n\n(Required)
\n","type":"text/plain"},"type":"any","value":"","key":"census_id"}]}},"response":[{"id":"fe5c067e-17ab-4b40-b820-04eb8777f90b","name":"200 response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"This endpoint retrieves high cost conditions for a specific census ID.
\nThe request does not require any parameters or a request body.
\nHTTP Method: GET
\nBase URL: https://api.verikai.com
\nPath: /medrx/v2/:census_id/high-cost-conditions
\nExample Response Body
\n[\n {\n \"Condition\": \"\",\n \"IcdCodes\": \"\",\n \"MembersAllTime\": \"\",\n \"Members12Months\": \"\"\n }\n]\n\n(Required)
\n","type":"text/plain"},"type":"any","value":"","key":"census_id"}]}},"response":[{"id":"540ced04-1ec9-4b4c-ab8e-63db4836b2d1","name":"200 response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"This endpoint allows you to retrieve a list of high cost drugs for a specific census.
\nThe request does not require a request body.
\nhighCostDrugs: An array of high cost drugs associated with the specified census.Example response body:
\n[\n {\n \"RxName\": \"\",\n \"RxCodes\": [],\n \"MembersAllTime\": \"\",\n \"Members12Months\": \"\",\n \"SingleFillCost\": \"\",\n \"AverageSingleFillCost\": 0.0,\n \"TotalGroupSpend\": 0.0\n }\n]\n\n(Required)
\n","type":"text/plain"},"type":"any","value":"","key":"census_id"}]}},"response":[{"id":"2f088e7a-52a9-4263-863d-fb8fea097f0c","name":"200 response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"This endpoint retrieves individual claims for a specific census ID.
\nThis endpoint is paginated if results are greater than 1000. If so, a token will be returned in the body of the response which you can use to receive the next batch of data.
\nGET /v2/:census_id/individual-claims
GET /v2/:census_id/individual-claims?token=\"\"
census_id (path parameter) : The ID of the census for which individual claims are to be retrieved.tokenIf the results are greater than 1000 then they will be paginated. A token will be returned in the response body which you can use to populate the query parameters.
IMPORTANT: You will need to encode the token to populate it in the API call.
\nExample response body:
\n{\n \"individuals\": \n [\n {\n \"individual_id\": \"1234567890\"\n \"total_claims\": \"2000\",\n }\n ],\n \"next_token\": null,\n \"total_individuals\": 1\n}\n\nThis endpoint retrieves a signed url to facilitate the retrieval of MedRx information for the specified report.
\ncensus_id (path parameter) : The ID of the census for which individual claims are to be retrieved.Example response body:
\nhttps: //verikai-census.s3.us-west-2.amazonaws.com/archive/84/2024_03_28/medrx-37ff6320-ed4e-11ee-aee0-c7e64f9977e2-1318.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIA3UMXYTZ57MMXAJIV/20250310/us-west-2/s3/aws4_request&X-Amz-Date=20250310T173825Z&X-Amz-Expires=300&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEEoaCXVzLXdlc3QtMiJHMEUCIBZS+Qgsra8+J4HQ2ekTfeEnfSx80oI+Q53K8A9Eyr8QAiEAyJRSZA1/j3GZtJXXnb1NK+s1ASWqtWJx+YemE1UASPIq9wIIk///////////ARAAGgw3OTk3MTkwNzEzNTUiDHk2+goJPby8xPvRgyrLAunPOF2Lb3QOsAgBB9jJ+gCIc67pn0vIUYNkgIyQgt9kSWZ6gWA+mWeFQphnmA1YIMoaD0BwAqW5x/JotPBbC5k3InxMP59jX6e8WVHc6TKuEecYOs35PFoDGrhrzDJPwmqLavFNDnH+IN/4xt8OarNYownwFKFAI7NmZ6GrZcjBUar0/gxlE5wz0xVYO+PTpLkSWBYywrvMwfdspW8PhnJ2l/Gh12bBGyPvi7qhZS44ysCC7Xhl1MRw2QTFL8bCFvjcgtLWTJhZsQOETM2N0eoYDT+5iVv9X1qPapPr1FOQkc96WkCW5ObKvg6G2SOUUD1OXQKDIl324ZjKHllwcpZlFNexaAsA09dCLybZ/WHdnKVCEwTWv5AZej2dPQFHqlV90aPg8xKz91/soyNMbvJMZCP3A9AuvbdUkYKwOiQsHHJtEKkA9K4qODow8sS8vgY6ngGCZzZSpQQYSPOZj9G/bq9GrcyRSTZ63VxGbokrrQcqku9HtvjPI5y6lm85dGfk9tWN5h4hs7g/Jpu5Godi337MQZD+CENZYPXt1HPobrUmo/4jtReJdQHfxECVOvmZ9Td88hr+EVQRRBzbJ4gNsj+9uMC2qn5WdhxkCbr86MOpV2tTp4BApVBpItU1t9IYPSf8Y3mKSsgGqYPN2Ph7bw==&X-Amz-Signature=af18e79ed95f594d59cd264bd01e3a4abf03a5da8105ade0249c297d94495fb2&X-Amz-SignedHeaders=host&x-id=GetObject\n\nThe MedRx object and it's associated actions
\n\n","_postman_id":"edeb6a8b-315d-4d28-aa1b-9d7cc978eb19"}],"event":[{"listen":"prerequest","script":{"id":"26c70bfb-6957-40f5-837b-4523e293f8ce","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"50db215b-81f2-42f2-824e-e0f8fbe0f1f2","type":"text/javascript","exec":[""]}}],"variable":[{"key":"basePath","value":"census"},{"key":"baseUrl","value":"https://api.verikai.com"},{"key":"apiKey","value":"","type":"string"},{"key":"census_id","value":"","type":"string"}]}