Business Updated
A business Entity has been updated
Example Use Case
A Business' data has been updated and you want to run KYB checks on the Business Entity
Request Specifications
Required API Field | Definition | Notes |
---|---|---|
timestamp | Timestamp 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": "business_updated",
"event_status": "successful",
"event_lifecycle_id": "X12-43jf-8432favmjjja",
"data": {
"external_entity_id": "e3065d04-95aa-47a1-915c-84b575ff3855",
"timestamp": "2024-03-25T22:17:14.923Z",
"addresses": [
{
"line_1": "170 Elizabeth St",
"line_2": "Suite 1",
"city": "New York",
"state": "NY",
"postal_code": "10002",
"country_code": "US",
"type": "business_primary"
}
],
"supplemental_data": {}
}
}
{
"status_code": 201,
"event_request_token": "EV-ReD5nstqFhcH6Rk9NcYR",
"_links": {
"self": {
"href": "/v1/events/EV-ReD5nstqFhcH6Rk9NcYR"
}
},
"event": {
"event_type": "business_updated",
"event_status": "PROCESSED",
"data": {
"entity_token": "B-4x8WzjvGz5Oz8RWA6MvY",
"external_entity_id": "e3065d04-95aa-47a1-915c-84b575ff3855",
"created_at": 1711404359986,
"business_name": "forecast Inc.",
"business_alternate_name": null,
"business_federal_ein": "507136425",
"business_registry_id": null,
"addresses": [
{
"line_1": "170 Elizabeth St",
"line_2": "Suite 1",
"city": "New York",
"state": "NY",
"postal_code": "10002",
"created_at": 1711405025806,
"type": "business_primary",
"evaluation_token": null
},
{
"line_1": "123 Allen St",
"line_2": "Suite 1",
"city": "New York",
"state": "NY",
"postal_code": "10002",
"created_at": 1711404359538,
"type": "business_primary",
"evaluation_token": null
}
],
"emails": [
{
"email_address": "[email protected]"
}
],
"phones": [],
"type": "business",
"_links": {
"self": {
"href": "/v1/entities/businesses/B-4x8WzjvGz5Oz8RWA6MvY"
}
}
},
"evaluations": [],
"journey_applications": []
}
}
Updated 2 months ago