Person Updated

A person entity has been updated

Example Use Case

An existing Customer has changed their PII and you want to screen the entire Entity profile through your Fraud and/or CIP Journey.

Request Specifications

Required API FieldDefinitionNotes
timestampTimestamp of the event.
One of:
external_entity_id
entity_token
Unique identifier for the Entity being updated.The external_entity_id field is immutable and cannot be changed to a different value if one is already set.

If not yet set, providing both an external_entity_id and an entity_token will set the provided value to the External ID of the Entity specified by the entity_token.

Example Request/Response:

{
  "event_type": "person_updated",
  "event_status": "pending",
  "event_lifecycle_id": "X12-43jf-8743jkfdsa",
  "data": {
    "external_entity_id": "cf88a0a1-34d6-492d-b617-c8b43785e7b7",
    "timestamp": "2024-03-25T22:28:42.692Z",
    "emails": [
      {
        "email_address": "[email protected]"
      }
    ],
    "phones": [
      {
        "phone_number": "+1934428189"
      }
    ],
    "name_first": "NewFirstName",
    "addresses": [
      {
        "line_1": "41 E 11th St",
        "line_2": "Floor 2",
        "city": "New York",
        "state": "NY",
        "postal_code": "10002",
        "country_code": "US",
        "type": "primary"
      }
    ],
    "supplemental_data": {}
  }
}

{
    "status_code": 201,
    "event_request_token": "EV-0TzoUqB3PL2dxl3FgOAz",
    "_links": {
        "self": {
            "href": "/v1/events/EV-0TzoUqB3PL2dxl3FgOAz"
        }
    },
    "event": {
        "event_type": "person_updated",
        "event_status": "PROCESSED",
        "data": {
            "entity_token": "P-TfkFe6lCPkElc9Xktd3V",
            "external_entity_id": "cf88a0a1-34d6-492d-b617-c8b43785e7b7",
            "created_at": 1711405410009,
            "person_details_updated_at": 1711405734899,
            "gender": null,
            "birth_date": "*********",
            "name_first": "NewFirstName",
            "name_middle": null,
            "name_last": "Doe",
            "document_ssn": "*********",
            "document_license": null,
            "document_passport": null,
            "addresses": [
                {
                    "line_1": "41 E 11th St",
                    "line_2": "Floor 2",
                    "city": "New York",
                    "state": "NY",
                    "postal_code": "10002",
                    "created_at": 1711405734899,
                    "type": "primary",
                    "evaluation_token": null
                },
                {
                    "line_1": "123 Allen St",
                    "line_2": "Apt 7",
                    "city": "New York",
                    "state": "NY",
                    "postal_code": "10002",
                    "created_at": 1711405409394,
                    "type": "primary",
                    "evaluation_token": null
                }
            ],
            "emails": [
                {
                    "email_address": "[email protected]"
                }
            ],
            "phones": [
                {
                    "phone_number": "+1937074322"
                }
            ],
            "type": "person",
            "_embedded": {
                "document_ssns": [
                    {
                        "document_ssn": "*********",
                        "created_at": 1711405409394
                    }
                ],
                "birth_dates": [
                    {
                        "birth_date": "*********",
                        "created_at": 1711405409394
                    }
                ]
            },
            "_links": {
                "self": {
                    "href": "/v1/entities/persons/P-TfkFe6lCPkElc9Xktd3V"
                }
            }
        },
        "evaluations": [],
        "journey_applications": []
    }
}