Get exports
Retrieve CSV-formatted reports on claim submissions and outcomes. This endpoint returns Export objects that contain an authenticated URL to a customer’s reports with a 2min TTL. The schema for the CSV export can be found here.
Schema changes: Changing column order, removing columns, or changing the name of a column is considered a Breaking Change. Adding new columns to the end of the Exports file is not considered a Breaking Change and happens periodically. For this reason, it is important that any downstream automation or processes built on top of Candid Health’s export files be resilient to the addition of new columns at the end of the file.
SLA guarantees: Files for a given date are guaranteed to be available after 3 business days. For example, Friday’s file will be available by Wednesday at the latest. If file generation is still in progress upon request before 3 business days have passed, the caller will receive a 422 response. If the file has already been generated, it will be served. Historic files should be available up to 90 days in the past by default. Please email our Support team with any data requests outside of these stated guarantees.
New Customers: This endpoint is not enabled by default for new Candid customers. To have this endpoint enabled for your organization, please email our Support team with the request.
Headers
OAuth authentication of the form <token>.
Query parameters
Beginning date of claim versions returned in the export, ISO 8601 date e.g. 2019-08-24. Must be at least 1 calendar day in the past. Cannot be earlier than 2022-10-07.
Ending date of claim versions returned in the export, ISO 8601 date; e.g. 2019-08-24. Must be within 30 days of start_date.
Response
Report name; contains date strings representing the start and end date of the export.
Authenticated URL where a customer’s report can be retrieved.
Expiration datetime of the authenticated URL. URLs expire after 2 minutes.