Search
K
Policy

PartyPatchRequestPartyUpdate

object
actionstring

Allowed values:ADDUPDATEDELETE

partyRolestring

Allowed values:PayeePrimaryBeneficiaryContingentBeneficiary

customerIdstring

Assigned by Sales Force and used by all platforms(for Everly). Especially for United web.

Example:0017b000010N4bCAAS

relationshipToPartystring

The type of relationship to the party

Allowed values:TRUSTEETRUSTEEOFMINORTRUSTEEOFINCOMPETENTPOWEROFATTORNEYCONTROLLINGPERSONOFENTITYBROTHERCHILDDAUGHTERDOMESTICPARTNEREXECUTORSFATHERFIANCEGRANDCHILDLIFEPARTNERMOTHERSISTERSONSPOUSESTEPFATHERSTEPMOTHERSELFLEGALGUARDIANBUSINESSBUSINESSASSOCIATEPARTNEREMPLOYERFORMERSPOUSEGRANDPARENTPARENTOWNERSIBLINGSTEPCHILDSTEPARENTOTHERAUNTGRANDFATHERGRANDMOTHERHUSBANDWIFEUNCLENIECENEPHEWESTATETRUSTGRANDSONGRANDDAUGHTERNONSPOUSECHILDRENEQUALLYCHILDRENPERSTIRPESPERSTIRPESSURVIVINGSPOUS

partyobject
Show Child Parameters
Example
{
  "action": "ADD",
  "partyRole": "Payee",
  "customerId": "0017b000010N4bCAAS",
  "relationshipToParty": "TRUSTEE",
  "party": {
    "partyType": "INDIVIDUAL",
    "partyRoleId": "partyRoleId",
    "parentPartyId": "1",
    "beneficiaryPercentage": 100,
    "agentPercentage": 100,
    "agentExternalId": "3160000751",
    "agentType": "ACCOUNTMANAGER",
    "firstName": "Karen",
    "middleName": "Anne",
    "lastName": "Bates",
    "fullName": "Karen Anne Bates",
    "prefix": "MR",
    "suffix": "JR",
    "gender": "MALE",
    "dateOfBirth": "2023-01-01",
    "genderIdentity": "TBD",
    "attainedAge": 55,
    "birthCountry": "US",
    "citizenCountry": "US",
    "birthState": "AA",
    "doingBusinessAs": "TBD",
    "abbreviatedName": "TBD",
    "organizationCode": "TBD",
    "entityType": "SOLEPROPRIETORSHIP",
    "trustDate": "2023-01-01",
    "amendedTrustDate": "2023-01-01",
    "governingStateOfTrust": "AA",
    "trustType": "INDIVIDUALTRUST",
    "trustTitle": "TBD",
    "trustAccessCode": "TBD",
    "preferredCommunicationType": "EMAIL",
    "preferredAddressIndicator": "1",
    "preferredAddressId": "1",
    "preferredEmailId": "1",
    "preferredPhoneId": "1",
    "partyPercentage": 12.1213,
    "formerName": {
      "firstName": "Karen",
      "middleName": "Anne",
      "lastName": "Bates",
      "prefix": "MR",
      "suffix": "JR",
      "fullName": "Karen Anne Bates",
      "abbreviatedName": "TBD",
      "doingBusinessAs": "TBD"
    },
    "identifications": [
      {
        "identificationId": "1",
        "startDate": "2023-01-01",
        "endDate": "2023-01-01",
        "identificationType": "PASSPORT",
        "identificationKey": "666-50-8548",
        "identificationValue": "666-50-8548",
        "identificationDescription": "Employee Control Number",
        "issueState": "AA",
        "issueCountry": "US"
      }
    ],
    "taxWithholdings": [
      {
        "appliesToPartyId": "Party_PI_1",
        "taxWithholdingType": "FEDERAL",
        "taxRateToUse": "NOWITHHOLDINGELECTED",
        "filingStatus": "SINGLE",
        "dollar": 0,
        "percentage": 0,
        "exemptions": 0,
        "taxJurisdiction": "USA_WY",
        "contribution": "NOTAPPLICABLE",
        "taxFormType": "T1035COSTBASIS",
        "w4p": {
          "totalAmountOfOtherIncomeAndOtherPensionsOrAnnuities": 12.12,
          "totalAmountOfClaimsAndOtherCredits": 213.73,
          "otherIncome": 144.53,
          "otherDeduction": 42.83
        }
      }
    ],
    "partyStatus": "APPROVED",
    "isPartyBeneficiaryNonNatural": true,
    "isIrrevocable": true,
    "isRequiredMinimumDistributionDesignated": true,
    "lastContactDate": "2023-01-01",
    "beneficiaryShareMethod": "PERSTIRPESDISTRIBUTION",
    "addresses": [
      {
        "startDate": "2023-01-01",
        "endDate": "2023-01-01",
        "addressType": "RESIDENCE",
        "addressLine1": "1112 Pickle Street",
        "addressLine2": "South Jersey",
        "addressLine3": "1234 Post box",
        "city": "Garden City",
        "state": "AA",
        "zipCode": "67846",
        "zipCodeExtension": "23",
        "country": "US",
        "isPreferred": true
      }
    ],
    "phones": [
      {
        "startDate": "2023-01-01",
        "endDate": "2023-01-01",
        "phoneType": "MOBILE",
        "countryCode": "9",
        "areaCode": "973",
        "dialNumber": "765789",
        "extension": "null",
        "bestTime": "null",
        "timezone": "null",
        "isPreferred": true
      }
    ],
    "emails": [
      {
        "startDate": "2023-01-01",
        "endDate": "2023-01-01",
        "emailType": "PERSONAL",
        "emailAddress": "will.smith@gmail.com",
        "isPreferred": true
      }
    ],
    "bankDetails": [
      {
        "startDate": "2023-01-01",
        "endDate": "2023-01-01",
        "nameOnAccount": "abcdqwe",
        "accountStatus": "ACTIVEBANKACCOUNT",
        "accountType": "CHECKING",
        "bankAccountPurpose": "LOANINTERESTBILLING",
        "accountNumber": "34567777745678",
        "routingNumber": "123456789",
        "internationalBankAccountNumber": "ibanNumber_66",
        "branchName": "branch_66",
        "branchPhoneNumber": "7766667777",
        "branchAddress": {
          "addressType": "RESIDENCE",
          "addressLine1": "1112 Pickle Street",
          "addressLine2": "South Jersey",
          "addressLine3": "1234 Post box",
          "city": "Garden City",
          "state": "AA",
          "zipCode": "67846",
          "zipCodeExtension": "23",
          "country": "US"
        }
      }
    ],
    "startDate": "2023-01-01",
    "endDate": "2023-01-01",
    "beneficiaryAllocation": [
      {
        "partyPolicyId": "partyPolicyId",
        "allocationPercentage": 0
      }
    ],
    "partyAllocation": [
      {
        "partyPolicyId": "partyPolicyId",
        "allocationPercentage": 0
      }
    ]
  }
}

PartyPatchRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d

effectiveDatestring(date)

Date the Party was added to the Policy

Example:2023-01-01

partyUpdatesarray[object]
Show Child Parameters
Example
{
  "correlationId": "5df63b47-54fc-4905-a8ff-e1c5f12e667d",
  "effectiveDate": "2023-01-01",
  "partyUpdates": [
    {
      "action": "ADD",
      "partyRole": "Payee",
      "customerId": "0017b000010N4bCAAS",
      "relationshipToParty": "TRUSTEE",
      "party": {
        "partyType": "INDIVIDUAL",
        "partyRoleId": "partyRoleId",
        "parentPartyId": "1",
        "beneficiaryPercentage": 100,
        "agentPercentage": 100,
        "agentExternalId": "3160000751",
        "agentType": "ACCOUNTMANAGER",
        "firstName": "Karen",
        "middleName": "Anne",
        "lastName": "Bates",
        "fullName": "Karen Anne Bates",
        "prefix": "MR",
        "suffix": "JR",
        "gender": "MALE",
        "dateOfBirth": "2023-01-01",
        "genderIdentity": "TBD",
        "attainedAge": 55,
        "birthCountry": "US",
        "citizenCountry": "US",
        "birthState": "AA",
        "doingBusinessAs": "TBD",
        "abbreviatedName": "TBD",
        "organizationCode": "TBD",
        "entityType": "SOLEPROPRIETORSHIP",
        "trustDate": "2023-01-01",
        "amendedTrustDate": "2023-01-01",
        "governingStateOfTrust": "AA",
        "trustType": "INDIVIDUALTRUST",
        "trustTitle": "TBD",
        "trustAccessCode": "TBD",
        "preferredCommunicationType": "EMAIL",
        "preferredAddressIndicator": "1",
        "preferredAddressId": "1",
        "preferredEmailId": "1",
        "preferredPhoneId": "1",
        "partyPercentage": 12.1213,
        "formerName": {
          "firstName": "Karen",
          "middleName": "Anne",
          "lastName": "Bates",
          "prefix": "MR",
          "suffix": "JR",
          "fullName": "Karen Anne Bates",
          "abbreviatedName": "TBD",
          "doingBusinessAs": "TBD"
        },
        "identifications": [
          {
            "identificationId": "1",
            "startDate": "2023-01-01",
            "endDate": "2023-01-01",
            "identificationType": "PASSPORT",
            "identificationKey": "666-50-8548",
            "identificationValue": "666-50-8548",
            "identificationDescription": "Employee Control Number",
            "issueState": "AA",
            "issueCountry": "US"
          }
        ],
        "taxWithholdings": [
          {
            "appliesToPartyId": "Party_PI_1",
            "taxWithholdingType": "FEDERAL",
            "taxRateToUse": "NOWITHHOLDINGELECTED",
            "filingStatus": "SINGLE",
            "dollar": 0,
            "percentage": 0,
            "exemptions": 0,
            "taxJurisdiction": "USA_WY",
            "contribution": "NOTAPPLICABLE",
            "taxFormType": "T1035COSTBASIS",
            "w4p": {
              "totalAmountOfOtherIncomeAndOtherPensionsOrAnnuities": 12.12,
              "totalAmountOfClaimsAndOtherCredits": 213.73,
              "otherIncome": 144.53,
              "otherDeduction": 42.83
            }
          }
        ],
        "partyStatus": "APPROVED",
        "isPartyBeneficiaryNonNatural": true,
        "isIrrevocable": true,
        "isRequiredMinimumDistributionDesignated": true,
        "lastContactDate": "2023-01-01",
        "beneficiaryShareMethod": "PERSTIRPESDISTRIBUTION",
        "addresses": [
          {
            "startDate": "2023-01-01",
            "endDate": "2023-01-01",
            "addressType": "RESIDENCE",
            "addressLine1": "1112 Pickle Street",
            "addressLine2": "South Jersey",
            "addressLine3": "1234 Post box",
            "city": "Garden City",
            "state": "AA",
            "zipCode": "67846",
            "zipCodeExtension": "23",
            "country": "US",
            "isPreferred": true
          }
        ],
        "phones": [
          {
            "startDate": "2023-01-01",
            "endDate": "2023-01-01",
            "phoneType": "MOBILE",
            "countryCode": "9",
            "areaCode": "973",
            "dialNumber": "765789",
            "extension": "null",
            "bestTime": "null",
            "timezone": "null",
            "isPreferred": true
          }
        ],
        "emails": [
          {
            "startDate": "2023-01-01",
            "endDate": "2023-01-01",
            "emailType": "PERSONAL",
            "emailAddress": "will.smith@gmail.com",
            "isPreferred": true
          }
        ],
        "bankDetails": [
          {
            "startDate": "2023-01-01",
            "endDate": "2023-01-01",
            "nameOnAccount": "abcdqwe",
            "accountStatus": "ACTIVEBANKACCOUNT",
            "accountType": "CHECKING",
            "bankAccountPurpose": "LOANINTERESTBILLING",
            "accountNumber": "34567777745678",
            "routingNumber": "123456789",
            "internationalBankAccountNumber": "ibanNumber_66",
            "branchName": "branch_66",
            "branchPhoneNumber": "7766667777",
            "branchAddress": {
              "addressType": "RESIDENCE",
              "addressLine1": "1112 Pickle Street",
              "addressLine2": "South Jersey",
              "addressLine3": "1234 Post box",
              "city": "Garden City",
              "state": "AA",
              "zipCode": "67846",
              "zipCodeExtension": "23",
              "country": "US"
            }
          }
        ],
        "startDate": "2023-01-01",
        "endDate": "2023-01-01",
        "beneficiaryAllocation": [
          {
            "partyPolicyId": "partyPolicyId",
            "allocationPercentage": 0
          }
        ],
        "partyAllocation": [
          {
            "partyPolicyId": "partyPolicyId",
            "allocationPercentage": 0
          }
        ]
      }
    }
  ]
}

TransactionResponse

object
correlationIdstring

The unique ID to track each transaction request across all systems

Example:864e43a0-2c2f-4a11-9d7f-69ed40115066

transactionIdstring

A unique identifier assigned to every transaction within the system, used to track and reference individual actions such as premium payments, policy updates, or claims etc

Example:337

entityIdstring

Example:1

Example
{
  "correlationId": "864e43a0-2c2f-4a11-9d7f-69ed40115066",
  "transactionId": "337",
  "entityId": "1"
}

Details

object
codestring
messagestring
Example
{
  "code": "code",
  "message": "message"
}

TransactionErrorResponse

object
timestampstring(date-time)

Example:2023-01-01T12:00:00.000Z

messagestring
correlationIdstring

The unique ID to track each transaction request across all systems

Example:864e43a0-2c2f-4a11-9d7f-69ed40115066

errorDetailsarray[object]
Show Child Parameters
Example
{
  "timestamp": "2023-01-01T12:00:00.000Z",
  "message": "message",
  "correlationId": "864e43a0-2c2f-4a11-9d7f-69ed40115066",
  "errorDetails": [
    {
      "code": "code",
      "message": "message"
    }
  ]
}