--- title: "ThirdPartyAdministrator" url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/ThirdPartyAdministrator" --- > Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md # ThirdPartyAdministrator ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: Policy Service version: 0.0.21 servers: - url: https://qa.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" 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 ThirdPartyAdministrator: 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 customerId: type: string description: Assigned by Sales Force and used by all platforms example: TBD 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: TBD example: Zinnia doingBusinessAs: type: string description: The name the organization is commonly known as example: TBD 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: "12345678" 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" 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: TBD 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 version: type: integer description: TBD format: int32 ```