Policy number issued to the customer as assigned by the insurer e.g GI86585700-1
{"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/policies/purchase-a-policy","slug":"/api-reference/policies/purchase-a-policy","pageMetadata":{"openapi":"post /api/v1/policies","title":"Purchase a policy","description":"Purchase a new policy for your customer","href":"/api-reference/policies/purchase-a-policy"},"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: \"Purchase a new policy for your 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/policies","title":"Purchase a policy","description":"Purchase a new policy for your customer","href":"/api-reference/policies/purchase-a-policy"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"purchase-policy","description":"Purchase a new policy for your customer","summary":"Purchase a policy","parameters":["ad33c0f3-8a24-44e3-8bef-65ab6fd8ff06"],"tags":["Policies"],"requestBody":"3315e959-6ab2-4718-88e1-d5a487043377","security":["8e30515d-1371-44f7-92c0-b8bc744c125a"],"responses":{"201":"d7132e53-361d-4aca-ba77-a5b0c9471328","400":"8be73876-9064-4d62-9496-c6f014026626","500":"1490aca4-34c0-4ff6-a593-27597ea7bef3"},"method":"post","type":"path","servers":[],"path":"/api/v1/policies","baseUrlOptions":["https://dev.superpool.unyte.africa/","https://superpool.unyte.africa/"],"title":"Purchase a policy","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ad33c0f3-8a24-44e3-8bef-65ab6fd8ff06":{"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"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Improved data handler for policy purchase requests","properties":{"intent_id":{"type":"string","description":"Intent ID","isRequired":true,"uniqueKey":"intent_id","typeLabel":"string"},"merchant_code":{"type":"string","description":"Merchant or Partner Seller short code","maxLength":50,"isRequired":true,"uniqueKey":"merchant_code","typeLabel":"string"},"additional_information":{"description":"Insurance Product-specific additional information required for the selected product type e.g {\"vehicle_make\": \"Toyota\", \"vehicle_model\": \"Camry\"}","isRequired":true,"uniqueKey":"additional_information","typeLabel":"any"},"activation_metadata":{"type":"object","properties":{"renew":{"type":"boolean","description":"Set this insurance policy to auto-renew","uniqueKey":"activation_metadata.renew","typeLabel":"boolean"},"send_customer_notification":{"type":"boolean","writeOnly":true,"default":false,"uniqueKey":"activation_metadata.send_customer_notification","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"activation_metadata","typeLabel":"object"}},"required":["activation_metadata","additional_information","intent_id","merchant_code"],"uniqueKey":"","typeLabel":"object"},"examples":{"PolicyPurchaseRequest":{"title":"PolicyPurchaseRequest","value":{"intent_id":"d5c36562-b86f-4e97-8288-8c6cb2da35ef","merchant_code":"ERO-2635","additional_information":{"make":"Honda","model":"CBR600RR","value":15000,"owner":"Alex Rider","year":"2021-05-15","usecase":"private","vehicle_type":"saloon","engine_number":"ENG567890","chassis_number":"CHS678901","registration_number":"MOT1234"},"activation_metadata":{"renew":true,"send_customer_notification":true}}},"CargoInsurancePurchaseRequest":{"title":"CargoInsurancePurchaseRequest","value":{"intent_id":"d5c36562-b86f-4e97-8288-8c6cb2da35ef","merchant_code":"ERO-2635","additional_information":{"shipment_type":"international","shipment_value":750000.5,"originating_port":"Lagos, Nigeria","destination_port":"Accra, Ghana","shipment_carrier":"XYZ Couriers","shipment_carrier_details":{"tracking_number":"NG987654321","service_type":"Air Freight"},"exchange_rate":750,"tin_number":"TIN-123456","lc_number":"LLC-123456","cac_number":"CAC-123456","bank_name":"GTBank","invoice_number":"INV-123456","currency":"USD"},"activation_metadata":{"renew":true,"send_customer_notification":true}}},"TravelInsurancePurchaseRequest":{"title":"TravelInsurancePurchaseRequest","value":{"intent_id":"d5c36562-b86f-4e97-8288-8c6cb2da35ef","merchant_code":"ERO-2635","additional_information":{"destination":"France","departure_date":"2023-09-01","return_date":"2023-09-15","number_of_travellers":2,"trip_duration":14,"trip_type":"round_trip","trip_type_details":"leisure","insurance_options":"\u003cinsurance_plan_or_null>"},"activation_metadata":{"renew":true,"send_customer_notification":true}}},"DeviceInsurancePurchaseRequest":{"title":"DeviceInsurancePurchaseRequest","value":{"intent_id":"d5c36562-b86f-4e97-8288-8c6cb2da35ef","merchant_code":"ERO-2635","additional_information":{"device_type":"Smartphone","make":"Samsung","model":"Galaxy S21","value":100000,"serial_number":"SNG-123456","imei":"IMEI-123456"},"activation_metadata":{"renew":true,"send_customer_notification":true}}}},"exampleType":"examples"},"application/x-www-form-urlencoded":{"schema":{"type":"object","description":"Improved data handler for policy purchase requests","properties":{"intent_id":{"type":"string","description":"Intent ID","isRequired":true,"uniqueKey":"intent_id","typeLabel":"string"},"merchant_code":{"type":"string","description":"Merchant or Partner Seller short code","maxLength":50,"isRequired":true,"uniqueKey":"merchant_code","typeLabel":"string"},"additional_information":{"description":"Insurance Product-specific additional information required for the selected product type e.g {\"vehicle_make\": \"Toyota\", \"vehicle_model\": \"Camry\"}","isRequired":true,"uniqueKey":"additional_information","typeLabel":"any"},"activation_metadata":{"type":"object","properties":{"renew":{"type":"boolean","description":"Set this insurance policy to auto-renew","uniqueKey":"activation_metadata.renew","typeLabel":"boolean"},"send_customer_notification":{"type":"boolean","writeOnly":true,"default":false,"uniqueKey":"activation_metadata.send_customer_notification","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"activation_metadata","typeLabel":"object"}},"required":["activation_metadata","additional_information","intent_id","merchant_code"],"uniqueKey":"","typeLabel":"object"},"examples":{"PolicyPurchaseRequest":{"title":"PolicyPurchaseRequest","value":{"intent_id":"d5c36562-b86f-4e97-8288-8c6cb2da35ef","merchant_code":"ERO-2635","additional_information":{"make":"Honda","model":"CBR600RR","value":15000,"owner":"Alex Rider","year":"2021-05-15","usecase":"private","vehicle_type":"saloon","engine_number":"ENG567890","chassis_number":"CHS678901","registration_number":"MOT1234"},"activation_metadata":{"renew":true,"send_customer_notification":true}}},"CargoInsurancePurchaseRequest":{"title":"CargoInsurancePurchaseRequest","value":{"intent_id":"d5c36562-b86f-4e97-8288-8c6cb2da35ef","merchant_code":"ERO-2635","additional_information":{"shipment_type":"international","shipment_value":750000.5,"originating_port":"Lagos, Nigeria","destination_port":"Accra, Ghana","shipment_carrier":"XYZ Couriers","shipment_carrier_details":{"tracking_number":"NG987654321","service_type":"Air Freight"},"exchange_rate":750,"tin_number":"TIN-123456","lc_number":"LLC-123456","cac_number":"CAC-123456","bank_name":"GTBank","invoice_number":"INV-123456","currency":"USD"},"activation_metadata":{"renew":true,"send_customer_notification":true}}},"TravelInsurancePurchaseRequest":{"title":"TravelInsurancePurchaseRequest","value":{"intent_id":"d5c36562-b86f-4e97-8288-8c6cb2da35ef","merchant_code":"ERO-2635","additional_information":{"destination":"France","departure_date":"2023-09-01","return_date":"2023-09-15","number_of_travellers":2,"trip_duration":14,"trip_type":"round_trip","trip_type_details":"leisure","insurance_options":"\u003cinsurance_plan_or_null>"},"activation_metadata":{"renew":true,"send_customer_notification":true}}},"DeviceInsurancePurchaseRequest":{"title":"DeviceInsurancePurchaseRequest","value":{"intent_id":"d5c36562-b86f-4e97-8288-8c6cb2da35ef","merchant_code":"ERO-2635","additional_information":{"device_type":"Smartphone","make":"Samsung","model":"Galaxy S21","value":100000,"serial_number":"SNG-123456","imei":"IMEI-123456"},"activation_metadata":{"renew":true,"send_customer_notification":true}}}},"exampleType":"examples"},"multipart/form-data":{"schema":{"type":"object","description":"Improved data handler for policy purchase requests","properties":{"intent_id":{"type":"string","description":"Intent ID","isRequired":true,"uniqueKey":"intent_id","typeLabel":"string"},"merchant_code":{"type":"string","description":"Merchant or Partner Seller short code","maxLength":50,"isRequired":true,"uniqueKey":"merchant_code","typeLabel":"string"},"additional_information":{"description":"Insurance Product-specific additional information required for the selected product type e.g {\"vehicle_make\": \"Toyota\", \"vehicle_model\": \"Camry\"}","isRequired":true,"uniqueKey":"additional_information","typeLabel":"any"},"activation_metadata":{"type":"object","properties":{"renew":{"type":"boolean","description":"Set this insurance policy to auto-renew","uniqueKey":"activation_metadata.renew","typeLabel":"boolean"},"send_customer_notification":{"type":"boolean","writeOnly":true,"default":false,"uniqueKey":"activation_metadata.send_customer_notification","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"activation_metadata","typeLabel":"object"}},"required":["activation_metadata","additional_information","intent_id","merchant_code"],"uniqueKey":"","typeLabel":"object"},"examples":{"PolicyPurchaseRequest":{"title":"PolicyPurchaseRequest","value":{"intent_id":"d5c36562-b86f-4e97-8288-8c6cb2da35ef","merchant_code":"ERO-2635","additional_information":{"make":"Honda","model":"CBR600RR","value":15000,"owner":"Alex Rider","year":"2021-05-15","usecase":"private","vehicle_type":"saloon","engine_number":"ENG567890","chassis_number":"CHS678901","registration_number":"MOT1234"},"activation_metadata":{"renew":true,"send_customer_notification":true}}},"CargoInsurancePurchaseRequest":{"title":"CargoInsurancePurchaseRequest","value":{"intent_id":"d5c36562-b86f-4e97-8288-8c6cb2da35ef","merchant_code":"ERO-2635","additional_information":{"shipment_type":"international","shipment_value":750000.5,"originating_port":"Lagos, Nigeria","destination_port":"Accra, Ghana","shipment_carrier":"XYZ Couriers","shipment_carrier_details":{"tracking_number":"NG987654321","service_type":"Air Freight"},"exchange_rate":750,"tin_number":"TIN-123456","lc_number":"LLC-123456","cac_number":"CAC-123456","bank_name":"GTBank","invoice_number":"INV-123456","currency":"USD"},"activation_metadata":{"renew":true,"send_customer_notification":true}}},"TravelInsurancePurchaseRequest":{"title":"TravelInsurancePurchaseRequest","value":{"intent_id":"d5c36562-b86f-4e97-8288-8c6cb2da35ef","merchant_code":"ERO-2635","additional_information":{"destination":"France","departure_date":"2023-09-01","return_date":"2023-09-15","number_of_travellers":2,"trip_duration":14,"trip_type":"round_trip","trip_type_details":"leisure","insurance_options":"\u003cinsurance_plan_or_null>"},"activation_metadata":{"renew":true,"send_customer_notification":true}}},"DeviceInsurancePurchaseRequest":{"title":"DeviceInsurancePurchaseRequest","value":{"intent_id":"d5c36562-b86f-4e97-8288-8c6cb2da35ef","merchant_code":"ERO-2635","additional_information":{"device_type":"Smartphone","make":"Samsung","model":"Galaxy S21","value":100000,"serial_number":"SNG-123456","imei":"IMEI-123456"},"activation_metadata":{"renew":true,"send_customer_notification":true}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"d7132e53-361d-4aca-ba77-a5b0c9471328":{"content":{"application/json":{"schema":{"type":"object","description":"Limited view of the PolicySerializer for the purchase response","properties":{"effective_from":{"type":"string","format":"date","description":"Date the policy becomes active - determined by the time of purchase","isRequired":true,"uniqueKey":"effective_from","typeLabel":"string\u003cdate>"},"effective_through":{"type":"string","format":"date","description":"Date the policy expires","isRequired":true,"uniqueKey":"effective_through","typeLabel":"string\u003cdate>"},"premium":{"type":"string","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","description":"Amount paid for the policy","isRequired":true,"uniqueKey":"premium","typeLabel":"string\u003cdecimal>"},"insurer":{"type":"string","isRequired":true,"uniqueKey":"insurer","typeLabel":"string"},"policy_status":{"type":"string","isRequired":true,"uniqueKey":"policy_status","typeLabel":"string"},"product_information":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"product_information.additionalProperties","typeLabel":"any"},"description":"Returns the product information as a dictionary","readOnly":true,"isRequired":true,"uniqueKey":"product_information","typeLabel":"object"},"customer_information":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"customer_information.additionalProperties","typeLabel":"any"},"description":"Returns the customer information as a dictionary","readOnly":true,"isRequired":true,"uniqueKey":"customer_information","typeLabel":"object"},"renewal_information":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"renewal_information.additionalProperties","typeLabel":"any"},"description":"Returns the renewal information as a dictionary","readOnly":true,"isRequired":true,"uniqueKey":"renewal_information","typeLabel":"object"},"policy_id":{"type":"string","format":"uuid","description":"Unique identifier for the policy","uniqueKey":"policy_id","typeLabel":"string\u003cuuid>"},"policy_reference_number":{"type":"string","default":"","description":"Policy number issued to the customer as assigned by the insurer e.g GI86585700-1","uniqueKey":"policy_reference_number","typeLabel":"string"}},"required":["customer_information","effective_from","effective_through","insurer","policy_status","premium","product_information","renewal_information"],"uniqueKey":"","typeLabel":"object"},"examples":{"SuccessfulPolicyPurchaseExample":{"title":"SuccessfulPolicyPurchaseExample","value":{"policy_id":"ba4fc272-5591-4812-9f36-48c3ffb27a69","policy_reference_number":"EXAMPLE-POLICY-NUMBER","effective_from":"2022-08-10","effective_through":"2024-12-11","premium":"10000.00","insurer":"AXA","policy_status":"active","product_information":{"product_name":"Home Insurance","product_type":"Home","product_description":"Home"},"customer_information":{"customer_name":"John Doe","customer_email":"john.doestar@email.com","customer_phone":"1234567890","customer_address":"123 Main St, Springfield, IL"},"renewal_information":{"renewable":false}}}},"exampleType":"examples"}},"description":"Policy purchase successful","exampleType":"examples"},"8be73876-9064-4d62-9496-c6f014026626":{"description":"Bad Request","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"1490aca4-34c0-4ff6-a593-27597ea7bef3":{"description":"Internal Server Error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"8e30515d-1371-44f7-92c0-b8bc744c125a":{"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/policies/purchase-a-policy","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T04:46:55.867Z","originalFileLocation":"api-reference/policies/purchase-a-policy.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=\"Purchase a new policy for your 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/policies/purchase-a-policy\">\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/policies/purchase-a-policy\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/policies/purchase-a-policy.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/policies/purchase-a-policy#webpage\",\"url\":\"https://docs.unyte.africa/api-reference/policies/purchase-a-policy\",\"name\":\"Purchase a policy\",\"description\":\"Purchase a new policy for your customer\",\"dateModified\":\"2026-01-07T04:46:55.867Z\",\"isPartOf\":{\"@id\":\"https://docs.unyte.africa#website\"},\"breadcrumb\":{\"@id\":\"https://docs.unyte.africa/api-reference/policies/purchase-a-policy#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.unyte.africa/api-reference/policies/purchase-a-policy#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Unyte\",\"item\":\"https://docs.unyte.africa\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Purchase a policy\",\"item\":\"https://docs.unyte.africa/api-reference/policies/purchase-a-policy\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.unyte.africa/api-reference/policies/purchase-a-policy#apireference\",\"headline\":\"Purchase a policy\",\"name\":\"Purchase a policy\",\"description\":\"Purchase a new policy for your customer\",\"url\":\"https://docs.unyte.africa/api-reference/policies/purchase-a-policy\",\"mainEntityOfPage\":{\"@id\":\"https://docs.unyte.africa/api-reference/policies/purchase-a-policy#webpage\"},\"image\":\"https://docs.unyte.africa/images/unyte_seo_banner_hd.png\",\"dateModified\":\"2026-01-07T04:46:55.867Z\",\"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","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","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","description":"Onboarding endpoint for registering 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,"description":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"]}