--- title: "Roles" url: "https://developers.zinnia.com/apis/new-business-annuity/versions/45a989ab-c3aa-4f85-8f67-f05c41747ed7/schemas/Roles" --- > Full API specification: https://developers.zinnia.com/apis/new-business-annuity/versions/45a989ab-c3aa-4f85-8f67-f05c41747ed7.md # Roles ## OpenAPI definition ```yaml openapi: 3.1.0 info: title: Zinnia New Business Annuity API version: 0.6.0 servers: - url: https://qa.api.zinnia.io description: QA Environment - url: https://dev.api.zinnia.io description: DEV Environment - url: https://uat.api.zinnia.io description: UAT Environment - url: https://api.zinnia.io description: PROD Environment components: schemas: Phones: type: object required: - phoneType - countryCode - areaCode - number properties: phoneType: type: string description: This filed capture the type of phone like Home Phone, Work Phone enum: - BF - BP - CP - H2 - HF - HP - MD countryCode: type: string description: Two digit country code areaCode: type: string description: This field stores the telephone Area Code of client address number: type: string description: This field stores the phone number. extension: type: string description: This field stores the Extension number Addresses: type: object required: - addressType - addressLine1 - city - state - zip - country properties: addressType: type: string required: - addressType enum: - B - H - S addressLine1: type: string description: Address Line 1 addressLine2: type: string description: Address Line 2 addressLine3: type: string description: Address Line 3 city: type: string description: City Name state: type: string enum: - AA - AE - AK - AL - AP - AR - AZ - CA - CD - CO - CT - DC - DE - FL - FN - GA - GU - HI - IA - ID - IL - IN - KS - KY - LA - MA - MD - ME - MI - MN - MO - MS - MT - NC - ND - NE - NH - NJ - NM - NV - NY - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UT - VA - VI - VT - WA - WI - WV - WY description: 2 digit state code zip: type: string description: ZIP code zipSuffix: type: string description: ZIP code suffix country: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BM - BN - BO - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CS - CU - CV - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IN - IO - IQ - IR - IS - IT - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - NO - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PT - PW - PY - QA - RE - RO - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - ST - SU - SV - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - USA - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - YE - YT - YU - ZA - ZM - ZR - ZW description: Country codes Email: type: object properties: emailId: type: string format: email description: Email address of associated party example: abc@zinnia.com emailType: type: string enum: - BUSINESS - PERSONAL description: This field captures the type of email address like business or personal email. BankInfo: type: object required: - bankName - abaNumber - accountNumber - bankingType properties: bankName: type: string description: Bank name abaNumber: type: string description: ABA number accountNumber: type: string description: Account Number bankingType: type: string Roles: type: object required: - roleType - roleOption - naturalNameIndicator - nameType - lastName - dob - sex - phones - addresses - eDelivery properties: roleType: type: string enum: - "38" - "36" - "0" - "-1" - "-2" - "-3" - "-4" - "-5" - "-6" - "-7" - "-8" - "-9" - "-10" - "-11" - "-12" - "-13" - "-14" - "-15" - "-16" - "-17" - "-18" - "-19" - "-20" - "-21" - "-22" - "-23" - "-24" - "-25" - "-26" - "-50" - "-51" - "-60" - "-70" - "-71" - "-72" - "-80" - "-81" - "-82" - "-83" - "-84" - "-85" - "-86" - "-87" - "-88" - "-89" - "-90" - "-91" - "-999" description: Role type example: "0" roleOption: type: string description: Role Option associated with the respective Role Type enum: - "-6" - "-5" - "-1" - "0" - "1" - "2" - "3" - "4" - "5" - "6" - "7" naturalNameIndicator: type: string enum: - Y - N nameType: type: string enum: - CO - IN - OT - TR - UG firstName: type: string description: First name of the party role example: firstName when name type is Natural/Individual middleName: type: string description: Moddle name of the party role example: B lastName: type: string description: Last name of the party role example: Doe prefix: type: string description: Prefix example: Dr suffix: type: string description: Suffix example: Sr dob: type: string format: date description: Date of birth of party role. Applicable in case of Individual. (with pattern "yyyy-mm-dd"). Regex Expression ^\d{4}-((0\d)|(1[012]))-(([012]\d)|3[01])$. example: 2023-12-19 sex: type: string enum: - M - F - O description: Any one of the possible value for the gender. taxId: type: string pattern: \d{9} description: 9 digit Social Security number example: "123456789" minLength: 9 maxLength: 9 crdNumber: type: string example: when party is an agent and one of the agent specific identifier in MCS is mandatory description: CRD number for the party role, used as Agent Identifier. nationalProducerNumber: type: string example: when party is an agent and one of the agent specific identifier in MCS is mandatory description: NPN number for the agent, used as Agent Identifier. distributorAgentAssignedId: type: string example: when party is an agent and one of the agent specific identifier in MCS is mandatory description: Distributor assigned Id for an agent, used as Agent Identifier. carrierAgentAssignedId: type: string example: when party is an agent and one of the agent specific identifier in MCS is mandatory description: Internal identifier assigned to the agent by carrier, used as Agent Identifier. externalId: type: string example: when party is an agent and one of the agent specific identifier in MCS is mandatory description: Unique number assigned by the MCS system, used as Agent Identifier. phones: type: array items: $ref: "#/components/schemas/Phones" relationship: type: string enum: - "-999" - "1" - "2" - "3" - "4" - "5" - "6" - "7" - "8" - "9" - "10" - "11" - "12" - "13" - "14" - "15" - "16" - "17" - "18" - "19" - "20" - "21" - "22" - "23" - "24" - "25" - "100" - "101" - "102" - "103" - "104" - "105" - "106" description: Relationship code addresses: type: array items: $ref: "#/components/schemas/Addresses" trustType: type: string example: "1" enum: - "1" - "2" description: Type of trust & TrustType is required when the role is a trust eDelivery: type: string description: eDelivery is required/not for the role enum: - Y - N emails: type: array description: Email for associated party, email is required when eDelivery is 'Y'. items: $ref: "#/components/schemas/Email" bankInformation: $ref: "#/components/schemas/BankInfo" dod: type: string description: Date of Death. (with pattern "yyyy-mm-dd"). Regex Expression ^\d{4}-((0\d)|(1[012]))-(([012]\d)|3[01])$. ```