{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Unyte","colors":{"primary":"#2AB673","light":"#55D799","dark":"#117866"},"logo":{"light":"https://mintcdn.com/unyte/pJ2ZzkNRYCpUMHmv/logo/logo.png?fit=max\u0026auto=format\u0026n=pJ2ZzkNRYCpUMHmv\u0026q=85\u0026s=d0178384ea8afac38a4891da460de351","dark":"https://mintcdn.com/unyte/pJ2ZzkNRYCpUMHmv/logo/logo.png?fit=max\u0026auto=format\u0026n=pJ2ZzkNRYCpUMHmv\u0026q=85\u0026s=d0178384ea8afac38a4891da460de351","href":"https://unyte.africa"},"favicon":"/logo/logo.png","api":{"playground":{"display":"interactive"},"mdx":{"server":["https://dev.superpool.unyte.africa/","https://superpool.unyte.africa/"]}},"navbar":{"links":[{"label":"Talk to us","href":"mailto:tech@unyte.africa"}],"primary":{"type":"button","label":"Sign Up","href":"https://bridge.unyte.africa/merchant/sign-up"}},"footer":{"socials":{"x":"https://x.com/unyte_africa","linkedin":"https://www.linkedin.com/company/unyteafrica","instagram":"https://www.instagram.com/unyteafrica"},"links":[{"header":"Legal","items":[{"label":"Terms of Service","href":"https://unyte.africa/terms-of-service"},{"label":"Privacy Policy","href":"https://unyte.africa/privacypolicy"}]}]},"seo":{"metatags":{"og:title":"Unyte - Developer Documentation","og:description":"Comprehensive insurance management infrastructure for businesses in Africa - Unyte","og:image":"images/unyte_seo_banner_hd.png","og:logo":"/logo/logo.png","twitter:url":"@unyte_africa"}},"banner":{"content":"We are currently in beta. If you have any feedback, please email us at [tech@unyte.africa](mailto:tech@unyte.africa) or learn more about our product at [https://unyte.africa](https://unyte.africa)"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"unyte","hasAudioNarration":false,"actualSubdomain":"unyte","customDomains":["docs.unyte.africa"],"gitSource":{"type":"github","owner":"unyteafrica","repo":"superpool-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c63f016d95c09d0e9849","collectionId":"1d46b185-91f6-4165-a2e1-5990c24c7940","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20c63f016d95c09d0e9849:success","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":36},{"language":"default","tag":"Documentation","count":20},{"language":"default","tag":"Core Resources","count":9},{"language":"default","tag":"Policies","count":7},{"language":"default","tag":"Merchant","count":5},{"language":"default","tag":"Claims","count":4},{"language":"default","tag":"Customers","count":4},{"language":"default","tag":"REST APIs","count":4},{"language":"default","tag":"Environments","count":3},{"language":"default","tag":"Insurance Providers","count":3}]},"assistantConfig":{},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/claims/submit-a-claim","slug":"/api-reference/claims/submit-a-claim","pageMetadata":{"openapi":"post /api/v1/claims/","title":"Submit a claim","description":"Submits a new claim entry on behalf of a customer","href":"/api-reference/claims/submit-a-claim"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Submits a new claim entry on behalf of a customer\"\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":{"config":{},"pageMetadata":{"openapi":"post /api/v1/claims/","title":"Submit a claim","description":"Submits a new claim entry on behalf of a customer","href":"/api-reference/claims/submit-a-claim"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"submit_claim","description":"Submits a new claim entry on behalf of a customer","summary":"Submit a claim","parameters":["0381e8fc-b5f1-4678-b789-aaea243d582f","be871fd8-f1ba-49f4-99a6-f377f5339abe"],"tags":["Claims"],"requestBody":"f56e0f82-0216-4462-b2b0-b6a2cf1f260f","security":["389d632f-be1c-4a92-a00b-808797863a8b"],"responses":{"201":"9c849f0f-3ce5-4e73-a2b4-36ca1bdf6359"},"method":"post","type":"path","servers":[],"path":"/api/v1/claims/","baseUrlOptions":["https://dev.superpool.unyte.africa/","https://superpool.unyte.africa/"],"title":"Submit a claim","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0381e8fc-b5f1-4678-b789-aaea243d582f":{"in":"header","name":"U-Request-Id","schema":{"type":"string","description":"Idempotency key to enforce idempotent processing of POST requests","uniqueKey":"","typeLabel":"string"},"description":"Idempotency key to enforce idempotent processing of POST requests"},"be871fd8-f1ba-49f4-99a6-f377f5339abe":{"in":"path","name":"id","schema":{"type":"string","isRequired":true,"description":"UUID of the claim","uniqueKey":"","typeLabel":"string"},"description":"UUID of the claim","required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Validates incoming request data for creating a new claim.","properties":{"claimant_metadata":{"type":"object","description":"Validates incoming request data for creating a new claim.","properties":{"first_name":{"type":"string","isRequired":true,"uniqueKey":"claimant_metadata.first_name","typeLabel":"string"},"last_name":{"type":"string","isRequired":true,"uniqueKey":"claimant_metadata.last_name","typeLabel":"string"},"birth_date":{"type":"string","format":"date","isRequired":true,"uniqueKey":"claimant_metadata.birth_date","typeLabel":"string\u003cdate>"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"claimant_metadata.email","typeLabel":"string\u003cemail>"},"phone_number":{"type":"string","uniqueKey":"claimant_metadata.phone_number","typeLabel":"string"},"relationship":{"type":"string","description":"The relationship of the claimant to the policyholder","uniqueKey":"claimant_metadata.relationship","typeLabel":"string"}},"required":["birth_date","email","first_name","last_name"],"isRequired":true,"uniqueKey":"claimant_metadata","typeLabel":"object"},"claim_details":{"type":"object","description":"Specifies the data structure for capturing claim details","properties":{"claim_type":{"enum":["basic","premium","advanced","accident","death","illness","theft","other"],"type":"string","description":"* `basic` - Basic\n* `premium` - Premium\n* `advanced` - Advanced\n* `accident` - Accident\n* `death` - Death\n* `illness` - Illness\n* `theft` - Theft\n* `other` - Other","isRequired":true,"uniqueKey":"claim_details.claim_type","typeLabel":"enum\u003cstring>"},"incident_date":{"type":"string","format":"date","isRequired":true,"uniqueKey":"claim_details.incident_date","typeLabel":"string\u003cdate>"},"incident_description":{"type":"string","description":"Detailed account of the event that led to the claim","uniqueKey":"claim_details.incident_description","typeLabel":"string"},"claim_amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","description":"Estimated amount of the claim in the format \"1000.00\"","uniqueKey":"claim_details.claim_amount","typeLabel":"string\u003cdecimal>"},"supporting_documents":{"type":"array","items":{"type":"object","properties":{"document_name":{"type":"string","description":"Name of the document uploaded.","maxLength":255,"isRequired":true,"uniqueKey":"claim_details.supporting_documents.items.[INDEX].document_name","typeLabel":"string"},"evidence_type":{"type":"string","description":"Type of evidence uploaded.\n\n* `video` - Video\n* `audio` - Audio\n* `document` - Document\n* `picture` - Picture","enum":["video","audio","document","picture"],"isRequired":true,"uniqueKey":"claim_details.supporting_documents.items.[INDEX].evidence_type","typeLabel":"enum\u003cstring>"},"document_url":{"oneOf":[{"type":"string","format":"uri","title":"File Reference","description":"Reference to the stored document (e.g., Google Cloud Storage blob name).","maxLength":1024,"uniqueKey":"claim_details.supporting_documents.items.[INDEX].document_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","title":"File Reference","description":"Reference to the stored document (e.g., Google Cloud Storage blob name).","maxLength":1024,"uniqueKey":"claim_details.supporting_documents.items.[INDEX].document_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"claim_details.supporting_documents.items.[INDEX].document_url","typeLabel":"string\u003curi> | null"}},"required":["document_name","evidence_type","uploaded_at"],"uniqueKey":"claim_details.supporting_documents.items.[INDEX]","typeLabel":"object"},"description":"List of supporting documents in the format [{\"document_name\": \"Name of Document\", \"evidence_type\": \"Type of Evidence\", \"blob\": \"Base64 encoded document\"}]","uniqueKey":"claim_details.supporting_documents","typeLabel":"object[]"}},"required":["claim_type","incident_date"],"isRequired":true,"uniqueKey":"claim_details","typeLabel":"object"},"policy_id":{"type":"string","format":"uuid","uniqueKey":"policy_id","typeLabel":"string\u003cuuid>"},"policy_number":{"type":"string","uniqueKey":"policy_number","typeLabel":"string"},"witness_details":{"type":"array","items":{"type":"object","description":"Specifies the data structure for capturing witness information of a claim\n\nThere can be 0 - n witnesses for a claim","properties":{"witness_name":{"type":"string","description":"Full name of the witness in the format, \"First Name Last Name\"","isRequired":true,"uniqueKey":"witness_details.items.[INDEX].witness_name","typeLabel":"string"},"witness_statement":{"type":"string","description":"A brief statement from the witness about the incident","isRequired":true,"uniqueKey":"witness_details.items.[INDEX].witness_statement","typeLabel":"string"},"witness_contact_phone":{"type":"string","uniqueKey":"witness_details.items.[INDEX].witness_contact_phone","typeLabel":"string"},"witness_contact_email":{"type":"string","format":"email","uniqueKey":"witness_details.items.[INDEX].witness_contact_email","typeLabel":"string\u003cemail>"}},"required":["witness_name","witness_statement"],"uniqueKey":"witness_details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"witness_details","typeLabel":"object[]"},"authority_report":{"type":"object","description":"Specifies the data structure for the Authority Report e.g Police Report","properties":{"report_number":{"type":"string","isRequired":true,"uniqueKey":"authority_report.report_number","typeLabel":"string"},"report_date":{"type":"string","format":"date","isRequired":true,"uniqueKey":"authority_report.report_date","typeLabel":"string\u003cdate>"},"filing_station":{"type":"string","uniqueKey":"authority_report.filing_station","typeLabel":"string"}},"required":["report_date","report_number"],"uniqueKey":"authority_report","typeLabel":"object"}},"required":["claim_details","claimant_metadata"],"uniqueKey":"","typeLabel":"object"},"examples":{"BasicValidPayloadWithRequiredFields":{"title":"BasicValidPayloadWithRequiredFields","value":{"claimant_metadata":{"first_name":"John","last_name":"Doe","birth_date":"1985-05-15","email":"johndoe@example.com","relationship":"Self"},"claim_details":{"claim_type":"accident","incident_description":"Car accident on highway","incident_date":"2024-07-10","claim_amount":"1500.00","supporting_documents":[{"document_name":"Police Report","evidence_type":"PDF","document_url":"https://example.com/police-report.pdf","uploaded_at":"2024-07-11T08:00:00Z"}]},"policy_id":"123e4567-e89b-12d3-a456-426614174000","witness_details":[],"authority_report":{"report_number":"ABC123456","report_date":"2024-07-11","filing_station":"Miami Police Station"}}},"MinimalValidPayloadWithOnlyRequiredField-OmittingOptionalFields":{"title":"MinimalValidPayloadWithOnlyRequiredField-OmittingOptionalFields","value":{"claimant_metadata":{"first_name":"Alice","last_name":"Johnson","birth_date":"1980-01-01","email":"alicejohnson@example.com","relationship":"Parent"},"claim_details":{"claim_type":"theft","incident_description":"Bicycle stolen from garage","incident_date":"2024-07-20"}}},"FullValidPayloadWithAllFields":{"title":"FullValidPayloadWithAllFields","value":{"claimant_metadata":{"first_name":"Jane","last_name":"Smith","birth_date":"1990-12-01","email":"janesmith@example.com","phone_number":"+1234567890","relationship":"Spouse"},"claim_details":{"claim_type":"illness","incident_description":"Hospitalized due to severe illness","incident_date":"2024-06-15","claim_amount":"5000.00","supporting_documents":[{"document_name":"Police Report","evidence_type":"PDF","document_url":"https://example.com/police-report.pdf","uploaded_at":"2024-07-11T08:00:00Z"}]},"policy_id":"123e4567-e89b-12d3-a456-426614174001","policy_number":"POL12345678","witness_details":[{"witness_name":"Michael Doe","witness_contact_phone":"+1987654321","witness_contact_email":"michael.doe@example.com","witness_statement":"I saw the entire incident happen."}],"authority_report":{"report_number":"XYZ987654","report_date":"2024-06-17","filing_station":"IsaleEko Police Station"}}}},"exampleType":"examples"},"application/x-www-form-urlencoded":{"schema":{"type":"object","description":"Validates incoming request data for creating a new claim.","properties":{"claimant_metadata":{"type":"object","description":"Validates incoming request data for creating a new claim.","properties":{"first_name":{"type":"string","isRequired":true,"uniqueKey":"claimant_metadata.first_name","typeLabel":"string"},"last_name":{"type":"string","isRequired":true,"uniqueKey":"claimant_metadata.last_name","typeLabel":"string"},"birth_date":{"type":"string","format":"date","isRequired":true,"uniqueKey":"claimant_metadata.birth_date","typeLabel":"string\u003cdate>"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"claimant_metadata.email","typeLabel":"string\u003cemail>"},"phone_number":{"type":"string","uniqueKey":"claimant_metadata.phone_number","typeLabel":"string"},"relationship":{"type":"string","description":"The relationship of the claimant to the policyholder","uniqueKey":"claimant_metadata.relationship","typeLabel":"string"}},"required":["birth_date","email","first_name","last_name"],"isRequired":true,"uniqueKey":"claimant_metadata","typeLabel":"object"},"claim_details":{"type":"object","description":"Specifies the data structure for capturing claim details","properties":{"claim_type":{"enum":["basic","premium","advanced","accident","death","illness","theft","other"],"type":"string","description":"* `basic` - Basic\n* `premium` - Premium\n* `advanced` - Advanced\n* `accident` - Accident\n* `death` - Death\n* `illness` - Illness\n* `theft` - Theft\n* `other` - Other","isRequired":true,"uniqueKey":"claim_details.claim_type","typeLabel":"enum\u003cstring>"},"incident_date":{"type":"string","format":"date","isRequired":true,"uniqueKey":"claim_details.incident_date","typeLabel":"string\u003cdate>"},"incident_description":{"type":"string","description":"Detailed account of the event that led to the claim","uniqueKey":"claim_details.incident_description","typeLabel":"string"},"claim_amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","description":"Estimated amount of the claim in the format \"1000.00\"","uniqueKey":"claim_details.claim_amount","typeLabel":"string\u003cdecimal>"},"supporting_documents":{"type":"array","items":{"type":"object","properties":{"document_name":{"type":"string","description":"Name of the document uploaded.","maxLength":255,"isRequired":true,"uniqueKey":"claim_details.supporting_documents.items.[INDEX].document_name","typeLabel":"string"},"evidence_type":{"type":"string","description":"Type of evidence uploaded.\n\n* `video` - Video\n* `audio` - Audio\n* `document` - Document\n* `picture` - Picture","enum":["video","audio","document","picture"],"isRequired":true,"uniqueKey":"claim_details.supporting_documents.items.[INDEX].evidence_type","typeLabel":"enum\u003cstring>"},"document_url":{"oneOf":[{"type":"string","format":"uri","title":"File Reference","description":"Reference to the stored document (e.g., Google Cloud Storage blob name).","maxLength":1024,"uniqueKey":"claim_details.supporting_documents.items.[INDEX].document_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","title":"File Reference","description":"Reference to the stored document (e.g., Google Cloud Storage blob name).","maxLength":1024,"uniqueKey":"claim_details.supporting_documents.items.[INDEX].document_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"claim_details.supporting_documents.items.[INDEX].document_url","typeLabel":"string\u003curi> | null"}},"required":["document_name","evidence_type","uploaded_at"],"uniqueKey":"claim_details.supporting_documents.items.[INDEX]","typeLabel":"object"},"description":"List of supporting documents in the format [{\"document_name\": \"Name of Document\", \"evidence_type\": \"Type of Evidence\", \"blob\": \"Base64 encoded document\"}]","uniqueKey":"claim_details.supporting_documents","typeLabel":"object[]"}},"required":["claim_type","incident_date"],"isRequired":true,"uniqueKey":"claim_details","typeLabel":"object"},"policy_id":{"type":"string","format":"uuid","uniqueKey":"policy_id","typeLabel":"string\u003cuuid>"},"policy_number":{"type":"string","uniqueKey":"policy_number","typeLabel":"string"},"witness_details":{"type":"array","items":{"type":"object","description":"Specifies the data structure for capturing witness information of a claim\n\nThere can be 0 - n witnesses for a claim","properties":{"witness_name":{"type":"string","description":"Full name of the witness in the format, \"First Name Last Name\"","isRequired":true,"uniqueKey":"witness_details.items.[INDEX].witness_name","typeLabel":"string"},"witness_statement":{"type":"string","description":"A brief statement from the witness about the incident","isRequired":true,"uniqueKey":"witness_details.items.[INDEX].witness_statement","typeLabel":"string"},"witness_contact_phone":{"type":"string","uniqueKey":"witness_details.items.[INDEX].witness_contact_phone","typeLabel":"string"},"witness_contact_email":{"type":"string","format":"email","uniqueKey":"witness_details.items.[INDEX].witness_contact_email","typeLabel":"string\u003cemail>"}},"required":["witness_name","witness_statement"],"uniqueKey":"witness_details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"witness_details","typeLabel":"object[]"},"authority_report":{"type":"object","description":"Specifies the data structure for the Authority Report e.g Police Report","properties":{"report_number":{"type":"string","isRequired":true,"uniqueKey":"authority_report.report_number","typeLabel":"string"},"report_date":{"type":"string","format":"date","isRequired":true,"uniqueKey":"authority_report.report_date","typeLabel":"string\u003cdate>"},"filing_station":{"type":"string","uniqueKey":"authority_report.filing_station","typeLabel":"string"}},"required":["report_date","report_number"],"uniqueKey":"authority_report","typeLabel":"object"}},"required":["claim_details","claimant_metadata"],"uniqueKey":"","typeLabel":"object"},"examples":{"BasicValidPayloadWithRequiredFields":{"title":"BasicValidPayloadWithRequiredFields","value":{"claimant_metadata":{"first_name":"John","last_name":"Doe","birth_date":"1985-05-15","email":"johndoe@example.com","relationship":"Self"},"claim_details":{"claim_type":"accident","incident_description":"Car accident on highway","incident_date":"2024-07-10","claim_amount":"1500.00","supporting_documents":[{"document_name":"Police Report","evidence_type":"PDF","document_url":"https://example.com/police-report.pdf","uploaded_at":"2024-07-11T08:00:00Z"}]},"policy_id":"123e4567-e89b-12d3-a456-426614174000","witness_details":[],"authority_report":{"report_number":"ABC123456","report_date":"2024-07-11","filing_station":"Miami Police Station"}}},"MinimalValidPayloadWithOnlyRequiredField-OmittingOptionalFields":{"title":"MinimalValidPayloadWithOnlyRequiredField-OmittingOptionalFields","value":{"claimant_metadata":{"first_name":"Alice","last_name":"Johnson","birth_date":"1980-01-01","email":"alicejohnson@example.com","relationship":"Parent"},"claim_details":{"claim_type":"theft","incident_description":"Bicycle stolen from garage","incident_date":"2024-07-20"}}},"FullValidPayloadWithAllFields":{"title":"FullValidPayloadWithAllFields","value":{"claimant_metadata":{"first_name":"Jane","last_name":"Smith","birth_date":"1990-12-01","email":"janesmith@example.com","phone_number":"+1234567890","relationship":"Spouse"},"claim_details":{"claim_type":"illness","incident_description":"Hospitalized due to severe illness","incident_date":"2024-06-15","claim_amount":"5000.00","supporting_documents":[{"document_name":"Police Report","evidence_type":"PDF","document_url":"https://example.com/police-report.pdf","uploaded_at":"2024-07-11T08:00:00Z"}]},"policy_id":"123e4567-e89b-12d3-a456-426614174001","policy_number":"POL12345678","witness_details":[{"witness_name":"Michael Doe","witness_contact_phone":"+1987654321","witness_contact_email":"michael.doe@example.com","witness_statement":"I saw the entire incident happen."}],"authority_report":{"report_number":"XYZ987654","report_date":"2024-06-17","filing_station":"IsaleEko Police Station"}}}},"exampleType":"examples"},"multipart/form-data":{"schema":{"type":"object","description":"Validates incoming request data for creating a new claim.","properties":{"claimant_metadata":{"type":"object","description":"Validates incoming request data for creating a new claim.","properties":{"first_name":{"type":"string","isRequired":true,"uniqueKey":"claimant_metadata.first_name","typeLabel":"string"},"last_name":{"type":"string","isRequired":true,"uniqueKey":"claimant_metadata.last_name","typeLabel":"string"},"birth_date":{"type":"string","format":"date","isRequired":true,"uniqueKey":"claimant_metadata.birth_date","typeLabel":"string\u003cdate>"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"claimant_metadata.email","typeLabel":"string\u003cemail>"},"phone_number":{"type":"string","uniqueKey":"claimant_metadata.phone_number","typeLabel":"string"},"relationship":{"type":"string","description":"The relationship of the claimant to the policyholder","uniqueKey":"claimant_metadata.relationship","typeLabel":"string"}},"required":["birth_date","email","first_name","last_name"],"isRequired":true,"uniqueKey":"claimant_metadata","typeLabel":"object"},"claim_details":{"type":"object","description":"Specifies the data structure for capturing claim details","properties":{"claim_type":{"enum":["basic","premium","advanced","accident","death","illness","theft","other"],"type":"string","description":"* `basic` - Basic\n* `premium` - Premium\n* `advanced` - Advanced\n* `accident` - Accident\n* `death` - Death\n* `illness` - Illness\n* `theft` - Theft\n* `other` - Other","isRequired":true,"uniqueKey":"claim_details.claim_type","typeLabel":"enum\u003cstring>"},"incident_date":{"type":"string","format":"date","isRequired":true,"uniqueKey":"claim_details.incident_date","typeLabel":"string\u003cdate>"},"incident_description":{"type":"string","description":"Detailed account of the event that led to the claim","uniqueKey":"claim_details.incident_description","typeLabel":"string"},"claim_amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","description":"Estimated amount of the claim in the format \"1000.00\"","uniqueKey":"claim_details.claim_amount","typeLabel":"string\u003cdecimal>"},"supporting_documents":{"type":"array","items":{"type":"object","properties":{"document_name":{"type":"string","description":"Name of the document uploaded.","maxLength":255,"isRequired":true,"uniqueKey":"claim_details.supporting_documents.items.[INDEX].document_name","typeLabel":"string"},"evidence_type":{"type":"string","description":"Type of evidence uploaded.\n\n* `video` - Video\n* `audio` - Audio\n* `document` - Document\n* `picture` - Picture","enum":["video","audio","document","picture"],"isRequired":true,"uniqueKey":"claim_details.supporting_documents.items.[INDEX].evidence_type","typeLabel":"enum\u003cstring>"},"document_url":{"oneOf":[{"type":"string","format":"uri","title":"File Reference","description":"Reference to the stored document (e.g., Google Cloud Storage blob name).","maxLength":1024,"uniqueKey":"claim_details.supporting_documents.items.[INDEX].document_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","title":"File Reference","description":"Reference to the stored document (e.g., Google Cloud Storage blob name).","maxLength":1024,"uniqueKey":"claim_details.supporting_documents.items.[INDEX].document_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"claim_details.supporting_documents.items.[INDEX].document_url","typeLabel":"string\u003curi> | null"}},"required":["document_name","evidence_type","uploaded_at"],"uniqueKey":"claim_details.supporting_documents.items.[INDEX]","typeLabel":"object"},"description":"List of supporting documents in the format [{\"document_name\": \"Name of Document\", \"evidence_type\": \"Type of Evidence\", \"blob\": \"Base64 encoded document\"}]","uniqueKey":"claim_details.supporting_documents","typeLabel":"object[]"}},"required":["claim_type","incident_date"],"isRequired":true,"uniqueKey":"claim_details","typeLabel":"object"},"policy_id":{"type":"string","format":"uuid","uniqueKey":"policy_id","typeLabel":"string\u003cuuid>"},"policy_number":{"type":"string","uniqueKey":"policy_number","typeLabel":"string"},"witness_details":{"type":"array","items":{"type":"object","description":"Specifies the data structure for capturing witness information of a claim\n\nThere can be 0 - n witnesses for a claim","properties":{"witness_name":{"type":"string","description":"Full name of the witness in the format, \"First Name Last Name\"","isRequired":true,"uniqueKey":"witness_details.items.[INDEX].witness_name","typeLabel":"string"},"witness_statement":{"type":"string","description":"A brief statement from the witness about the incident","isRequired":true,"uniqueKey":"witness_details.items.[INDEX].witness_statement","typeLabel":"string"},"witness_contact_phone":{"type":"string","uniqueKey":"witness_details.items.[INDEX].witness_contact_phone","typeLabel":"string"},"witness_contact_email":{"type":"string","format":"email","uniqueKey":"witness_details.items.[INDEX].witness_contact_email","typeLabel":"string\u003cemail>"}},"required":["witness_name","witness_statement"],"uniqueKey":"witness_details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"witness_details","typeLabel":"object[]"},"authority_report":{"type":"object","description":"Specifies the data structure for the Authority Report e.g Police Report","properties":{"report_number":{"type":"string","isRequired":true,"uniqueKey":"authority_report.report_number","typeLabel":"string"},"report_date":{"type":"string","format":"date","isRequired":true,"uniqueKey":"authority_report.report_date","typeLabel":"string\u003cdate>"},"filing_station":{"type":"string","uniqueKey":"authority_report.filing_station","typeLabel":"string"}},"required":["report_date","report_number"],"uniqueKey":"authority_report","typeLabel":"object"}},"required":["claim_details","claimant_metadata"],"uniqueKey":"","typeLabel":"object"},"examples":{"BasicValidPayloadWithRequiredFields":{"title":"BasicValidPayloadWithRequiredFields","value":{"claimant_metadata":{"first_name":"John","last_name":"Doe","birth_date":"1985-05-15","email":"johndoe@example.com","relationship":"Self"},"claim_details":{"claim_type":"accident","incident_description":"Car accident on highway","incident_date":"2024-07-10","claim_amount":"1500.00","supporting_documents":[{"document_name":"Police Report","evidence_type":"PDF","document_url":"https://example.com/police-report.pdf","uploaded_at":"2024-07-11T08:00:00Z"}]},"policy_id":"123e4567-e89b-12d3-a456-426614174000","witness_details":[],"authority_report":{"report_number":"ABC123456","report_date":"2024-07-11","filing_station":"Miami Police Station"}}},"MinimalValidPayloadWithOnlyRequiredField-OmittingOptionalFields":{"title":"MinimalValidPayloadWithOnlyRequiredField-OmittingOptionalFields","value":{"claimant_metadata":{"first_name":"Alice","last_name":"Johnson","birth_date":"1980-01-01","email":"alicejohnson@example.com","relationship":"Parent"},"claim_details":{"claim_type":"theft","incident_description":"Bicycle stolen from garage","incident_date":"2024-07-20"}}},"FullValidPayloadWithAllFields":{"title":"FullValidPayloadWithAllFields","value":{"claimant_metadata":{"first_name":"Jane","last_name":"Smith","birth_date":"1990-12-01","email":"janesmith@example.com","phone_number":"+1234567890","relationship":"Spouse"},"claim_details":{"claim_type":"illness","incident_description":"Hospitalized due to severe illness","incident_date":"2024-06-15","claim_amount":"5000.00","supporting_documents":[{"document_name":"Police Report","evidence_type":"PDF","document_url":"https://example.com/police-report.pdf","uploaded_at":"2024-07-11T08:00:00Z"}]},"policy_id":"123e4567-e89b-12d3-a456-426614174001","policy_number":"POL12345678","witness_details":[{"witness_name":"Michael Doe","witness_contact_phone":"+1987654321","witness_contact_email":"michael.doe@example.com","witness_statement":"I saw the entire incident happen."}],"authority_report":{"report_number":"XYZ987654","report_date":"2024-06-17","filing_station":"IsaleEko Police Station"}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"9c849f0f-3ce5-4e73-a2b4-36ca1bdf6359":{"content":{"application/json":{"schema":{"type":"object","description":"V2 Serializer for formating responses when","properties":{"claim_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"claim_id","typeLabel":"string\u003cuuid>"},"policy_id":{"type":"string","isRequired":true,"uniqueKey":"policy_id","typeLabel":"string"},"claim_status":{"type":"string","isRequired":true,"uniqueKey":"claim_status","typeLabel":"string"},"insurer":{"type":"string","isRequired":true,"uniqueKey":"insurer","typeLabel":"string"}},"required":["claim_id","claim_status","insurer","policy_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"ClaimSubmissionResponse":{"title":"ClaimSubmissionResponse","value":{"claim_id":"d2d0c0b4-bf72-4a61-a02e-3ab896dd8bf7","claim_reference_number":"CLAIM-20240813-5678","claim_status":"submitted","insurer":"Leadway Assurance"}}},"exampleType":"examples"}},"description":"Claim submitted successfully","exampleType":"examples"}},"security":{"389d632f-be1c-4a92-a00b-808797863a8b":{"ClientKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[]}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[]},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ClientKeyAuth","name":"X-API-Key"}],"title":"ClientKeyAuth"}]},"originalFileLocation":"api-reference/schema.json"},"subdomain":"unyte","siteName":"Unyte","title":"Unyte - Developer Documentation","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api-reference/claims/submit-a-claim","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T04:46:55.483Z","originalFileLocation":"api-reference/claims/submit-a-claim.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=\"Submits a new claim entry on behalf of a customer\">\u003cmeta data-mint-head name=\"application-name\" content=\"Unyte\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/unyte/0_0kQA1ownyrn2t5/_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/unyte/0_0kQA1ownyrn2t5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/unyte/0_0kQA1ownyrn2t5/_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/unyte/0_0kQA1ownyrn2t5/_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/unyte/0_0kQA1ownyrn2t5/_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/unyte/0_0kQA1ownyrn2t5/_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/unyte/0_0kQA1ownyrn2t5/_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/unyte/0_0kQA1ownyrn2t5/_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/unyte/0_0kQA1ownyrn2t5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Unyte - Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Comprehensive insurance management infrastructure for businesses in Africa - Unyte\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Unyte\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.unyte.africa/api-reference/claims/submit-a-claim\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://unyte.mintlify.app/images/unyte_seo_banner_hd.png\">\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=\"Unyte - Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Comprehensive insurance management infrastructure for businesses in Africa - Unyte\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://unyte.mintlify.app/images/unyte_seo_banner_hd.png\">\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/unyte/0_0kQA1ownyrn2t5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Unyte\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2AB673\">\u003cmeta data-mint-head name=\"og:logo\" content=\"/logo/logo.png\">\u003cmeta data-mint-head name=\"twitter:url\" content=\"@unyte_africa\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.unyte.africa/api-reference/claims/submit-a-claim\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/claims/submit-a-claim.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.unyte.africa/#organization\",\"name\":\"Unyte\",\"url\":\"https://docs.unyte.africa\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/unyte/pJ2ZzkNRYCpUMHmv/logo/logo.png?fit=max\u0026auto=format\u0026n=pJ2ZzkNRYCpUMHmv\u0026q=85\u0026s=d0178384ea8afac38a4891da460de351\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.unyte.africa#website\",\"name\":\"Unyte\",\"url\":\"https://docs.unyte.africa\",\"publisher\":{\"@id\":\"https://docs.unyte.africa/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.unyte.africa/api-reference/claims/submit-a-claim#webpage\",\"url\":\"https://docs.unyte.africa/api-reference/claims/submit-a-claim\",\"name\":\"Submit a claim\",\"description\":\"Submits a new claim entry on behalf of a customer\",\"dateModified\":\"2026-01-07T04:46:55.483Z\",\"isPartOf\":{\"@id\":\"https://docs.unyte.africa#website\"},\"breadcrumb\":{\"@id\":\"https://docs.unyte.africa/api-reference/claims/submit-a-claim#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.unyte.africa/api-reference/claims/submit-a-claim#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Claims\",\"item\":\"https://docs.unyte.africa/api-reference/claims/view-all-claims-made-by-your-customers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Submit a claim\",\"item\":\"https://docs.unyte.africa/api-reference/claims/submit-a-claim\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.unyte.africa/api-reference/claims/submit-a-claim#apireference\",\"headline\":\"Submit a claim\",\"name\":\"Submit a claim\",\"description\":\"Submits a new claim entry on behalf of a customer\",\"url\":\"https://docs.unyte.africa/api-reference/claims/submit-a-claim\",\"mainEntityOfPage\":{\"@id\":\"https://docs.unyte.africa/api-reference/claims/submit-a-claim#webpage\"},\"image\":\"https://docs.unyte.africa/images/unyte_seo_banner_hd.png\",\"dateModified\":\"2026-01-07T04:46:55.483Z\",\"publisher\":{\"@id\":\"https://docs.unyte.africa/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.unyte.africa#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Unyte\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Unyte","nav":{"global":null,"versions":[{"version":"v1","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Claims","pages":[{"openapi":"get /api/v1/claims/","title":"View all claims made by your customers","description":"Retrieve a list of claims based on query parameters.","href":"/api-reference/claims/view-all-claims-made-by-your-customers"},{"openapi":"post /api/v1/claims/","title":"Submit a claim","href":"/api-reference/claims/submit-a-claim"},{"openapi":"get /api/v1/claims/{id}/","title":"Retrieve a claim by its ID or Reference Number","description":"Retrieve a single claim by its unique ID or claim reference number","href":"/api-reference/claims/retrieve-a-claim-by-its-id-or-reference-number"},{"openapi":"patch /api/v1/claims/{id}/","title":"Update the details of a previously filed claim by a cutstomer","href":"/api-reference/claims/update-the-details-of-a-previously-filed-claim-by-a-cutstomer"}]},{"group":"Customers","pages":[{"openapi":"get /api/v1/customers/","title":"Retrieve all customers for a merchant","href":"/api-reference/customers/retrieve-all-customers-for-a-merchant"},{"openapi":"get /api/v1/customers/{id}/","title":"Retrieve a specific customer's details","href":"/api-reference/customers/retrieve-a-specific-customers-details"},{"openapi":"get /api/v1/customers/{id}/claims/","title":"Retrieve all claims for a specific customer","href":"/api-reference/customers/retrieve-all-claims-for-a-specific-customer"},{"openapi":"get /api/v1/customers/{id}/policies/","title":"Retrieve all active policies for a specific customer","href":"/api-reference/customers/retrieve-all-active-policies-for-a-specific-customer"}]},{"group":"Environments","pages":[{"openapi":"get /api/v1/environments/","title":"Retrieve all environments","href":"/api-reference/environments/retrieve-all-environments"},{"openapi":"post /api/v1/environments/","title":"Create a new environment","href":"/api-reference/environments/create-a-new-environment"},{"openapi":"get /api/v1/environments/{id}/","title":null,"href":"/api-reference/environments/get-apiv1environments-"}]},{"group":"Platform Status","pages":[{"openapi":"get /api/v1/health","title":"Health Check","href":"/api-reference/platform-status/health-check"}]},{"group":"Insurance Providers","pages":[{"openapi":"get /api/v1/insurers/","title":"List all insurance providers","href":"/api-reference/insurance-providers/list-all-insurance-providers"},{"openapi":"get /api/v1/insurers/{name}/","title":"View details about a specific insurance provider","href":"/api-reference/insurance-providers/view-details-about-a-specific-insurance-provider"},{"openapi":"get /api/v1/providers/search/","title":"Search for insurance providers","href":"/api-reference/insurance-providers/search-for-insurance-providers"}]},{"group":"Job Tasks","pages":[{"openapi":"get /api/v1/jobs/{job_id}/status/","title":"Check Job Status","href":"/api-reference/job-tasks/check-job-status"}]},{"group":"Merchant","pages":[{"openapi":"get /api/v1/merchants","title":"List all merchants","href":"/api-reference/merchant/list-all-merchants"},{"openapi":"post /api/v1/merchants/","title":"Register a new merchant on Unyte","href":"/api-reference/merchant/register-a-new-merchant-on-unyte"},{"openapi":"get /api/v1/merchants/{merchant_id}/","title":"Retrieve a merchant instance by its `merchant_id` (merchant id, refers to a unique merchant code assigned to the merchant)","href":"/api-reference/merchant/retrieve-a-merchant-instance-by-its-`merchant_id`-merchant-id-refers-to-a-unique-merchant-code-assigned-to-the-merchant"},{"openapi":"get /api/v1/merchants/{merchant_id}/verify/","title":"Verify merchant email","href":"/api-reference/merchant/verify-merchant-email"},{"openapi":"patch /api/v1/merchants/{tenant_id}/","title":"Update a merchant information as a customer support agent","href":"/api-reference/merchant/update-a-merchant-information-as-a-customer-support-agent"}]},{"group":"Providers' Onboarding","pages":[{"openapi":"post /api/v1/onboarding/providers/{provider_id}/next_steps/","title":"Onboard Partner Provider Products","href":"/api-reference/providers-onboarding/onboard-partner-provider-products"},{"openapi":"post /api/v1/onboarding/providers/registration/","title":"Register a new Insurance Provider","href":"/api-reference/providers-onboarding/register-a-new-insurance-provider"}]},{"group":"Policies","pages":[{"openapi":"post /api/v1/policies","title":"Purchase a policy","href":"/api-reference/policies/purchase-a-policy"},{"openapi":"get /api/v1/policies/","title":null,"href":"/api-reference/policies/view-all-purchased-policies--admin-only"},{"openapi":"get /api/v1/policies/{policy_id}/","title":"View the details of a specific insurance policy by its ID","href":"/api-reference/policies/view-the-details-of-a-specific-insurance-policy-by-its-id"},{"openapi":"post /api/v1/policies/cancel","title":"Cancel an active policy subscription","href":"/api-reference/policies/cancel-an-active-policy-subscription"},{"openapi":"post /api/v1/policies/renew/","title":"Renew a policy","href":"/api-reference/policies/renew-a-policy"},{"openapi":"get /api/v1/policies/search/","title":"Search and filter for policies","href":"/api-reference/policies/search-and-filter-for-policies"},{"openapi":"patch /api/v1/policies/update/","title":"Update an existing policy data","href":"/api-reference/policies/update-an-existing-policy-data"}]},{"group":"Products","pages":[{"openapi":"get /api/v1/products","title":"List all products","href":"/api-reference/products/list-all-products"},{"openapi":"get /api/v1/products/{id}/","title":"Retrieve a product by ID","href":"/api-reference/products/retrieve-a-product-by-id"},{"openapi":"get /api/v1/products/{product_name}/","title":"Retrieve a product by name","href":"/api-reference/products/retrieve-a-product-by-name"}]},{"group":"Quotes","pages":[{"openapi":"post /api/v1/quotes","title":"Request a quote for an insurance policy or product","href":"/api-reference/quotes/request-a-quote-for-an-insurance-policy-or-product"},{"openapi":"get /api/v1/quotes/{quote_code}/","title":"Retrieve a specific quote by its reference code","href":"/api-reference/quotes/retrieve-a-specific-quote-by-its-reference-code"},{"openapi":"post /api/v1/quotes/{quote_code}/intent/capture/","title":"Capture a new purchase intent for an insurance policy","href":"/api-reference/quotes/capture-a-new-purchase-intent-for-an-insurance-policy"}]}]},{"tab":"Knowledge Base","icon":"book-open","href":"https://unyte.africa/company/learn"},{"tab":"Changelog","icon":"clock","pages":[{"title":"Changelog","href":"/changelog"}]}]}]},"title":"Unyte - Developer Documentation","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-DblVYOPe.js","dist-BnkC_6oA.js","lib--scc4DXi.js","lib-B8HbPgcC.js","clsx-CCOYKgaU.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","AssistantPageLink-BM4S31-f.js"]}