Account Beneficiaries
Account Beneficiaries can be managed through our Account Beneficiaries APIs, which provides flexibility on the account, as it does not require beneficiaries be set up on Account creation.
!
NOTE: In the Beneficiary List the share percentage is not required to sum to 100%, but the API service does ensure that the share percentage does not exceed 100%.Account beneficiaries - APIs
Search beneficiaries
GET /accounts/1041000017/beneficiaries
{"accountBeneficiaries": [{"beneficiaryId": "32e84b3a-80f7-4619-af74-cbbf6decb388","name": {"first": "John","middle": "J.","last": "Smith"},"taxId": "*****6632","beneficiaryType": "PRIMARY","relationship": "OTHERS","sharePercentage": 20},{"beneficiaryId": "6ca89459-573e-4cac-8af3-d9ccb9b04d11","name": {"first": "Joaquin","middle": "M.","last": "Fenix"},"taxId": "*****6732","beneficiaryType": "CONTINGENT","relationship": "OTHERS","sharePercentage": 80}],"page": {"nextOffset": "3","prevOffset": "1","totalElements": 3},"links": {"next": {"href": "https://api.infinant.com/accounts/1041000017/beneficiaries?offSet=3&limit=10","action": "GET","rel": "self","types": ["application/pdf"]}}}
Add beneficiary
POST /accounts/1041000017/beneficiaries
Request Body
{"name": {"first": "John","middle": "J.","last": "Smith"},"taxId": "*****7632","taxIdType": "ITIN","dateOfBirth": "1975-09-18","addresses": [{"line1": "1 Main St","line2": "Main","line3": "St","city": "Melrose","state": "NY","postalCode": "12121","country": "US","type": "HOME"}],"emails": [{"type": "HOME","email": "JSmith@gmail.com"}],"phones": [{"type": "HOME","country": "US","number": "(555) 555-1234"}],"beneficiaryType": "PRIMARY","relationship": "FAMILY_RELATIVE","sharePercentage": 100}
Response
{"beneficiaryId": "32e84b3a-80f7-4619-af74-cbbf6decb388","name": {"first": "John","middle": "J.","last": "Smith"},"taxId": "*****7632","taxIdType": "ITIN","dateOfBirth": "1975-09-18","addresses": [{"line1": "1 Main St","line2": "Main","line3": "St","city": "Melrose","state": "NY","postalCode": "12121","country": "US","type": "HOME"}],"emails": [{"type": "HOME","email": "JSmith@gmail.com"}],"phones": [{"type": "HOME","country": "US","number": "(555) 555-1234"}],"beneficiaryType": "PRIMARY","relationship": "FAMILY_RELATIVE","sharePercentage": 100}
Beneficiary details
GET /accounts/1041000017/beneficiaries/32e84b3a-80f7-4619-af74-cbbf6decb388
{"beneficiaryId": "32e84b3a-80f7-4619-af74-cbbf6decb388","name": {"first": "John","middle": "J.","last": "Smith"},"taxId": "*****7632","taxIdType": "ITIN","dateOfBirth": "1975-09-18","addresses": [{"line1": "1 Main St","line2": "Main","line3": "St","city": "Melrose","state": "NY","postalCode": "12121","country": "US","type": "HOME"}],"emails": [{"type": "HOME","email": "JSmith@gmail.com"}],"phones": [{"type": "HOME","country": "US","number": "(555) 555-1234"}],"beneficiaryType": "PRIMARY","relationship": "FAMILY_RELATIVE","sharePercentage": 100}
Update beneficiary
PATCH /accounts/1041000017/beneficiaries/32e84b3a-80f7-4619-af74-cbbf6decb388
Request Body
{"name": {"first": "John","middle": "J.","last": "Smith"},"taxId": "*****7632","taxIdType": "ITIN","dateOfBirth": "1975-09-18","addresses": [{"line1": "1 Main St","line2": "Main","line3": "St","city": "Melrose","state": "NY","postalCode": "12121","country": "US","type": "HOME"}],"emails": [{"type": "HOME","email": "JSmith@gmail.com"}],"phones": [{"type": "HOME","country": "US","number": "(555) 555-1234"}],"beneficiaryType": "PRIMARY","relationship": "FAMILY_RELATIVE","sharePercentage": 50}
Response
{"beneficiaryId": "32e84b3a-80f7-4619-af74-cbbf6decb388","name": {"first": "John","middle": "J.","last": "Smith"},"taxId": "*****7632","taxIdType": "ITIN","dateOfBirth": "1975-09-18","addresses": [{"line1": "1 Main St","line2": "Main","line3": "St","city": "Melrose","state": "NY","postalCode": "12121","country": "US","type": "HOME"}],"emails": [{"type": "HOME","email": "JSmith@gmail.com"}],"phones": [{"type": "HOME","country": "US","number": "(555) 555-1234"}],"beneficiaryType": "PRIMARY","relationship": "FAMILY_RELATIVE","sharePercentage": 100}
Delete beneficiary
DELETE /accounts/1041000017/beneficiaries/32e84b3a-80f7-4619-af74-cbbf6decb388
Response
{"beneficiaryId": "32e84b3a-80f7-4619-af74-cbbf6decb388","name": {"first": "John","middle": "J.","last": "Smith"},"taxId": "*****7632","taxIdType": "ITIN","dateOfBirth": "1975-09-18","addresses": [{"line1": "1 Main St","line2": "Main","line3": "St","city": "Melrose","state": "NY","postalCode": "12121","country": "US","type": "HOME"}],"emails": [{"type": "HOME","email": "JSmith@gmail.com"}],"phones": [{"type": "HOME","country": "US","number": "(555) 555-1234"}],"beneficiaryType": "PRIMARY","relationship": "FAMILY_RELATIVE","sharePercentage": 100}
Related Links:
- API References: Under Accounts -> Accounts beneficiaries