Person Created

Example Use Case

Backfilling historical person records, or creating an individual that wasn't otherwise created in Alloy during account onboarding.

Request Specifications

Required API FieldDefinitionNotes
One of:
external_entity_id
entity_token
Unique identifier for the Entity.The external_entity_id field is immutable and cannot be changed to a different value if one is already set. The value you supply in this field should be the best identifier to uniquely the Person/Business entity at your financial institution.
timestampTimestamp of the event.

Example Request / Response

{
    "event_type": "person_created",
    "event_status": "successful",
    "event_lifecycle_id": "X12-43jf-8743jkfdsa",
    "data": {
        "external_entity_id": "cf88a0a1-34d6-492d-b617-c8b43785e7b7",
        "timestamp": "2024-03-25T22:23:07.712Z",
        "name_first": "John",
        "name_last": "Doe",
        "birth_date": "1990-01-01",
        "document_ssn": "666666666",
        "phones": [{
            "phone_number": "+19344281891"
        }],
        "emails": [{
            "email_address": "[email protected]"
        }],
        "addresses": [{
          "line_1": "41 E. 11th",
          "line_2": null,
          "city": "New York",
          "state": "NY",
          "postal_code": "10003",
          "country_code": "US",
          "type": "primary"
        }],
        "meta": {
            "channel": "online"
        },
        "supplemental_data": {}
    }
}
{
    "status_code": 201,
    "event_request_token": "EV-6E6Yj33Iz3DmTcglFFwa",
    "_links": {
        "self": {
            "href": "/v1/events/EV-6E6Yj33Iz3DmTcglFFwa"
        }
    },
    "event": {
        "event_type": "person_created",
        "event_status": "PROCESSED",
        "data": {
            "entity_token": "P-TfkFe6lCPkElc9Xktd3V",
            "external_entity_id": "cf88a0a1-34d6-492d-b617-c8b43785e7b7",
            "created_at": 1711405410009,
            "person_details_updated_at": 1711405409394,
            "gender": null,
            "birth_date": "*********",
            "name_first": "John",
            "name_middle": null,
            "name_last": "Doe",
            "document_ssn": "*********",
            "document_license": null,
            "document_passport": null,
            "addresses": [{
                "line_1": "123 Allen St",
                "line_2": "Apt 1",
                "city": "New York",
                "state": "NY",
                "postal_code": "10002",
                "country_code": "US",
                "type": "primary"
            }],
            "emails": [{
                "email_address": "[email protected]"
            }],
            "phones": [{
                "phone_number": "+1934428189"
            }],
            "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": []
    }
}