{"components":{"responses":{"unprocessable_entity":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Unprocessable Entity"}},"schemas":{"WebhookSubscriptionsResponse":{"description":"A response containing multiple WebhookSubscriptions","properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookSubscription"},"type":"array"}},"title":"WebhookSubscriptionsResponse","type":"object"},"Enrollment":{"description":"The defined access of a household member to a given benefit Program","example":{"enrolled_at":"2022-01-01T22:01:00Z","enrollment_events":[{"category":"created","details":{"something":"someval"},"id":789}],"expires_at":"2023-01-01T22:01:00Z","id":345,"member_id":"AcEyH","program_id":"391b64c0-2c09-4c4d-a6f6-b923f14a0048"},"properties":{"enrolled_at":{"description":"Date / Time of Enrollment","format":"date-time","type":"string"},"expires_at":{"description":"Date / Time when the Enrollment expires","format":"date-time","type":"string"},"id":{"description":"Record identifier","type":"string"},"member_id":{"description":"Member ID","type":"string"},"program_id":{"description":"Program ID","format":"uuid","type":"string"}},"title":"Enrollment","type":"object"},"MemberSearchParams":{"description":"Parameters for a member search","properties":{"born_on":{"description":"Date of birth","example":"1976-07-04","format":"date","type":"string"},"employee_id":{"description":"Employee ID of primary participant","example":"abc1234","type":"string"},"first_name":{"description":"First name","example":"george","type":"string"},"first_name_prefix":{"description":"First initial","example":"g","minLength":1,"type":"string"},"last_name":{"description":"Last name","example":"washington","type":"string"},"last_name_prefix":{"description":"First 3 characters of last name","example":"was","minLength":3,"type":"string"},"updated_since":{"description":"Updated since date","example":"2020-01-01","format":"date","type":"string"}},"title":"MemberSearchParams","type":"object"},"MemberEmail":{"description":"member email","properties":{"type":{"description":"email type","enum":["personal","work","primary_member","other"],"type":"string"},"value":{"description":"email address","format":"email","type":"string"}},"title":"MemberEmail","type":"object"},"ClaimLineItem":{"description":"Line item for a claim service","properties":{"amount_charged":{"description":"Charge for listed service","type":"string"},"claim_line_identifier":{"description":"provider-managed unique identifier for line item","type":"string"},"cpt_code":{"description":"CPT code","type":"string"},"diagnosis_pointer":{"description":"Reference to diagnosis tied to service","type":"string"},"line_number":{"description":"line item number","type":"integer"},"note":{"description":"provider notes","type":"string"}},"title":"ClaimLineItem","type":"object"},"ProgramsResponse":{"description":"Response containing multiple Programs","properties":{"data":{"items":{"$ref":"#/components/schemas/Program"},"type":"array"},"end_cursor":{"description":"Cursor of the last program on this page. Pass it as `after` for the next page.","nullable":true,"type":"string"},"has_next_page":{"description":"Whether more programs follow this page. Reliable when paging forward with `first`; always `true` for a request with `last` and `before`.","type":"boolean"},"has_previous_page":{"description":"Whether more programs precede this page. Reliable when paging backward with `last`; always `true` for a request with `first` and `after`.","type":"boolean"},"start_cursor":{"description":"Cursor of the first program on this page. Pass it as `before` for the previous page.","nullable":true,"type":"string"}},"title":"ProgramsResponse","type":"object"},"ConsentResponse":{"description":"Response schema for a single consent","properties":{"data":{"$ref":"#/components/schemas/Consent"}},"title":"ConsentResponse","type":"object"},"FieldErrors":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Attributes that were each valid but inconsistent, keyed by field name","title":"FieldErrors","type":"object"},"MemberRequest":{"description":"body for creating an enrollment","properties":{"member":{"anyOf":[{"$ref":"#/components/schemas/Member"}]}},"required":["member"],"title":"MemberRequest","type":"object"},"Consent":{"description":"A response by a member to a request for legal consent","example":{"category":"sms","consent_details":{"sms_phone_number":"+15558675309"},"consented_at":"2022-01-01T22:01:00Z","id":"123","member_id":"aCeYh","member_response":true,"program_id":"180badec-7a57-4116-8814-909b020427fd"},"properties":{"category":{"description":"Category","type":"string"},"consent_details":{"additionalProperties":true,"nullable":true,"type":"object"},"consented_at":{"description":"Date / Time of Consent","format":"date-time","type":"string"},"id":{"description":"Unique identifier","type":"string"},"member_id":{"description":"Member identifier","type":"string"},"member_response":{"type":"boolean"},"program_id":{"description":"Program identifier","format":"uuid","type":"string"}},"title":"Consent","type":"object"},"MemberResponse":{"description":"Response schema for a single member","properties":{"data":{"$ref":"#/components/schemas/Member"}},"title":"MemberResponse","type":"object"},"MembersResponse":{"description":"Response containing multiple Members","properties":{"data":{"items":{"$ref":"#/components/schemas/Member"},"type":"array"},"end_cursor":{"type":"string"},"start_cursor":{"type":"string"}},"title":"MembersResponse","type":"object"},"ClaimDiagnosis":{"description":"Diagnosis for a claim","properties":{"code":{"description":"ICD10 diagnosis code","type":"string"},"qualifier":{"description":"diagnosis priority","enum":["primary","other"],"type":"string"}},"title":"ClaimDiagnosis","type":"object"},"WebhookSubscription":{"description":"A subscription to receive event notifications via a webhook callback URL","example":{"event":"member.create","id":"C04BD965-399D-4241-AD06-573E487634F3","program_id":null,"url":"https://test.test/webhookrecv"},"properties":{"event":{"description":"Event identifier","type":"string"},"id":{"description":"Unique identifier","format":"uuid","type":"string"},"program_id":{"description":"Optional program ID to scope the subscription. When set, only events for members enrolled in this program will be delivered.","format":"uuid","nullable":true,"type":"string"},"url":{"description":"Callback URL","type":"string"}},"title":"WebhookSubscription","type":"object"},"Claim":{"description":"A claim for payment for services rendered","example":{"admitted_on":"2025-01-02","allowed_amount":"123.45","billing_provider_npi":"ABC12345","charge_amount":"123.45","claim_id":"AA12345","claim_member_identifier":"MEM123456789","coinsurance_amount":"0.00","copayment_amount":"0.00","deductible_amount":"123.45","diagnoses":[{"code":"A12345","qualifier":"primary"},{"code":"B23456","qualifier":"other"}],"discharged_on":"2025-01-04","end_on":"2025-01-04","id":"391b64c0-2c09-4c4d-a6f6-b923f14a0048","in_network":false,"line_items":[{"amount_charged":"123.45","claim_line_identifier":"BBB001-01","cpt_code":"ABC12345","diagnosis_pointer":"A","line_number":1,"note":"PBQ RTS AACM5"}],"member_id":"AcEyH","paid_amount":"123.45","paid_on":"2025-01-04","referring_provider_npi":"ABC23456","rendering_provider_npi":"ABC34567","service_location_npi":"ABC45678","start_on":"2025-01-02","total_cost_amount":"123.45"},"properties":{"admitted_on":{"description":"Date of admission (for inpatient procedures)","format":"date","type":"string"},"allowed_amount":{"description":"Allowed amount","type":"string"},"billing_provider_npi":{"description":"NPI for billing provider","type":"string"},"charge_amount":{"description":"charged amount","type":"string"},"claim_id":{"description":"Claim Identifier from claimant","type":"string"},"claim_member_identifier":{"description":"Unique member identifier supplied with claim","type":"string"},"coinsurance_amount":{"description":"coinsurance amount","type":"string"},"copayment_amount":{"description":"copayment amount","type":"string"},"deductible_amount":{"description":"deductible amount","type":"string"},"diagnoses":{"items":{"$ref":"#/components/schemas/ClaimDiagnosis"},"type":"array"},"discharged_on":{"description":"Date of discharge (for inpatient procedures)","format":"date","type":"string"},"end_on":{"description":"Claim end date","format":"date","type":"string"},"id":{"description":"Unique identifier","type":"string"},"in_network":{"description":"Indicator that the claim is in-network","type":"boolean"},"line_items":{"items":{"$ref":"#/components/schemas/ClaimLineItem"},"type":"array"},"member_id":{"description":"Datanexus member ID","type":"string"},"paid_amount":{"description":"paid amount","type":"string"},"paid_on":{"description":"Date on which claim was paid","format":"date","type":"string"},"referring_provider_npi":{"description":"NPI for referring provider","type":"string"},"rendering_provider_npi":{"description":"NPI for rendering provider","type":"string"},"service_location_npi":{"description":"NPI for service location","type":"string"},"start_on":{"description":"Claim begin date","format":"date","type":"string"},"total_cost_amount":{"description":"total cost amount","type":"string"}},"title":"Claim","type":"object"},"HouseholdMember":{"description":"A member in a primary member's household","properties":{"born_on":{"description":"Date of birth","format":"date","type":"string"},"email":{"description":"email address","format":"email","type":"string"},"enrollments":{"description":"Member enrollments","items":{"$ref":"#/components/schemas/Enrollment"},"type":"array"},"first_name":{"description":"First Name","type":"string"},"id":{"description":"Unique identifier","type":"string"},"last_name":{"description":"Last Name","type":"string"}},"title":"HouseholdMember","type":"object"},"EnrollmentRequest":{"description":"POST body for creating an enrollment","properties":{"enrollment":{"anyOf":[{"$ref":"#/components/schemas/Enrollment"}]}},"required":["enrollment"],"title":"EnrollmentRequest","type":"object"},"EnrollmentResponse":{"description":"Response schema for a single enrollment","properties":{"data":{"$ref":"#/components/schemas/Enrollment"}},"title":"EnrollmentResponse","type":"object"},"ConsentRequest":{"description":"POST body for creating a consent","properties":{"consent":{"anyOf":[{"$ref":"#/components/schemas/Consent"}]}},"required":["consent"],"title":"ConsentRequest","type":"object"},"WebhookSubscriptionResponse":{"description":"Response schema for a single webhook subscription","properties":{"data":{"$ref":"#/components/schemas/WebhookSubscription"}},"title":"WebhookSubscriptionResponse","type":"object"},"HouseholdMembersResponse":{"description":"Response containing multiple Members in a household","properties":{"data":{"items":{"$ref":"#/components/schemas/HouseholdMember"},"type":"array"},"end_cursor":{"type":"string"},"start_cursor":{"type":"string"}},"title":"HouseholdMembersResponse","type":"object"},"Program":{"description":"A program offered by a vendor to a Sponsor's Members","example":{"id":"12345","name":"Acme Inc. MyHealthPal"},"properties":{"id":{"description":"Unique identifier","type":"string"},"name":{"description":"Name","type":"string"}},"title":"Program","type":"object"},"WebhookSubscriptionRequest":{"description":"POST body for creating a webhook subscription","properties":{"webhook_subscription":{"anyOf":[{"$ref":"#/components/schemas/WebhookSubscription"}]}},"required":["webhook_subscription"],"title":"WebhookSubscriptionRequest","type":"object"},"Member":{"description":"A member who accesses healthcare services","example":{"born_on":"1975-05-15","city":"Newport Beach","consents":[{"category":"sms","consent_details":{"sms_phone_number":"+15558675309"},"consented_at":"2024-01-02T12:00:00Z","id":"1234567890","member_id":"A5c7X","program_id":"ABCDE-13245-ABCDEFGH12345678"}],"eligibility_end_on":"2025-01-01","eligibility_start_on":"2024-01-01","email":"abc@def.test","employee_id":"BO12345","enrollments":[{"enrolled_at":"2024-01-02T12:05:00Z","expires_at":null,"id":"2345678901","member_id":"A5c7X","program_id":"ABCDE-13245-ABCDEFGH12345678"}],"first_name":"Michael","gender":"male","group_number":"GRP-9001","health_plan_coverage_tier":"Employee Only","health_plan_description":"TestInsurer, Inc.","health_plan_identifier":"ABC123","health_plan_subscriber_id":"SUB-123456","id":"A5c7X","insurance_identifiers":[{"id":"987654321","name":"bcbs"}],"last_name":"Bluth","middle_name":"George","option_id":"9743","parent_sponsor_member_identifier":null,"phone_number":"+19875555550","postal_code":"92658","relationship_type":"PP","sponsor_member_identifier":"123456789","state":"CA","street_address_1":"1 Lucille Lane"},"properties":{"group_number":{"description":"Insurance group number","type":"string"},"vendor_data":{"description":"Free-form vendor-specific member attributes. Writes upsert; reads return the array of vendor datasets accessible to the caller.","oneOf":[{"additionalProperties":true,"type":"object"},{"items":{"additionalProperties":true,"type":"object"},"type":"array"}]},"postal_code":{"description":"Postal Code","type":"string"},"insurance_identifiers":{"description":"Member identifiers and other info for insurance providers","items":{"$ref":"#/components/schemas/InsuranceIdentifier"},"type":"array"},"eligibility_end_on":{"description":"Date on which member is no longer eligible for services","format":"date","type":"string"},"relationship_type":{"description":"Member relationship to parent member","type":"string"},"work_email":{"deprecated":true,"description":"Employer-provided email address","format":"email","type":"string"},"employee_id":{"description":"Employee ID","type":"string"},"eligibility_start_on":{"description":"Date on which member is eligible for services","format":"date","type":"string"},"option_id":{"description":"Option ID","type":"string"},"payment_card_number":{"description":"Payment card number, when applicable","type":"string"},"gender":{"description":"Gender","enum":["female","male","unknown"],"type":"string"},"email":{"deprecated":true,"description":"email address","format":"email","type":"string"},"health_plan_coverage_tier":{"description":"Health Plan coverage tier","type":"string"},"city":{"description":"City","type":"string"},"health_plan_description":{"description":"Health Plan description (usually insurance carrier name)","type":"string"},"street_address_1":{"description":"Street Address (line 1)","type":"string"},"emails":{"description":"Member emails","items":{"$ref":"#/components/schemas/MemberEmail"},"type":"array"},"street_address_2":{"description":"Street Address (line 2)","nullable":true,"type":"string"},"born_on":{"description":"Date of birth","format":"date","type":"string"},"parent_sponsor_member_identifier":{"description":"Sponsor member identifier for parent member","type":"string"},"consents":{"description":"Member consents for program","items":{"$ref":"#/components/schemas/Consent"},"type":"array"},"country":{"description":"Country","type":"string"},"sponsor_member_identifier":{"description":"Sponsor member identifier","type":"string"},"state":{"description":"State","type":"string"},"last_name":{"description":"Last Name","type":"string"},"id":{"description":"Datanexus Unique identifier","type":"string"},"phone_number":{"description":"Phone Number","type":"string"},"first_name":{"description":"First Name","type":"string"},"health_plan_subscriber_id":{"description":"Subscriber ID with the insurance provider","type":"string"},"enrollments":{"description":"Member enrollments in program","items":{"$ref":"#/components/schemas/Enrollment"},"type":"array"},"middle_name":{"description":"Middle Name","type":"string"},"health_plan_identifier":{"description":"Health Plan Identifier","type":"string"}},"title":"Member","type":"object"},"PingResponse":{"description":"Ping response","properties":{"response":{"type":"string"}},"title":"PingResponse","type":"object"},"ProgramResponse":{"description":"Response schema for a single program","properties":{"data":{"$ref":"#/components/schemas/Program"}},"title":"ProgramResponse","type":"object"},"ClaimsResponse":{"description":"Response containing multiple Claims","properties":{"data":{"items":{"$ref":"#/components/schemas/Claim"},"type":"array"},"end_cursor":{"type":"string"},"start_cursor":{"type":"string"}},"title":"ClaimsResponse","type":"object"},"MemberSearchResponse":{"description":"Response containing multiple Members","properties":{"data":{"items":{"$ref":"#/components/schemas/Member"},"type":"array"},"more_results":{"description":"More members match than the search returned. The search cannot be paged: narrow the criteria and search again.","type":"boolean"}},"title":"MemberSearchResponse","type":"object"},"RequestValidationErrors":{"description":"The request did not match the request schema","items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"},"title":{"type":"string"}},"type":"object"},"title":"RequestValidationErrors","type":"array"},"ClaimResponse":{"description":"Response schema for a single claim","properties":{"data":{"$ref":"#/components/schemas/Claim"}},"title":"ClaimResponse","type":"object"},"ClaimRequest":{"description":"POST body for creating a claim","properties":{"claim":{"anyOf":[{"$ref":"#/components/schemas/Claim"}]}},"required":["claim"],"title":"ClaimRequest","type":"object"},"CodedError":{"additionalProperties":false,"description":"A failure with a stable code","properties":{"code":{"description":"Stable reason for the failure. Branch on this, not on `detail`.","enum":["no_prevailing_sponsor_member","program_not_found","not_eligible_for_program"],"type":"string"},"detail":{"description":"Human-readable reason","type":"string"}},"required":["code","detail"],"title":"CodedError","type":"object"},"EnrollmentCreateError":{"description":"Response schema for a failed enrollment create","example":{"errors":{"code":"not_eligible_for_program","detail":"Member is not eligible for this program on the enrollment date."}},"properties":{"errors":{"description":"A coded failure, a map of field errors, or a list of request validation errors.","oneOf":[{"additionalProperties":false,"description":"A failure with a stable code","properties":{"code":{"description":"Stable reason for the failure. Branch on this, not on `detail`.","enum":["no_prevailing_sponsor_member","program_not_found","not_eligible_for_program"],"type":"string"},"detail":{"description":"Human-readable reason","type":"string"}},"required":["code","detail"],"title":"CodedError","type":"object"},{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Attributes that were each valid but inconsistent, keyed by field name","title":"FieldErrors","type":"object"},{"description":"The request did not match the request schema","items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"},"title":{"type":"string"}},"type":"object"},"title":"RequestValidationErrors","type":"array"}]}},"required":["errors"],"title":"EnrollmentCreateError","type":"object"},"InsuranceIdentifier":{"description":"Member identifier for an insurance provider","properties":{"coverage_begin_on":{"description":"Date on which coverage begins","format":"date","type":"string"},"coverage_end_on":{"description":"Date on which coverage ends","format":"date","type":"string"},"id":{"description":"Insurer-specific identifier","type":"string"},"name":{"description":"Insurer name","type":"string"}},"title":"InsuranceIdentifier","type":"object"}},"securitySchemes":{"ApiKeyAuth":{"in":"header","name":"authorization","type":"apiKey"}}},"info":{"contact":{"email":"developers@darthealth.com"},"description":"Group Health and Benefits Data. Solved.\n---\nThis is the API for Dart Health's [Data Nexus](https://www.darthealth.com/product). It supports benefits Administrators, Providers, Employers, and Analysts who need to manage real-time information for eligible Program Members.\n\nIn order to authenticate your API requests, please include your API key in the header:\n\n```\nauthorization: apikey YOURAPIKEYHERE\n```\n\n## Client libraries:\n\n### Ruby\n\nA Ruby client is maintained for this API, the [`data_nexus`](https://rubygems.org/gems/data_nexus) gem, with its source at [github.com/DartHealth/datanexus-ruby](https://github.com/DartHealth/datanexus-ruby). It is optional, as every endpoint also works over plain HTTP. It handles:\n  * the `authorization: apikey` header and the base URL;\n  * checking a member search's parameters against the valid combinations before sending, raising `ArgumentError` for any other;\n  * adding `program_id` to enrollment and consent create requests;\n  * paging through `GET /api/members` and `GET /api/programs`;\n  * Error classes per failure, such as `DataNexus::UnprocessableEntityError`, and `DataNexus::RateLimitError` with `retry_after`.\n\nIt installs from RubyGems.org with `gem \"data_nexus\", \">= 0.3\"` in a Gemfile. `client.programs.list` needs version 0.3.0 or later. For example:\n```\nclient = DataNexus::Client.new(api_key: ENV[\"DATANEXUS_API_KEY\"], base_url: ENV[\"DATANEXUS_BASE_URL\"])\nprogram = client.programs.list(name: \"Example Program\").data.first\nclient.programs(program[:id]).search_members(born_on: \"1976-07-04\", employee_id: \"ABC1234\")\n```\n\nIt covers programs (`GET /api/programs`); program members, including search (`/api/programs/{program_id}/members/search`), list, show, update and household; members (`/api/members`: list, show, update); and each member's enrollments (`/api/members/{member_id}/enrollments`) and consents (`/api/members/{member_id}/consents`): create, show, update and delete.\n\n\n## About Dart Health\n\nMore info is available at [https://www.darthealth.com/](https://www.darthealth.com/).\n\n## CHANGELOG (newest entries first):\n\n* 2026-10-07 A failed enrollment create now says why. When the member or program is the problem,\nits `422` body carries an `errors.code` of `no_prevailing_sponsor_member`, `program_not_found` or\n`not_eligible_for_program`, where it previously said only \"Unprocessable Content\". Field and\nrequest validation errors keep their shapes, with no `code`. The status is still `422`.\n* 2026-10-05 The reference describes `data_nexus`, the Ruby client for this API, and the endpoints it covers.\nIts server is now the path `/`, which resolves against the host that serves it.\n* 2026-10-02 List Members (`GET /api/members`) is no longer deprecated.\n* 2026-09-29 List programs now accepts the `first`, `last`, `after` and `before` paging\nparameters and a case-insensitive `name` filter, and returns `has_next_page` and\n`has_previous_page`. Invalid paging input returns 422. Show program now documents its\n`data` wrapper.\n* 2026-09-28 Member search now documents its result cap, that it cannot be paged, and what\n`more_results` means.\n* 2025-05-01 Member emails will now be provided as a list element, `emails`. We have deprecated `email` and\n`work_email` but will provide them until the next major API version update.\n","title":"DataNexus","version":"1.0"},"openapi":"3.0.0","paths":{"/api/claims":{"get":{"callbacks":{},"operationId":"DatanexusApi.ClaimController.index","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimsResponse"}}},"description":"Claims response"}},"summary":"List Claims","tags":["claims"]}},"/api/claims/{id}":{"delete":{"callbacks":{},"description":"Delete a claim by ID","operationId":"DatanexusApi.ClaimController.delete","parameters":[{"description":"Claim ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":"Empty response"}},"summary":"Delete claim","tags":["claims"]},"get":{"callbacks":{},"description":"Show a claim by ID","operationId":"DatanexusApi.ClaimController.show","parameters":[{"description":"Claim ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Claim"}}},"description":"Claim"}},"summary":"Show claim","tags":["claims"]},"patch":{"callbacks":{},"description":"Update a claim by ID","operationId":"DatanexusApi.ClaimController.update (2)","parameters":[{"description":"Claim ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"description":"Claim attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimResponse"}}},"description":"Claim"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Update claim","tags":["claims"]},"put":{"callbacks":{},"description":"Update a claim by ID","operationId":"DatanexusApi.ClaimController.update","parameters":[{"description":"Claim ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"description":"Claim attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimResponse"}}},"description":"Claim"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Update claim","tags":["claims"]}},"/api/members":{"get":{"callbacks":{},"description":"Request data on members. This operation supports limited filtering.","operationId":"DatanexusApi.MemberController.index","parameters":[{"description":"Cursor for next group of records","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Cursor for previous group of records","in":"query","name":"before","required":false,"schema":{"type":"string"}},{"description":"Date of Birth","example":"2020-01-01","in":"query","name":"born_on","required":false,"schema":{"format":"date","type":"string"}},{"description":"Number of records to fetch after cursor","in":"query","name":"first","required":false,"schema":{"type":"integer"}},{"description":"Return members with provided first name","in":"query","name":"first_name","required":false,"schema":{"type":"string"}},{"description":"Number of records to fetch after cursor","in":"query","name":"last","required":false,"schema":{"type":"integer"}},{"description":"Return members with provided last name","in":"query","name":"last_name","required":false,"schema":{"type":"string"}},{"description":"[DEPRECATED]Return only pending members","in":"query","name":"pending","required":false,"schema":{"type":"boolean"}},{"description":"Return members eligible for the specified Program","in":"query","name":"program_id","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Return records updated since this date/time","example":"2020-01-01T00:00:00Z","in":"query","name":"updated_since","required":false,"schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Members response","headers":{"X-Cursor-Next":{"description":"cursor for next page of records","style":"simple"}}}},"summary":"List Members","tags":["members"]}},"/api/members/{id}":{"get":{"callbacks":{},"deprecated":true,"description":"Show a member by ID","operationId":"DatanexusApi.MemberController.show","parameters":[{"description":"Member ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}},"description":"Member"}},"summary":"Show member","tags":["members"]},"patch":{"callbacks":{},"deprecated":true,"description":"Update a member by ID","operationId":"DatanexusApi.MemberController.update (2)","parameters":[{"description":"Member ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberRequest"}}},"description":"Member attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberResponse"}}},"description":"Member"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Update member","tags":["members"]},"put":{"callbacks":{},"deprecated":true,"description":"Update a member by ID","operationId":"DatanexusApi.MemberController.update","parameters":[{"description":"Member ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberRequest"}}},"description":"Member attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberResponse"}}},"description":"Member"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Update member","tags":["members"]}},"/api/members/{id}/republish":{"post":{"callbacks":{},"deprecated":true,"description":"Republish a member by ID","operationId":"DatanexusApi.MemberController.republish","parameters":[{"description":"Member ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}},"description":"Member"}},"summary":"Republish member","tags":["members"]}},"/api/members/{member_id}/claims":{"post":{"callbacks":{},"operationId":"DatanexusApi.ClaimController.create","parameters":[{"description":"Member ID","in":"path","name":"member_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"description":"Claim attributes","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimResponse"}}},"description":"Claim"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Create claim","tags":["claims"]}},"/api/members/{member_id}/consents":{"post":{"callbacks":{},"operationId":"DatanexusApi.ConsentController.create","parameters":[{"description":"Member ID","in":"path","name":"member_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentRequest"}}},"description":"Consent attributes","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentResponse"}}},"description":"Consent"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Create consent","tags":["consents"]}},"/api/members/{member_id}/consents/{id}":{"delete":{"callbacks":{},"description":"Delete an consent by ID","operationId":"DatanexusApi.ConsentController.delete","parameters":[{"description":"Member ID","in":"path","name":"member_id","required":true,"schema":{"type":"string"}},{"description":"Consent ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Empty response"}},"summary":"Delete consent","tags":["consents"]},"get":{"callbacks":{},"description":"Show a consent by ID","operationId":"DatanexusApi.ConsentController.show","parameters":[{"description":"Member ID","in":"path","name":"member_id","required":true,"schema":{"type":"string"}},{"description":"Consent ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentResponse"}}},"description":"Consent"}},"summary":"Show consent","tags":["consents"]},"patch":{"callbacks":{},"description":"Update an consent by ID","operationId":"DatanexusApi.ConsentController.update (2)","parameters":[{"description":"Member ID","in":"path","name":"member_id","required":true,"schema":{"type":"string"}},{"description":"Consent ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentRequest"}}},"description":"Consent attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentResponse"}}},"description":"Consent"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Update consent","tags":["consents"]},"put":{"callbacks":{},"description":"Update an consent by ID","operationId":"DatanexusApi.ConsentController.update","parameters":[{"description":"Member ID","in":"path","name":"member_id","required":true,"schema":{"type":"string"}},{"description":"Consent ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentRequest"}}},"description":"Consent attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentResponse"}}},"description":"Consent"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Update consent","tags":["consents"]}},"/api/members/{member_id}/enrollments":{"post":{"callbacks":{},"operationId":"DatanexusApi.EnrollmentController.create","parameters":[{"description":"Member ID","in":"path","name":"member_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentRequest"}}},"description":"Enrollment attributes","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentResponse"}}},"description":"Enrollment"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCreateError"}}},"description":"The enrollment was not created. The causes below all return `422`, so tell them apart by the shape of `errors`.\n\nWhen `errors` is an object with a `code`, branch on the code:\n\n* `no_prevailing_sponsor_member`: the member has no sponsor membership to enroll under.\n* `program_not_found`: `program_id` is missing, no program has that ID, or the program is not available to this API key.\n* `not_eligible_for_program`: the member's most recent sponsor membership has no active eligibility period for the program on the enrollment date. That date is the UTC date of `enrolled_at`, or today in UTC when it is absent. This is also the answer for another sponsor's program that this API key can see.\n\nWhen `errors` is an object without a `code`, it maps field names to messages: the attributes were each valid but inconsistent, such as an `expires_at` before `enrolled_at`.\n\nWhen `errors` is a list, the request did not match the request schema.\n"}},"summary":"Create enrollment","tags":["enrollments"]}},"/api/members/{member_id}/enrollments/{id}":{"delete":{"callbacks":{},"description":"Delete an enrollment by ID","operationId":"DatanexusApi.EnrollmentController.delete","parameters":[{"description":"Member ID","in":"path","name":"member_id","required":true,"schema":{"type":"string"}},{"description":"Enrollment ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Empty response"}},"summary":"Delete enrollment","tags":["enrollments"]},"get":{"callbacks":{},"description":"Show an enrollment by ID","operationId":"DatanexusApi.EnrollmentController.show","parameters":[{"description":"Member ID","in":"path","name":"member_id","required":true,"schema":{"type":"string"}},{"description":"Enrollment ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentResponse"}}},"description":"Enrollment"}},"summary":"Show enrollment","tags":["enrollments"]},"patch":{"callbacks":{},"description":"Update an enrollment by ID","operationId":"DatanexusApi.EnrollmentController.update (2)","parameters":[{"description":"Member ID","in":"path","name":"member_id","required":true,"schema":{"type":"string"}},{"description":"Enrollment ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentRequest"}}},"description":"Enrollment attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentResponse"}}},"description":"Enrollment"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Update enrollment","tags":["enrollments"]},"put":{"callbacks":{},"description":"Update an enrollment by ID","operationId":"DatanexusApi.EnrollmentController.update","parameters":[{"description":"Member ID","in":"path","name":"member_id","required":true,"schema":{"type":"string"}},{"description":"Enrollment ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentRequest"}}},"description":"Enrollment attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentResponse"}}},"description":"Enrollment"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Update enrollment","tags":["enrollments"]}},"/api/pings":{"get":{"callbacks":{},"operationId":"DatanexusApi.PingController.index","parameters":[],"responses":{"200":{"content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PingResponse"}}},"description":"Pong response"}},"summary":"request a test response","tags":["testing"]}},"/api/programs":{"get":{"callbacks":{},"description":"Lists the programs your API key can see, ordered by name.\n\nResults are paged by cursor. Without `first` or `last`, a page holds 25 programs. To read the next page, pass the response's `end_cursor` as `after`, and stop when `has_next_page` is `false`.\n","operationId":"DatanexusApi.ProgramController.index","parameters":[{"description":"Return programs after this cursor (an `end_cursor`)","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Return programs before this cursor (a `start_cursor`)","in":"query","name":"before","required":false,"schema":{"type":"string"}},{"description":"Number of programs to return, paging forward","in":"query","name":"first","required":false,"schema":{"maximum":10000,"minimum":1,"type":"integer"}},{"description":"Number of programs to return, paging backward","in":"query","name":"last","required":false,"schema":{"maximum":10000,"minimum":1,"type":"integer"}},{"description":"Return only programs with this name, ignoring case","example":"Acme Inc. MyHealthPal","in":"query","name":"name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramsResponse"}}},"description":"Programs response","headers":{"x-end-cursor":{"description":"Cursor of the last program on the page","schema":{"type":"string"},"style":"simple"},"x-start-cursor":{"description":"Cursor of the first program on the page","schema":{"type":"string"},"style":"simple"}}},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"List Programs","tags":["programs"]}},"/api/programs/{id}":{"get":{"callbacks":{},"description":"Show a program by ID","operationId":"DatanexusApi.ProgramController.show","parameters":[{"description":"Program ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramResponse"}}},"description":"Program"},"404":{"description":"Program not found"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Show program","tags":["programs"]}},"/api/programs/{program_id}/members":{"get":{"callbacks":{},"operationId":"DatanexusApi.ProgramMemberController.index","parameters":[{"description":"Program Identifier","in":"path","name":"program_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"First name","example":"george","in":"query","name":"first_name","required":false,"schema":{"type":"string"}},{"description":"First initial","example":"g","in":"query","name":"first_name_prefix","required":false,"schema":{"type":"string"}},{"description":"Last name","example":"washington","in":"query","name":"last_name","required":false,"schema":{"type":"string"}},{"description":"First 3 characters of last name","example":"was","in":"query","name":"last_name_prefix","required":false,"schema":{"type":"string"}},{"description":"Date of Birth","example":"2020-01-01","in":"query","name":"born_on","required":false,"schema":{"format":"date","type":"string"}},{"description":"Employee ID of primary participant","example":"abc123","in":"query","name":"employee_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Program Members response","headers":{"X-Cursor-Next":{"description":"cursor for next page of records","style":"simple"}}}},"summary":"List Program Members","tags":["members"]}},"/api/programs/{program_id}/members/search":{"post":{"callbacks":{},"description":"Returns the program's members who match one combination of search criteria.\n\nA search returns at most 10 members and cannot be paged: cursor and paging parameters are ignored. When more members match, the response sets `more_results` to `true`. Treat the list as incomplete, and narrow the criteria, for example by adding `employee_id` or the full first and last name, then search again.\n","operationId":"DatanexusApi.ProgramMemberController.search","parameters":[{"description":"Program ID","in":"path","name":"program_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"by_employee_id":{"summary":"search by employee ID and DOB","value":{"born_on":"1976-07-04","employee_id":"ABC1234"}},"by_name":{"summary":"search by member name","value":{"born_on":"1976-07-04","first_name":"george","last_name":"washington"}},"by_name_and_employee_id":{"summary":"search by member name and employee ID","value":{"born_on":"1976-07-04","employee_id":"ABC1234","first_name":"george","last_name":"washington"}},"by_name_prefix":{"summary":"search by member name prefix","value":{"born_on":"1976-07-04","first_name_prefix":"g","last_name_prefix":"was"}},"by_name_prefix_and_employee_id":{"summary":"search by member name prefix and employee ID","value":{"born_on":"1976-07-04","employee_id":"ABC1234","first_name_prefix":"g","last_name_prefix":"was"}}},"schema":{"$ref":"#/components/schemas/MemberSearchParams"}}},"description":"Member search params","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberSearchResponse"}}},"description":"Program Members search response"}},"summary":"Search Program Members","tags":["members"]}},"/api/programs/{program_id}/members/{id}":{"get":{"callbacks":{},"description":"Show a member by ID","operationId":"DatanexusApi.ProgramMemberController.show","parameters":[{"description":"Program ID","in":"path","name":"program_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Member ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}},"description":"Member"}},"summary":"Show member","tags":["members"]},"patch":{"callbacks":{},"description":"Update a program member by ID","operationId":"DatanexusApi.ProgramMemberController.update (2)","parameters":[{"description":"Member ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Program ID","in":"path","name":"program_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberRequest"}}},"description":"Member attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberResponse"}}},"description":"Member"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Update program member","tags":["members"]},"put":{"callbacks":{},"description":"Update a program member by ID","operationId":"DatanexusApi.ProgramMemberController.update","parameters":[{"description":"Member ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Program ID","in":"path","name":"program_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberRequest"}}},"description":"Member attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberResponse"}}},"description":"Member"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Update program member","tags":["members"]}},"/api/programs/{program_id}/members/{id}/household":{"get":{"callbacks":{},"description":"List household members by member ID","operationId":"DatanexusApi.ProgramMemberController.household","parameters":[{"description":"Program ID","in":"path","name":"program_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Member ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HouseholdMembersResponse"}}},"description":"Program Members response"}},"summary":"List household members","tags":["members"]}},"/api/webhook_subscriptions":{"get":{"callbacks":{},"operationId":"DatanexusApi.WebhookSubscriptionController.index","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionsResponse"}}},"description":"Webhook Subscriptions response"}},"summary":"List Webhook Subscriptions","tags":["webhook_subscriptions"]},"post":{"callbacks":{},"operationId":"DatanexusApi.WebhookSubscriptionController.create","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionRequest"}}},"description":"WebhookSubscription attributes","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionResponse"}}},"description":"WebhookSubscription"}},"summary":"Create webhook subscription","tags":["webhook_subscriptions"]}},"/api/webhook_subscriptions/{id}":{"delete":{"callbacks":{},"description":"Delete a webhook subscription by ID","operationId":"DatanexusApi.WebhookSubscriptionController.delete","parameters":[{"description":"Webhook subscription ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":"Empty response"}},"summary":"Delete webhook subscription","tags":["webhook_subscriptions"]},"get":{"callbacks":{},"description":"Show a webhook subscription by ID","operationId":"DatanexusApi.WebhookSubscriptionController.show","parameters":[{"description":"Webhook subscription ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionResponse"}}},"description":"WebhookSubscription"}},"summary":"Show webhook subscription","tags":["webhook_subscriptions"]},"patch":{"callbacks":{},"operationId":"DatanexusApi.WebhookSubscriptionController.update (2)","parameters":[{"description":"Webhook subscription ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionRequest"}}},"description":"Webhook subscription attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionResponse"}}},"description":"WebhookSubscription"}},"summary":"Update webhook subscription","tags":["webhook_subscriptions"]},"put":{"callbacks":{},"operationId":"DatanexusApi.WebhookSubscriptionController.update","parameters":[{"description":"Webhook subscription ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionRequest"}}},"description":"Webhook subscription attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionResponse"}}},"description":"WebhookSubscription"}},"summary":"Update webhook subscription","tags":["webhook_subscriptions"]}}},"security":[{"ApiKeyAuth":[]}],"servers":[{"url":"/","variables":{}}],"tags":[]}