--- title: "Party" url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/schemas/Party" --- > Full API specification: https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84.md # Party ## OpenAPI definition ```yaml openapi: 3.1.0 info: title: Zinnia Policy Transactions API. version: 1.0.8 servers: - url: https://dev.api.zinnia.io description: DEV Environment - url: https://qa.api.zinnia.io description: QA Environment components: schemas: 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 - YE - 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 - CW - CG - MC - VA - SZ - PS - JE - IM - RS - ME - HM description: Abbreviated names for countries State: type: string example: AL enum: - AL - AK - AZ - AR - CA - CO - CT - DC - DE - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY description: Abbreviated names for states FormerName: allOf: - $ref: "#/components/schemas/PartyName" Identification: type: object properties: identificationType: type: string enum: - PASSPORT - STATEPHOTOID - DRIVERSLICENSENUMBER - SOCIALSECURITYNUMBER - TAXPAYERIDENTIFICATIONNUMBER - OTHER description: The suffix of the party party name identificationValue: type: string issueState: $ref: "#/components/schemas/State" issueCountry: $ref: "#/components/schemas/Country" Address: type: object properties: startDate: type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: Date (with pattern "yyyy-mm-dd") endDate: type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: Date (with pattern "yyyy-mm-dd") addressType: type: string enum: - RESIDENCE - BUSINESS - POBOX - SEASONAL - OTHER description: Address type addressLine1: type: string example: 1112 Pickle Street description: First line of address addressLine2: type: string example: South Jersey description: Second line of address addressLine3: type: string example: 1234 Post box description: Third line of address city: type: string example: Houston description: Name of the city state: $ref: "#/components/schemas/State" zipCode: type: string example: "66636" description: zip code zipCodeExtension: type: string example: "1232" description: zip code extension country: $ref: "#/components/schemas/Country" Phone: type: object properties: startDate: type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: Date (with pattern "yyyy-mm-dd") endDate: type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: Date (with pattern "yyyy-mm-dd") phoneType: type: string enum: - MOBILE - HOME - BUSINESS - CLAIMCENTER - CUSTOMERSERVICE - CORPORATEOFFICE - FAX - OTHER description: Phone type countryCode: type: string example: "011" description: Country code areaCode: type: string example: "973" description: Area code dialNumber: type: string example: "765789" description: Dial number extension: type: string example: "131312" description: Extension bestTime: type: string example: "131312" description: Best time timezone: type: string example: "131312" description: Timezone for the entered phone details Email: type: object properties: startDate: type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: Date (with pattern "yyyy-mm-dd") endDate: type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: Date (with pattern "yyyy-mm-dd").If provided by the user, the system will apply an end date to the emailaddress, ensuring that a new emailaddress is not generated. emailType: type: string enum: - PERSONAL - BUSINESS - CUSTOMERSERVICE - OTHER description: Email type emailAddress: type: string example: will.smith@gmail.com description: Type of the email. PERSONAL for personal emails, BUSINESS for business emails, CUSTOMERSERVICE for customer service emails, OTHER for any other type of emails. required: - startDate - emailType - emailAddress BankAccount: type: object properties: startDate: type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: Date (with pattern "yyyy-mm-dd") endDate: type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: Date (with pattern "yyyy-mm-dd") nameOnAccount: type: string example: abcdqwe description: Name of the registered user accountStatus: type: string enum: - ACTIVEBANKACCOUNT - TERMINATEDBANKACCOUNT description: Account Status accountType: type: string enum: - CHECKING - SAVINGS - CREDITCARDACCOUNT - DEBITCARDACCOUNT - BROKERAGEACCOUNT - CERTIFICATEOFDEPOSITACCOUNT description: Account Type accountNumber: type: string example: "34567777745678" description: Account Number routingNumber: type: string example: Routing_Number description: Routing Number internationalBankAccountNumber: type: string example: ibaNumber_66 description: internationalBankAccountNumber branchName: type: string example: branch_66 description: branch name branchPhoneNumber: type: string example: "7766667777" description: Branch Phone Number branchAddress: $ref: "#/components/schemas/BranchAddress" BeneficiaryAllocation: type: object properties: partyPolicyId: type: string example: Party_OW_3 description: party policy id allocationPercentage: type: number format: double example: 10 description: TBD TaxWithholding: type: object properties: appliesToPartyId: type: string description: TBD example: Party_PI_1 taxWithholdingType: type: string enum: - FEDERAL - STATE - BACKUP - NRA description: TBD taxRateToUse: type: string enum: - NOWITHHOLDINGELECTED - USEVALUESENTERED - NOWITHHOLDINGALLOWED - USEDEFAULTTABLE description: TBD filingStatus: type: string enum: - SINGLE - DEFAULT - MARRIED description: TBD dollar: type: number format: double description: TBD example: 0 percentage: type: number format: double description: TBD example: 0 exemptions: type: string description: TBD example: TBD taxJurisdiction: type: string description: TBD, but applies only for PartyType - Owner,Payee example: USA_WY PartyName: type: object properties: firstName: type: string example: John description: First name middleName: type: string example: William description: Middle name lastName: type: string example: Doe description: Last Name fullName: type: string example: John William Doe description: Full Name prefix: type: string enum: - MR - MS - MISS - MRS description: Prefix Type suffix: type: string enum: - JR - SN - I - II - III description: Suffix Type doingBusinessAs: type: string example: TPA description: Doing Business As abbreviatedName: type: string example: AG description: Abbreviated Name BranchAddress: type: object properties: addressType: type: string enum: - RESIDENCE - BUSINESS - POBOX - SEASONAL - OTHER description: Address type addressLine1: type: string example: 1112 Pickle Street description: First line of address addressLine2: type: string example: South Jersey description: Second line of address addressLine3: type: string example: 1234 Post box description: Third line of address city: type: string example: Houston description: Name of the city state: type: string example: TX enum: - AL - AK - AZ - AR - CA - CO - CT - DC - DE - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY description: State zipCode: type: string example: "66636" description: Preferred address indicator zipCodeExtension: type: string example: "1232" description: zip code extension 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 - YE - 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 - CW - CG - MC - VA - SZ - PS - JE - IM - RS - ME - HM description: Preferred address indicator Party: type: object properties: startDate: type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: Date (with pattern "yyyy-mm-dd") endDate: type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: Date (with pattern "yyyy-mm-dd") partyId: type: string description: Party ID at Policy Level that comes in from External source (for Everly it will be Acord 103) example: Party_PB_Primary_Bene_1 partyType: type: string enum: - Individual - Organization description: Defines Party type example individual or Organization. For Insured this should always be Individual firstName: type: string description: The first name of the party example: Karen middleName: type: string description: The middle name of the party example: Anne lastName: type: string description: The last name of the party example: Bates fullName: type: string description: Fullname of the party. Available only when PartyType is Trust/Organization example: Karen Anne Bates prefix: type: string enum: - MR - MS - MISS - MRS description: The prefix of the party party name suffix: type: string enum: - JR - SN - I - II - III description: The suffix of the party party name gender: type: string enum: - MALE - FEMALE - UNISEX description: Party gender dateOfBirth: type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: Party date of birth (with pattern "yyyy-mm-dd") attainedAge: type: number format: int32 description: Party age calculated by Date of Birth example: 55 birthCountry: $ref: "#/components/schemas/Country" birthState: $ref: "#/components/schemas/State" doingBusinessAs: type: string description: The name the organization is commonly known as example: TBD abbreviatedName: type: string description: TBD example: TBD organizationCode: type: string description: Code to Identify organization example: TBD entityType: type: string enum: - SOLEPROPRIETORSHIP - GENERALPARTNERSHIP - LIMITEDPARTNERSHIP - CCORPORATION - SCORPORATION - LIMITEDLIABILITYCOMPANY - CHARITABLEORGANIZATION - ESTATE - TRUST - CORPORATION description: Type of Organization Structure (Partnership, corporation etc) trustDate: type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: The trust agreement issued date to the party trustTitle: type: string description: The title of the trustee example: TBD trustAccessCode: type: string description: Access code of the trustee example: TBD preferredCommunicationType: type: string enum: - EMAIL - MAIL - PHONE - FAX - TEXT - NONE - OTHER description: The preference of communication such as phone, email or mail text: type: string example: in-person or video call id https://company.us/j/1234567890 description: If type OTHER, then provide further info using text. preferredAddressIndicator: type: string enum: - YES - NO description: Indicates whether the address being added should be set as default or not. Yes - address being entered is default. formerName: $ref: "#/components/schemas/FormerName" 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" bankDetails: type: array items: $ref: "#/components/schemas/BankAccount" beneficiaryAllocations: type: array items: $ref: "#/components/schemas/BeneficiaryAllocation" taxWithholdings: type: array items: $ref: "#/components/schemas/TaxWithholding" ```