Sigorta
Referans
Sigorta Tipleri ve Şemalar

Sigorta Tipleri ve Şemalar

⚠️

Bu sayfa sigorta tiplerinin şemasını anlatır; isteğin kendisi Teklif sayfasındadır.

Sigorta tipi, Lunixi'nin sağlayıcıdan bağımsız sigorta kodudur. Teklif ve sipariş isteklerinde hangi sigortayı istediğinizi bu kodla belirtirsiniz. Hangi sağlayıcı ürününün kullanılacağını isteğiniz değil, sağlayıcı bağlantılarınız belirler.

  • Yayınlanmış bir tip kodu değişmez ve silinmez. Yeni tipler kataloğa eklenir.
  • Alan adları ve biçimler hangi sağlayıcıyla çalışırsanız çalışın aynıdır. Sağlayıcıya özgü alan adı kabul edilmez.
  • Primi kimin tahsil ettiği tipe değil, bağlantınızdaki ürüne bağlıdır. Teklif seçeneğindeki premiumCollectedBy alanına bakın; değer PROVIDER ise primi sağlayıcınız tahsil eder: Sağlayıcı Tahsilatı.

Tip kataloğu

TipKoruduğuSepet kalemi türüTip nesnesiDurum
TICKET_CANCELLATIONOtobüs, uçak ve tren bileti iptaliTICKETtickets (dizi)Etkin, şema sürüm 1
HOTEL_CANCELLATIONOtel rezervasyonu iptaliHOTELstay (nesne)Etkin, şema sürüm 1
DEVICE_INSURANCECep telefonu sigortasıDEVICEdevice (nesne)Etkin, şema sürüm 1
DEVICE_PROTECTIONCep telefonu onarım ve koruma paketiDEVICEdevice (nesne)Etkin, şema sürüm 1
EXTENDED_WARRANTYElektronik ve beyaz eşya için uzatılmış garantiELECTRONICSproduct (nesne)Etkin, şema sürüm 1
ROADSIDE_ASSISTANCEAraç yol yardımıVEHICLEvehicle (nesne)Etkin, şema sürüm 1
TRAVEL_HEALTHYurt içi ve yurt dışı seyahat sağlık sigortasıTRAVELtrip (nesne)Etkin, şema sürüm 1
MUSICAL_INSTRUMENT_PROTECTIONMüzik aleti onarım ve koruma paketiMUSICAL_INSTRUMENTinstrument (nesne)Etkin, şema sürüm 1
EVENT_ACCIDENTEtkinlik katılımcısı için günlük ferdi kazaEVENTevent (nesne)Etkin, şema sürüm 1
MICROMOBILITY_ACCIDENTKiralık scooter sürücüsü için günlük ferdi kazaMICROMOBILITYrental (nesne)Etkin, şema sürüm 1
PERSONAL_ACCIDENTYıllık ferdi kazaYok: sepet kalemi olmadan satılıraccident (nesne)Etkin, şema sürüm 1
MEDICAL_COMPLICATIONSağlık turizminde tıbbi işlem komplikasyonuHEALTHprocedure (nesne)Etkin, şema sürüm 1
PET_HEALTHKedi ve köpek için sağlık sigortasıPET; sepet kalemi olmadan da satılırpet (nesne)Etkin, şema sürüm 1
VEHICLE_TAG_PROTECTIONTaşıt tanıma cihazı (UTTS) korumasıVEHICLE; sepet kalemi olmadan da satılırvehicle (nesne)Etkin, şema sürüm 1
MOTOR_GREEN_CARDYeşil Kart: aracın yurt dışındaki sorumluluk sigortasıVEHICLE ya da TRAVEL; sepet kalemi olmadan da satılırvehicle (nesne)Etkin, şema sürüm 1
INBOUND_TRAVEL_HEALTHTürkiye'ye gelen yabancı ziyaretçi için sağlık sigortasıTRAVEL; sepet kalemi olmadan da satılırtrip (nesne)Etkin, şema sürüm 1
FOREIGN_RESIDENT_HEALTHTürkiye'de ikamet eden yabancı için sağlık sigortasıYok: sepet kalemi olmadan satılırresidence (nesne)Etkin, şema sürüm 1
ABROAD_STAY_HEALTHYurt dışında öğrenim ya da çalışma süresince sağlık sigortasıEDUCATION ya da TRAVEL; sepet kalemi olmadan da satılırabroadStay (nesne)Etkin, şema sürüm 1
MOTOR_THIRD_PARTY_LIABILITYZorunlu trafik sigortasıVEHICLE; sepet kalemi olmadan da satılır; talep de açılırvehicle (nesne)Etkin, şema sürüm 1; talep şeması sürüm 1
MOTOR_COMPREHENSIVEKaskoVEHICLE; sepet kalemi olmadan da satılır; talep de açılırvehicle (nesne)Etkin, şema sürüm 1; talep şeması sürüm 1
MOTOR_EXCESS_LIABILITYAraç için ihtiyari mali mesuliyet (İMM) sigortasıVEHICLE; sepet kalemi olmadan da satılırvehicle (nesne)Etkin, şema sürüm 1
COMPULSORY_EARTHQUAKEZorunlu deprem sigortası (DASK)HOME; sepet kalemi olmadan da satılırproperty (nesne)Etkin, şema sürüm 1
HOME_INSURANCEKonut sigortasıHOME; sepet kalemi olmadan da satılırproperty (nesne)Etkin, şema sürüm 1
SUPPLEMENTARY_HEALTHTamamlayıcı sağlık sigortasıYok: sepet kalemi olmadan satılırhealth (nesne)Etkin, şema sürüm 1
CARGO_TRANSITKarayolu yük taşıma (nakliyat) sigortasıYok: yalnızca talepshipment (nesne)Etkin, talep şeması sürüm 1

Sepet kalemi türü, kalemin insuranceCategory değeridir; tipin hangi sepet kalemine sunulacağı bu alandan çözülür (bkz. Sepet Kalemleri). DEVICE türünde iki ayrı tip vardır: cihaz sigortası ve onarım paketi teminatı, girdisi ve belgesi farklı iki üründür.

Sepet kalemi türü olmayan tip bir sepet kalemine bağlanmaz; yalnızca API yolunda, sepet kalemi olmadan satılır: Sepet Kalemi Olmadan Satış. "Sepet kalemi olmadan da satılır" yazan tipler iki yolla satılır: sepet kalemiyle ve API yolunda sepet kalemi olmadan. Diğer tipler yalnızca bir sepet kalemiyle sunulur.

tickets dışındaki tip nesneleri tekildir: bir teklif tek bir konaklamayı, cihazı, ürünü, aracı, seyahati, müzik aletini, etkinlik biletini, kiralamayı, tıbbi işlemi, hayvanı, dönemi ya da konutu korur; sepete bağlı teklifte bu tek bir sepet kalemidir. PERSONAL_ACCIDENT, FOREIGN_RESIDENT_HEALTH ve SUPPLEMENTARY_HEALTH teklifi tek bir kişiyi korur. INBOUND_TRAVEL_HEALTH ve ABROAD_STAY_HEALTH teklifinde bütün sigortalılar aynı poliçededir.

Talep tipleri ("Yalnızca talep") teklif vermez. Bu tiplerde teklif, tahsilat ve poliçe yoktur; alıcının bilgileri bağlantınızdaki sağlayıcıya talep olarak iletilir: Talep. Talep tipi için teklif isteği 412 insurance.type.not_available alır. Talep tiplerinin alanları talep şemasındadır.

"Talep de açılır" yazan tipler hem teklif verir hem talep alır. Teklif isteği tipin şemasıyla, talep isteği tipin talep şemasıyla gönderilir. Teklif bağlantılarınızdaki teklif veren ürüne, talep talep alan ürüne gider; ikisi ayrı ürünlerdir.

Şema sürümü (schemaVersion)

Her tipin alanları bir şemayla tanımlanır ve şema tip başına sürümlenir (schemaVersion).

  • Yayınlanmış bir şema sürümü değişmez: alan kümesi ve zorunlulukları sonradan sıkılaştırılmaz.
  • Kırıcı bir değişiklik yeni bir schemaVersion olarak yayınlanır; eski sürüm yanında durmaya devam eder.
  • Sağlayıcının kendi ürününü güncellemesi Lunixi şemasını değiştirmez.

Sepet kaleminde ön veri

Sepet kalemiyle satılan her tipte, bu sayfadaki alanları teklif isteğinden önce sepet kaleminde de verebilirsiniz:

  • Kişisel olmayan alanların bir kısmı kalemin insuranceContext'inden doldurulur. Hangi anahtarın hangi tipte hangi alanı doldurduğu: Sepet Kalemleri › Ön doldurma.
  • Kişi alanları ve tip nesnesinin diğer alanları kalemin insuranceData'sıyla verilir. Alan adları ve biçimler bu sayfadakiyle aynıdır; tip nesnesi kalem için tek nesnedir (tickets dahil) ve basketItemId taşımaz: Sepet Kalemleri › Sigorta ön verisi.
  • Sepette verdiğiniz alanlar teklifte zorunluluk için sayılır. Teklif isteğinde yalnızca eksikleri gönderirsiniz: Teklif › Ön veriyle teklif.

Yalnızca sepet kalemi olmadan satılan tiplerin ve talep tiplerinin alanları istekte gönderilir.

Aşamalar

Bir alanın zorunlu olup olmadığı, isteğin hangi aşamada olduğuna bağlıdır:

AşamaNe zamanZorunlu alanlar
QUOTETeklif alırkenFiyat için gereken alanlar
POLICYSipariş oluştururken ve poliçe kesilirkenQUOTE aşamasının zorunlu alanları ve ek olarak poliçe için gerekenler
  • Teklif bir ödemenin sepetine bağlıysa (ödeme kimliğiyle ya da Checkout Form'da), tip nesnesinde basketItemId de zorunludur; tickets gibi dizi olan tip nesnesinde her ögede.
  • Sepet kalemi olmadan alınan teklifte basketItemId gönderilmez; gönderilirse istek reddedilir.
  • POLICY aşamasının alanlarını da teklif isteğinde gönderin. Sipariş ve poliçe isteklerinde ayrıca alan gönderilmez; poliçe teklifin bilgileriyle kesilir. Bkz. Teklif.

Ürüne göre ek zorunlu alanlar

Bir tipin şeması, o tipi sunan bütün ürünlerin alanlarını kapsar. Bağlantılarınızdaki bir ürün, şemada isteğe bağlı olan bir alanı zorunlu tutabilir ya da bir alanı şemadakinden daha erken bir aşamada isteyebilir.

  • Bu alanlar Uygunluk yanıtının fields dizisinde requiredBy ile işaretlidir.
  • Ürünün teklif aşamasında istediği bir alan eksikse yalnızca o ürünün seçeneği elenir; diğer seçenekler döner: Teklif › Elenen seçenekler.
  • Ürünün poliçe aşamasında istediği bir alan eksikse sipariş 422 insurance.validation.invalid ile reddedilir.

Kişi alanları (policyholder, insured[])

Kişi alanları bütün tiplerde aynıdır. Tipten tipe değişen, hangi kimlik türlerinin kabul edildiği, kaç sigortalı gönderilebildiği ve hangi alanın hangi aşamada zorunlu olduğudur. Bunlar her tipin bölümündeki kişi tablosundadır.

AlanTipKural
identityTypeenumKimlik türü: TCKN, PASSPORT, VKN; tipin kabul ettikleriyle sınırlıdır. Gönderilirse identityNumber da zorunludur.
identityNumberstringKimlik numarası; identityType'a göre doğrulanır. Gönderilirse identityType da zorunludur.
firstNamestringAd. Metin, en fazla 100 karakter.
lastNamestringSoyad. Metin, en fazla 100 karakter.
birthDatestringDoğum tarihi, YYYY-MM-DD; gelecekte olamaz. MOTOR_THIRD_PARTY_LIABILITY şemasında yalnızca gerçek kişide (TCKN, PASSPORT) geçerlidir; identityType: VKN ile gönderilirse istek reddedilir.
genderenumCinsiyet: MALE, FEMALE. Yalnızca DEVICE_INSURANCE, TRAVEL_HEALTH, MUSICAL_INSTRUMENT_PROTECTION, MEDICAL_COMPLICATION, INBOUND_TRAVEL_HEALTH ve FOREIGN_RESIDENT_HEALTH şemalarında vardır; diğer tiplerde gönderilirse istek reddedilir.
birthPlacestringDoğum yeri. Metin, en fazla 100 karakter. Yalnızca MEDICAL_COMPLICATION, INBOUND_TRAVEL_HEALTH ve FOREIGN_RESIDENT_HEALTH şemalarında vardır; diğer tiplerde gönderilirse istek reddedilir.
fatherNamestringBaba adı. Metin, en fazla 100 karakter. Yalnızca FOREIGN_RESIDENT_HEALTH şemasında vardır; diğer tiplerde gönderilirse istek reddedilir.
relationshipenumSigortalının sigorta ettirene yakınlığı: SELF (kendisi), SPOUSE (eşi), CHILD (çocuğu). Yalnızca ABROAD_STAY_HEALTH şemasında ve yalnızca insured[] ögelerinde vardır; başka yerde gönderilirse istek reddedilir.
nationalityCountryCodestringUyruk, ISO 3166-1 alpha-2. Yalnızca EVENT_ACCIDENT, MICROMOBILITY_ACCIDENT, INBOUND_TRAVEL_HEALTH ve FOREIGN_RESIDENT_HEALTH şemalarında vardır; diğer tiplerde gönderilirse istek reddedilir.
companyNamestringTicari unvan. Metin, en fazla 200 karakter. Yalnızca MUSICAL_INSTRUMENT_PROTECTION ve MOTOR_THIRD_PARTY_LIABILITY şemalarında ve yalnızca identityType: VKN iken geçerlidir; başka kimlik türüyle ya da başka tipte gönderilirse istek reddedilir.
heightCmintegerSağlık beyanı: boy, santimetre; 30-250. Yalnızca SUPPLEMENTARY_HEALTH şemasında ve yalnızca insured[] ögelerinde vardır; başka yerde gönderilirse istek reddedilir.
weightKgintegerSağlık beyanı: kilo, kilogram; 1-350. Yalnızca SUPPLEMENTARY_HEALTH şemasında ve yalnızca insured[] ögelerinde vardır.
pregnancyStatusenumSağlık beyanı: hamilelik durumu, PREGNANT. Yalnızca SUPPLEMENTARY_HEALTH şemasında, yalnızca insured[] ögelerinde ve yalnızca hamilelik teminatı istenen teklifte geçerlidir: SUPPLEMENTARY_HEALTH.
emailstringE-posta adresi.
phonestringTelefon, E.164.
addressnesneAdres; alanları aşağıda.

address:

AlanTipKural
countryCodestringÜlke, ISO 3166-1 alpha-2.
cityCodestringİl plaka kodu, 01-81.
districtCodestringİlçe, Lunixi referans kodu (DISTRICT, ilin altında).
linestringAçık adres. Metin, en fazla 500 karakter.

Sağlık beyanı (heightCm, weightKg, pregnancyStatus) özel nitelikli kişisel veridir.

Kişi tablolarında "Adres (il, ilçe, satır)" yazan aşamada address ile birlikte cityCode, districtCode ve line zorunludur. "Adres (ülke, il, ilçe, satır)" yazan aşamada countryCode de zorunludur; "adres satırı" yazan aşamada address ile birlikte yalnızca line zorunludur. Tabloda adı geçmeyen kişi alanları isteğe bağlıdır.

Talep şemalarında policyholder yalnızca kimlik türü ve numarası, doğum tarihi, e-posta ve telefon taşır; diğer kişi alanları gönderilirse istek reddedilir. Bkz. Talep şemaları.

Biçimlerin ayrıntısı: Veri Biçimleri.

Referans kodları

Marka, model, araç tipi, kullanım şekli, sorumluluk limiti, ürün kategorisi, meslek, tıbbi işlem, evcil hayvan ırkı, konut türü, banka ve ilçe gibi alanlar Lunixi referans kodu taşır. Sağlayıcının kimlikleri kabul edilmez. Geçerli kodları şu uçtan alın:

GET /api/v1/insurance/reference/{kind}

kindVeriparentCode
COUNTRYÜlke (ISO 3166-1 alpha-2)Gönderilmez
CITYİl (plaka kodu)Gönderilmez
DISTRICTİlçeZorunlu: il kodu
DEVICE_BRANDCep telefonu markasıGönderilmez
DEVICE_MODELCep telefonu modeliZorunlu: DEVICE_BRAND kodu
VEHICLE_BRANDAraç markasıGönderilmez
VEHICLE_MODELAraç modeliZorunlu: VEHICLE_BRAND kodu
VEHICLE_TYPEAraç tipi (araç tarzı ya da sınıfı)Gönderilmez
PRODUCT_CATEGORYÜrün kategorisi (elektronik ve beyaz eşya, müzik aleti)Gönderilmez
OCCUPATIONMeslekGönderilmez
MEDICAL_PROCEDURE_COVERTıbbi işlem ve teminat limitiGönderilmez
PET_BREEDEvcil hayvan ırkıZorunlu: hayvanın türü, CAT ya da DOG
VEHICLE_USAGEAraç kullanım şekliGönderilmez
LIABILITY_LIMITAraç başı sorumluluk limitiGönderilmez
DWELLING_TYPEKonut türüGönderilmez
DWELLING_FLOORBağımsız bölümün bulunduğu katGönderilmez
BANKBankaGönderilmez
BANK_BRANCHBanka şubesiZorunlu: BANK kodu
FINANCE_INSTITUTIONFinans kurumuGönderilmez
ADDRESS_VILLAGEAdres zinciri: belde ya da köyZorunlu: DISTRICT kodu
ADDRESS_NEIGHBOURHOODAdres zinciri: mahalleZorunlu: ADDRESS_VILLAGE kodu
ADDRESS_STREETAdres zinciri: cadde ya da sokakZorunlu: ADDRESS_NEIGHBOURHOOD kodu
ADDRESS_BUILDINGAdres zinciri: binaZorunlu: ADDRESS_STREET kodu; ayrıca outerDoorNumber
ADDRESS_UNITAdres zinciri: bağımsız bölüm (daire); kodu UAVT adres kodudurZorunlu: ADDRESS_BUILDING kodu
Sorgu parametresiTipAçıklama
parentCodestringÜst kod. Tabloda zorunlu olan türlerde gönderin.
limitintegerSayfa başına kayıt, 1-100. Varsayılan 25.
cursorstringÖnceki yanıttaki pageInfo.nextCursor. İlk sayfada gönderilmez.
vehicleTypeCodestringYalnızca VEHICLE_BRAND ve VEHICLE_MODEL: araç tipi kodu (VEHICLE_TYPE). modelYear ile birlikte gönderilir; bkz. Araç tipine ve yılına göre liste.
modelYearintegerYalnızca VEHICLE_BRAND ve VEHICLE_MODEL: model yılı. vehicleTypeCode ile birlikte gönderilir.
outerDoorNumberstringYalnızca ADDRESS_BUILDING ve orada zorunlu: binanın dış kapı numarası; bkz. UAVT adres zinciri.

Yanıtta kodlar data.items dizisindedir; her öge code, label (dil koduna göre görünen adlar, ör. tr-TR) ve parentCode taşır. Sayfalama bilgisi pageInfo alanındadır. Liste yalnızca kullanımdaki kodları döner ve bütün merchant'lar için aynıdır; araç tipine ve yılına göre süzülen marka ve model listesi ile adres zinciri bunun dışındadır.

  • Kodu olduğu gibi gönderin; görünen adı (label) istekte kullanmayın.
  • Biçimi doğru ama tanınmayan ya da bağlantınızın sağlayıcısında karşılığı olmayan bir kod teklifte 422 insurance.reference.unknown ile reddedilir (Hata Kodları). Tahmini ya da boş değer göndermeyin.
  • Ülke kodu (COUNTRY) uyruk ve gidilecek ülke alanlarında da kullanılır. Bir ülkenin bağlantınızın sağlayıcısında karşılığı yoksa o alan da 422 insurance.reference.unknown alır.

Araç tipine ve yılına göre liste

VEHICLE_BRAND ve VEHICLE_MODEL listelerini araç tipine ve model yılına göre süzebilirsiniz: GET /api/v1/insurance/reference/VEHICLE_BRAND?vehicleTypeCode=<araç tipi kodu>&modelYear=<yıl>. Model listesinde markayı parentCode ile gönderin.

  • Süzülen liste, bağlantılarınızdaki sağlayıcılardan istek anında okunur. Yalnızca bağlantılarınızın sunduğu ve Lunixi kodu olan marka ve modeller döner; bu yüzden liste hesabınıza özgüdür ve zamanla değişebilir.
  • vehicleTypeCode ve modelYear birlikte gönderilir. Biri eksikse istek 422 insurance.validation.invalid (reason: required) alır. İkisi de gönderilmezse kullanımdaki bütün kodlar döner.
  • Model yılı 1950 ile içinde bulunulan yılın bir sonrası arasında olmalıdır; değilse reason: invalid_model_year.
  • Bu parametreler başka bir türde gönderilirse reason: not_applicable döner.
  • Bağlantılarınızda süzülmüş liste sunan bir sağlayıcı yoksa 422 insurance.validation.invalid (field: kind, reason: live_reference_unavailable) döner. Araç tipi kodunun bağlantınızın sağlayıcısında karşılığı yoksa 422 insurance.reference.unknown döner.

UAVT adres zinciri

Konut tiplerinde (COMPULSORY_EARTHQUAKE, HOME_INSURANCE) konutun adresi tek bir alanla gönderilir: property.uavtAddressCode, Ulusal Adres Veri Tabanı'ndaki (UAVT) bağımsız bölümün adres kodu. UAVT adres kodu ulusal bir koddur. Alıcınız kodu biliyorsa doğrudan gönderebilirsiniz; bilmiyorsa kodu adres zincirini adım adım dolaşarak bulun. Her adımda alıcıya listeyi gösterin, seçtiği ögenin code değerini bir sonraki adımın parentCode'u olarak gönderin:

AdımİstekSeçilen kod
1. İlGET /api/v1/insurance/reference/CITYİl plaka kodu
2. İlçeGET /api/v1/insurance/reference/DISTRICT?parentCode=<il kodu>İlçe kodu
3. Belde ya da köyGET /api/v1/insurance/reference/ADDRESS_VILLAGE?parentCode=<ilçe kodu>Belde ya da köy kodu
4. MahalleGET /api/v1/insurance/reference/ADDRESS_NEIGHBOURHOOD?parentCode=<belde ya da köy kodu>Mahalle kodu
5. Cadde ya da sokakGET /api/v1/insurance/reference/ADDRESS_STREET?parentCode=<mahalle kodu>Cadde ya da sokak kodu
6. BinaGET /api/v1/insurance/reference/ADDRESS_BUILDING?parentCode=<sokak kodu>&outerDoorNumber=<dış kapı numarası>Bina kodu
7. Bağımsız bölümGET /api/v1/insurance/reference/ADDRESS_UNIT?parentCode=<bina kodu>UAVT adres kodu

Son adımda seçilen ögenin code değeri UAVT adres kodudur; teklif isteğinde property.uavtAddressCode olarak gönderin. Zincirin diğer kodları teklife gönderilmez.

  • Belde ya da köy adımından başlayarak listeler bağlantılarınızdaki sağlayıcılardan istek anında okunur ve kalıcı olarak saklanmaz. Bağlantılarınızda adres zinciri sunan bir sağlayıcı yoksa istek 422 insurance.validation.invalid (field: kind, reason: live_reference_unavailable) alır.
  • Zincirin kodları ulusal adres kodlarıdır. Belde ya da köy, mahalle, cadde ya da sokak ve bina kodu 1-12 hanedir; bağımsız bölümün kodu (UAVT adres kodu) 10 hanedir. Kodlar metindir; baştaki sıfırlar korunur. Bu adımlarda biçimi bozuk bir üst kod parentCode alan yoluyla reason: invalid_reference_code alır.
  • Belde ya da köy adımında ilçe kodunun bağlantınızın sağlayıcısında karşılığı yoksa istek parentCode alan yoluyla 422 insurance.reference.unknown alır.
  • Bina listesi sokak koduyla birlikte binanın dış kapı numarasını (outerDoorNumber) ister. Dış kapı numarası rakamla başlar; rakam, harf, /, -, . ve boşluk içerebilir; en fazla 16 karakterdir (ör. 12, 12A, 12/1). Gönderilmezse reason: required, biçimi bozuksa reason: invalid_outer_door_number döner. Başka bir türde gönderilirse reason: not_applicable döner.
  • Adres listelerinde label resmî yer adıdır; tr-TR ve en-US aynı metni taşır. Sayfalama diğer referans listeleriyle aynıdır (limit, cursor).
  • Adres kişisel veridir. Zincirin kodlarını ve UAVT adres kodunu sepet kaleminin insuranceContext alanında göndermeyin.

Teklif sırasında UAVT adres kodu doğrulanır. Biçimi bozuk kod property.uavtAddressCode alan yoluyla 422 insurance.validation.invalid (reason: invalid_uavt_address_code) alır. Biçimi doğru ama UAVT'de bulunmayan kod da aynı alan yoluyla reason: unknown_uavt_address_code alır ve teklif isteği sağlayıcıya gönderilmez.

TICKET_CANCELLATION: şema sürüm 1

Otobüs, uçak ve tren biletinin iptaline karşı sigorta. Sepet kaleminde insuranceCategory: TICKET ile çözülür.

İstek gövdesindeki tipe ait alanlar üç köktür: policyholder, insured ve tip nesnesi tickets.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türleri: TCKN, PASSPORT, VKN.
insureddiziQUOTESigortalılar; 1-10 öge. Kabul edilen kimlik türleri: TCKN, PASSPORT.
ticketsdiziQUOTESigortalanan biletler; 1-10 öge. basketItemId biletler arasında tekildir: bir sepet kalemi tek bir bilettir.

tickets[]

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteBiletin bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; baştaki ve sondaki boşluk kabul edilmez, değer olduğu gibi saklanır.
transportModeenumQUOTEBUS, FLIGHT, TRAIN
carrierstringQUOTETaşıyıcı firma. Metin, en fazla 100 karakter.
priceAmountintegerQUOTEBilet tutarı, kuruş; en az 1.
departureAtstringQUOTEKalkış zamanı. ISO 8601, saat dilimi zorunlu.
originCitystringQUOTEKalkış şehri. Metin, en fazla 100 karakter.
destinationCitystringQUOTEVarış şehri. Metin, en fazla 100 karakter.
originAirportCodestringQUOTE, yalnız FLIGHTKalkış havalimanı, IATA üç harf.
destinationAirportCodestringQUOTE, yalnız FLIGHTVarış havalimanı, IATA üç harf.
isPromotionalbooleanHayırPromosyonlu bilet. Gönderilmezse bilet promosyonsuz sayılır.
pnrstringPOLICYRezervasyon kodu. Metin, en fazla 32 karakter.
ticketNumberstringPOLICYBilet numarası. Metin, en fazla 64 karakter.
flightNumberstringPOLICY, yalnız FLIGHTUçuş numarası.

"Yalnız FLIGHT" işaretli alanlar yalnızca transportMode: FLIGHT olan bilette geçerlidir ve zorunluluk da yalnızca o zaman uygulanır. Başka bir taşıma türünde gönderilirlerse istek reddedilir.

Kişiler

KişiQUOTEPOLICY
insured[]Kimlik türü ve numarası, doğum tarihiE-posta, telefon
policyholder——

policyholder içinde hiçbir kişi alanı tek başına zorunlu değildir; yalnızca identityType ile identityNumber birlikte gönderilir.

Pasaportla sigortalanan kişi

Yabancı uyruklu yolcuyu TC kimlik numarası yerine pasaportla (identityType: PASSPORT) sigortalayabilirsiniz. Pasaportlu kişide şu alanlar da gerekir:

AlanKişiZorunluKural
firstName, lastNameinsured[], policyholderQUOTEAd ve soyad. Her kimlik türünde gönderilebilir; yalnızca pasaportta zorunludur.
genderinsured[], policyholderQUOTEMALE, FEMALE. Yalnızca pasaportta geçerlidir.
residenceCountryCodeinsured[]QUOTEİkamet edilen ülke, ISO 3166-1 iki harf (TR, DE). Yalnızca pasaportta geçerlidir.

gender ve residenceCountryCode TC kimlik numarasıyla gönderilirse alan yoluyla not_applicable alır. Bu alanlar sepet kaleminde insuranceData ile de verilebilir: Sepet Kalemleri › Sigorta ön verisi.

Örnek istek: Teklif.

HOTEL_CANCELLATION: şema sürüm 1

Otel rezervasyonunun iptaline karşı sigorta. Sepet kaleminde insuranceCategory: HOTEL ile çözülür. Tip nesnesi stay tek bir konaklamadır.

AlanTipZorunluKural
policyholdernesnePOLICYSigorta ettiren. Kabul edilen kimlik türleri: TCKN, PASSPORT, VKN.
insureddiziQUOTESigortalılar; 1-10 öge. Kabul edilen kimlik türleri: TCKN, PASSPORT.
staynesneQUOTESigortalanan konaklama.

stay

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteKonaklamanın bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır.
hotelNamestringQUOTEOtelin adı. Metin, en fazla 200 karakter.
checkInDatestringQUOTEGiriş günü, YYYY-MM-DD.
checkOutDatestringQUOTEÇıkış günü, YYYY-MM-DD; giriş gününden sonra olmalıdır.
guestCountintegerQUOTEKişi sayısı, 1-20.
reservationAmountintegerQUOTERezervasyon tutarı, kuruş; en az 1.
cityCodestringPOLICYOtelin bulunduğu il, plaka kodu 01-81.

Tarihler konaklama yerinin takvim günüdür.

Kişiler

KişiQUOTEPOLICY
insured[]Kimlik türü ve numarası, doğum tarihi—
policyholder—Kimlik türü ve numarası, doğum tarihi, e-posta, telefon, adres (il, ilçe, satır)

Örnek

Bu sayfadaki örnekler teklif isteğinin yalnızca tipe ait alanlarını, poliçe alanlarıyla birlikte gösterir; para birimi ve sepet kaynağı için bkz. Teklif. Değerler örnektir; açılı parantez içindeki değerlerin yerine alıcınızın bilgilerini, referans kodlarının yerine referans uçlarından aldığınız kodları yazın:

{
  "insuranceType": "HOTEL_CANCELLATION",
  "policyholder": {
    "identityType": "TCKN",
    "identityNumber": "<kimlik numarası>",
    "birthDate": "<YYYY-MM-DD>",
    "email": "<e-posta>",
    "phone": "<E.164 telefon>",
    "address": {
      "cityCode": "35",
      "districtCode": "<ilçe kodu>",
      "line": "<açık adres>"
    }
  },
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>"
    }
  ],
  "stay": {
    "basketItemId": "hotel-1",
    "hotelName": "Örnek Otel",
    "checkInDate": "2025-12-23",
    "checkOutDate": "2025-12-25",
    "guestCount": 2,
    "reservationAmount": 450000,
    "cityCode": "35"
  }
}

DEVICE_INSURANCE: şema sürüm 1

Cep telefonu için sigorta poliçesi. Sepet kaleminde insuranceCategory: DEVICE ile çözülür. Tip nesnesi device tek bir cihazdır. Cihazın IMEI'si ve teminat tutarı teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türleri: TCKN, PASSPORT. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziQUOTESigortalı: cihazın sahibi; tam olarak 1 öge. Kabul edilen kimlik türleri: TCKN, PASSPORT.
devicenesneQUOTESigortalanan cihaz.

device

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteCihazın bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır.
brandCodestringQUOTEMarka, referans kodu (DEVICE_BRAND).
modelCodestringQUOTEModel, referans kodu (DEVICE_MODEL, markanın altında).
imeistringQUOTECihazın IMEI'si: 15 hane, kontrol hanesi doğrulanır.
sumInsuredAmountintegerQUOTETeminat tutarı (cihaz bedeli), kuruş; en az 1.
coverageStartDatestringHayırTeminatın başlangıç günü, YYYY-MM-DD. Bağlantınızdaki ürün başlangıç günü almıyorsa teklif reddedilir.

Kişiler

KişiQUOTEPOLICY
insured[0]Kimlik türü ve numarası, ad, soyad, doğum tarihi, e-posta, telefonCinsiyet, adres (il, ilçe, satır)
policyholder——

Fiyat sigortalının bilgileriyle hesaplanır; bu yüzden kişi alanları teklif aşamasında zorunludur.

Örnek

{
  "insuranceType": "DEVICE_INSURANCE",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "firstName": "<ad>",
      "lastName": "<soyad>",
      "birthDate": "<YYYY-MM-DD>",
      "gender": "FEMALE",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>",
      "address": {
        "cityCode": "34",
        "districtCode": "<ilçe kodu>",
        "line": "<açık adres>"
      }
    }
  ],
  "device": {
    "basketItemId": "phone-1",
    "brandCode": "<marka kodu>",
    "modelCode": "<model kodu>",
    "imei": "<IMEI>",
    "sumInsuredAmount": 3500000
  }
}

DEVICE_PROTECTION: şema sürüm 1

Cep telefonunun onarım masrafını karşılayan koruma paketi. Sepet kaleminde insuranceCategory: DEVICE ile çözülür. Tip nesnesi device tek bir cihazdır. Teklif yalnızca marka ve modelle, IMEI'siz ve kişisel veri olmadan alınır.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türleri: TCKN, PASSPORT. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziPOLICYSigortalı: cihazın sahibi; en fazla 1 öge. Kabul edilen kimlik türleri: TCKN, PASSPORT.
devicenesneQUOTEKorunan cihaz.

device

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteCihazın bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır.
brandCodestringQUOTEMarka, referans kodu (DEVICE_BRAND).
modelCodestringQUOTEModel, referans kodu (DEVICE_MODEL, markanın altında).
imeistringPOLICYCihazın IMEI'si: 15 hane, kontrol hanesi doğrulanır.
deviceValueAmountintegerHayırCihaz bedeli, kuruş; en az 1. Fiyatı modele göre belirleyen ürün bu alanı kullanmaz.
coverageStartDatestringHayırTeminatın başlangıç günü, YYYY-MM-DD.

IMEI, poliçeden sonra tanımlanamaz; en geç teklif isteğinde, poliçe alanlarıyla birlikte gönderin.

Kişiler

KişiQUOTEPOLICY
insured[0]—Kimlik türü ve numarası, doğum tarihi, e-posta, telefon, adres (il, ilçe, satır)
policyholder——

Örnek

{
  "insuranceType": "DEVICE_PROTECTION",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>",
      "address": {
        "cityCode": "06",
        "districtCode": "<ilçe kodu>",
        "line": "<açık adres>"
      }
    }
  ],
  "device": {
    "basketItemId": "phone-1",
    "brandCode": "<marka kodu>",
    "modelCode": "<model kodu>",
    "imei": "<IMEI>"
  }
}

EXTENDED_WARRANTY: şema sürüm 1

Elektronik ve beyaz eşyanın üretici garantisi bittikten sonra 12 ya da 24 ay ek güvence. Sepet kaleminde insuranceCategory: ELECTRONICS ile çözülür. Tip nesnesi product tek bir üründür. Teklif kişisel veri olmadan alınır.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türleri: TCKN, PASSPORT. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziPOLICYSigortalı: ürünün sahibi; en fazla 1 öge. Kabul edilen kimlik türleri: TCKN, PASSPORT.
productnesneQUOTEGarantisi uzatılan ürün.

product

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteÜrünün bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır.
categoryCodestringQUOTEÜrün kategorisi, referans kodu (PRODUCT_CATEGORY).
brandstringQUOTEÜrünün markası. Metin, en fazla 100 karakter.
modelstringQUOTEÜrünün modeli. Metin, en fazla 100 karakter.
priceAmountintegerQUOTEÜrünün satış bedeli, kuruş; en az 1.
warrantyMonthsintegerQUOTEEk garanti süresi, ay: 12 ya da 24. JSON sayısıdır; "12" gibi metin kabul edilmez.

Ürün bedelinin üst sınırı bağlantınızdaki ürünün kuralıdır; sınırı aşan istek teklif aşamasında reddedilir. Kurumsal müşteri (vergi kimlik numarası) bu sürümde desteklenmez.

Kişiler

KişiQUOTEPOLICY
insured[0]—Kimlik türü ve numarası, ad, soyad, doğum tarihi, e-posta, telefon, adres (il, ilçe, satır)
policyholder——

Örnek

{
  "insuranceType": "EXTENDED_WARRANTY",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "firstName": "<ad>",
      "lastName": "<soyad>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>",
      "address": {
        "cityCode": "16",
        "districtCode": "<ilçe kodu>",
        "line": "<açık adres>"
      }
    }
  ],
  "product": {
    "basketItemId": "tv-1",
    "categoryCode": "<kategori kodu>",
    "brand": "Örnek Marka",
    "model": "Örnek Model 55",
    "priceAmount": 2500000,
    "warrantyMonths": 24
  }
}

ROADSIDE_ASSISTANCE: şema sürüm 1

Aracın yolda kalması hâlinde çekici ve yerinde yardım hizmeti. Sepet kaleminde insuranceCategory: VEHICLE ile çözülür. Tip nesnesi vehicle tek bir araçtır. Teklif kişisel veri ve plaka olmadan alınır.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türleri: TCKN, PASSPORT. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziPOLICYSigortalı: aracın sahibi; en fazla 1 öge. Kabul edilen kimlik türleri: TCKN, PASSPORT.
vehiclenesneQUOTEHizmet verilecek araç.

vehicle

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteAracın bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır.
brandCodestringQUOTEMarka, referans kodu (VEHICLE_BRAND).
modelCodestringQUOTEModel, referans kodu (VEHICLE_MODEL, markanın altında).
modelYearintegerQUOTEModel yılı. JSON sayısıdır; 1950 ile içinde bulunulan yılın bir sonrası arasında.
vehicleTypeCodestringQUOTEAraç tipi, referans kodu (VEHICLE_TYPE).
platestringPOLICYTürkiye plakası; boşluksuz, büyük harf.

Bu sürüm yalnızca Türkiye plakalı araçları kabul eder.

Kişiler

KişiQUOTEPOLICY
insured[0]—Ad, soyad, e-posta, telefon, adres (il, ilçe, satır)
policyholder——

Sigortalının kimliği ve doğum tarihi isteğe bağlıdır. Adres fatura adresi olarak da kullanılır.

Örnek

{
  "insuranceType": "ROADSIDE_ASSISTANCE",
  "insured": [
    {
      "firstName": "<ad>",
      "lastName": "<soyad>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>",
      "address": {
        "cityCode": "07",
        "districtCode": "<ilçe kodu>",
        "line": "<açık adres>"
      }
    }
  ],
  "vehicle": {
    "basketItemId": "car-1",
    "brandCode": "<marka kodu>",
    "modelCode": "<model kodu>",
    "modelYear": 2022,
    "vehicleTypeCode": "<araç tipi kodu>",
    "plate": "<plaka>"
  }
}

TRAVEL_HEALTH: şema sürüm 1

Yurt içi ve yurt dışı seyahat için sağlık sigortası. Sepet kaleminde insuranceCategory: TRAVEL ile çözülür. Tip nesnesi trip tek bir seyahattir; seyahatteki bütün sigortalılar aynı poliçededir.

AlanTipZorunluKural
policyholdernesnePOLICYSigorta ettiren. Kabul edilen kimlik türleri: TCKN, PASSPORT.
insureddiziQUOTESigortalılar; 1-10 öge. Kabul edilen kimlik türleri: TCKN, PASSPORT. identityNumber sigortalılar arasında tekildir.
tripnesneQUOTESigortalanan seyahat.

trip

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteSeyahatin bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır.
scopeenumQUOTEKapsam: DOMESTIC (yurt içi) ya da INTERNATIONAL (yurt dışı).
startDatestringQUOTEBaşlangıç günü, YYYY-MM-DD.
endDatestringQUOTEBitiş günü, YYYY-MM-DD; başlangıç gününden sonra olmalıdır.
residenceCountryCodestringQUOTEİkamet ülkesi, ISO 3166-1 alpha-2.
destinationCountryCodesstring[]QUOTE, yalnız INTERNATIONALGidilecek ülkeler; 1-10 öge, her biri ISO 3166-1 alpha-2, tekrar yok.
originCityCodestringPOLICY, yalnız DOMESTICYurt içi seyahatin kalkış ili, plaka kodu 01-81.

"Yalnız INTERNATIONAL" ve "yalnız DOMESTIC" işaretli alanlar yalnızca o kapsamda geçerlidir ve zorunluluk da yalnızca o zaman uygulanır. Diğer kapsamda gönderilirlerse istek reddedilir.

Kişiler

KişiQUOTEPOLICY
insured[]Kimlik türü ve numarası, doğum tarihi—
policyholder—Kimlik türü ve numarası, doğum tarihi, e-posta, telefon

Bağlantınızdaki ürünler seyahatin kapsamına ve sigortalıların kimlik türüne göre ayrışır. Pasaportla sigortalanan kişi için ad, soyad ve cinsiyet (gender) de gerekebilir; bu alanları elinizde varsa gönderin. İsteğe uymayan üründen teklif dönmez. Hiçbir ürün isteğe uymuyorsa (örneğin bağlantınızdaki ürünler tek bir varış ülkesi kabul ediyorsa ve birden çok ülke gönderdiyseniz) teklif 422 insurance.quote.declined ile reddedilir.

Örnek

Yurt dışı seyahat:

{
  "insuranceType": "TRAVEL_HEALTH",
  "policyholder": {
    "identityType": "TCKN",
    "identityNumber": "<kimlik numarası>",
    "birthDate": "<YYYY-MM-DD>",
    "email": "<e-posta>",
    "phone": "<E.164 telefon>"
  },
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>"
    }
  ],
  "trip": {
    "basketItemId": "tour-1",
    "scope": "INTERNATIONAL",
    "startDate": "2025-12-23",
    "endDate": "2025-12-30",
    "residenceCountryCode": "TR",
    "destinationCountryCodes": ["DE"]
  }
}

Yurt içi seyahatte destinationCountryCodes gönderilmez; poliçe için kalkış ili originCityCode gönderilir:

{
  "scope": "DOMESTIC",
  "startDate": "2025-12-23",
  "endDate": "2025-12-26",
  "residenceCountryCode": "TR",
  "originCityCode": "06"
}

MUSICAL_INSTRUMENT_PROTECTION: şema sürüm 1

Müzik aletinin ani ve beklenmedik hasarında onarım masrafını karşılayan koruma paketi. Sepet kaleminde insuranceCategory: MUSICAL_INSTRUMENT ile çözülür. Tip nesnesi instrument tek bir alettir. Teklif kişisel veri olmadan, aletin markası, modeli ve bedeliyle alınır.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türleri: TCKN, VKN. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziPOLICYSigortalı: aletin sahibi; en fazla 1 öge. Kabul edilen kimlik türleri: TCKN (gerçek kişi), VKN (kurum).
instrumentnesneQUOTEKorunan müzik aleti.

instrument

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteAletin bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır.
brandstringQUOTEAletin markası. Metin, en fazla 100 karakter.
modelstringQUOTEAletin modeli. Metin, en fazla 100 karakter.
valueAmountintegerQUOTEAletin bedeli, kuruş; en az 1.
categoryCodestringHayırAletin kategorisi, referans kodu (PRODUCT_CATEGORY).
serialNumberstringHayırAletin seri numarası. Metin, en fazla 100 karakter.
  • Müzik aleti kategorileri PRODUCT_CATEGORY listesindedir. Bu tipte müzik aleti kategorisi olmayan bir kod (örneğin bir elektronik ürün kategorisi) 422 insurance.reference.unknown ile reddedilir.
  • Seri numarasını gönderirseniz poliçe belgesine yazılır.
  • Bağlantınızdaki ürün birden çok paket sunuyorsa bir teklif isteği paket başına ayrı bir seçenek döner: Teklif › Birden çok seçenek.

Kişiler

KişiQUOTEPOLICY
insured[0]—Kimlik türü ve numarası, e-posta, telefon; kimlik türüne göre aşağıdaki alanlar
policyholder——

Poliçe aşamasında kimlik türüne göre ayrıca:

  • TCKN: doğum tarihi (birthDate) ya da ad ve soyad (firstName, lastName). İkisi de yoksa istek insured[0].birthDate alan yoluyla 422 insurance.validation.invalid alır. Cinsiyet (gender) isteğe bağlıdır.
  • VKN: ticari unvan (companyName).

Kurumsal (VKN) poliçede bağlantınızdaki ürün iptali desteklemiyorsa iptalin sonucu insurance.policy.cancel_failed olur ve poliçe yürürlükte kalır: İptal ve Prim İadesi.

Örnek

{
  "insuranceType": "MUSICAL_INSTRUMENT_PROTECTION",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>"
    }
  ],
  "instrument": {
    "basketItemId": "guitar-1",
    "brand": "Örnek Marka",
    "model": "Örnek Model",
    "valueAmount": 4500000,
    "categoryCode": "<kategori kodu>",
    "serialNumber": "<seri numarası>"
  }
}

Sigortalı bir kurumsa insured şöyle gönderilir:

"insured": [
  {
    "identityType": "VKN",
    "identityNumber": "<vergi kimlik numarası>",
    "companyName": "<ticari unvan>",
    "email": "<e-posta>",
    "phone": "<E.164 telefon>"
  }
]

EVENT_ACCIDENT: şema sürüm 1

Etkinlik katılımcısı için etkinlik günü geçerli ferdi kaza sigortası. Sepet kaleminde insuranceCategory: EVENT ile çözülür. Tip nesnesi event tek bir etkinlik biletidir: bir teklif tek bileti ve tek katılımcıyı korur. Fiyat katılımcının bilgileriyle hesaplanır; bu yüzden kişi alanları teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türü: TCKN. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziQUOTESigortalı: katılımcı; tam olarak 1 öge. Kabul edilen kimlik türü: TCKN.
eventnesneQUOTESigortalanan etkinlik bileti.

event

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteBiletin bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır.
coverageStartDatestringQUOTEEtkinlik günü, YYYY-MM-DD. Teklifi aldığınız gün olmalıdır.
  • Poliçe kesildiği gün geçerlidir ve en fazla bir gün sürer. Teklifi etkinlik günü alın.
  • Gün, Türkiye takvim günüdür. Geçmiş bir gün 422 insurance.validation.invalid (reason: must_not_be_past), ileri bir gün 422 insurance.quote.declined ile reddedilir.
  • Gün sipariş ve tahsilat sırasında yeniden kontrol edilir. Teklif alındıktan sonra gün değiştiyse işlem insurance.quote.declined ile reddedilir; yeni teklif alın.
  • Her bilet ayrı bir sepet kalemi ve ayrı bir tekliftir.

Kişiler

KişiQUOTEPOLICY
insured[0]Kimlik türü ve numarası, doğum tarihi, e-posta, telefon—
policyholder——

Uyruk (nationalityCountryCode) isteğe bağlıdır; gönderilmezse TR kabul edilir.

Örnek

{
  "insuranceType": "EVENT_ACCIDENT",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>"
    }
  ],
  "event": {
    "basketItemId": "concert-1",
    "coverageStartDate": "<bugün, YYYY-MM-DD>"
  }
}

MICROMOBILITY_ACCIDENT: şema sürüm 1

Kiralık scooter sürücüsü için kiralama günü geçerli ferdi kaza sigortası. Sepet kaleminde insuranceCategory: MICROMOBILITY ile çözülür. Tip nesnesi rental tek bir kiralamadır: bir teklif tek kiralamayı ve tek sürücüyü korur. Fiyat sürücünün bilgileriyle hesaplanır; bu yüzden kişi alanları teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türü: TCKN. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziQUOTESigortalı: sürücü; tam olarak 1 öge. Kabul edilen kimlik türü: TCKN.
rentalnesneQUOTESigortalanan kiralama.

rental

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteKiralamanın bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır.
coverageStartDatestringHayırTeminat günü, YYYY-MM-DD. Gönderirseniz teklifi aldığınız gün olmalıdır.
  • Poliçe kesildiği gün geçerlidir ve en fazla bir gün sürer.
  • Gün, Türkiye takvim günüdür. Geçmiş bir gün 422 insurance.validation.invalid (reason: must_not_be_past), ileri bir gün 422 insurance.quote.declined ile reddedilir. Günü gönderdiyseniz ve teklif alındıktan sonra gün değiştiyse sipariş insurance.quote.declined ile reddedilir.

Kişiler

KişiQUOTEPOLICY
insured[0]Kimlik türü ve numarası, doğum tarihi, e-posta, telefon—
policyholder——

Uyruk (nationalityCountryCode) isteğe bağlıdır; gönderilmezse TR kabul edilir.

Örnek

{
  "insuranceType": "MICROMOBILITY_ACCIDENT",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>"
    }
  ],
  "rental": {
    "basketItemId": "ride-1"
  }
}

PERSONAL_ACCIDENT: şema sürüm 1

Bir kişi için yıllık ferdi kaza sigortası. Bu tip bir sepet kalemine bağlanmaz; yalnızca API yolunda, sepet kalemi olmadan satılır: Sepet Kalemi Olmadan Satış. Tip nesnesi accident sigortanın bilgileridir ve basketItemId taşımaz. Teklif kişisel veri olmadan, yalnızca başlangıç günüyle alınır.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türü: TCKN. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziPOLICYSigortalı; en fazla 1 öge. Kabul edilen kimlik türü: TCKN.
accidentnesneQUOTESigortanın bilgileri.

accident

AlanTipZorunluKural
coverageStartDatestringQUOTETeminatın başlangıç günü, YYYY-MM-DD; bugünden önce olamaz.
occupationCodestringPOLICYSigortalının mesleği, referans kodu (OCCUPATION).
beneficiaryNamestringPOLICYLehtarın (menfaattarın) adı. Metin, en fazla 100 karakter.
vehiclePlatestringHayırTürkiye plakası; boşluksuz, büyük harf.
  • Gün, Türkiye takvim günüdür. Geçmiş bir başlangıç günü teklifte 422 insurance.validation.invalid (reason: must_not_be_past) alır. Sipariş oluşturulurken başlangıç günü geçmişse sipariş insurance.quote.declined ile reddedilir; yeni teklif alın.
  • Meslek kodu, sipariş oluşturulurken bağlantınızın sağlayıcısındaki karşılığıyla kontrol edilir. Karşılığı olmayan kod siparişte 422 insurance.reference.unknown alır ve prim tahsil edilmez. Geçerli kodları referans ucundan alın.

Kişiler

KişiQUOTEPOLICY
insured[0]—Kimlik türü ve numarası, doğum tarihi, e-posta, telefon
policyholder——

Örnek

{
  "insuranceType": "PERSONAL_ACCIDENT",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>"
    }
  ],
  "accident": {
    "coverageStartDate": "<YYYY-MM-DD>",
    "occupationCode": "<meslek kodu>",
    "beneficiaryName": "<lehtarın adı>"
  }
}

MEDICAL_COMPLICATION: şema sürüm 1

Sağlık turizmi kapsamında yapılan tıbbi işlemin komplikasyonuna karşı sigorta. Sepet kaleminde insuranceCategory: HEALTH ile çözülür. Tip nesnesi procedure tek bir işlemdir: bir teklif tek işlemi ve tek hastayı korur. Kişiler pasaportla sigortalanır. Fiyat sigortalının bilgileriyle hesaplanır; bu yüzden kişi ve işlem alanları teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türü: PASSPORT. Gönderilmezse sigortalı aynı zamanda sigorta ettirendir; gönderilirse farklı bir kişi olabilir.
insureddiziQUOTESigortalı: işlemi olan kişi; tam olarak 1 öge. Kabul edilen kimlik türü: PASSPORT.
procedurenesneQUOTESigortalanan tıbbi işlem.

procedure

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteİşlemin bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır.
procedureCoverCodestringQUOTEİşlem ve teminat limiti, referans kodu (MEDICAL_PROCEDURE_COVER).
procedureDatestringQUOTEİşlem günü, YYYY-MM-DD; teminat dönemi içinde olmalıdır.
facilityNamestringQUOTEİşlemi yapan sağlık kurumunun adı. Metin, en fazla 200 karakter.
startDatestringQUOTETeminatın başlangıç günü, YYYY-MM-DD; bugünden önce olamaz.
endDatestringQUOTETeminatın bitiş günü, YYYY-MM-DD; başlangıç gününden sonra olmalıdır.
  • Günler Türkiye takvim günüdür. Teminat dönemi dışındaki işlem günü procedure.procedureDate alan yoluyla 422 insurance.validation.invalid (reason: out_of_range) alır.
  • Sipariş oluşturulurken başlangıç günü geçmişse sipariş insurance.quote.declined ile reddedilir; yeni teklif alın.
  • Bağlantınızdaki ürün bu poliçenin iptalini desteklemiyorsa iptal isteği 412 insurance.provider.not_integrated döner.

Kişiler

KişiQUOTEPOLICY
insured[0]Kimlik türü ve numarası, ad, soyad, cinsiyet, doğum tarihi, doğum yeri, e-posta, telefon—
policyholder (gönderilirse)Kimlik türü ve numarası, ad, soyad, cinsiyet, doğum tarihi, doğum yeri—

Örnek

{
  "insuranceType": "MEDICAL_COMPLICATION",
  "insured": [
    {
      "identityType": "PASSPORT",
      "identityNumber": "<pasaport numarası>",
      "firstName": "<ad>",
      "lastName": "<soyad>",
      "gender": "MALE",
      "birthDate": "<YYYY-MM-DD>",
      "birthPlace": "<doğum yeri>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>"
    }
  ],
  "procedure": {
    "basketItemId": "treatment-1",
    "procedureCoverCode": "<işlem kodu>",
    "procedureDate": "<YYYY-MM-DD>",
    "facilityName": "Örnek Hastane",
    "startDate": "<YYYY-MM-DD>",
    "endDate": "<YYYY-MM-DD>"
  }
}

PET_HEALTH: şema sürüm 1

Kedi ve köpek için sağlık sigortası. Sepet kaleminde insuranceCategory: PET ile çözülür; sepet kalemi olmadan da satılır (Sepet Kalemi Olmadan Satış). Tip nesnesi pet tek bir hayvandır. Fiyat hayvanın ve sahibinin bilgileriyle hesaplanır; bu yüzden sahibin ve hayvanın alanları teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneQUOTESigorta ettiren: hayvanın sahibi. Kabul edilen kimlik türü: TCKN.
insureddiziHayırEn fazla 1 öge. Kabul edilen kimlik türü: TCKN. Gönderirseniz sigorta ettirenle aynı kişi olmalıdır.
petnesneQUOTESigortalanan hayvan.

pet

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteHayvanın bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır. Sepet kalemi olmadan alınan teklifte gönderilmez.
coverageStartDatestringQUOTETeminatın başlangıç günü, YYYY-MM-DD; bugünden önce olamaz.
petNamestringQUOTEHayvanın adı. Metin, en fazla 100 karakter.
petSpeciesenumQUOTETür: CAT (kedi), DOG (köpek).
petBreedCodestringQUOTEIrk, referans kodu (PET_BREED, türün altında).
petGenderenumQUOTEHayvanın cinsiyeti: MALE, FEMALE.
petBirthDatestringQUOTEHayvanın doğum günü, YYYY-MM-DD; gelecekte olamaz.
petColorstringHayırHayvanın rengi. Metin, en fazla 50 karakter.
  • Irk kodlarını türün altından alın: GET /api/v1/insurance/reference/PET_BREED?parentCode=CAT. Irkı türüyle uyumlu gönderin.
  • Gün, Türkiye takvim günüdür. Geçmiş bir başlangıç günü teklifte 422 insurance.validation.invalid (reason: must_not_be_past) alır. Sipariş oluşturulurken başlangıç günü geçmişse sipariş insurance.quote.declined ile reddedilir; yeni teklif alın.
  • Bağlantınızdaki bazı ürünler hayvanın rengini ister. petColor göndermezseniz yalnızca bu ürünlerin seçenekleri pet.petColor alan yoluyla elenir; diğer seçenekler döner: Teklif › Elenen seçenekler.
  • Bağlantınızdaki ürün birden çok paket sunuyorsa bir teklif isteği paket başına ayrı bir seçenek döner: Teklif › Birden çok seçenek.

Kişiler

KişiQUOTEPOLICY
policyholderKimlik türü ve numarası, doğum tarihi, e-posta, telefon—
insured[0] (gönderilirse)——

Örnek

{
  "insuranceType": "PET_HEALTH",
  "policyholder": {
    "identityType": "TCKN",
    "identityNumber": "<kimlik numarası>",
    "birthDate": "<YYYY-MM-DD>",
    "email": "<e-posta>",
    "phone": "<E.164 telefon>"
  },
  "pet": {
    "basketItemId": "pet-1",
    "coverageStartDate": "<YYYY-MM-DD>",
    "petName": "<hayvanın adı>",
    "petSpecies": "CAT",
    "petBreedCode": "<ırk kodu>",
    "petGender": "FEMALE",
    "petBirthDate": "<YYYY-MM-DD>",
    "petColor": "<renk>"
  }
}

Sepet kalemi olmadan alınan teklifte pet.basketItemId gönderilmez.

VEHICLE_TAG_PROTECTION: şema sürüm 1

Aracın taşıt tanıma cihazı (UTTS) için koruma: cihaz, yanlış akaryakıt dolumu ve çekme ya da kurtarma teminatları. Sepet kaleminde insuranceCategory: VEHICLE ile çözülür; sepet kalemi olmadan da satılır. Tip nesnesi vehicle tek bir aracın cihazıdır. Teklif kişisel veri ve araç kimliği olmadan, yalnızca başlangıç günüyle alınır.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türü: TCKN. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziPOLICYSigortalı: aracın sahibi; en fazla 1 öge. Kabul edilen kimlik türü: TCKN.
vehiclenesneQUOTECihazın takılı olduğu araç.

vehicle

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteAracın bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır. Sepet kalemi olmadan alınan teklifte gönderilmez.
coverageStartDatestringQUOTETeminatın başlangıç günü, YYYY-MM-DD; bugünden önce olamaz.
platestringPOLICYTürkiye plakası; boşluksuz, büyük harf.
chassisNumberstringPOLICYŞasi numarası (VIN), 17 karakter.
tagInstallationCodestringPOLICYCihazın montaj kodu: boşluksuz, büyük harf ve rakam, 4-32 karakter.
  • Bu sürüm yalnızca Türkiye plakalı araçları kabul eder.
  • Gün, Türkiye takvim günüdür. Geçmiş bir başlangıç günü teklifte 422 insurance.validation.invalid (reason: must_not_be_past) alır. Sipariş oluşturulurken başlangıç günü geçmişse sipariş insurance.quote.declined ile reddedilir; yeni teklif alın.
  • Şasi numarası ve montaj kodunun biçimi: Veri Biçimleri › Araç belgeleri ve kimlikleri.

Kişiler

KişiQUOTEPOLICY
insured[0]—Kimlik türü ve numarası, doğum tarihi, e-posta, telefon
policyholder——

Örnek

{
  "insuranceType": "VEHICLE_TAG_PROTECTION",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>"
    }
  ],
  "vehicle": {
    "basketItemId": "car-1",
    "coverageStartDate": "<YYYY-MM-DD>",
    "plate": "<plaka>",
    "chassisNumber": "<şasi numarası>",
    "tagInstallationCode": "<montaj kodu>"
  }
}

MOTOR_GREEN_CARD: şema sürüm 1

Yeşil Kart: aracın yurt dışındaki sorumluluk sigortası. Sepet kaleminde insuranceCategory: VEHICLE ya da TRAVEL ile çözülür; sepet kalemi olmadan da satılır. Tip nesnesi vehicle tek bir aracın tek dönemidir. Fiyat sigortalının ve aracın bilgileriyle hesaplanır; bu yüzden bütün alanlar teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türü: TCKN. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziQUOTESigortalı: aracın sahibi; tam olarak 1 öge. Kabul edilen kimlik türü: TCKN.
vehiclenesneQUOTESigortalanan araç ve teminat dönemi.

vehicle

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteAracın bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır. Sepet kalemi olmadan alınan teklifte gönderilmez.
platestringQUOTETürkiye plakası; boşluksuz, büyük harf.
registrationDocumentnesneQUOTERuhsat (araç tescil belgesi): serial ve number; ikisi de zorunlu.
registrationDatestringQUOTETescil tarihi, YYYY-MM-DD; gelecekte olamaz.
seatCountintegerQUOTEKoltuk sayısı, sürücü dahil; 1-100.
vehicleTypeCodestringQUOTEAraç sınıfı, referans kodu (VEHICLE_TYPE).
startDatestringQUOTETeminatın başlangıç günü, YYYY-MM-DD; bugünden önce olamaz.
endDatestringQUOTETeminatın bitiş günü, YYYY-MM-DD; başlangıç gününden sonra olmalıdır.

registrationDocument:

AlanTipKural
serialstringRuhsatın seri kodu: 1-4 büyük harf.
numberstringRuhsatın numarası: 4-10 hane, metin olarak.
  • Bu sürüm yalnızca Türkiye plakalı araçları kabul eder.
  • Araç sınıfının seçtiğiniz dönem için fiyatı yoksa teklif 422 insurance.quote.declined ile reddedilir.
  • Gün, Türkiye takvim günüdür. Geçmiş bir başlangıç günü teklifte 422 insurance.validation.invalid (reason: must_not_be_past) alır. Sipariş oluşturulurken başlangıç günü geçmişse sipariş insurance.quote.declined ile reddedilir; yeni teklif alın.
  • Poliçe kesildiğinde Yeşil Kart sertifikasını sertifika ucundan alabilirsiniz.

Kişiler

KişiQUOTEPOLICY
insured[0]Kimlik türü ve numarası, doğum tarihi, e-posta, telefon—
policyholder——

Örnek

{
  "insuranceType": "MOTOR_GREEN_CARD",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>"
    }
  ],
  "vehicle": {
    "basketItemId": "car-1",
    "plate": "<plaka>",
    "registrationDocument": {
      "serial": "<seri kodu>",
      "number": "<ruhsat numarası>"
    },
    "registrationDate": "<YYYY-MM-DD>",
    "seatCount": 5,
    "vehicleTypeCode": "<araç sınıfı kodu>",
    "startDate": "<YYYY-MM-DD>",
    "endDate": "<YYYY-MM-DD>"
  }
}

INBOUND_TRAVEL_HEALTH: şema sürüm 1

Türkiye'ye gelen yabancı ziyaretçi için sağlık sigortası. TRAVEL_HEALTH'ten ayrı bir tiptir: tip nesnesinin adı aynıdır (trip), alanları bu şemanındır. Sepet kaleminde insuranceCategory: TRAVEL ile çözülür; sepet kalemi olmadan da satılır. Tip nesnesi trip tek bir ziyaretin tek dönemidir; bütün sigortalılar aynı poliçededir. Kişiler pasaportla sigortalanır. Fiyat kişilerin bilgileriyle hesaplanır; bu yüzden kişi alanları teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneQUOTESigorta ettiren. Kabul edilen kimlik türü: PASSPORT. Sigortalılardan biri olması gerekmez.
insureddiziQUOTESigortalılar; 1-10 öge. Kabul edilen kimlik türü: PASSPORT. identityNumber sigortalılar arasında tekildir.
tripnesneQUOTESigortalanan ziyaret.

trip

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteZiyaretin bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır. Sepet kalemi olmadan alınan teklifte gönderilmez.
startDatestringQUOTETeminatın başlangıç günü, YYYY-MM-DD; bugünden önce olamaz.
endDatestringQUOTETeminatın bitiş günü, YYYY-MM-DD; başlangıç gününden sonra olmalıdır.
  • Gün, Türkiye takvim günüdür. Geçmiş bir başlangıç günü teklifte 422 insurance.validation.invalid (reason: must_not_be_past) alır. Sipariş oluşturulurken başlangıç günü geçmişse sipariş insurance.quote.declined ile reddedilir; yeni teklif alın.
  • Uyruğun (nationalityCountryCode) bağlantınızın sağlayıcısında karşılığı yoksa teklif, kişinin alan yoluyla 422 insurance.reference.unknown alır.
  • Bağlantınızdaki ürün bu poliçenin iptalini desteklemiyorsa iptal isteği 412 insurance.provider.not_integrated döner.

Kişiler

KişiQUOTEPOLICY
policyholderKimlik türü ve numarası, ad, soyad, cinsiyet, doğum tarihi, doğum yeri, uyruk, adres satırı, e-posta, telefon—
insured[]Kimlik türü ve numarası, ad, soyad, cinsiyet, doğum tarihi, doğum yeri, uyruk, adres satırı—

İletişim bilgileri sigorta ettirenindir; sigortalıların e-posta ve telefonu isteğe bağlıdır.

Örnek

{
  "insuranceType": "INBOUND_TRAVEL_HEALTH",
  "policyholder": {
    "identityType": "PASSPORT",
    "identityNumber": "<pasaport numarası>",
    "firstName": "<ad>",
    "lastName": "<soyad>",
    "gender": "FEMALE",
    "birthDate": "<YYYY-MM-DD>",
    "birthPlace": "<doğum yeri>",
    "nationalityCountryCode": "DE",
    "email": "<e-posta>",
    "phone": "<E.164 telefon>",
    "address": {
      "line": "<açık adres>"
    }
  },
  "insured": [
    {
      "identityType": "PASSPORT",
      "identityNumber": "<pasaport numarası>",
      "firstName": "<ad>",
      "lastName": "<soyad>",
      "gender": "FEMALE",
      "birthDate": "<YYYY-MM-DD>",
      "birthPlace": "<doğum yeri>",
      "nationalityCountryCode": "DE",
      "address": {
        "line": "<açık adres>"
      }
    }
  ],
  "trip": {
    "basketItemId": "visit-1",
    "startDate": "<YYYY-MM-DD>",
    "endDate": "<YYYY-MM-DD>"
  }
}

FOREIGN_RESIDENT_HEALTH: şema sürüm 1

Türkiye'de ikamet eden yabancı için sağlık sigortası. Bu tip bir sepet kalemine bağlanmaz; yalnızca API yolunda, sepet kalemi olmadan satılır: Sepet Kalemi Olmadan Satış. Tip nesnesi residence ikamet dönemidir ve basketItemId taşımaz. Teklif kişisel veri olmadan, yalnızca başlangıç günüyle alınır. Kişi pasaportla sigortalanır.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türü: PASSPORT. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziPOLICYSigortalı; en fazla 1 öge. Kabul edilen kimlik türü: PASSPORT.
residencenesneQUOTEİkamet dönemi.

residence

AlanTipZorunluKural
startDatestringQUOTETeminatın başlangıç günü, YYYY-MM-DD; bugünden önce olamaz.
endDatestringPOLICYTeminatın bitiş günü, YYYY-MM-DD; başlangıç gününden sonra olmalıdır.
  • Gün, Türkiye takvim günüdür. Geçmiş bir başlangıç günü teklifte 422 insurance.validation.invalid (reason: must_not_be_past) alır. Sipariş oluşturulurken başlangıç günü geçmişse sipariş insurance.quote.declined ile reddedilir; yeni teklif alın.
  • İkamet adresi Türkiye'dedir: insured[0].address.countryCode TR olmalıdır. Başka bir ülkeyle sipariş insurance.quote.declined ile reddedilir.
  • Uyruğun, adres ülkesinin, ilin ya da ilçenin bağlantınızın sağlayıcısında karşılığı yoksa sipariş, alanın yoluyla 422 insurance.reference.unknown alır ve prim tahsil edilmez.
  • Bağlantınızdaki ürün bu poliçenin iptalini desteklemiyorsa iptal isteği 412 insurance.provider.not_integrated döner.

Kişiler

KişiQUOTEPOLICY
insured[0]—Kimlik türü ve numarası, ad, soyad, cinsiyet, doğum tarihi, doğum yeri, baba adı, uyruk, e-posta, telefon, adres (ülke, il, ilçe, satır)
policyholder——

Örnek

{
  "insuranceType": "FOREIGN_RESIDENT_HEALTH",
  "insured": [
    {
      "identityType": "PASSPORT",
      "identityNumber": "<pasaport numarası>",
      "firstName": "<ad>",
      "lastName": "<soyad>",
      "gender": "MALE",
      "birthDate": "<YYYY-MM-DD>",
      "birthPlace": "<doğum yeri>",
      "fatherName": "<baba adı>",
      "nationalityCountryCode": "DE",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>",
      "address": {
        "countryCode": "TR",
        "cityCode": "34",
        "districtCode": "<ilçe kodu>",
        "line": "<açık adres>"
      }
    }
  ],
  "residence": {
    "startDate": "<YYYY-MM-DD>",
    "endDate": "<YYYY-MM-DD>"
  }
}

ABROAD_STAY_HEALTH: şema sürüm 1

Yurt dışında öğrenim ya da çalışma süresince sağlık sigortası. TRAVEL_HEALTH'ten ayrı bir tiptir. Sepet kaleminde insuranceCategory: EDUCATION ya da TRAVEL ile çözülür; sepet kalemi olmadan da satılır. Tip nesnesi abroadStay tek bir dönemin tek gidiş ülkesidir; bütün sigortalılar aynı poliçededir. Kişiler TC kimlik numarasıyla sigortalanır. Fiyat kişilerin bilgileriyle hesaplanır; bu yüzden kişi alanları teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneQUOTESigorta ettiren. Kabul edilen kimlik türü: TCKN.
insureddiziQUOTESigortalılar; 1-10 öge. Kabul edilen kimlik türü: TCKN. identityNumber sigortalılar arasında tekildir.
abroadStaynesneQUOTESigortalanan dönem.

abroadStay

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteDönemin bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır. Sepet kalemi olmadan alınan teklifte gönderilmez.
startDatestringQUOTETeminatın başlangıç günü, YYYY-MM-DD; bugünden önce olamaz.
endDatestringQUOTETeminatın bitiş günü, YYYY-MM-DD; başlangıç gününden sonra olmalıdır.
coverageRegionenumQUOTETeminat bölgesi: EUROPE (Avrupa) ya da WORLDWIDE (dünya).
destinationCountryCodestringQUOTEGidilecek ülke, ISO 3166-1 alpha-2. Seçilen bölgenin ülkelerinden biri olmalıdır.
  • Gidilecek ülke Türkiye (TR) olamaz; teklif 422 insurance.quote.declined ile reddedilir.
  • Gidilecek ülkenin, seçilen bölgede bağlantınızın sağlayıcısında karşılığı yoksa teklif abroadStay.destinationCountryCode alan yoluyla 422 insurance.reference.unknown alır.
  • Sigorta ettirenin adresi Türkiye'dedir: policyholder.address.countryCode TR olmalıdır. Başka bir ülkeyle sipariş insurance.quote.declined ile reddedilir.
  • Gün, Türkiye takvim günüdür. Geçmiş bir başlangıç günü teklifte 422 insurance.validation.invalid (reason: must_not_be_past) alır. Sipariş oluşturulurken başlangıç günü geçmişse sipariş insurance.quote.declined ile reddedilir; yeni teklif alın.

Kişiler

KişiQUOTEPOLICY
policyholderKimlik türü ve numarası, doğum tarihi, e-posta, telefon, adres satırıAdres (ülke, il, ilçe, satır)
insured[]Kimlik türü ve numarası, doğum tarihi, yakınlık (relationship)—

Sigorta ettiren kendini de sigortalatıyorsa insured[] içinde relationship: SELF ile yer alır.

Örnek

{
  "insuranceType": "ABROAD_STAY_HEALTH",
  "policyholder": {
    "identityType": "TCKN",
    "identityNumber": "<kimlik numarası>",
    "birthDate": "<YYYY-MM-DD>",
    "email": "<e-posta>",
    "phone": "<E.164 telefon>",
    "address": {
      "countryCode": "TR",
      "cityCode": "06",
      "districtCode": "<ilçe kodu>",
      "line": "<açık adres>"
    }
  },
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "relationship": "CHILD"
    }
  ],
  "abroadStay": {
    "basketItemId": "school-1",
    "startDate": "<YYYY-MM-DD>",
    "endDate": "<YYYY-MM-DD>",
    "coverageRegion": "EUROPE",
    "destinationCountryCode": "DE"
  }
}

MOTOR_THIRD_PARTY_LIABILITY: şema sürüm 1

Zorunlu trafik sigortası. Sepet kaleminde insuranceCategory: VEHICLE ile çözülür; sepet kalemi olmadan da satılır. Bu tipte talep de açılabilir: Talep şemaları. Tip nesnesi vehicle tek bir aracın tek poliçesidir. Hangi araç alanlarının gerektiğini aracın kayıt senaryosu (registrationScenario) belirler. Fiyat sigortalının ve aracın bilgileriyle hesaplanır; bu yüzden bütün alanlar teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türleri: TCKN, PASSPORT, VKN. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziQUOTESigortalı: aracın sahibi; tam olarak 1 öge. Kabul edilen kimlik türleri: TCKN, PASSPORT, VKN; kayıt senaryosuna göre bunlardan biri geçerlidir (Kayıt senaryoları).
vehiclenesneQUOTESigortalanan araç.

vehicle

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteAracın bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır. Sepet kalemi olmadan alınan teklifte gönderilmez.
registrationScenarioenumQUOTEAracın kayıt senaryosu: RENEWAL, NEW_REGISTRATION, FOREIGN_PLATE, OWNERSHIP_TRANSFER, DEALER_SHORT_TERM. Varsayılan değeri yoktur.
plateCityCodestringQUOTE, yalnız NEW_REGISTRATIONPlakası henüz olmayan aracın plaka il kodu, 01-81.
platestringQUOTE, NEW_REGISTRATION dışındaPlaka; boşluksuz, büyük harf. FOREIGN_PLATE senaryosunda yabancı plaka, diğer senaryolarda Türkiye plakası.
registrationDocumentnesneQUOTE, yalnız RENEWAL, OWNERSHIP_TRANSFER, DEALER_SHORT_TERMRuhsat (araç tescil belgesi): serial ve number; ikisi de zorunlu.
chassisNumberstringQUOTE, yalnız NEW_REGISTRATION, FOREIGN_PLATEŞasi numarası (VIN), 17 karakter.
engineNumberstringQUOTE, yalnız NEW_REGISTRATION, FOREIGN_PLATEMotor numarası.
modelCodestringQUOTE, RENEWAL dışındaModel, referans kodu (VEHICLE_MODEL). Marka, modelin üst kodudur; ayrıca gönderilmez.
modelYearintegerQUOTE, yalnız NEW_REGISTRATION, FOREIGN_PLATE, DEALER_SHORT_TERMModel yılı. JSON sayısıdır; 1950 ile içinde bulunulan yılın bir sonrası arasında.
vehicleTypeCodestringQUOTE, RENEWAL dışındaAraç tipi (kullanım tarzı), referans kodu (VEHICLE_TYPE).
policyDurationMonthsintegerQUOTE, yalnız FOREIGN_PLATEPoliçe süresi, ay; 1-12.

Senaryo işaretli alanlar yalnızca o senaryolarda geçerlidir ve zorunluluk da yalnızca o zaman uygulanır. Başka bir senaryoda gönderilirlerse istek, alanın yoluyla 422 insurance.validation.invalid (reason: not_applicable) alır.

Kayıt senaryoları

registrationScenarioAraçSigortalının kimlik türüAraç alanları
RENEWALTescilli aracın poliçesiTCKNplate, registrationDocument
NEW_REGISTRATIONHenüz tescil edilmemiş, plakası olmayan araçTCKNplateCityCode, modelCode, modelYear, vehicleTypeCode, engineNumber, chassisNumber
FOREIGN_PLATEYabancı plakalı araçPASSPORTplate (yabancı plaka), modelCode, modelYear, vehicleTypeCode, engineNumber, chassisNumber, policyDurationMonths
OWNERSHIP_TRANSFERNoter devri öncesindeki tescilli araç; sigortalı aracı devralacak kişidirTCKNplate, registrationDocument, vehicleTypeCode, modelCode
DEALER_SHORT_TERMGalericinin kısa süreli poliçesi; sigortalı galerici kurumdurVKNplate, registrationDocument, vehicleTypeCode, modelCode, modelYear

Teklifi adım adım hazırlayın:

  1. Alıcıyla aracın kayıt senaryosunu belirleyin ve registrationScenario olarak gönderin.
  2. Senaryonun kimlik türüyle sigortalının bilgilerini alın. Kimlik türü senaryoya uymazsa teklif insured[0].identityType alan yoluyla 422 insurance.validation.invalid (reason: not_supported_for_registration_scenario) alır ve istek sağlayıcıya gönderilmez.
  3. Senaryo RENEWAL değilse araç tipini VEHICLE_TYPE listesinden alın; modeli araç tipine ve yılına göre listeden bulun: önce VEHICLE_BRAND, ardından markanın altındaki VEHICLE_MODEL.
  4. Senaryonun araç alanlarını tablodaki gibi doldurup teklifi alın.
  • VKN ile sigortalıda ticari unvan (companyName) zorunludur; doğum tarihi gönderilmez. TCKN ve PASSPORT ile doğum tarihi zorunludur.
  • Bu tipte teminat başlangıç günü gönderilmez; poliçenin dönemini bağlantınızdaki ürün belirler.
  • NEW_REGISTRATION senaryosunda model yılı bağlantınızdaki ürünün kabul ettiği yıllardan biri değilse teklif vehicle.modelYear alan yoluyla 422 insurance.validation.invalid (reason: not_supported_by_provider) alır.
  • Araç tipinin ya da modelin bağlantınızın sağlayıcısında karşılığı yoksa teklif, alanın yoluyla 422 insurance.reference.unknown alır.
  • Bağlantınızdaki ürün yalnızca Türkiye cep telefonu numarası kabul ediyorsa başka bir numarayla teklif 422 insurance.quote.declined alır.
  • Pasaport ya da vergi kimlik numarasıyla kesilen poliçede bağlantınızdaki ürün iptali desteklemiyorsa iptalin sonucu insurance.policy.cancel_failed olur ve poliçe yürürlükte kalır: İptal ve Prim İadesi.
  • Yabancı plakanın ve motor numarasının biçimi: Veri Biçimleri.

Kişiler

KişiQUOTEPOLICY
insured[0]Kimlik türü ve numarası, e-posta, telefon; TCKN ve PASSPORT ile doğum tarihi, VKN ile ticari unvan (companyName)—
policyholder——

Örnek

Yenileme (RENEWAL):

{
  "insuranceType": "MOTOR_THIRD_PARTY_LIABILITY",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>"
    }
  ],
  "vehicle": {
    "basketItemId": "car-1",
    "registrationScenario": "RENEWAL",
    "plate": "<plaka>",
    "registrationDocument": {
      "serial": "<seri kodu>",
      "number": "<ruhsat numarası>"
    }
  }
}

Yeni kayıt (NEW_REGISTRATION) aracında plaka yerine plaka il kodu gönderilir:

"vehicle": {
  "basketItemId": "car-1",
  "registrationScenario": "NEW_REGISTRATION",
  "plateCityCode": "34",
  "modelCode": "<model kodu>",
  "modelYear": 2026,
  "vehicleTypeCode": "<araç tipi kodu>",
  "engineNumber": "<motor numarası>",
  "chassisNumber": "<şasi numarası>"
}

Galericinin kısa süreli poliçesinde (DEALER_SHORT_TERM) sigortalı vergi kimlik numarasıyla gönderilir:

"insured": [
  {
    "identityType": "VKN",
    "identityNumber": "<vergi kimlik numarası>",
    "companyName": "<ticari unvan>",
    "email": "<e-posta>",
    "phone": "<E.164 telefon>"
  }
]

MOTOR_COMPREHENSIVE: şema sürüm 1

Kasko. Sepet kaleminde insuranceCategory: VEHICLE ile çözülür; sepet kalemi olmadan da satılır. Bu tipte talep de açılabilir: Talep şemaları. Tip nesnesi vehicle tek bir aracın tek poliçesidir. Fiyat sigortalının ve aracın bilgileriyle hesaplanır; bu yüzden alanlar teklif aşamasında gönderilir.

Bağlantılarınızdaki ürünler farklı araç alanları ister. Şema bu alanların hepsini kapsar; şemada zorunlu olan yalnızca bütün ürünlerin istediği alanlardır. Bir ürünün istediği isteğe bağlı bir alan eksikse yalnızca o ürünün seçeneği elenir: Ürüne göre ek zorunlu alanlar.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türü: TCKN. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziQUOTESigortalı: aracın sahibi; tam olarak 1 öge. Kabul edilen kimlik türü: TCKN.
vehiclenesneQUOTESigortalanan araç.

vehicle

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteAracın bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır. Sepet kalemi olmadan alınan teklifte gönderilmez.
platestringQUOTETürkiye plakası; boşluksuz, büyük harf.
coverageStartDatestringQUOTETeminatın başlangıç günü, YYYY-MM-DD; bugünden önce olamaz.
registrationDocumentnesneHayırRuhsat (araç tescil belgesi): serial ve number; gönderirseniz ikisi de zorunlu.
registrationDatestringHayırTescil tarihi, YYYY-MM-DD; gelecekte olamaz.
modelYearintegerHayırModel yılı. JSON sayısıdır; 1950 ile içinde bulunulan yılın bir sonrası arasında.
vehicleTypeCodestringHayırAraç tipi, referans kodu (VEHICLE_TYPE).
modelCodestringHayırModel, referans kodu (VEHICLE_MODEL).
chassisNumberstringHayırŞasi numarası (VIN), 17 karakter.
engineNumberstringHayırMotor numarası.
originCountryCodestringHayırBaşlangıç ülkesi, ISO 3166-1 alpha-2.
driverIdentityNumberstringHayırSürücünün TC kimlik numarası; TCKN biçiminde doğrulanır.
  • Bağlantınızdaki bir ürün ruhsatı, bir başkası model yılını ve tescil tarihini isteyebilir. Yurt dışında yaşayan araç sahibine sunulan seçenekler bunlara ek olarak başlangıç ülkesini, motor ve şasi numarasını, modeli, araç tipini ve sürücünün kimlik numarasını ister. Bütün seçenekleri almak için alıcınızdan alabildiğiniz bütün araç alanlarını gönderin. Eksik alan, elenen seçenekte alan yoluyla döner (ör. vehicle.registrationDocument): Teklif › Elenen seçenekler.
  • Bağlantılarınızdaki her ürün kendi seçeneğini döner; bir teklif isteğinde birden çok seçenek dönebilir: Teklif › Birden çok seçenek.
  • Bu sürüm yalnızca Türkiye plakalı araçları kabul eder.
  • Gün, Türkiye takvim günüdür. Geçmiş bir başlangıç günü teklifte 422 insurance.validation.invalid (reason: must_not_be_past) alır. Sipariş oluşturulurken başlangıç günü geçmişse sipariş insurance.quote.declined ile reddedilir; yeni teklif alın.
  • Araç tipinin, modelin ya da başlangıç ülkesinin bağlantınızın sağlayıcısında karşılığı yoksa o ürünün seçeneği alanın yoluyla insurance.reference.unknown ile elenir.
  • Bağlantınızdaki ürün yalnızca Türkiye cep telefonu numarası kabul ediyorsa başka bir numarayla teklif 422 insurance.quote.declined alır.

Kişiler

KişiQUOTEPOLICY
insured[0]Kimlik türü ve numarası, doğum tarihi, e-posta, telefon—
policyholder——

Örnek

{
  "insuranceType": "MOTOR_COMPREHENSIVE",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>"
    }
  ],
  "vehicle": {
    "basketItemId": "car-1",
    "plate": "<plaka>",
    "coverageStartDate": "<YYYY-MM-DD>",
    "registrationDocument": {
      "serial": "<seri kodu>",
      "number": "<ruhsat numarası>"
    },
    "registrationDate": "<YYYY-MM-DD>",
    "modelYear": 2022,
    "vehicleTypeCode": "<araç tipi kodu>"
  }
}

MOTOR_EXCESS_LIABILITY: şema sürüm 1

Araç için ihtiyari mali mesuliyet (İMM) sigortası. Sepet kaleminde insuranceCategory: VEHICLE ile çözülür; sepet kalemi olmadan da satılır. Tip nesnesi vehicle tek bir aracın tek poliçesidir. Fiyat sigortalının ve aracın bilgileriyle ve seçilen limitle hesaplanır; bu yüzden bütün alanlar teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türü: TCKN. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziQUOTESigortalı: aracın sahibi; tam olarak 1 öge. Kabul edilen kimlik türü: TCKN.
vehiclenesneQUOTESigortalanan araç ve limit.

vehicle

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteAracın bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır. Sepet kalemi olmadan alınan teklifte gönderilmez.
platestringQUOTETürkiye plakası; boşluksuz, büyük harf.
registrationDocumentnesneQUOTERuhsat (araç tescil belgesi): serial ve number; ikisi de zorunlu.
chassisNumberstringQUOTEŞasi numarası (VIN), 17 karakter.
engineNumberstringQUOTEMotor numarası.
modelCodestringQUOTEModel, referans kodu (VEHICLE_MODEL).
modelYearintegerQUOTEModel yılı. JSON sayısıdır; 1950 ile içinde bulunulan yılın bir sonrası arasında.
vehicleTypeCodestringQUOTEAraç tipi, referans kodu (VEHICLE_TYPE).
vehicleUsageCodestringQUOTEAracın kullanım şekli, referans kodu (VEHICLE_USAGE).
coverageStartDatestringQUOTETeminatın başlangıç günü, YYYY-MM-DD; bugünden önce olamaz.
liabilityLimitCodestringQUOTEAraç başı sorumluluk limiti, referans kodu (LIABILITY_LIMIT).
  • Limitleri GET /api/v1/insurance/reference/LIABILITY_LIMIT listesinden alın. Alıcıya görünen adı (label) gösterin, istekte kodu gönderin.
  • Bu sürüm yalnızca Türkiye plakalı araçları kabul eder.
  • Gün, Türkiye takvim günüdür. Geçmiş bir başlangıç günü teklifte 422 insurance.validation.invalid (reason: must_not_be_past) alır. Sipariş oluşturulurken başlangıç günü geçmişse sipariş insurance.quote.declined ile reddedilir; yeni teklif alın.
  • Limitin, kullanım şeklinin, araç tipinin ya da modelin bağlantınızın sağlayıcısında karşılığı yoksa teklif, alanın yoluyla 422 insurance.reference.unknown alır.
  • Bağlantınızdaki ürün yalnızca Türkiye cep telefonu numarası kabul ediyorsa başka bir numarayla teklif 422 insurance.quote.declined alır.

Kişiler

KişiQUOTEPOLICY
insured[0]Kimlik türü ve numarası, doğum tarihi, e-posta, telefon—
policyholder——

Örnek

{
  "insuranceType": "MOTOR_EXCESS_LIABILITY",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>"
    }
  ],
  "vehicle": {
    "basketItemId": "car-1",
    "plate": "<plaka>",
    "registrationDocument": {
      "serial": "<seri kodu>",
      "number": "<ruhsat numarası>"
    },
    "chassisNumber": "<şasi numarası>",
    "engineNumber": "<motor numarası>",
    "modelCode": "<model kodu>",
    "modelYear": 2022,
    "vehicleTypeCode": "<araç tipi kodu>",
    "vehicleUsageCode": "<kullanım şekli kodu>",
    "coverageStartDate": "<YYYY-MM-DD>",
    "liabilityLimitCode": "<limit kodu>"
  }
}

COMPULSORY_EARTHQUAKE: şema sürüm 1

Konut için zorunlu deprem sigortası (DASK). Sepet kaleminde insuranceCategory: HOME ile çözülür; sepet kalemi olmadan da satılır. Tip nesnesi property tek bir bağımsız bölümün (konutun) tek poliçesidir. Konutun adresi UAVT adres koduyla gönderilir: UAVT adres zinciri. Fiyat sigortalının ve konutun bilgileriyle hesaplanır; bu yüzden konut alanları teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türü: TCKN. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziQUOTESigortalı; tam olarak 1 öge. Kabul edilen kimlik türü: TCKN.
propertynesneQUOTESigortalanan konut.

property

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteKonutun bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır. Sepet kalemi olmadan alınan teklifte gönderilmez.
uavtAddressCodestringQUOTEUAVT adres kodu: 10 hane, metin.
coverageStartDatestringQUOTETeminatın başlangıç günü, YYYY-MM-DD; bugünden önce olamaz.
areaSqmintegerQUOTEBağımsız bölümün brüt alanı, metrekare; 1-100000.
floorCountintegerQUOTEBinanın toplam kat sayısı; 1-200.
constructionTypeenumQUOTEYapı tarzı: REINFORCED_CONCRETE_STEEL (çelik, betonarme ya da karkas) ya da OTHER (diğer).
constructionYearintegerQUOTEBinanın inşa yılı. JSON sayısıdır; 1800 ile içinde bulunulan yıl arasında.
priorDamageenumQUOTEBinanın önceki hasar durumu: NONE (hasarsız), LIGHT (az), MODERATE (orta), TOTAL_LOSS (ağır hasarlı).
usageenumQUOTEBağımsız bölümün kullanım şekli: RESIDENTIAL (mesken), COMMERCIAL (işyeri), OTHER (diğer).
lienholdernesneHayırDaini mürtehin: konutun kredisini veren banka ya da finans kurumu. Alanları aşağıda.

lienholder:

AlanTipZorunluKural
institutionTypeenumlienholder gönderilirseKurumun türü: BANK (banka) ya da FINANCE (finans kurumu).
bankCodestringYalnız BANKBanka, referans kodu (BANK).
bankBranchCodestringYalnız BANKŞube, referans kodu (BANK_BRANCH, bankanın altında).
branchCityCodestringYalnız BANKŞubenin bulunduğu il, plaka kodu 01-81.
financeInstitutionCodestringYalnız FINANCEFinans kurumu, referans kodu (FINANCE_INSTITUTION).

"Yalnız BANK" ve "yalnız FINANCE" işaretli alanlar yalnızca o kurum türünde geçerlidir ve zorunludur. Diğer türde gönderilirlerse istek reddedilir. Daini mürtehin yoksa lienholder göndermeyin.

  • UAVT adres kodunun doğrulanması: UAVT adres zinciri.
  • Bina alanları ham değerlerdir (yıl, kat sayısı, metrekare); aralıklara çevirmeyin. Bağlantınızdaki ürünün kabul etmediği bir değer (ör. ürünün sınırından fazla kat sayısı) alan yoluyla 422 insurance.validation.invalid (reason: not_supported_by_provider) alır.
  • Gün, Türkiye takvim günüdür. Geçmiş bir başlangıç günü teklifte 422 insurance.validation.invalid (reason: must_not_be_past) alır. Sipariş oluşturulurken başlangıç günü geçmişse sipariş insurance.quote.declined ile reddedilir; yeni teklif alın.
  • Banka, şube, finans kurumu ya da adresteki ilçenin bağlantınızın sağlayıcısında karşılığı yoksa istek, alanın yoluyla 422 insurance.reference.unknown alır.
  • Bağlantınızdaki ürün yalnızca Türkiye cep telefonu numarası kabul ediyorsa başka bir numarayla teklif 422 insurance.quote.declined alır.

Kişiler

KişiQUOTEPOLICY
insured[0]Kimlik türü ve numarası, doğum tarihi, e-posta, telefonAdres (il, ilçe, satır)
policyholder——

Örnek

{
  "insuranceType": "COMPULSORY_EARTHQUAKE",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>",
      "address": {
        "cityCode": "35",
        "districtCode": "<ilçe kodu>",
        "line": "<açık adres>"
      }
    }
  ],
  "property": {
    "basketItemId": "home-1",
    "uavtAddressCode": "<UAVT adres kodu>",
    "coverageStartDate": "<YYYY-MM-DD>",
    "areaSqm": 120,
    "floorCount": 5,
    "constructionType": "REINFORCED_CONCRETE_STEEL",
    "constructionYear": 2005,
    "priorDamage": "NONE",
    "usage": "RESIDENTIAL"
  }
}

Konutun kredisini bir banka verdiyse lienholder şöyle gönderilir:

"lienholder": {
  "institutionType": "BANK",
  "bankCode": "<banka kodu>",
  "bankBranchCode": "<şube kodu>",
  "branchCityCode": "35"
}

HOME_INSURANCE: şema sürüm 1

Konut sigortası. Sepet kaleminde insuranceCategory: HOME ile çözülür; sepet kalemi olmadan da satılır. Tip nesnesi property tek bir bağımsız bölümün (konutun) tek poliçesidir. Konutun adresi UAVT adres koduyla gönderilir: UAVT adres zinciri. Fiyat sigortalının ve konutun bilgileriyle ve teminat bedelleriyle hesaplanır; bu yüzden bütün alanlar teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türü: TCKN. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziQUOTESigortalı; tam olarak 1 öge. Kabul edilen kimlik türü: TCKN.
propertynesneQUOTESigortalanan konut.

property

AlanTipZorunluKural
basketItemIdstringSepete bağlı teklifteKonutun bağlı olduğu sepet kaleminin id'si. En fazla 256 karakter; değer olduğu gibi saklanır. Sepet kalemi olmadan alınan teklifte gönderilmez.
uavtAddressCodestringQUOTEUAVT adres kodu: 10 hane, metin.
areaSqmintegerQUOTEBağımsız bölümün brüt alanı, metrekare; 1-100000.
constructionYearintegerQUOTEBinanın inşa yılı. JSON sayısıdır; 1800 ile içinde bulunulan yıl arasında.
dwellingTypeCodestringQUOTEKonut türü, referans kodu (DWELLING_TYPE).
floorCodestringQUOTEBağımsız bölümün bulunduğu kat, referans kodu (DWELLING_FLOOR).
contentsFireAmountintegerQUOTEEşya yangın teminat bedeli, kuruş; en az 1, en fazla 100000000 (1.000.000 TL).
interiorDecorationAmountintegerQUOTEDahili dekorasyon teminat bedeli, kuruş; en az 1, en fazla 100000000 (1.000.000 TL).
glassBreakageAmountintegerQUOTECam kırılması teminat bedeli, kuruş; en az 2000000 (20.000 TL).
vacantOverThreeMonthsbooleanQUOTEKonut yılda üç aydan uzun süre boş kalıyor.
hasEarthquakePolicybooleanQUOTEKonutun yürürlükte bir zorunlu deprem sigortası poliçesi var.
inGatedSitebooleanQUOTEKonut bir site içinde.
hasAlarmbooleanQUOTEKonutta alarm var.
hasCamerabooleanQUOTEKonutta güvenlik kamerası var.
hasWindowBarsbooleanQUOTEPencerelerde demir parmaklık var.
hasFireExtinguisherbooleanQUOTEKonutta yangın söndürme cihazı var.
hasSprinklerbooleanQUOTEKonutta yağmurlama (sprinkler) sistemi var.
hasResidualCurrentDevicebooleanQUOTEKonutta kaçak akım rölesi var.
hasGasDetectorbooleanQUOTEKonutta doğalgaz dedektörü var.
isOwnerbooleanQUOTESigortalı konutun sahibi.
includeWatercraftbooleanQUOTEDeniz taşıtları teminatı isteniyor.
lienholdernesneHayırDaini mürtehin: konutun kredisini veren banka ya da finans kurumu. Alanları aşağıda.

lienholder alanları COMPULSORY_EARTHQUAKE ile aynıdır (yukarıda); yalnızca şubenin ili (branchCityCode) bu şemada yoktur ve gönderilirse istek reddedilir.

  • Evet/hayır alanları JSON boolean'dır (true, false) ve hepsi zorunludur; "true" gibi metin kabul edilmez.
  • Teminat bedeli sınırların dışındaysa teklif, alanın yoluyla 422 insurance.validation.invalid alır: üst sınırda reason: must_be_at_most_100000000, alt sınırda reason: must_be_at_least_<sınır>.
  • Bağlantınızdaki ürün teminat bedellerini tam lira olarak alıyorsa kuruş içeren bir bedel alan yoluyla reason: not_supported_by_provider alır. Bedelleri tam lira olarak gönderin (100'ün katı kuruş).
  • Bu sürümde teminat başlangıç günü gönderilmez; poliçenin dönemini bağlantınızdaki ürün belirler.
  • UAVT adres kodunun doğrulanması: UAVT adres zinciri.
  • Konut türünün, katın, bankanın, şubenin ya da finans kurumunun bağlantınızın sağlayıcısında karşılığı yoksa teklif, alanın yoluyla 422 insurance.reference.unknown alır.
  • Bağlantınızdaki ürün yalnızca Türkiye cep telefonu numarası kabul ediyorsa başka bir numarayla teklif 422 insurance.quote.declined alır.

Kişiler

KişiQUOTEPOLICY
insured[0]Kimlik türü ve numarası, doğum tarihi, e-posta, telefon—
policyholder——

Örnek

{
  "insuranceType": "HOME_INSURANCE",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>"
    }
  ],
  "property": {
    "basketItemId": "home-1",
    "uavtAddressCode": "<UAVT adres kodu>",
    "areaSqm": 120,
    "constructionYear": 2005,
    "dwellingTypeCode": "<konut türü kodu>",
    "floorCode": "<kat kodu>",
    "contentsFireAmount": 50000000,
    "interiorDecorationAmount": 10000000,
    "glassBreakageAmount": 2000000,
    "vacantOverThreeMonths": false,
    "hasEarthquakePolicy": true,
    "inGatedSite": false,
    "hasAlarm": false,
    "hasCamera": false,
    "hasWindowBars": false,
    "hasFireExtinguisher": true,
    "hasSprinkler": false,
    "hasResidualCurrentDevice": true,
    "hasGasDetector": true,
    "isOwner": true,
    "includeWatercraft": false
  }
}

SUPPLEMENTARY_HEALTH: şema sürüm 1

Tamamlayıcı sağlık sigortası. Bu tip bir sepet kalemine bağlanmaz; yalnızca API yolunda, sepet kalemi olmadan satılır: Sepet Kalemi Olmadan Satış. Tip nesnesi health sigortanın bilgileridir ve basketItemId taşımaz. Bir teklif tek bir kişiyi korur; kişi TC kimlik numarasıyla sigortalanır. Sağlık beyanı (boy, kilo, hamilelik durumu) sigortalının alanlarındadır. Fiyat sigortalının bilgileriyle hesaplanır; bu yüzden kişi alanları teklif aşamasında zorunludur.

AlanTipZorunluKural
policyholdernesneHayırSigorta ettiren. Kabul edilen kimlik türü: TCKN. Gönderirseniz sigortalıyla aynı kişi olmalıdır.
insureddiziQUOTESigortalı; tam olarak 1 öge. Kabul edilen kimlik türü: TCKN.
healthnesneQUOTESigortanın bilgileri.

health

AlanTipZorunluKural
planTypeenumQUOTEPlan türü: INPATIENT (yatarak) ya da INPATIENT_OUTPATIENT (yatarak ve ayakta).
pregnancyCoverbooleanHayırtrue: yalnızca hamilelik teminatlı planlar istenir. Gönderilmezse ya da false ise yalnızca hamilelik teminatı olmayan planlar döner.
installmentCountintegerHayırTaksit sayısı, 1-12. Gönderilmezse prim tek çekimle tahsil edilir.

Sağlık beyanı

AlanTipZorunluKural
insured[0].heightCmintegerQUOTEBoy, santimetre; 30-250.
insured[0].weightKgintegerQUOTEKilo, kilogram; 1-350.
insured[0].pregnancyStatusenumpregnancyCover: true ikenHamilelik durumu: PREGNANT.
  • Teklif yalnızca planType ile seçilen plan türündeki planları döner. Bağlantınızdaki ürün birden çok sigorta şirketinin planını sunuyorsa bir teklif isteği şirket ve plan başına ayrı bir seçenek döner: Teklif › Birden çok seçenek.
  • pregnancyCover: true iken insured[0].pregnancyStatus zorunludur; gönderilmezse reason: required döner. Hamilelik teminatı istenmeyen teklifte pregnancyStatus gönderilirse reason: not_applicable ile reddedilir.
  • Sağlık beyanı özel nitelikli kişisel veridir. Yalnızca teklif isteğinde gönderilir; hata yanıtlarında yalnızca alanın yolu döner, değeri dönmez. Testlerde gerçek bir kişinin bilgilerini kullanmayın.
  • Seçeneğin anlaşmalı sağlık kurumlarını il il listeleyebilirsiniz: Teklif › Anlaşmalı kurumlar.
  • Bazı seçenekler taksitli ödeme almaz. Böyle bir seçenekte installmentCount 1'den büyükse primin tahsilatı insurance.quote.declined ile reddedilir.
  • Sigortalının adresi Türkiye'dedir: insured[0].address.countryCode TR olmalıdır. Başka bir ülkeyle sipariş insurance.quote.declined ile reddedilir.
  • Adresteki ilin, ilçenin ya da ülkenin bağlantınızın sağlayıcısında karşılığı yoksa istek, alanın yoluyla 422 insurance.reference.unknown alır.
  • Ad ve soyad gerekmez.
  • Bağlantınızdaki ürün yalnızca Türkiye cep telefonu numarası kabul ediyorsa başka bir numarayla teklif 422 insurance.quote.declined alır.

Kişiler

KişiQUOTEPOLICY
insured[0]Kimlik türü ve numarası, doğum tarihi, e-posta, telefon, adresin ili (address.cityCode), boy, kilo; hamilelik teminatında hamilelik durumuAdresin ülkesi, ilçesi ve satırı (countryCode, districtCode, line)
policyholder——

Örnek

{
  "insuranceType": "SUPPLEMENTARY_HEALTH",
  "insured": [
    {
      "identityType": "TCKN",
      "identityNumber": "<kimlik numarası>",
      "birthDate": "<YYYY-MM-DD>",
      "email": "<e-posta>",
      "phone": "<E.164 telefon>",
      "heightCm": 170,
      "weightKg": 70,
      "address": {
        "countryCode": "TR",
        "cityCode": "06",
        "districtCode": "<ilçe kodu>",
        "line": "<açık adres>"
      }
    }
  ],
  "health": {
    "planType": "INPATIENT_OUTPATIENT"
  }
}

Talep şemaları

Talep tiplerinin alanları talep şemasıyla tanımlanır. Talep şeması teklif şemasıyla aynı kuralları kullanır ve tip başına ayrı sürümlenir (schemaVersion).

  • Talepte aşama yoktur: tabloda "Evet" yazan alanlar talep isteğinde zorunludur.
  • Her talep şemasının kökünde isteğe bağlı note alanı vardır: talep notu, metin, en fazla 1000 karakter. Not kişisel veri taşıyabilir; talebin maskeli görüntüsünde gizlenir.
  • Talepte tutar, para birimi, sepet kalemi ve ödeme yoktur.
  • İstek ve sonuçlar: Talep.

MOTOR_THIRD_PARTY_LIABILITY ve MOTOR_COMPREHENSIVE: talep şeması sürüm 1

Zorunlu trafik sigortası (MOTOR_THIRD_PARTY_LIABILITY) ve kasko (MOTOR_COMPREHENSIVE) talebi. İki tipin talep şeması aynıdır. Tip nesnesi vehicle tek bir araçtır.

AlanTipZorunluKural
policyholdernesneEvetTalep sahibi: aracın sahibi. Alanları aşağıda.
vehiclenesneEvetAraç. Alanları aşağıda.
notestringHayırTalep notu. Metin, en fazla 1000 karakter.

policyholder:

AlanTipZorunluKural
identityTypeenumEvetKimlik türü: yalnızca TCKN.
identityNumberstringEvetTC kimlik numarası.
birthDatestringEvetDoğum tarihi, YYYY-MM-DD; gelecekte olamaz.
emailstringEvetE-posta adresi.
phonestringEvetTelefon, E.164.

vehicle:

AlanTipZorunluKural
platestringEvetTürkiye plakası; boşluksuz, büyük harf.
registrationDocumentnesneEvetRuhsat (araç tescil belgesi): serial (1-4 büyük harf) ve number (4-10 hane, metin); ikisi de zorunlu.

Örnek:

{
  "insuranceType": "MOTOR_COMPREHENSIVE",
  "policyholder": {
    "identityType": "TCKN",
    "identityNumber": "<kimlik numarası>",
    "birthDate": "<YYYY-MM-DD>",
    "email": "<e-posta>",
    "phone": "<E.164 telefon>"
  },
  "vehicle": {
    "plate": "<plaka>",
    "registrationDocument": {
      "serial": "<seri kodu>",
      "number": "<ruhsat numarası>"
    }
  },
  "note": "<talep notu>"
}

CARGO_TRANSIT: talep şeması sürüm 1

Karayolu yük taşıma (nakliyat) sigortası talebi. Tip nesnesi shipment tek bir seferdir; vehicle taşıyan araçtır.

AlanTipZorunluKural
policyholdernesneEvetTalep sahibi: yetkili kişi. Alanları trafik ve kasko talebiyle aynıdır: yukarıda.
companynesneHayırTalebi açan firmanın vergi kimliği. Alanları aşağıda.
shipmentnesneEvetSefer. Alanları aşağıda.
vehiclenesneEvetTaşıyan aracın plakası (plate) ve ruhsatı (registrationDocument). Alanları trafik ve kasko talebiyle aynıdır: yukarıda.
notestringHayırTalep notu. Metin, en fazla 1000 karakter.

company:

AlanTipZorunluKural
identityTypeenumEvetKimlik türü: yalnızca VKN.
identityNumberstringEvetVergi kimlik numarası: 10 hane, kontrol hanesi doğrulanır.

company gönderirseniz iki alanı da gönderin. Ticari unvan bu şemada yoktur; gönderilirse istek reddedilir.

shipment:

AlanTipZorunluKural
cargoDescriptionstringEvetTaşınan emtia. Metin, en fazla 500 karakter.
carrierVehicleenumEvetTaşıyan araç türü: TRUCK.
invoiceAmountintegerEvetEmtianın fatura bedeli, kuruş; en az 1.
consigneeNamestringEvetAlıcı firma. Metin, en fazla 200 karakter.
originCityCodestringEvetÇıkış ili, plaka kodu 01-81.
destinationCityCodestringEvetVarış ili, plaka kodu 01-81.
departureDatestringEvetSefer günü, YYYY-MM-DD.

Örnek:

{
  "insuranceType": "CARGO_TRANSIT",
  "policyholder": {
    "identityType": "TCKN",
    "identityNumber": "<kimlik numarası>",
    "birthDate": "<YYYY-MM-DD>",
    "email": "<e-posta>",
    "phone": "<E.164 telefon>"
  },
  "company": {
    "identityType": "VKN",
    "identityNumber": "<vergi kimlik numarası>"
  },
  "shipment": {
    "cargoDescription": "<emtia>",
    "carrierVehicle": "TRUCK",
    "invoiceAmount": 50000000,
    "consigneeName": "<alıcı firma>",
    "originCityCode": "34",
    "destinationCityCode": "06",
    "departureDate": "<YYYY-MM-DD>"
  },
  "vehicle": {
    "plate": "<plaka>",
    "registrationDocument": {
      "serial": "<seri kodu>",
      "number": "<ruhsat numarası>"
    }
  }
}

Doğrulama

  • Şemada olmayan her alan reddedilir. Sağlayıcının kendi alan adıyla gönderilen bir alan da şemada olmadığı için reddedilir.
  • Metin alanları kırpılır ve Unicode NFC'ye çevrilir. Boş metin, satır sonu gibi kontrol karakterleri ve "yok" gibi yer tutucu değerler kabul edilmez. Değer yoksa alanı göndermeyin.
  • Sayı alanları (tutar, kişi sayısı, koltuk sayısı, model yılı, garanti süresi, poliçe süresi, metrekare, kat sayısı, inşa yılı, boy, kilo, taksit sayısı) JSON sayısıdır; metin olarak gönderilen sayı kabul edilmez. Ruhsat numarası (registrationDocument.number) ve UAVT adres kodu (uavtAddressCode) ise metindir.
  • Bütün ihlaller tek bir hata yanıtında toplanır. Her ihlal alanın yolunu taşır, örneğin tickets[0].departureAt, stay.checkOutDate, vehicle.registrationDocument.number, property.lienholder.bankCode ya da insured[1].identityNumber. Gönderdiğiniz değer hata yanıtına yazılmaz.
  • Şema doğrulamasından sonra referans kodlarının varlığı, tipin sizin hesabınızda açık olması ve sepetle tutarlılık ayrıca kontrol edilir.