A company admin answers the health declaration on the employees’ behalf. all_employees is the default set of answers; ids_or_emails overrides them for the employees whose history differs. The answers are stored on the members of the policy, and its payment_link appears once nobody is left in pending_declarations.
Where the company pays. A fresh signed link on every read, valid 15 minutes. Null while anyone is in pending_declarations, and once the policy is issued.
The invoice for the premium the company paid, one line per package tier, once the company has paid. Null before that. On sandbox the document is watermarked SANDBOX and is not a tax invoice.
Format YYYY-MM-DD. Saudi nationals whose national id starts with 1 give the Hijri (Umm al-Qura) date printed on their id, for example 1409-09-14; everyone else gives a Gregorian date. Employees must be between 18 and 110 years old.
Family members covered under this employee's policy. They get the same provider and category as the employee. Optional; omit or send an empty array for an employee without dependents.
Format YYYY-MM-DD. Saudi nationals whose national id starts with 1 give the Hijri (Umm al-Qura) date printed on their id, for example 1409-09-14; everyone else gives a Gregorian date. A dependent can be any age up to 110.
{"docsConfig":{"theme":"linden","$schema":"https://mintlify.com/docs.json","name":"Yasmina embedded insurance","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/yasmina/gYT_wrUNH6DJHRcX/logo/light.svg?fit=max\u0026auto=format\u0026n=gYT_wrUNH6DJHRcX\u0026q=85\u0026s=8f104780e9e2be0f5ed858abf5daf565","dark":"https://mintcdn.com/yasmina/gYT_wrUNH6DJHRcX/logo/dark.svg?fit=max\u0026auto=format\u0026n=gYT_wrUNH6DJHRcX\u0026q=85\u0026s=4b99116ce5278adfe03cc2508a4ead66"},"favicon":"https://mintcdn.com/yasmina/gYT_wrUNH6DJHRcX/favicon.svg?fit=max\u0026auto=format\u0026n=gYT_wrUNH6DJHRcX\u0026q=85\u0026s=011065c671b0598099e2297a50ad5260","api":{"params":{"expanded":"all"},"playground":{"display":"interactive","proxy":false},"examples":{"defaults":"required"}},"background":{"color":{"light":"#FFF","dark":"#000"}},"navbar":{"primary":{"type":"button","label":"Portal","href":"https://portal.yasmina.ai"}},"fonts":{"family":"Inter, sans-serif"},"styling":{"eyebrows":"breadcrumbs","latex":false},"integrations":{"amplitude":{"apiKey":"3fd7f32ecb0ff851ba9ea3b6670cd855"},"intercom":{"appId":"yu8wo042"}},"contextual":{"options":["mcp"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"yasmina","hasAudioNarration":false,"actualSubdomain":"yasmina","customDomains":["docs.yasmina.ai"],"gitSource":{"type":"github","owner":"yasminaai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae1e198494007f2550fe1f0","collectionId":"ced6d93c-21c5-4dec-9fbe-701c9efc2701","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae1e198494007f2550fe1f0"},"entitlements":{},"buildId":"6ae1e198494007f2550fe1f0","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API Reference","count":61},{"language":"default","tag":"Policies","count":24},{"language":"default","tag":"Guide","count":21},{"language":"default","tag":"SME Medical APIs","count":18},{"language":"default","tag":"Motor Insurance APIs (Multiple Providers)","count":17},{"language":"default","tag":"SDKs","count":10},{"language":"default","tag":"Front-End SDKs","count":10},{"language":"default","tag":"Insurance Integration Guides","count":9},{"language":"default","tag":"Quotes","count":9},{"language":"default","tag":"Property Insurance APIs","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-logo{height:40px}#pagination{display:none!important}.ai-note{display:flex;align-items:flex-start;gap:.65rem;margin:1rem 0 1.5rem;padding:.9rem 1rem;border:1px solid #93c5fd;border-radius:.75rem;background-color:#eff6ff;color:#1e40af}.ai-note svg{flex-shrink:0;margin-top:.2rem}.ai-note p{margin:0;color:inherit}.ai-note a{color:inherit;font-weight:600;text-decoration:underline}.dark .ai-note{border-color:#1e40af;background-color:rgba(30,58,138,.25);color:#93c5fd}"}],"page":{"pagePath":"medical-api-reference/medical-forms/fill-the-declarations","slug":"/medical-api-reference/medical-forms/fill-the-declarations","pageMetadata":{"title":"Fill the declarations","description":"A company admin answers the health declaration on the employees' behalf. `all_employees` is the default set of answers; `ids_or_emails` overrides them for the employees whose history differs. The answers are stored on the members of the policy, and its `payment_link` appears once nobody is left in `pending_declarations`.","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json post /policies/{policyId}/declarations","href":"/medical-api-reference/medical-forms/fill-the-declarations","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"A company admin answers the health declaration on the employees’ behalf. \", _jsx(_components.code, {\n children: \"all_employees\"\n }), \" is the default set of answers; \", _jsx(_components.code, {\n children: \"ids_or_emails\"\n }), \" overrides them for the employees whose history differs. The answers are stored on the members of the policy, and its \", _jsx(_components.code, {\n children: \"payment_link\"\n }), \" appears once nobody is left in \", _jsx(_components.code, {\n children: \"pending_declarations\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Fill the declarations","description":"A company admin answers the health declaration on the employees' behalf. `all_employees` is the default set of answers; `ids_or_emails` overrides them for the employees whose history differs. The answers are stored on the members of the policy, and its `payment_link` appears once nobody is left in `pending_declarations`.","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json post /policies/{policyId}/declarations","href":"/medical-api-reference/medical-forms/fill-the-declarations","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/yasmina/ccacd844f457d935/script.js"],"openApiReferenceData":{"operation":{"summary":"Fill the declarations","description":"A company admin answers the health declaration on the employees' behalf. `all_employees` is the default set of answers; `ids_or_emails` overrides them for the employees whose history differs. The answers are stored on the members of the policy, and its `payment_link` appears once nobody is left in `pending_declarations`.","tags":["Medical Forms"],"parameters":["6e1bf012-2ab4-4170-addc-1de3639a1dfe"],"requestBody":"420d8763-ae1e-4be0-89c3-1bce0328254d","responses":{"200":"011ae26e-7131-43bc-b13d-5f7abb9fd61c","401":"402f7d09-d453-47a7-adbe-33a59a8053e6","404":"1dcde134-ece6-4f35-bdb4-eda3ebb70fd7","422":"1d1872bf-1352-4901-a902-ef5c6fa24a30"},"method":"post","type":"path","servers":["babe9e8c-22b4-4dff-9aa4-fb8a7cb7dca5","549dafe9-6d4d-4406-899c-a14be3d58458"],"security":["e9276e3f-3867-49d5-bed9-55d7c26f9fc8"],"path":"/policies/{policyId}/declarations","baseUrlOptions":["https://production.yasmina.ai/api/v1/medical","https://sandbox.yasmina.ai/api/v1/medical"],"title":"Fill the declarations","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"6e1bf012-2ab4-4170-addc-1de3639a1dfe":{"name":"policyId","in":"path","required":true,"schema":{"type":"integer","isRequired":true,"uniqueKey":"","typeLabel":"integer"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["all_employees"],"properties":{"all_employees":{"type":"object","description":"Yes or No for each question, and the list of chronic diseases.","properties":{"allergies":{"type":"string","enum":["Yes","No"],"uniqueKey":"all_employees.allergies","typeLabel":"enum\u003cstring>"},"current_medications":{"type":"string","enum":["Yes","No"],"uniqueKey":"all_employees.current_medications","typeLabel":"enum\u003cstring>"},"hospitalizations":{"type":"string","enum":["Yes","No"],"uniqueKey":"all_employees.hospitalizations","typeLabel":"enum\u003cstring>"},"pre_existing_conditions":{"type":"string","enum":["Yes","No"],"uniqueKey":"all_employees.pre_existing_conditions","typeLabel":"enum\u003cstring>"},"past_surgeries":{"type":"string","enum":["Yes","No"],"uniqueKey":"all_employees.past_surgeries","typeLabel":"enum\u003cstring>"},"surgery_complications":{"type":"string","enum":["Yes","No"],"uniqueKey":"all_employees.surgery_complications","typeLabel":"enum\u003cstring>"},"chest_pain_or_breathlessness":{"type":"string","enum":["Yes","No"],"uniqueKey":"all_employees.chest_pain_or_breathlessness","typeLabel":"enum\u003cstring>"},"heart_procedures":{"type":"string","enum":["Yes","No"],"uniqueKey":"all_employees.heart_procedures","typeLabel":"enum\u003cstring>"},"smoking":{"type":"string","enum":["Yes","No"],"uniqueKey":"all_employees.smoking","typeLabel":"enum\u003cstring>"},"alcohol_consumption":{"type":"string","enum":["Yes","No"],"uniqueKey":"all_employees.alcohol_consumption","typeLabel":"enum\u003cstring>"},"physical_activity":{"type":"string","enum":["Yes","No"],"uniqueKey":"all_employees.physical_activity","typeLabel":"enum\u003cstring>"},"family_history":{"type":"string","enum":["Yes","No"],"uniqueKey":"all_employees.family_history","typeLabel":"enum\u003cstring>"},"chronic_disease":{"type":"array","items":{"type":"string","enum":["Diabetes","Asthma","Chronic Kidney Disease","Liver Disease","Cancer","None of the above"],"uniqueKey":"all_employees.chronic_disease.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"all_employees.chronic_disease","typeLabel":"enum\u003cstring>[]"}},"isRequired":true,"uniqueKey":"all_employees","typeLabel":"object"},"ids_or_emails":{"type":"array","description":"Employees whose answers differ from all_employees, named by nationality_id or iqama_id.","items":{"type":"object","required":["id_or_email","answers"],"properties":{"id_or_email":{"type":"string","example":"1111111111","isRequired":true,"uniqueKey":"ids_or_emails.items.[INDEX].id_or_email","typeLabel":"string"},"answers":{"type":"object","description":"Yes or No for each question, and the list of chronic diseases.","properties":{"allergies":{"type":"string","enum":["Yes","No"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.allergies","typeLabel":"enum\u003cstring>"},"current_medications":{"type":"string","enum":["Yes","No"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.current_medications","typeLabel":"enum\u003cstring>"},"hospitalizations":{"type":"string","enum":["Yes","No"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.hospitalizations","typeLabel":"enum\u003cstring>"},"pre_existing_conditions":{"type":"string","enum":["Yes","No"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.pre_existing_conditions","typeLabel":"enum\u003cstring>"},"past_surgeries":{"type":"string","enum":["Yes","No"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.past_surgeries","typeLabel":"enum\u003cstring>"},"surgery_complications":{"type":"string","enum":["Yes","No"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.surgery_complications","typeLabel":"enum\u003cstring>"},"chest_pain_or_breathlessness":{"type":"string","enum":["Yes","No"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.chest_pain_or_breathlessness","typeLabel":"enum\u003cstring>"},"heart_procedures":{"type":"string","enum":["Yes","No"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.heart_procedures","typeLabel":"enum\u003cstring>"},"smoking":{"type":"string","enum":["Yes","No"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.smoking","typeLabel":"enum\u003cstring>"},"alcohol_consumption":{"type":"string","enum":["Yes","No"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.alcohol_consumption","typeLabel":"enum\u003cstring>"},"physical_activity":{"type":"string","enum":["Yes","No"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.physical_activity","typeLabel":"enum\u003cstring>"},"family_history":{"type":"string","enum":["Yes","No"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.family_history","typeLabel":"enum\u003cstring>"},"chronic_disease":{"type":"array","items":{"type":"string","enum":["Diabetes","Asthma","Chronic Kidney Disease","Liver Disease","Cancer","None of the above"],"uniqueKey":"ids_or_emails.items.[INDEX].answers.chronic_disease.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"ids_or_emails.items.[INDEX].answers.chronic_disease","typeLabel":"enum\u003cstring>[]"}},"isRequired":true,"uniqueKey":"ids_or_emails.items.[INDEX].answers","typeLabel":"object"}},"uniqueKey":"ids_or_emails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"ids_or_emails","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"all_employees":{"chronic_disease":[]},"ids_or_emails":[{"id_or_email":"1111111111","answers":{"chronic_disease":[]}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"011ae26e-7131-43bc-b13d-5f7abb9fd61c":{"description":"The policy, with its declarations recorded","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"id","typeLabel":"integer"},"status":{"type":"integer","description":"0 pending payment, 1 active, 2 cancelled.","uniqueKey":"status","typeLabel":"integer"},"price":{"type":"number","description":"The premium for everyone on the policy, for a year.","uniqueKey":"price","typeLabel":"number"},"pending_declarations":{"type":"array","items":{"type":"string","uniqueKey":"pending_declarations.items.[INDEX]","typeLabel":"string"},"description":"Employees who still have to declare their medical history. Empty once everyone has.","uniqueKey":"pending_declarations","typeLabel":"string[]"},"payment_link":{"oneOf":[{"type":"string","description":"Where the company pays. A fresh signed link on every read, valid 15 minutes. Null while anyone is in pending_declarations, and once the policy is issued.","uniqueKey":"payment_link.oneOf.0","typeLabel":"string"},{"type":"null","description":"Where the company pays. A fresh signed link on every read, valid 15 minutes. Null while anyone is in pending_declarations, and once the policy is issued.","uniqueKey":"payment_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link","typeLabel":"string | null"},"provider_policy_id":{"oneOf":[{"type":"string","description":"The insurer's policy number, once issued.","uniqueKey":"provider_policy_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The insurer's policy number, once issued.","uniqueKey":"provider_policy_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_policy_id","typeLabel":"string | null"},"policy_url":{"oneOf":[{"type":"string","description":"The policy schedule listing every member, once the company has paid. Null before that.","uniqueKey":"policy_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The policy schedule listing every member, once the company has paid. Null before that.","uniqueKey":"policy_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"policy_url","typeLabel":"string | null"},"invoice_url":{"oneOf":[{"type":"string","description":"The invoice for the premium the company paid, one line per package tier, once the company has paid. Null before that. On sandbox the document is watermarked SANDBOX and is not a tax invoice.","uniqueKey":"invoice_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The invoice for the premium the company paid, one line per package tier, once the company has paid. Null before that. On sandbox the document is watermarked SANDBOX and is not a tax invoice.","uniqueKey":"invoice_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_url","typeLabel":"string | null"},"redirect_url":{"oneOf":[{"type":"string","uniqueKey":"redirect_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"redirect_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"redirect_url","typeLabel":"string | null"},"meta_data":{"type":"object","properties":{"company_id":{"type":"integer","uniqueKey":"meta_data.company_id","typeLabel":"integer"},"insurance_provider":{"type":"string","uniqueKey":"meta_data.insurance_provider","typeLabel":"string"},"quote_request_id":{"type":"string","format":"uuid","uniqueKey":"meta_data.quote_request_id","typeLabel":"string\u003cuuid>"},"quote_price_id":{"type":"string","format":"uuid","uniqueKey":"meta_data.quote_price_id","typeLabel":"string\u003cuuid>"},"insured":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"meta_data.insured.items.[INDEX].name","typeLabel":"string"},"nationality_iso":{"type":"string","isRequired":true,"uniqueKey":"meta_data.insured.items.[INDEX].nationality_iso","typeLabel":"string"},"category":{"type":"string","enum":["basic","standard","premium","executive"],"description":"The tier this employee picked. Every provider sells all four, so the quote request can price it with each of them.","isRequired":true,"uniqueKey":"meta_data.insured.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"mobile_number":{"type":"string","description":"The employee's mobile number.","example":"0500000001","isRequired":true,"uniqueKey":"meta_data.insured.items.[INDEX].mobile_number","typeLabel":"string"},"date_of_birth":{"type":"string","description":"Format YYYY-MM-DD. Saudi nationals whose national id starts with 1 give the Hijri (Umm al-Qura) date printed on their id, for example 1409-09-14; everyone else gives a Gregorian date. Employees must be between 18 and 110 years old.","isRequired":true,"uniqueKey":"meta_data.insured.items.[INDEX].date_of_birth","typeLabel":"string"},"nationality_id":{"type":"string","description":"For Saudis only. Exactly 10 digits.","pattern":"^[0-9]{10}$","example":"1111111111","uniqueKey":"meta_data.insured.items.[INDEX].nationality_id","typeLabel":"string"},"iqama_id":{"type":"string","description":"For non-Saudis. Exactly 10 digits. A non-Saudi whose iqama is not issued yet sends border_number instead.","pattern":"^[0-9]{10}$","example":"2222222222","uniqueKey":"meta_data.insured.items.[INDEX].iqama_id","typeLabel":"string"},"border_number":{"type":"string","description":"For non-Saudis without an iqama yet, in place of iqama_id. Exactly 10 digits.","pattern":"^[0-9]{10}$","example":"3000000001","uniqueKey":"meta_data.insured.items.[INDEX].border_number","typeLabel":"string"},"sponsor_id":{"type":"string","description":"The employee's sponsor id. Optional. Exactly 10 digits.","pattern":"^[0-9]{10}$","example":"1000000001","uniqueKey":"meta_data.insured.items.[INDEX].sponsor_id","typeLabel":"string"},"is_married":{"type":"boolean","description":"Whether the employee is married. Optional.","example":true,"uniqueKey":"meta_data.insured.items.[INDEX].is_married","typeLabel":"boolean"},"dependents":{"type":"array","description":"Family members covered under this employee's policy. They get the same provider and category as the employee. Optional; omit or send an empty array for an employee without dependents.","items":{"type":"object","required":["name","relationship","nationality_iso","date_of_birth"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"meta_data.insured.items.[INDEX].dependents.items.[INDEX].name","typeLabel":"string"},"relationship":{"type":"string","enum":["spouse","child","parent"],"description":"How the dependent is related to the employee","isRequired":true,"uniqueKey":"meta_data.insured.items.[INDEX].dependents.items.[INDEX].relationship","typeLabel":"enum\u003cstring>"},"nationality_iso":{"type":"string","description":"ISO 3166-1 alpha-2 country code","isRequired":true,"uniqueKey":"meta_data.insured.items.[INDEX].dependents.items.[INDEX].nationality_iso","typeLabel":"string"},"date_of_birth":{"type":"string","description":"Format YYYY-MM-DD. Saudi nationals whose national id starts with 1 give the Hijri (Umm al-Qura) date printed on their id, for example 1409-09-14; everyone else gives a Gregorian date. A dependent can be any age up to 110.","isRequired":true,"uniqueKey":"meta_data.insured.items.[INDEX].dependents.items.[INDEX].date_of_birth","typeLabel":"string"},"nationality_id":{"type":"string","description":"Required when nationality_iso is SA. Exactly 10 digits.","pattern":"^[0-9]{10}$","example":"1111111112","uniqueKey":"meta_data.insured.items.[INDEX].dependents.items.[INDEX].nationality_id","typeLabel":"string"},"iqama_id":{"type":"string","description":"Required when nationality_iso is not SA. Exactly 10 digits.","pattern":"^[0-9]{10}$","example":"2222222222","uniqueKey":"meta_data.insured.items.[INDEX].dependents.items.[INDEX].iqama_id","typeLabel":"string"}},"uniqueKey":"meta_data.insured.items.[INDEX].dependents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"meta_data.insured.items.[INDEX].dependents","typeLabel":"object[]"},"health_declaration":{"type":"object","readOnly":true,"description":"The employee's declaration, on the employees of a quote request and a policy. Set through Submit the declarations; ignored when sent in.","properties":{"answers":{"type":"object","description":"Yes or No for each question, and the list of chronic diseases.","properties":{"allergies":{"type":"string","enum":["Yes","No"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.allergies","typeLabel":"enum\u003cstring>"},"current_medications":{"type":"string","enum":["Yes","No"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.current_medications","typeLabel":"enum\u003cstring>"},"hospitalizations":{"type":"string","enum":["Yes","No"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.hospitalizations","typeLabel":"enum\u003cstring>"},"pre_existing_conditions":{"type":"string","enum":["Yes","No"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.pre_existing_conditions","typeLabel":"enum\u003cstring>"},"past_surgeries":{"type":"string","enum":["Yes","No"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.past_surgeries","typeLabel":"enum\u003cstring>"},"surgery_complications":{"type":"string","enum":["Yes","No"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.surgery_complications","typeLabel":"enum\u003cstring>"},"chest_pain_or_breathlessness":{"type":"string","enum":["Yes","No"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.chest_pain_or_breathlessness","typeLabel":"enum\u003cstring>"},"heart_procedures":{"type":"string","enum":["Yes","No"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.heart_procedures","typeLabel":"enum\u003cstring>"},"smoking":{"type":"string","enum":["Yes","No"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.smoking","typeLabel":"enum\u003cstring>"},"alcohol_consumption":{"type":"string","enum":["Yes","No"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.alcohol_consumption","typeLabel":"enum\u003cstring>"},"physical_activity":{"type":"string","enum":["Yes","No"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.physical_activity","typeLabel":"enum\u003cstring>"},"family_history":{"type":"string","enum":["Yes","No"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.family_history","typeLabel":"enum\u003cstring>"},"chronic_disease":{"type":"array","items":{"type":"string","enum":["Diabetes","Asthma","Chronic Kidney Disease","Liver Disease","Cancer","None of the above"],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.chronic_disease.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers.chronic_disease","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.answers","typeLabel":"object"},"consent":{"type":"boolean","enum":[true],"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.consent","typeLabel":"enum\u003cboolean>"},"filled_at":{"type":"string","format":"date-time","uniqueKey":"meta_data.insured.items.[INDEX].health_declaration.filled_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"meta_data.insured.items.[INDEX].health_declaration","typeLabel":"object"}},"required":["name","nationality_iso","category","mobile_number","date_of_birth"],"uniqueKey":"meta_data.insured.items.[INDEX]","typeLabel":"object"},"uniqueKey":"meta_data.insured","typeLabel":"object[]"}},"uniqueKey":"meta_data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"status":123,"price":123,"pending_declarations":["\u003cstring>"],"payment_link":"\u003cstring>","provider_policy_id":"\u003cstring>","policy_url":"\u003cstring>","invoice_url":"\u003cstring>","redirect_url":"\u003cstring>","meta_data":{"company_id":123,"insurance_provider":"\u003cstring>","quote_request_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","quote_price_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","insured":[{"name":"\u003cstring>","nationality_iso":"\u003cstring>","category":"basic","mobile_number":"0500000001","date_of_birth":"\u003cstring>","nationality_id":"1111111111","iqama_id":"2222222222","border_number":"3000000001","sponsor_id":"1000000001","is_married":true,"dependents":[{"name":"\u003cstring>","relationship":"spouse","nationality_iso":"\u003cstring>","date_of_birth":"\u003cstring>","nationality_id":"1111111112","iqama_id":"2222222222"}],"health_declaration":{"answers":{"allergies":"Yes","current_medications":"Yes","hospitalizations":"Yes","pre_existing_conditions":"Yes","past_surgeries":"Yes","surgery_complications":"Yes","chest_pain_or_breathlessness":"Yes","heart_procedures":"Yes","smoking":"Yes","alcohol_consumption":"Yes","physical_activity":"Yes","family_history":"Yes","chronic_disease":["Diabetes"]},"consent":true,"filled_at":"2023-11-07T05:31:56Z"}}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"402f7d09-d453-47a7-adbe-33a59a8053e6":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"40101","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"Unauthenticated","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"40101","message":"Unauthenticated"}}},"exampleType":"generated"}},"exampleType":"generated"},"1dcde134-ece6-4f35-bdb4-eda3ebb70fd7":{"description":"Record not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"40401","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"Not found","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"40401","message":"Not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"1d1872bf-1352-4901-a902-ef5c6fa24a30":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e9276e3f-3867-49d5-bed9-55d7c26f9fc8":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"babe9e8c-22b4-4dff-9aa4-fb8a7cb7dca5":{"url":"https://production.yasmina.ai/api/v1/medical"},"549dafe9-6d4d-4406-899c-a14be3d58458":{"url":"https://sandbox.yasmina.ai/api/v1/medical"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"medical-api-reference/openapi.json"},"subdomain":"yasmina","siteName":"Yasmina embedded insurance","title":"Fill the declarations - Yasmina embedded insurance","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T11:51:10.549Z","originalFileLocation":"medical-api-reference/medical-forms/fill-the-declarations.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=\"A company admin answers the health declaration on the employees\u0026#x27; behalf. all_employees is the default set of answers; ids_or_emails overrides them for the employees whose history differs. The answers are stored on the members of the policy, and its payment_link appears once nobody is left in pending_declarations.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Yasmina embedded insurance\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/yasmina/Flkq5q_nHTtKlHnv/_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/yasmina/Flkq5q_nHTtKlHnv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/yasmina/Flkq5q_nHTtKlHnv/_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/yasmina/Flkq5q_nHTtKlHnv/_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/yasmina/Flkq5q_nHTtKlHnv/_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/yasmina/Flkq5q_nHTtKlHnv/_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/yasmina/Flkq5q_nHTtKlHnv/_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/yasmina/Flkq5q_nHTtKlHnv/_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/yasmina/Flkq5q_nHTtKlHnv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Fill the declarations - Yasmina embedded insurance\">\u003cmeta data-mint-head property=\"og:description\" content=\"A company admin answers the health declaration on the employees\u0026#x27; behalf. all_employees is the default set of answers; ids_or_emails overrides them for the employees whose history differs. The answers are stored on the members of the policy, and its payment_link appears once nobody is left in pending_declarations.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Yasmina embedded insurance\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.yasmina.ai/medical-api-reference/medical-forms/fill-the-declarations\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://yasmina.mintlify.app/_mintlify/api/og/v2?division=Medical+Forms\u0026amp;title=Fill+the+declarations\u0026amp;description=A+company+admin+answers+the+health+declaration+on+the+employees%27+behalf.+%60all_employees%60+is+the+default+set+of+answers%3B+%60ids_or_emails%60+overrides+them+for+the+e\u0026amp;theme=e2077e43cb421df0ca824625\u0026amp;signature=fa2fb18129be03d22bc18bbf5573aef24d1e58d864476df218390b5d3973f625\">\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=\"Fill the declarations - Yasmina embedded insurance\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A company admin answers the health declaration on the employees\u0026#x27; behalf. all_employees is the default set of answers; ids_or_emails overrides them for the employees whose history differs. The answers are stored on the members of the policy, and its payment_link appears once nobody is left in pending_declarations.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://yasmina.mintlify.app/_mintlify/api/og/v2?division=Medical+Forms\u0026amp;title=Fill+the+declarations\u0026amp;description=A+company+admin+answers+the+health+declaration+on+the+employees%27+behalf.+%60all_employees%60+is+the+default+set+of+answers%3B+%60ids_or_emails%60+overrides+them+for+the+e\u0026amp;theme=e2077e43cb421df0ca824625\u0026amp;signature=fa2fb18129be03d22bc18bbf5573aef24d1e58d864476df218390b5d3973f625\">\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/yasmina/Flkq5q_nHTtKlHnv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Yasmina embedded insurance\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.yasmina.ai/medical-api-reference/medical-forms/fill-the-declarations\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/medical-api-reference/medical-forms/fill-the-declarations.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.yasmina.ai/#organization\",\"name\":\"Yasmina embedded insurance\",\"url\":\"https://docs.yasmina.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/yasmina/gYT_wrUNH6DJHRcX/logo/light.svg?fit=max\u0026auto=format\u0026n=gYT_wrUNH6DJHRcX\u0026q=85\u0026s=8f104780e9e2be0f5ed858abf5daf565\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.yasmina.ai#website\",\"name\":\"Yasmina embedded insurance\",\"url\":\"https://docs.yasmina.ai\",\"publisher\":{\"@id\":\"https://docs.yasmina.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.yasmina.ai/medical-api-reference/medical-forms/fill-the-declarations#webpage\",\"url\":\"https://docs.yasmina.ai/medical-api-reference/medical-forms/fill-the-declarations\",\"name\":\"Fill the declarations\",\"description\":\"A company admin answers the health declaration on the employees' behalf. all_employees is the default set of answers; ids_or_emails overrides them for the employees whose history differs. The answers are stored on the members of the policy, and its payment_link appears once nobody is left in pending_declarations.\",\"dateModified\":\"2026-10-28T11:51:10.549Z\",\"isPartOf\":{\"@id\":\"https://docs.yasmina.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.yasmina.ai/medical-api-reference/medical-forms/fill-the-declarations#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.yasmina.ai/medical-api-reference/medical-forms/fill-the-declarations#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"SME Medical APIs\",\"item\":\"https://docs.yasmina.ai/medical-api-reference/company/list-companies\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Medical Forms\",\"item\":\"https://docs.yasmina.ai/medical-api-reference/medical-forms/submit-the-declarations\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Fill the declarations\",\"item\":\"https://docs.yasmina.ai/medical-api-reference/medical-forms/fill-the-declarations\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.yasmina.ai/medical-api-reference/medical-forms/fill-the-declarations#apireference\",\"headline\":\"Fill the declarations\",\"name\":\"Fill the declarations\",\"description\":\"A company admin answers the health declaration on the employees' behalf. all_employees is the default set of answers; ids_or_emails overrides them for the employees whose history differs. The answers are stored on the members of the policy, and its payment_link appears once nobody is left in pending_declarations.\",\"url\":\"https://docs.yasmina.ai/medical-api-reference/medical-forms/fill-the-declarations\",\"mainEntityOfPage\":{\"@id\":\"https://docs.yasmina.ai/medical-api-reference/medical-forms/fill-the-declarations#webpage\"},\"dateModified\":\"2026-10-28T11:51:10.549Z\",\"publisher\":{\"@id\":\"https://docs.yasmina.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.yasmina.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Yasmina embedded insurance\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Yasmina embedded insurance","nav":{"global":null,"tabs":[{"tab":"Guide","icon":"book","pages":[{"title":"Guide","href":"/introduction"}]},{"tab":"API Reference","icon":"file-code","groups":[{"group":"Authentication","pages":[{"group":"Oauth 2.0","pages":[{"title":"Generate Token","deprecated":null,"version":null,"openapi":"/auth-api-reference/openapi.json post /oauth/token","href":"/auth-api-reference/oauth-20/generate-token"}]}]},{"group":"SME Medical APIs","pages":[{"group":"Company","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json get /companies","href":"/medical-api-reference/company/list-companies"},{"title":"Create company","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json post /companies","href":"/medical-api-reference/company/create-company"},{"title":"Cancel policy","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json post /companies/{companyId}/policy-cancellation","href":"/medical-api-reference/company/cancel-policy"}]},{"group":"Employees","pages":[{"title":"List the employees","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json get /companies/{companyId}/employees","href":"/medical-api-reference/employees/list-the-employees"},{"title":"Save the employees","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json put /companies/{companyId}/employees","href":"/medical-api-reference/employees/save-the-employees"},{"title":"Fetch the employees","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json post /companies/{companyId}/employees/fetch","href":"/medical-api-reference/employees/fetch-the-employees"}]},{"group":"Medical Forms","pages":[{"title":"Submit the declarations","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json put /companies/{companyId}/declarations","href":"/medical-api-reference/medical-forms/submit-the-declarations"},{"title":"Download the declaration form","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json get /medical-forms/download","href":"/medical-api-reference/medical-forms/download-the-declaration-form"},{"title":"Get the Medical form questions","description":"This is for showing the required medical questions and presenting it to employees","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json get /medical-forms","href":"/medical-api-reference/medical-forms/get-the-medical-form-questions"},{"title":"Fill the declarations","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json post /policies/{policyId}/declarations","href":"/medical-api-reference/medical-forms/fill-the-declarations"}]},{"group":"Quotes","pages":[{"title":"Get prices from every provider","description":"Prices the company's saved employees, at the tiers they picked, with every insurance provider at once. Every employee has to have declared their medical history first. One response, one quote per provider, each with its own `quote_price_id`, its total and price per employee, and the benefits and hospital network of each tier the employees picked. The response `id` is the `quote_request_id`. A quote prices the employees as they stood when it was asked for.","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json post /quote-requests","href":"/medical-api-reference/quotes/get-prices-from-every-provider"},{"title":"Read a quote request","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json get /quote-requests/{quoteRequestId}","href":"/medical-api-reference/quotes/read-a-quote-request"}]},{"group":"Policies","pages":[{"title":"List policies","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json get /policies","href":"/medical-api-reference/policies/list-policies"},{"title":"Issue the policy","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json post /policies","href":"/medical-api-reference/policies/issue-the-policy"},{"title":"Read the policy","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json get /policies/{policyId}","href":"/medical-api-reference/policies/read-the-policy"},{"title":"Cancel a policy","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json post /policies/{policyId}/deletion","href":"/medical-api-reference/policies/cancel-a-policy"}]},{"group":"Products","pages":[{"title":"List a network's facilities","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json get /products/networks","href":"/medical-api-reference/products/list-a-networks-facilities"},{"title":"List categories","deprecated":null,"version":null,"openapi":"/medical-api-reference/openapi.json get /products/categories","href":"/medical-api-reference/products/list-categories"}]}]},{"group":"Motor Insurance APIs (Multiple Providers)","pages":[{"group":"Vehicle lookups","pages":[{"title":"List vehicle makers","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json get /vehicle-makers","href":"/car-api-reference/vehicle-lookups/list-vehicle-makers"},{"title":"List vehicle models","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json get /vehicle-models","href":"/car-api-reference/vehicle-lookups/list-vehicle-models"},{"title":"List vehicle body types","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json get /vehicle-body-types","href":"/car-api-reference/vehicle-lookups/list-vehicle-body-types"}]},{"group":"Quotes","pages":[{"title":"Show quote","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json get /quote-requests/{id}","href":"/car-api-reference/quotes/show-quote"},{"title":"Delete quote","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json delete /quote-requests/{id}","href":"/car-api-reference/quotes/delete-quote"},{"title":"List quotes","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json get /quote-requests","href":"/car-api-reference/quotes/list-quotes"},{"title":"Request quotes","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json post /quote-requests","href":"/car-api-reference/quotes/request-quotes"},{"title":"Guideline texts","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json get /guideline-texts","href":"/car-api-reference/quotes/guideline-texts"},{"title":"Upload vehicle photos","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json post /quote-requests/{id}/attachments","href":"/car-api-reference/quotes/upload-vehicle-photos"}]},{"group":"Embed sessions","pages":[{"title":"Create embed session","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json post /embed-sessions","href":"/car-api-reference/embed-sessions/create-embed-session"},{"title":"Show embed session","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json get /embed-sessions/{id}","href":"/car-api-reference/embed-sessions/show-embed-session"},{"title":"Store vehicle photos for an embed session","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json post /embed-sessions/{id}/photos","href":"/car-api-reference/embed-sessions/store-vehicle-photos-for-an-embed-session"}]},{"group":"Policies","pages":[{"title":"Show policy","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json get /policies/{carPolicy}","href":"/car-api-reference/policies/show-policy"},{"title":"List policies","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json get /policies","href":"/car-api-reference/policies/list-policies"},{"title":"Issue policy","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json post /policies","href":"/car-api-reference/policies/issue-policy"}]},{"group":"OTPs","pages":[{"title":"Request OTP for quote verification","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json post /quote-otp","href":"/car-api-reference/otps/request-otp-for-quote-verification"},{"title":"Request OTP for Issuing Policy","deprecated":null,"version":null,"openapi":"/car-api-reference/openapi.json post /issue-otp","href":"/car-api-reference/otps/request-otp-for-issuing-policy"}]}]},{"group":"Property Insurance APIs","pages":[{"group":"Prices","pages":[{"title":"List prices","deprecated":null,"version":null,"openapi":"/property-api-reference/openapi.json get /prices","href":"/property-api-reference/prices/list-prices"}]},{"group":"Policies","pages":[{"title":"Show policy","deprecated":null,"version":null,"openapi":"/property-api-reference/openapi.json get /policies/{propertyPolicy}","href":"/property-api-reference/policies/show-policy"},{"title":"List policies","deprecated":null,"version":null,"openapi":"/property-api-reference/openapi.json get /policies","href":"/property-api-reference/policies/list-policies"},{"title":"Issue policy","deprecated":null,"version":null,"openapi":"/property-api-reference/openapi.json post /policies","href":"/property-api-reference/policies/issue-policy"},{"title":"Cancellation status","deprecated":null,"version":null,"openapi":"/property-api-reference/openapi.json get /policies/{propertyPolicy}/cancellation-status","href":"/property-api-reference/policies/cancellation-status"},{"title":"Upload documents","deprecated":null,"version":null,"openapi":"/property-api-reference/openapi.json post /policies/{propertyPolicy}/documents","href":"/property-api-reference/policies/upload-documents"}]},{"group":"Claims","pages":[{"title":"Issue claim","deprecated":null,"version":null,"openapi":"/property-api-reference/openapi.json post /policies/{propertyPolicy}/claims","href":"/property-api-reference/claims/issue-claim"}]},{"group":"Addresses","pages":[{"title":"Get full address from short address code","deprecated":null,"version":null,"openapi":"/property-api-reference/openapi.json get /address-from-short","href":"/property-api-reference/addresses/get-full-address-from-short-address-code"}]}]},{"group":"Travel Insurance APIs","pages":[{"group":"Quotes","pages":[{"title":"Request Quote","deprecated":null,"version":null,"openapi":"/yasmina-schengen-travel-insurance/openapi.json post /quotes","href":"/yasmina-schengen-travel-insurance/quotes/request-quote"}]},{"group":"Policies","pages":[{"title":"Show policy","deprecated":null,"version":null,"openapi":"/yasmina-schengen-travel-insurance/openapi.json get /policies/{travelPolicy}","href":"/yasmina-schengen-travel-insurance/policies/show-policy"},{"title":"List policies","deprecated":null,"version":null,"openapi":"/yasmina-schengen-travel-insurance/openapi.json get /policies","href":"/yasmina-schengen-travel-insurance/policies/list-policies"},{"title":"Purchase","deprecated":null,"version":null,"openapi":"/yasmina-schengen-travel-insurance/openapi.json post /policies","href":"/yasmina-schengen-travel-insurance/policies/purchase"}]}]},{"group":"Life (S\u0026P) Insurance APIs","pages":[{"group":"Offers","pages":[{"title":"Life S\u0026P Products","deprecated":null,"version":null,"openapi":"/life-snp/openapi.json post /offers","href":"/life-snp/offers/life-s\u0026p-products"}]},{"group":"Policies","pages":[{"title":"List policies","deprecated":null,"version":null,"openapi":"/life-snp/openapi.json get /policies","href":"/life-snp/policies/list-policies"},{"title":"Issue policy","deprecated":null,"version":null,"openapi":"/life-snp/openapi.json post /policies","href":"/life-snp/policies/issue-policy"},{"title":"Cancel policy","deprecated":null,"version":null,"openapi":"/life-snp/openapi.json post /policies/{lifePolicy}/cancellation","href":"/life-snp/policies/cancel-policy"}]},{"group":"Claims","pages":[{"title":"Submit claim","deprecated":null,"version":null,"openapi":"/life-snp/openapi.json post /policies/{policyId}/claims","href":"/life-snp/claims/submit-claim"}]}]},{"group":"TPL Motor Insurance - Flat Fee APIs V2","pages":[{"group":"Policies","pages":[{"title":"List policies","deprecated":null,"version":null,"openapi":"/cartpl-api-reference-v2/openapi.json get /v2/car/policies","href":"/cartpl-api-reference-v2/policies/list-policies"},{"title":"Issue policy","deprecated":null,"version":null,"openapi":"/cartpl-api-reference-v2/openapi.json post /v2/car/policies","href":"/cartpl-api-reference-v2/policies/issue-policy"},{"title":"Cancel policy","deprecated":null,"version":null,"openapi":"/cartpl-api-reference-v2/openapi.json post /v2/car/policies/{carPolicy}/cancellation","href":"/cartpl-api-reference-v2/policies/cancel-policy"},{"title":"Cancel policy by VIN","deprecated":null,"version":null,"openapi":"/cartpl-api-reference-v2/openapi.json post /v2/clients/policies/cancellation","href":"/cartpl-api-reference-v2/policies/cancel-policy-by-vin"}]}]},{"group":"Horse Insurance APIs","pages":[{"group":"Policies","pages":[{"title":"Create a horse policy","deprecated":null,"version":null,"openapi":"/horse-api-reference/openapi.json post /policies","href":"/horse-api-reference/policies/create-a-horse-policy"},{"title":"Cancel policy","deprecated":null,"version":null,"openapi":"/horse-api-reference/openapi.json post /policies/{horsePolicy}/cancellation","href":"/horse-api-reference/policies/cancel-policy"}]},{"group":"Claims","pages":[{"title":"Issue claim","deprecated":null,"version":null,"openapi":"/horse-api-reference/openapi.json post /policies/{policyId}/claims","href":"/horse-api-reference/claims/issue-claim"}]}]},{"group":"Payment","pages":[{"group":"Payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/payments-api-reference/openapi.json get /payments","href":"/payments-api-reference/payments/list-payments"}]}]}]},{"tab":"SDKs","icon":"brackets-curly","pages":[{"title":"SDKs","href":"/sdks/ios"}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Fill the declarations - Yasmina embedded insurance","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}