--- title: "Carrier" url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/Carrier" --- > Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md # Carrier ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: Policy Service version: 0.0.21 servers: - url: https://uat.api.zinnia.io components: schemas: Url: type: object properties: website: type: string description: Carrier or Third party administrator website example: https://zinnialive.com/ carrierLogin: type: string description: Carrier login example: https://zinnialive.com/ agentLogin: type: string description: Agent login example: https://zinnialive.com/ customerLogin: type: string description: Customer login example: https://wellabe.mypolicyview.com/ EntityType: type: string enum: - SOLEPROPRIETORSHIP - GENERALPARTNERSHIP - LIMITEDPARTNERSHIP - CCORPORATION - SCORPORATION - LIMITEDLIABILITYCOMPANY - CHARITABLEORGANIZATION - ESTATE - TRUST - CORPORATION - UNKNOWN CommunicationType: type: string enum: - EMAIL - REGULARMAIL - PHONE - FAX - TEXT - NOPREFERENCESPECIFIED - POSTAL - OTHER FormerOrganizationName: type: object properties: name: type: string description: Former legal name of the Organization example: Karen Anne Bates abbreviatedName: type: string description: The former shortened/abbreviated version of the organization`s name that is unique to the organization example: TBD doingBusinessAs: type: string description: The former name the organization is commonly known as example: TBD Identification: type: object properties: identificationId: type: string description: A unique system-generated ID for tracking individual identifier records example: "1" startDate: type: string description: The date from which the party`s identifier is considered valid. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date endDate: type: string description: The date after which the party`s identifier is no longer valid. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date identificationType: type: string enum: - PASSPORT - STATEPHOTOID - DRIVERLICENSENUMBER - SSN - TIN - EXTERNAL - EIN - NATIONALPRODUCERNUMBER - OTHER description: Specifies the kind of identifier provided for a party. It describes what type of document or number is being used to recognize or verify the party's identity nullable: true identificationKey: type: string example: 666-50-8548 description: A unique code (such as ECN, Life Party ID, or Series Code) used to uniquely identify and manage individuals, entities, or product groupings within life insurance and annuity systems identificationValue: type: string example: 666-50-8548 description: The unique number of the selected identification type nullable: true identificationDescription: type: string example: Employee Control Number description: A brief description of the identifier. issueState: type: string enum: - AA - AE - AL - AP - AK - AZ - AR - AS - CA - CO - CT - DC - DE - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MP - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UM - UT - VT - VA - VI - WA - WV - WI - WY nullable: true issueCountry: type: string enum: - US - CA - RU - EG - ZA - GR - NL - BE - FR - ES - HU - IT - RO - CH - AT - GB - DK - SE - NO - PL - DE - PE - MX - CU - AR - BR - CL - CO - VE - MY - AU - ID - PH - NZ - SG - TH - JP - VN - CN - TR - IN - PK - AF - LK - IR - MA - DZ - TN - LY - GM - SN - MR - ML - GN - BF - NE - TG - BJ - MU - LR - SL - GH - NG - CF - TD - CM - CV - ST - GQ - GA - BS - AO - BB - AX - SD - RW - ET - SO - DJ - KE - TZ - UG - BI - MZ - ZM - MG - RE - ZW - NA - MW - LS - BW - AG - KM - GW - CD - VG - SH - AW - FO - GL - KY - GI - PT - LU - IE - IS - AL - MT - CY - FI - BG - GG - LT - LV - EE - MD - AM - BY - AD - SM - UA - HR - SI - BA - MK - XK - CZ - SK - LI - BM - GD - FK - BZ - GT - SV - HN - NI - CR - PM - HT - PR - VI - GS - SX - BQ - GP - BO - GY - EC - GF - PY - MQ - SR - UY - AN - TC - BL - MF - MS - GU - AQ - BN - NR - PG - TO - SB - VU - FJ - WF - CK - NU - AS - KI - NC - TV - PF - MP - PW - MH - FM - SS - LC - DM - VC - DO - HK - MO - KH - LA - TT - KN - JM - BD - TW - MM - KR - KP - LB - JO - SY - IQ - KW - SA - OM - AE - IL - BH - QA - BT - NP - TJ - TM - AZ - GE - UZ - AI - PA - CI - ER - KZ - KG - CC - MN - BV - SC - IO - WS - TL - TF - YT - PN - SJ - TK - UM - EH - MV - CX - NF - CG - MC - VA - SZ - PS - JE - IM - RS - ME - HM - CW - CS - YE - YD - SU - YU - ZR nullable: true Address: type: object properties: startDate: type: string description: The start date of the party address. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 endDate: type: string description: The end date of the party address. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 addressType: $ref: "#/components/schemas/AddressType" addressLine1: type: string description: Address Line 1 of the party address example: 1112 Pickle Street addressLine2: type: string description: Address Line 2 of the party address example: South Jersey addressLine3: type: string description: Address Line 3 of the party address example: 1234 Post box city: type: string description: City of the party address example: Garden City state: $ref: "#/components/schemas/State" zipCode: type: string description: Zip code of the party address example: "67846" zipCodeExtension: type: string description: Unit of the party address example: "23" country: $ref: "#/components/schemas/Country" isPreferred: type: boolean description: TBD addressId: type: string description: The record Id stored internally in zahara for each address example: "1" preferredAddress: type: boolean description: TBD example: false Phone: type: object properties: startDate: type: string description: The start date of when the party can be reached via the phone.Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date endDate: type: string description: The end date of when the party can be reached via the phone. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date phoneType: $ref: "#/components/schemas/PhoneType" countryCode: type: string description: Country Code of the phone example: "9" areaCode: type: string description: Area code of the phone example: "973" dialNumber: type: string description: Dial number of the phone example: "765789" extension: type: string description: Dial in Extension for phone example: "null" bestTime: type: string description: The best time to contact the party via phone example: "null" timezone: type: string description: Timezone for the entered phone details example: "null" isPreferred: type: boolean description: The Preferred Phone Indicator is a boolean flag or attribute assigned to each phone number associated with a party, used to identify which phone number should be used as the primary contact number for communication phoneId: type: string description: The record Id stored internally in zahara for each phone example: "1" Email: type: object properties: startDate: type: string description: The start date of when the party can be reached via email.Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date endDate: type: string description: The end date of when the party can be reached via email. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date emailType: $ref: "#/components/schemas/EmailType" emailAddress: type: string description: Email address of the party example: user@example.com isPreferred: type: boolean description: The Preferred Email Indicator is a boolean flag associated with each email address linked to a party, used to designate which email address should be treated as the primary contact for electronic communications emailId: type: string description: The record Id stored internally in zahara for each email example: "1" BusinessSchedule: type: object properties: businessHourStart: type: string format: time example: 14:00:00Z description: Business Hour Start refers to the official start time of daily business operations for a specific organization, carrier, or department. In insurance and annuity systems, this value is often used to define operational cutoffs, processing schedules, customer service availability, and automated job executions businessHourEnd: type: string format: time description: Business Hour End refers to the official end time of daily business operations for a specific organization, carrier, or department. It defines the cutoff point for processing transactions, handling customer service requests, and running operational workflows on a given business day example: 20:00:00Z businessDays: type: array description: Business Days refer to the official working days of the week during which business operations, transaction processing, and customer services are conducted. In insurance and annuity systems, business days determine when policies are processed, disbursements are executed, and service-level agreements (SLAs) are measured items: type: string enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY budgetCenter: type: string description: Budget Center refers to a defined organizational unit within a company that is allocated a portion of the company’s overall budget and is responsible for tracking, managing, and controlling financial expenditures. In the context of insurance and annuity operations, a budget center is often linked to departments such as underwriting, claims, operations, or IT example: Everglades BankAccount: type: object properties: startDate: type: string description: Date the Bank Account of the Party was added to the Policy. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date endDate: type: string description: Date the Bank Account of the Party was terminated from the Policy. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date nameOnAccount: type: string description: Name of the Party on Bank Account example: abcdqwe accountStatus: $ref: "#/components/schemas/AccountStatus" accountType: $ref: "#/components/schemas/AccountType" bankAccountPurpose: $ref: "#/components/schemas/BankAccountPurpose" accountNumber: type: string description: The 7+ digit checking or savings account number example: "34567777745678" routingNumber: type: string description: The 9-digit routing transit number for the bank account/branch example: "123456789" internationalBankAccountNumber: type: string description: The bank account number for an international bank account (this field does not have check-digit validation) example: ibanNumber_66 branchName: type: string description: The name of the bank (such as Chase Manhattan) example: branch_66 branchPhoneNumber: type: string description: Phone Number of the Bank Branch example: "7766667777" branchAddress: $ref: "#/components/schemas/BranchAddress" bankId: type: string description: In the context of ACORD standards (the global data standards body for insurance), Bank ID refers to a unique identifier used to specify a financial institution involved in a disbursement, premium collection, or electronic funds transfer (EFT). It is critical for ensuring correct routing of payments or deposits between insurers, policyholders, beneficiaries, and third parties example: "1" appliesToPartyId: type: string example: Party_PI_1 description: This unique id ties to the Party Role that the bank details correspondes to. AddressType: type: string enum: - RESIDENCE - BUSINESS - POBOX - SEASONAL - SECONDARY - MAILING State: type: string enum: - AA - AE - AL - AP - AK - AZ - AR - AS - CA - CO - CT - DC - DE - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MP - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UM - UT - VT - VA - VI - WA - WV - WI - WY Country: type: string enum: - US - CA - RU - EG - ZA - GR - NL - BE - FR - ES - HU - IT - RO - CH - AT - GB - DK - SE - NO - PL - DE - PE - MX - CU - AR - BR - CL - CO - VE - MY - AU - ID - PH - NZ - SG - TH - JP - VN - CN - TR - IN - PK - AF - LK - IR - MA - DZ - TN - LY - GM - SN - MR - ML - GN - BF - NE - TG - BJ - MU - LR - SL - GH - NG - CF - TD - CM - CV - ST - GQ - GA - BS - AO - BB - AX - SD - RW - ET - SO - DJ - KE - TZ - UG - BI - MZ - ZM - MG - RE - ZW - NA - MW - LS - BW - AG - KM - GW - CD - VG - SH - AW - FO - GL - KY - GI - PT - LU - IE - IS - AL - MT - CY - FI - BG - GG - LT - LV - EE - MD - AM - BY - AD - SM - UA - HR - SI - BA - MK - XK - CZ - SK - LI - BM - GD - FK - BZ - GT - SV - HN - NI - CR - PM - HT - PR - VI - GS - SX - BQ - GP - BO - GY - EC - GF - PY - MQ - SR - UY - AN - TC - BL - MF - MS - GU - AQ - BN - NR - PG - TO - SB - VU - FJ - WF - CK - NU - AS - KI - NC - TV - PF - MP - PW - MH - FM - SS - LC - DM - VC - DO - HK - MO - KH - LA - TT - KN - JM - BD - TW - MM - KR - KP - LB - JO - SY - IQ - KW - SA - OM - AE - IL - BH - QA - BT - NP - TJ - TM - AZ - GE - UZ - AI - PA - CI - ER - KZ - KG - CC - MN - BV - SC - IO - WS - TL - TF - YT - PN - SJ - TK - UM - EH - MV - CX - NF - CG - MC - VA - SZ - PS - JE - IM - RS - ME - HM - CW - CS - YE - YD - SU - YU - ZR PhoneType: type: string enum: - MOBILE - HOME - BUSINESS - CLAIMCENTER - CUSTOMERSERVICE - CORPORATEOFFICE - FAX - UNKNOWN - OTHER EmailType: type: string enum: - PERSONAL - BUSINESS - CUSTOMERSERVICE - OTHER AccountStatus: type: string enum: - ACTIVEBANKACCOUNT - TERMINATEDBANKACCOUNT AccountType: type: string enum: - CHECKING - SAVINGS - CREDITCARD - DEBITCARD - BROKERAGEACCOUNT - CERTIFICATEOFDEPOSIT - WIRE BankAccountPurpose: type: string enum: - LOANINTERESTBILLING - DISBURSEMENTS - LOANPRINCIPALBILLING - PREMIUMBILLING - ONETIMEPREMIUMBILLING - PAYOUT - ONETIMEWIRE BranchAddress: type: object properties: addressType: $ref: "#/components/schemas/AddressType" addressLine1: type: string example: 1112 Pickle Street description: Address line 1 of the Bank addressLine2: type: string example: South Jersey description: Address line 2 of the Bank addressLine3: type: string example: 1234 Post box description: Address Line 3 of the bank city: type: string example: Garden City description: City of the bank address state: $ref: "#/components/schemas/State" zipCode: type: string example: "67846" description: Zip code of the bank address zipCodeExtension: type: string example: "23" description: Unit of the bank address country: $ref: "#/components/schemas/Country" Carrier: type: object properties: timestamp: type: string format: date-time description: TBD example: 2023-01-01T12:00:00.000Z partyId: type: string description: Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions example: ffae327c5ba748259fe426dd1bad5e9f partyType: type: string description: Defines Party type example individual or Organization or Trust. For Insured and Annuitant this should always be Individual example: Organization url: $ref: "#/components/schemas/Url" name: type: string description: The legal name of the Organization example: Everglades Insurance Company doingBusinessAs: type: string description: The name the organization is commonly known as example: Everglades Life abbreviatedName: type: string description: The shortened/abbreviated version of the organization's name that is unique to the organization example: EVGL organizationCode: type: string description: Code to Identify organization example: "110" entityType: $ref: "#/components/schemas/EntityType" preferredCommunicationType: $ref: "#/components/schemas/CommunicationType" preferredAddressIndicator: type: string description: Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section example: "1" formerName: $ref: "#/components/schemas/FormerOrganizationName" identifications: type: array items: $ref: "#/components/schemas/Identification" addresses: type: array items: $ref: "#/components/schemas/Address" phones: type: array items: $ref: "#/components/schemas/Phone" emails: type: array items: $ref: "#/components/schemas/Email" carrierId: type: string description: The Carrier ID is a unique identifier assigned to an insurance company (carrier) that issues and underwrites a policy. It helps track, manage, and differentiate insurance providers within industry databases, regulatory systems, and digital platforms example: EVGL parentCompanyId: type: string description: Ultimate Parent Company ID refers to the unique identifier assigned to the top-most legal entity or corporate parent in an organizational hierarchy. In insurance and annuity systems, this ID is used to link a subsidiary, affiliate, or operational entity to its controlling parent company, ensuring clarity in ownership, regulatory reporting, and financial consolidation example: EVGLBP organizationPurposeSystemOfRecord: type: string description: In the context of a System of Record (SOR) in insurance and annuity systems, Organization Purpose refers to the role the organization plays in relation to the policy or contract. Specifically, terms like Processing and Holding define how the organization interacts with the policy data, assets, or transactions example: PROCESSING generalAccountBusinessUnit: type: string description: General Account Business Unit refers to the organizational or legal entity within an insurance company responsible for managing assets and liabilities held in the general account. This unit is accountable for all financial activities related to non-segregated (non-variable) insurance products where the carrier assumes investment risk example: "158" separateAccountBusinessUnit: type: string description: Separate Account Business Unit refers to the organizational or legal entity within an insurance company responsible for managing products and assets that are legally segregated from the general account. This unit specifically handles variable or investment-linked products, where the policyholder assumes the investment risk, and assets are maintained in separate investment pools example: TBD setId: type: string description: Carrier SET ID refers to a unique identifier used within insurance systems to represent a specific insurance carrier`s data set across policy administration, disbursement, and accounting platforms. It groups together all configuration, accounting rules, product definitions, and ledger mappings that apply to a particular carrier or legal entity example: EVGLCOC bankCompanyId: type: string description: Bank Company ID is a unique identifier assigned to an insurance company or business entity by its bank for electronic funds transfers (EFT), such as ACH (Automated Clearing House) transactions. It is used primarily to identify the originator of payments in financial networks and helps receiving banks verify the legitimacy of transactions example: "3480409770" accountsPayableBusinessUnit: type: string description: AP Business Unit (Accounts Payable Business Unit) refers to the distinct organizational or legal entity within an insurance company responsible for processing, approving, and recording outgoing payments, such as claims, policy loans, commissions, refunds, or vendor invoices example: Everglades businessSchedule: $ref: "#/components/schemas/BusinessSchedule" emailSendingDomain: type: string description: The domain used for sending emails on behalf of the carrier example: example.com depositoryAccount: $ref: "#/components/schemas/BankAccount" depositoryAccounts: type: array items: $ref: "#/components/schemas/BankAccount" controlledDisbursementAccount: $ref: "#/components/schemas/BankAccount" controlledDisbursementAccounts: type: array items: $ref: "#/components/schemas/BankAccount" carrierCode: type: string description: TBD version: type: integer format: int32 ```