The ProcessBeneficiaryRequest interface provides the capability to add/update/delete one/many beneficiary mappings attached with a contract. Primary or contingent beneficiaries can be updated. If a new beneficiary is provided in the request which does not exist for the contract, then a new mapping is created as beneficiary in corresponding contract. The clients used for these mappings, must exist in ALIP.
| TR ID# | Technical Requirements | Interface Design Traceability | Test Case Traceability |
| TR1 | ACORDv2.36 502 transaction will be used to communicate between ALIP and Client systems | IDD-INT-004-7.2 | IDD-INT-004-12.1 |
| TR2 | ACORD Tx502 “ProcessBeneficiaryRequesttc=502” Interface will provide the ability to add/update the beneficiary information in ALIP based on a contract, party role sub type code & client information. | IDD-INT-004-7.2 | IDD-INT-004-12.1 |
| BR ID# | Business Requirements | Interface Design Traceability | Test Case Traceability |
| BR1 | ALIP will allow the add/update of the beneficiary information for a contract in ALIP. | IDD-INT-004-4 | IDD-INT-004-12.1 |
| BR2 | The beneficiary should be a party already existing in ALIP, and can be an individual/company/trust. | IDD-INT-004-7.4 #12 | IDD-INT-004-12.1 #1IDD-INT-004-12.1 #6 |
| BR3 | The percentage split for each beneficiary can be updated. An existing beneficiary can also be terminated by setting the percentage to 0. | IDD-INT-004-2IDD-INT-004-4 #3IDD-INT-004-4 #9 | IDD-INT-004-12.1 #1IDD-INT-004-12.1 #6 |
| BR4 | Both Primary and contingent beneficiaries can be updated via this interface, however not as a part of the same request. | IDD-INT-004-4 #8 | IDD-INT-004-12.1 #14 |
| BR5 | Any changes made by this interface, will be associated with a user called ‘Interface User’ in the ALIP database. | IDD-INT-004-7.2 | IDD-INT-004-12.1 |
The external system would post the message containing the beneficiary update request on the request queue.
ALIP process server will pick up the message, perform the necessary XSD validations, and other basic validations on the existence of the contract id, client ids in ALIP, summation of the percentage split of all beneficiaries to 100 etc.
Post the necessary validations, it would invoke a workflow to update the beneficiary mappings for the contract with the provided information.
The status of the beneficiary information update would be posted back to the response queue.
None
N/A
N/A
| Request Parameters | Description | Mandatory | Allowed values |
| Beneficiary Sub Type Code | Code that defines the type of the client type of the beneficiary. For example, the beneficiary may have a client type of Individual, Company,Trust, Clause. | Y | |
| Beneficiary Relation Type Code | Code representing the beneficiary relation type. This is an optional field available to all types of clients. | N | |
| User ID | Service User ID | Y | |
| Contract Number | A number which uniquely identifies a contract number within ALIP. | Y | |
| Beneficiary Designated Value Share Percent | The percentage of the designated value which is assigned to the beneficiary by the owner. Mandatory for all beneficiaries | Y | |
| Trust Name | Name of the trust. Mandatory if client type is trust. Not required for individual/company types. | Y | |
| Firm Name | Name of the company. Mandatory if client type is company. Not required for individual/trust types. | Y | |
| Beneficiary Tax Identification Number | The US taxpayer identification number of the beneficiary, also referred to as the TIN. For the beneficiary, this is their Social Security Number, or their ITIN if the individual is a foreign national. This is optional for beneficiaries, but will be treated as mandatory for interfaces to be able to uniquely identify the client. | Y |
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The ProcessBeneficiaryRequest call was successful with details being returned in the output | 1 | Success | Informational |
| Error | Error Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The ProcessBeneficiaryRequest call was NOT successful due to technical errors | 100 | Internal Error | Fatal | Any system error |
| #2 | The ProcessBeneficiaryRequest interface could not find the contract in ALIP. | 100 | No rows found | Warning | |
| #3 | The ProcessBeneficiaryRequest call was NOT successful as the beneficiary percentage does not add up to 100 | 100 | Internal Error | Fatal | Validation error |
| #4 | The ProcessBeneficiaryRequest call was NOT successful due to missing mandatory fields | 100 | Internal Error | Fatal | Validation error |
| #5 | The ProcessBeneficiaryRequest call was NOT successful due to incorrect lookup values for the beneficiary relation type code or party role code or client type code or the beneficiary sub type code, which are not from the allowable values. | 100 | Internal Error | Fatal | Validation error |