Create an Investigation
Changed onManually creates a new Investigation
Request
- Base URLhttps://sandbox.alloy.co/v1
- Auth
- OAuth 2Client credentialsToken URL/oauth/bearer
- or HTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"investigation_state": "alert_review",
"investigation_type": "Fraud",
"entity_tokens": [
"P-1GoQALm40nPQSp7UVTJS"
],
"journey_alerts": [
{
"agent_token": "AG-L83m6iTwcXdNg3CHndS4",
"journey_alert_token": "JA-mhjlfS6nZe1G6HuvAKVq",
"outcome": "Dismissed",
"reason": "Passed manual checks",
"note": "My note"
}
],
"investigation_assignee_token": "AG-L83m6iTwcXdNg3CHndS4",
"investigation_name": "Investigation Nick Armstrong",
"note": "My note",
"tags": [
{
"tag_name": "Suspicious Activity"
}
]
}Response
Investigation
Example response
{
"investigation_token": "INV-EAx2xoAsqF1ibKTQzkXV",
"closed_at": "2024-12-05T20:05:43.643Z",
"created_at": "2024-11-26T16:00:14.677Z",
"type": "Fraud",
"state": "case_review",
"source": "alert",
"outcome": "Dismissed",
"updated_at": "2024-12-05T20:05:43.643Z",
"archived_at": "2024-12-05T20:05:43.643Z",
"_embedded": {
"assigned_agent": {
"first_name": "Mike",
"last_name": "Alloy",
"email": "safeandseamless@alloy.com",
"token": "AG-L83m6iTwcXdNg3CHndS4"
},
"entities": {
"P-KaKZxdSGnbxXfKXnXdyp": {
"type": "person",
"entity_token": "P-KaKZxdSGnbxXfKXnXdyp",
"entity_name": "Trycia Turner",
"external_entity_identifier": "mjj09291-111824-3"
}
},
"events": [
{
"event": "closed",
"agent": {
"first_name": "Mike",
"last_name": "Alloy",
"email": "safeandseamless@alloy.com",
"token": "AG-L83m6iTwcXdNg3CHndS4"
}
}
],
"evidences": {
"journey_alerts": [
{
"journey_application_token": "JA-PA0M5o6nyYCGhVyhXYWH",
"journey_token": "J-O9aI8AWpkv895oavftOH"
}
],
"tags": [
{
"tag_color": "FB923C",
"tag_name": "Phone Reputation Fail",
"is_outcome_reason": true,
"added_by": {
"email": "agent@email.com",
"first_name": "Mike",
"last_name": "Alloy",
"token": "AG-L83m6iTwcXdNg3CHndS4"
}
}
]
},
"notes": [
{
"created_at": "2025-01-01T13:00:59.000Z",
"created_by": {
"first_name": "Mike",
"last_name": "Alloy",
"email": "agent@email.com",
"token": "AG-f5NJW4vCmoxwxkn4BpOV"
},
"entity_name": "Nick Armstrong",
"entity_token": "P-KaKZxdSGnbxXfKXnXdyp",
"text": "My note",
"is_investigation_level_note": true
}
],
"reviews": [
{
"new_investigation_state": "alert_review_closed",
"outcome": "Dismissed",
"previous_investigation_state": "alert_review",
"reason": "Verified by human",
"reviewed_at": "2024-12-05T20:05:43.643Z",
"reviewed_by": {
"first_name": "Mike",
"last_name": "Alloy",
"email": "safeandseamless@alloy.com",
"token": "AG-L83m6iTwcXdNg3CHndS4"
}
}
]
}
}Changes
- breaking
the request property
//became required - breaking
the request property
//became required - breaking
the
request property's minItems was increased to1 - breaking
the
request property's minItems was increased to1 - info
added the new optional request property
- info
added the new optional request property
- info
added
subschema #1subschema #2to the request bodyanyOflist - info
the request property
became optional - info
the request property
became optional - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- breaking