{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Heyrafiki","description":"Reference and integration guidance for the Heyrafiki API, Sandbox, insurance and institutional workflows.","colors":{"primary":"#184A34","light":"#56C995","dark":"#3D7B5C"},"logo":{"light":"https://mintcdn.com/heyrafiki/VzWzD9yh2LbdjA9G/images/logo-black.png?fit=max\u0026auto=format\u0026n=VzWzD9yh2LbdjA9G\u0026q=85\u0026s=adad3843b7b770dddb62d8d2a7095272","dark":"https://mintcdn.com/heyrafiki/VzWzD9yh2LbdjA9G/images/logo-white.png?fit=max\u0026auto=format\u0026n=VzWzD9yh2LbdjA9G\u0026q=85\u0026s=9d24495fb1c9d7a5cd24d6dd106b5641","href":"/"},"favicon":{"light":"https://mintcdn.com/heyrafiki/VzWzD9yh2LbdjA9G/images/mark-black.png?fit=max\u0026auto=format\u0026n=VzWzD9yh2LbdjA9G\u0026q=85\u0026s=4cf99d03241c11cfedcf0eef01032b16","dark":"https://mintcdn.com/heyrafiki/VzWzD9yh2LbdjA9G/images/mark-white.png?fit=max\u0026auto=format\u0026n=VzWzD9yh2LbdjA9G\u0026q=85\u0026s=01bf7726e0bcffdad1248183ae626074"},"api":{"openapi":"openapi/heyrafiki.openapi.yaml","playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["bash","javascript","python","go"],"prefill":true,"autogenerate":true}},"appearance":{"default":"system","strict":false},"navbar":{"links":[{"href":"https://heyrafiki.space","label":"Website"}],"primary":{"type":"button","label":"Request access","href":"https://heyrafiki.space/waitlist"}},"footer":{"socials":{"website":"https://heyrafiki.space","github":"https://github.com/heyrafiki","linkedin":"https://www.linkedin.com/company/heyrafiki","x":"https://x.com/heyrafikios","instagram":"https://www.instagram.com/heyrafikios"}},"search":{"prompt":"Search Heyrafiki Docs"},"seo":{"metatags":{"canonical":"https://docs.heyrafiki.space","og:locale":"en_KE"},"indexing":"navigable"},"fonts":{"heading":{"family":"Instrument Sans"},"body":{"family":"Instrument Sans"}},"styling":{"eyebrows":"breadcrumbs","codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor"],"display":"header"},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"heyrafiki","hasAudioNarration":false,"actualSubdomain":"heyrafiki","customDomains":["docs.heyrafiki.space"],"gitSource":{"type":"github","owner":"heyrafiki","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"collectionId":"84349ba1-a84d-4fd5-a07c-7cc15d884561","liveDeploymentHistoryId":"6a98f97431118af9857677b0","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a98f97431118af9857677b0"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a98f97431118af9857677b0","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API reference","count":34},{"language":"default","tag":"REST API","count":34},{"language":"default","tag":"Build","count":12},{"language":"default","tag":"Institutions","count":8},{"language":"default","tag":"Get started","count":7},{"language":"default","tag":"Insurance","count":6},{"language":"default","tag":"Integration tools","count":5},{"language":"default","tag":"Institutional integration","count":4},{"language":"default","tag":"Integration assurance","count":4},{"language":"default","tag":"Payer workflows","count":2}],"searchSettings":{"isFiltersEnabled":true,"maxResults":10,"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"hello@heyrafiki.space"}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--hr-brand:#184a34;--hr-brand-soft:color-mix(in srgb, var(--hr-brand) 34%, transparent)}#content-area h1,article h1{font-size:1.78rem;line-height:1.15;letter-spacing:-.03em;font-weight:600}#content-area h2,article h2{font-size:1.14rem;line-height:1.25;letter-spacing:-.02em;font-weight:600;margin-top:2.25rem}#content-area h3,article h3{font-size:.98rem;line-height:1.3;letter-spacing:-.015em;font-weight:600}#content-area li,#content-area p,article li,article p{font-size:.93rem;line-height:1.7}#content-area>div:first-child p:first-of-type{font-size:.98rem}#content-area table,article table{font-size:.84rem}#content-area th,article th{font-weight:600;letter-spacing:.01em}#content-area code,article code{font-size:.82rem}#content-area pre code,article pre code{font-size:.8rem;line-height:1.6}#content-area .card h2,#content-area .card h3{font-size:.91rem;margin-top:0}#content-area tbody tr:nth-child(even),article tbody tr:nth-child(even){background:color-mix(in srgb,var(--hr-brand) 3%,transparent)}#content-area a,#content-area button,article a,article button{text-underline-offset:.18em}#content-area [role=tablist],article [role=tablist]{column-gap:.75rem!important;padding-inline:.25rem;scrollbar-color:var(--hr-brand-soft) transparent;scrollbar-width:thin}#content-area [role=tablist]::-webkit-scrollbar,article [role=tablist]::-webkit-scrollbar{height:.25rem}#content-area [role=tablist]::-webkit-scrollbar-track,article [role=tablist]::-webkit-scrollbar-track{background:0 0}#content-area [role=tablist]::-webkit-scrollbar-thumb,article [role=tablist]::-webkit-scrollbar-thumb{background:var(--hr-brand-soft);border-radius:999px}#content-area [role=tablist] button,article [role=tablist] button{font-size:.78rem;white-space:nowrap}#content-area [role=tablist] button:focus-visible,article [role=tablist] button:focus-visible{outline:2px solid color-mix(in srgb,var(--hr-brand) 72%,white);outline-offset:2px}@media (min-width:48rem){#content-area [role=tablist],article [role=tablist]{column-gap:1rem!important}}"}],"page":{"pagePath":"api-reference/record-a-coverage-batch","slug":"/api-reference/record-a-coverage-batch","pageMetadata":{"title":"Record a Coverage batch","description":"Validates and records a versioned payer Coverage batch. Requires `coverages:write`.","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /coverage_batches","href":"/api-reference/record-a-coverage-batch","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Validates and records a versioned payer Coverage batch. Requires \", _jsx(_components.code, {\n children: \"coverages:write\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Record a Coverage batch","description":"Validates and records a versioned payer Coverage batch. Requires `coverages:write`.","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /coverage_batches","href":"/api-reference/record-a-coverage-batch","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/heyrafiki/3adcae0af99d46fb/legacy-domain-redirect.js"],"openApiReferenceData":{"operation":{"operationId":"recordCoverageBatch","summary":"Record a Coverage batch","description":"Validates and records a versioned payer Coverage batch. Requires `coverages:write`.","parameters":["2fa7a528-841a-4da3-a5b2-463352528e72","af67b782-14a3-41ac-b5e7-754cd00077ea"],"requestBody":"40b554f9-aa80-4e4b-a8ce-c81d9b6247a8","responses":{"200":"fb198058-7f8c-4886-bd9b-3c8ca210c177","201":"9da65b09-816a-4ad1-974e-2cc41e84cc5e","400":"6738891e-861a-485b-aa1c-b1c6bdae2953","401":"78074e44-8f48-48f8-8d0f-cc4adc34c969","403":"cfbff8fd-af0d-4458-8d8a-210d6755cab2","409":"4456862c-e59e-4a5f-a323-364c4cc0eb76","413":"c7ed7365-166e-4948-8939-92f5ef9e5f08","429":"74ecfe9b-4750-4bbf-b40a-876f7d3d8d49","503":"80a9cf41-0e97-4c4c-b74d-2232e364ca1f"},"method":"post","type":"path","servers":["205aa400-3d09-41ea-9e0f-e980a31088ea"],"security":["86494d2d-1144-4d2f-8ad9-2b59f577d19d","9d45a79f-700a-4daa-9635-034a1dbd0845"],"path":"/coverage_batches","baseUrlOptions":["https://api.heyrafiki.space/v1"],"title":"Record a Coverage batch","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","go"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.contract_version":"2026-08-01","body.batch_reference":"\u003cstring>","body.batch_version":"\u003cstring>","body.source_contract_reference":"\u003cstring>","body.generated_at":"2023-11-07T05:31:56Z","body.records.items.0.coverage_reference":"\u003cstring>","body.records.items.0.record_version":"\u003cstring>","body.records.items.0.tenant_reference":"\u003cstring>","body.records.items.0.member_reference":"\u003cstring>","body.records.items.0.plan_name":"\u003cstring>","body.records.items.0.service_code":"\u003cstring>","body.records.items.0.amount_limit":4503599627370496,"body.records.items.0.remaining_sessions":50000,"body.records.items.0.authorization_required":true,"body.records.items.0.coordination_priority.oneOf.0":50,"body.records.items.0.valid_from":"2023-11-07T05:31:56Z","body.records.items.0.valid_until":"2023-11-07T05:31:56Z"}]},"dependencies":{"parameters":{"2fa7a528-841a-4da3-a5b2-463352528e72":{"name":"Idempotency-Key","in":"header","required":true,"description":"A caller-owned key for safely retrying one write.","schema":{"type":"string","minLength":8,"maxLength":255,"isRequired":true,"description":"A caller-owned key for safely retrying one write.","uniqueKey":"","typeLabel":"string"}},"af67b782-14a3-41ac-b5e7-754cd00077ea":{"name":"X-Heyrafiki-Artifact-Reference","in":"header","required":true,"description":"Stable reference for the source artifact retained by the payer.","schema":{"type":"string","minLength":1,"maxLength":190,"pattern":"^[A-Za-z0-9][A-Za-z0-9:._/-]*$","isRequired":true,"description":"Stable reference for the source artifact retained by the payer.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["contract_version","batch_reference","batch_version","source_contract_reference","generated_at","records"],"properties":{"contract_version":{"type":"string","const":"2026-08-01","isRequired":true,"uniqueKey":"contract_version","typeLabel":"string"},"batch_reference":{"type":"string","minLength":1,"maxLength":220,"pattern":"^[A-Za-z0-9][A-Za-z0-9:._/-]*$","isRequired":true,"uniqueKey":"batch_reference","typeLabel":"string"},"batch_version":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"batch_version","typeLabel":"string"},"source_contract_reference":{"type":"string","minLength":1,"maxLength":220,"pattern":"^[A-Za-z0-9][A-Za-z0-9:._/-]*$","isRequired":true,"uniqueKey":"source_contract_reference","typeLabel":"string"},"generated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"generated_at","typeLabel":"string\u003cdate-time>"},"records":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"object","additionalProperties":false,"required":["coverage_reference","record_version","tenant_reference","member_reference","plan_name","service_code","status","currency","amount_limit","remaining_sessions","authorization_required","coordination_priority","valid_from","valid_until"],"properties":{"coverage_reference":{"type":"string","minLength":1,"maxLength":220,"pattern":"^[A-Za-z0-9][A-Za-z0-9:._/-]*$","isRequired":true,"uniqueKey":"records.items.[INDEX].coverage_reference","typeLabel":"string"},"record_version":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"records.items.[INDEX].record_version","typeLabel":"string"},"tenant_reference":{"type":"string","minLength":1,"maxLength":220,"pattern":"^[A-Za-z0-9][A-Za-z0-9:._/-]*$","isRequired":true,"uniqueKey":"records.items.[INDEX].tenant_reference","typeLabel":"string"},"member_reference":{"type":"string","minLength":1,"maxLength":220,"pattern":"^[A-Za-z0-9][A-Za-z0-9:._/-]*$","description":"An opaque payer reference. Do not send a name, contact detail or government identifier.","isRequired":true,"uniqueKey":"records.items.[INDEX].member_reference","typeLabel":"string"},"plan_name":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"records.items.[INDEX].plan_name","typeLabel":"string"},"service_code":{"type":"string","minLength":1,"maxLength":220,"pattern":"^[A-Za-z0-9][A-Za-z0-9:._/-]*$","isRequired":true,"uniqueKey":"records.items.[INDEX].service_code","typeLabel":"string"},"status":{"type":"string","enum":["active","paused","exhausted","expired"],"isRequired":true,"uniqueKey":"records.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["KES","USD","EUR","GBP"],"isRequired":true,"uniqueKey":"records.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"amount_limit":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Per-Session limit in the currency's minor unit.","isRequired":true,"uniqueKey":"records.items.[INDEX].amount_limit","typeLabel":"integer"},"remaining_sessions":{"type":"integer","minimum":0,"maximum":100000,"isRequired":true,"uniqueKey":"records.items.[INDEX].remaining_sessions","typeLabel":"integer"},"authorization_required":{"type":"boolean","isRequired":true,"uniqueKey":"records.items.[INDEX].authorization_required","typeLabel":"boolean"},"coordination_priority":{"oneOf":[{"type":"integer","minimum":1,"maximum":100,"isRequired":true,"uniqueKey":"records.items.[INDEX].coordination_priority.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":100,"isRequired":true,"uniqueKey":"records.items.[INDEX].coordination_priority.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"records.items.[INDEX].coordination_priority","typeLabel":"integer | null"},"valid_from":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"records.items.[INDEX].valid_from","typeLabel":"string\u003cdate-time>"},"valid_until":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"records.items.[INDEX].valid_until","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"records.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"records","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"contract_version":"2026-08-01","batch_reference":"\u003cstring>","batch_version":"\u003cstring>","source_contract_reference":"\u003cstring>","generated_at":"2023-11-07T05:31:56Z","records":[{"coverage_reference":"\u003cstring>","record_version":"\u003cstring>","tenant_reference":"\u003cstring>","member_reference":"\u003cstring>","plan_name":"\u003cstring>","service_code":"\u003cstring>","amount_limit":4503599627370496,"remaining_sessions":50000,"authorization_required":true,"coordination_priority":50,"valid_from":"2023-11-07T05:31:56Z","valid_until":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"fb198058-7f8c-4886-bd9b-3c8ca210c177":{"description":"A replayed Coverage batch result","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["object","batch_reference","artifact_sha256","total","recorded","replayed","observations"],"properties":{"object":{"type":"string","const":"coverage_batch_result","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"batch_reference":{"type":"string","isRequired":true,"uniqueKey":"batch_reference","typeLabel":"string"},"artifact_sha256":{"type":"string","pattern":"^[a-f0-9]{64}$","isRequired":true,"uniqueKey":"artifact_sha256","typeLabel":"string"},"total":{"type":"integer","minimum":1,"maximum":500,"isRequired":true,"uniqueKey":"total","typeLabel":"integer"},"recorded":{"type":"integer","minimum":0,"maximum":500,"isRequired":true,"uniqueKey":"recorded","typeLabel":"integer"},"replayed":{"type":"integer","minimum":0,"maximum":500,"isRequired":true,"uniqueKey":"replayed","typeLabel":"integer"},"observations":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"object","additionalProperties":false,"required":["id","object","coverage_id","source","source_contract_reference","external_coverage_reference","source_version","snapshot_version","status","service_code","amount_limit","remaining_sessions","authorization_required","coordination_priority","valid_from","valid_until","observed_at"],"properties":{"id":{"type":"string","pattern":"^cobs_[A-Za-z0-9_-]+$","isRequired":true,"uniqueKey":"observations.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","const":"coverage_observation","isRequired":true,"uniqueKey":"observations.items.[INDEX].object","typeLabel":"string"},"coverage_id":{"type":"string","pattern":"^cov_[A-Za-z0-9_-]+$","isRequired":true,"uniqueKey":"observations.items.[INDEX].coverage_id","typeLabel":"string"},"source":{"type":"string","enum":["payer_api","batch_file"],"isRequired":true,"uniqueKey":"observations.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"source_contract_reference":{"type":"string","isRequired":true,"uniqueKey":"observations.items.[INDEX].source_contract_reference","typeLabel":"string"},"external_coverage_reference":{"type":"string","isRequired":true,"uniqueKey":"observations.items.[INDEX].external_coverage_reference","typeLabel":"string"},"source_version":{"type":"string","isRequired":true,"uniqueKey":"observations.items.[INDEX].source_version","typeLabel":"string"},"snapshot_version":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"observations.items.[INDEX].snapshot_version","typeLabel":"integer"},"status":{"type":"string","enum":["active","paused","exhausted","expired"],"isRequired":true,"uniqueKey":"observations.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"service_code":{"type":"string","isRequired":true,"uniqueKey":"observations.items.[INDEX].service_code","typeLabel":"string"},"amount_limit":{"type":"object","additionalProperties":false,"required":["currency","value"],"properties":{"currency":{"type":"string","enum":["KES","USD","EUR","GBP"],"isRequired":true,"uniqueKey":"observations.items.[INDEX].amount_limit.currency","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"observations.items.[INDEX].amount_limit.value","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"observations.items.[INDEX].amount_limit","typeLabel":"object"},"remaining_sessions":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"observations.items.[INDEX].remaining_sessions","typeLabel":"integer"},"authorization_required":{"type":"boolean","isRequired":true,"uniqueKey":"observations.items.[INDEX].authorization_required","typeLabel":"boolean"},"coordination_priority":{"oneOf":[{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"observations.items.[INDEX].coordination_priority.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"isRequired":true,"uniqueKey":"observations.items.[INDEX].coordination_priority.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"observations.items.[INDEX].coordination_priority","typeLabel":"integer | null"},"valid_from":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"observations.items.[INDEX].valid_from","typeLabel":"string\u003cdate-time>"},"valid_until":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"observations.items.[INDEX].valid_until","typeLabel":"string\u003cdate-time>"},"observed_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"observations.items.[INDEX].observed_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"observations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"observations","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"object":"coverage_batch_result","batch_reference":"\u003cstring>","artifact_sha256":"\u003cstring>","total":250,"recorded":250,"replayed":250,"observations":[{"id":"\u003cstring>","object":"coverage_observation","coverage_id":"\u003cstring>","source":"payer_api","source_contract_reference":"\u003cstring>","external_coverage_reference":"\u003cstring>","source_version":"\u003cstring>","snapshot_version":2,"status":"active","service_code":"\u003cstring>","amount_limit":{"currency":"KES","value":2},"remaining_sessions":1,"authorization_required":true,"coordination_priority":2,"valid_from":"2023-11-07T05:31:56Z","valid_until":"2023-11-07T05:31:56Z","observed_at":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"9da65b09-816a-4ad1-974e-2cc41e84cc5e":{"description":"A recorded Coverage batch result","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current minute.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current minute.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp when the current limit resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["object","batch_reference","artifact_sha256","total","recorded","replayed","observations"],"properties":{"object":{"type":"string","const":"coverage_batch_result","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"batch_reference":{"type":"string","isRequired":true,"uniqueKey":"batch_reference","typeLabel":"string"},"artifact_sha256":{"type":"string","pattern":"^[a-f0-9]{64}$","isRequired":true,"uniqueKey":"artifact_sha256","typeLabel":"string"},"total":{"type":"integer","minimum":1,"maximum":500,"isRequired":true,"uniqueKey":"total","typeLabel":"integer"},"recorded":{"type":"integer","minimum":0,"maximum":500,"isRequired":true,"uniqueKey":"recorded","typeLabel":"integer"},"replayed":{"type":"integer","minimum":0,"maximum":500,"isRequired":true,"uniqueKey":"replayed","typeLabel":"integer"},"observations":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"object","additionalProperties":false,"required":["id","object","coverage_id","source","source_contract_reference","external_coverage_reference","source_version","snapshot_version","status","service_code","amount_limit","remaining_sessions","authorization_required","coordination_priority","valid_from","valid_until","observed_at"],"properties":{"id":{"type":"string","pattern":"^cobs_[A-Za-z0-9_-]+$","isRequired":true,"uniqueKey":"observations.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","const":"coverage_observation","isRequired":true,"uniqueKey":"observations.items.[INDEX].object","typeLabel":"string"},"coverage_id":{"type":"string","pattern":"^cov_[A-Za-z0-9_-]+$","isRequired":true,"uniqueKey":"observations.items.[INDEX].coverage_id","typeLabel":"string"},"source":{"type":"string","enum":["payer_api","batch_file"],"isRequired":true,"uniqueKey":"observations.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"source_contract_reference":{"type":"string","isRequired":true,"uniqueKey":"observations.items.[INDEX].source_contract_reference","typeLabel":"string"},"external_coverage_reference":{"type":"string","isRequired":true,"uniqueKey":"observations.items.[INDEX].external_coverage_reference","typeLabel":"string"},"source_version":{"type":"string","isRequired":true,"uniqueKey":"observations.items.[INDEX].source_version","typeLabel":"string"},"snapshot_version":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"observations.items.[INDEX].snapshot_version","typeLabel":"integer"},"status":{"type":"string","enum":["active","paused","exhausted","expired"],"isRequired":true,"uniqueKey":"observations.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"service_code":{"type":"string","isRequired":true,"uniqueKey":"observations.items.[INDEX].service_code","typeLabel":"string"},"amount_limit":{"type":"object","additionalProperties":false,"required":["currency","value"],"properties":{"currency":{"type":"string","enum":["KES","USD","EUR","GBP"],"isRequired":true,"uniqueKey":"observations.items.[INDEX].amount_limit.currency","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"observations.items.[INDEX].amount_limit.value","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"observations.items.[INDEX].amount_limit","typeLabel":"object"},"remaining_sessions":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"observations.items.[INDEX].remaining_sessions","typeLabel":"integer"},"authorization_required":{"type":"boolean","isRequired":true,"uniqueKey":"observations.items.[INDEX].authorization_required","typeLabel":"boolean"},"coordination_priority":{"oneOf":[{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"observations.items.[INDEX].coordination_priority.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"isRequired":true,"uniqueKey":"observations.items.[INDEX].coordination_priority.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"observations.items.[INDEX].coordination_priority","typeLabel":"integer | null"},"valid_from":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"observations.items.[INDEX].valid_from","typeLabel":"string\u003cdate-time>"},"valid_until":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"observations.items.[INDEX].valid_until","typeLabel":"string\u003cdate-time>"},"observed_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"observations.items.[INDEX].observed_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"observations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"observations","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"object":"coverage_batch_result","batch_reference":"\u003cstring>","artifact_sha256":"\u003cstring>","total":250,"recorded":250,"replayed":250,"observations":[{"id":"\u003cstring>","object":"coverage_observation","coverage_id":"\u003cstring>","source":"payer_api","source_contract_reference":"\u003cstring>","external_coverage_reference":"\u003cstring>","source_version":"\u003cstring>","snapshot_version":2,"status":"active","service_code":"\u003cstring>","amount_limit":{"currency":"KES","value":2},"remaining_sessions":1,"authorization_required":true,"coordination_priority":2,"valid_from":"2023-11-07T05:31:56Z","valid_until":"2023-11-07T05:31:56Z","observed_at":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"6738891e-861a-485b-aa1c-b1c6bdae2953":{"description":"The request failed validation.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"78074e44-8f48-48f8-8d0f-cc4adc34c969":{"description":"The API key is missing or invalid.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"cfbff8fd-af0d-4458-8d8a-210d6755cab2":{"description":"The API key does not permit this operation.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"4456862c-e59e-4a5f-a323-364c4cc0eb76":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c7ed7365-166e-4948-8939-92f5ef9e5f08":{"description":"The request body exceeds the endpoint limit.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"74ecfe9b-4750-4bbf-b40a-876f7d3d8d49":{"description":"The project exceeded its request limit.","headers":{"Retry-After":{"description":"Seconds until another request should be attempted.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current minute.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current minute.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp when the current limit resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"80a9cf41-0e97-4c4c-b74d-2232e364ca1f":{"description":"The service is temporarily unavailable.","headers":{"Retry-After":{"schema":{"type":"integer","example":5}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"86494d2d-1144-4d2f-8ad9-2b59f577d19d":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A sandbox or production secret key.","scopes":[]}},"9d45a79f-700a-4daa-9635-034a1dbd0845":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"An alternative for clients that cannot set Authorization.","scopes":[]}}},"servers":{"205aa400-3d09-41ea-9e0f-e980a31088ea":{"url":"https://api.heyrafiki.space/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A sandbox or production secret key.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A sandbox or production secret key.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"An alternative for clients that cannot set Authorization.","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"An alternative for clients that cannot set Authorization.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"x-api-key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"openapi/heyrafiki.openapi.yaml"},"subdomain":"heyrafiki","siteName":"Heyrafiki","title":"Record a Coverage batch - Heyrafiki","contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-10T15:07:04.815Z","originalFileLocation":"api-reference/record-a-coverage-batch.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Validates and records a versioned payer Coverage batch. Requires coverages:write.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Heyrafiki\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Record a Coverage batch - Heyrafiki\">\u003cmeta data-mint-head property=\"og:description\" content=\"Validates and records a versioned payer Coverage batch. Requires coverages:write.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Heyrafiki\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.heyrafiki.space/api-reference/record-a-coverage-batch\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://heyrafiki.mintlify.app/_mintlify/api/og/v2?division=REST+API\u0026amp;title=Record+a+Coverage+batch\u0026amp;description=Validates+and+records+a+versioned+payer+Coverage+batch.+Requires+%60coverages%3Awrite%60.\u0026amp;theme=21d32e2b607e525eebaffa65\u0026amp;signature=10020b0b34e8664ae0991aae8dcdd774fc466e78b221f79f48ee8cafc76bc041\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Record a Coverage batch - Heyrafiki\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Validates and records a versioned payer Coverage batch. Requires coverages:write.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://heyrafiki.mintlify.app/_mintlify/api/og/v2?division=REST+API\u0026amp;title=Record+a+Coverage+batch\u0026amp;description=Validates+and+records+a+versioned+payer+Coverage+batch.+Requires+%60coverages%3Awrite%60.\u0026amp;theme=21d32e2b607e525eebaffa65\u0026amp;signature=10020b0b34e8664ae0991aae8dcdd774fc466e78b221f79f48ee8cafc76bc041\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Heyrafiki\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#184A34\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_KE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.heyrafiki.space/api-reference/record-a-coverage-batch\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/record-a-coverage-batch.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.heyrafiki.space/#organization\",\"name\":\"Heyrafiki\",\"url\":\"https://docs.heyrafiki.space\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/heyrafiki/VzWzD9yh2LbdjA9G/images/logo-black.png?fit=max\u0026auto=format\u0026n=VzWzD9yh2LbdjA9G\u0026q=85\u0026s=adad3843b7b770dddb62d8d2a7095272\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.heyrafiki.space#website\",\"name\":\"Heyrafiki\",\"url\":\"https://docs.heyrafiki.space\",\"publisher\":{\"@id\":\"https://docs.heyrafiki.space/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.heyrafiki.space/api-reference/record-a-coverage-batch#webpage\",\"url\":\"https://docs.heyrafiki.space/api-reference/record-a-coverage-batch\",\"name\":\"Record a Coverage batch\",\"description\":\"Validates and records a versioned payer Coverage batch. Requires coverages:write.\",\"dateModified\":\"2026-08-10T15:07:04.815Z\",\"isPartOf\":{\"@id\":\"https://docs.heyrafiki.space#website\"},\"breadcrumb\":{\"@id\":\"https://docs.heyrafiki.space/api-reference/record-a-coverage-batch#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.heyrafiki.space/api-reference/record-a-coverage-batch#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST API\",\"item\":\"https://docs.heyrafiki.space/resources\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Record a Coverage batch\",\"item\":\"https://docs.heyrafiki.space/api-reference/record-a-coverage-batch\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.heyrafiki.space/api-reference/record-a-coverage-batch#apireference\",\"headline\":\"Record a Coverage batch\",\"name\":\"Record a Coverage batch\",\"description\":\"Validates and records a versioned payer Coverage batch. Requires coverages:write.\",\"url\":\"https://docs.heyrafiki.space/api-reference/record-a-coverage-batch\",\"mainEntityOfPage\":{\"@id\":\"https://docs.heyrafiki.space/api-reference/record-a-coverage-batch#webpage\"},\"dateModified\":\"2026-08-10T15:07:04.815Z\",\"publisher\":{\"@id\":\"https://docs.heyrafiki.space/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.heyrafiki.space#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Heyrafiki\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Heyrafiki","nav":{"global":null,"tabs":[{"tab":"Build","icon":"code","pages":[{"title":"Build","href":""}]},{"tab":"Insurance","icon":"shield-check","pages":[{"title":"Insurance","href":"/benefits"}]},{"tab":"Institutions","icon":"landmark","pages":[{"title":"Institutions","href":"/concepts/institutions"}]},{"tab":"API reference","icon":"brackets-curly","groups":[{"group":"REST API","pages":[{"title":"API overview","sidebarTitle":"Overview","href":"/resources"},{"title":"Inspect the API version and environment","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /","href":"/api-reference/inspect-the-api-version-and-environment"},{"title":"List Practitioners","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /practitioners","href":"/api-reference/list-practitioners"},{"title":"Retrieve a Practitioner","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /practitioners/{practitioner_id}","href":"/api-reference/retrieve-a-practitioner"},{"title":"Retrieve Practitioner availability","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /practitioners/{practitioner_id}/availability","href":"/api-reference/retrieve-practitioner-availability"},{"title":"List Bookings","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /bookings","href":"/api-reference/list-bookings"},{"title":"Create a Booking","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /bookings","href":"/api-reference/create-a-booking"},{"title":"Retrieve a Booking","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /bookings/{booking_id}","href":"/api-reference/retrieve-a-booking"},{"title":"List Sessions","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /sessions","href":"/api-reference/list-sessions"},{"title":"Retrieve a Session","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /sessions/{session_id}","href":"/api-reference/retrieve-a-session"},{"title":"Record a Coverage observation","description":"Appends a payer source observation and updates its Coverage snapshot. Requires `coverages:write`.","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /coverages","href":"/api-reference/record-a-coverage-observation"},{"title":"Record a Coverage batch","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /coverage_batches","href":"/api-reference/record-a-coverage-batch"},{"title":"Check Benefit eligibility","description":"Evaluates synthetic Cover for a scheduled service. Requires `benefits:write`.","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /eligibility_checks","href":"/api-reference/check-benefit-eligibility"},{"title":"Retrieve an eligibility check","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /eligibility_checks/{eligibility_check_id}","href":"/api-reference/retrieve-an-eligibility-check"},{"title":"Request a pre-authorization","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /preauthorizations","href":"/api-reference/request-a-pre-authorization"},{"title":"Retrieve a pre-authorization","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /preauthorizations/{preauthorization_id}","href":"/api-reference/retrieve-a-pre-authorization"},{"title":"Decide a pre-authorization","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /preauthorizations/{preauthorization_id}/decisions","href":"/api-reference/decide-a-pre-authorization"},{"title":"List Claims","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /claims","href":"/api-reference/list-claims"},{"title":"Submit a Claim","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /claims","href":"/api-reference/submit-a-claim"},{"title":"Retrieve a Claim","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /claims/{claim_id}","href":"/api-reference/retrieve-a-claim"},{"title":"Reproduce a Claim valuation","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /claims/{claim_id}/valuation","href":"/api-reference/reproduce-a-claim-valuation"},{"title":"Request Claim information","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /claims/{claim_id}/information_requests","href":"/api-reference/request-claim-information"},{"title":"Submit Claim evidence","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /claims/{claim_id}/evidence","href":"/api-reference/submit-claim-evidence"},{"title":"Adjudicate a Claim","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /claims/{claim_id}/adjudications","href":"/api-reference/adjudicate-a-claim"},{"title":"List remittances","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /remittances","href":"/api-reference/list-remittances"},{"title":"Record a remittance","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /remittances","href":"/api-reference/record-a-remittance"},{"title":"Retrieve a remittance","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /remittances/{remittance_id}","href":"/api-reference/retrieve-a-remittance"},{"title":"List Webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /webhook_endpoints","href":"/api-reference/list-webhook-endpoints"},{"title":"Create a Webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /webhook_endpoints","href":"/api-reference/create-a-webhook-endpoint"},{"title":"Retrieve a Webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /webhook_endpoints/{webhook_endpoint_id}","href":"/api-reference/retrieve-a-webhook-endpoint"},{"title":"Disable a Webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml delete /webhook_endpoints/{webhook_endpoint_id}","href":"/api-reference/disable-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /webhook_endpoints/{webhook_endpoint_id}/test","href":"/api-reference/send-a-test-event"},{"title":"Rate limits","href":"/rate-limits"},{"title":"Versioning","href":"/versioning"}]}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Record a Coverage batch - Heyrafiki","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}