EndUsers
Get an end user's fraud network scan
Returns the last fraud network scan for a submission: whether the identity it stated matches
Heron's fraud network, and Heron's business-only conclusions in `features`. People, ring size,
member data, amounts and dates are never returned, so `network`, `match_meta`,
`matched_node_heron_id`, `businesses`, `people` and `edges` are always empty.
To test the integration, first `POST /end_users` with
`{"end_user":{"end_user_id":"sandbox-fraud-test-001",
"name":"HERON SANDBOX FRAUD RING LLC"}}`. Use an unused `end_user_id`. Before the workflow
runs the enrichers, `PATCH /end_users/<heron_id>/end_user_information` with
`{"company_legal_business_name":"HERON SANDBOX FRAUD RING LLC","owner_1":
{"first_name":"HERON SANDBOX","last_name":"FRAUD RING"}}`. Do not send an EIN or SSN.
Instead of the PATCH, you can send an application form that names the business
`HERON SANDBOX FRAUD RING LLC` and the owner `HERON SANDBOX FRAUD RING`. It works whether
the form's owner name is parsed as `HERON SANDBOX` / `FRAUD RING` or as first `HERON`,
middle `SANDBOX`, last `FRAUD RING`.
This endpoint returns `status=match`, `classification=fraud_network`, and the sample ring's
business-only conclusions in `features`. Read the sample velocity result from
`GET /end_user_enrichers/<heron_id>/enricher_results`: select `broker_velocity`, then read
`broker_velocity_signal`, which is `high`.
For a lone actor, use `HERON SANDBOX LONE ACTOR LLC` with owner `HERON SANDBOX` /
`LONE ACTOR`; this endpoint returns `classification=lone_actor`. Any other made-up identity
returns `status=no_match`.
GET
Get an end user's fraud network scan
Response
OK