beneficiaries

base

/v2/private/salesAgent/aa/fe/beneficiaries/{leadId}

localhost

http://localhost:1350/v2/private/salesAgent/aa/fe/beneficiaries/{leadId}

dev

https://dev.everdays.com/v2/private/salesAgent/aa/fe/beneficiaries/{leadId}

prod

https://everdays.com/v2/private/salesAgent/aa/fe/beneficiaries/{leadId}

Available Methods

• [POST]

---

POST /v2/private/salesAgent/aa/fe/beneficiaries/{leadId}

This endpoint is used by a Sales Agent to submit the leads beneficiaries.

Params

Field	Type	Description	Structure
beneficiaries	Array	The leads beneficiaries, to send to AmAm. Beneficiaries will also be saved on the leads data.	Array of objects with format: { name: {first: string, last: string}, relationship: string, phone: number, email: string, beneficiaryType: "Primary" or "Contingent" }

Request Example

Example request body

{
    "beneficiaries": [
        {
            "name": {
                "first": "valeria",
                "last": "mora"
            },
            "relationship": "daughter",
            "phone": 9099195675,
            "email": "val@gmail.com",
            "beneficiaryType": "Primary"
        },
        {
            "name": {
                "first": "edith",
                "last": "vazquez"
            },
            "relationship": "niece",
            "phone": 9099195671,
            "email": "edith@gmail.com",
            "beneficiaryType": "Primary"
        },
        {
            "name": {
                "first": "ale",
                "last": "mora"
            },
            "relationship": "niece",
            "phone": 9099195672,
            "email": "ale@gmail.com",
            "beneficiaryType": "Primary"
        }

    ]
}

Returns

The lead and the updated beneficiaries

Example return of am am object

user: {
  ...userData,
  purchase: {
    aa: {
        ...restOfFields,
        "beneficiaries": [
                    {
                        "name": {
                            "first": "valeria",
                            "last": "mora"
                        },
                        "_id": "6798feb640c7d0d204953a0c",
                        "relationship": "daughter",
                        "phone": 9099195675,
                        "email": "val@gmail.com",
                        "beneficiaryType": "Primary"
                    },
                    {
                        "name": {
                            "first": "edith",
                            "last": "vazquez"
                        },
                        "_id": "6798feb640c7d0d204953a0d",
                        "relationship": "niece",
                        "phone": 9099195671,
                        "email": "edith@gmail.com",
                        "beneficiaryType": "Primary"
                    },
                    {
                        "name": {
                            "first": "ale",
                            "last": "mora"
                        },
                        "_id": "6798feb640c7d0d204953a0e",
                        "relationship": "niece",
                        "phone": 9099195672,
                        "email": "ale@gmail.com",
                        "beneficiaryType": "Primary"
                    }
            ]
    }
  }
}