Analyst override

POST

/v1/submissions/{id}/override

const url = 'https://api.fromenance.com/v1/submissions/sub_01J8Z9X0Q3K4M5N6P7R8S9T0V1/override';
const options = {
  method: 'POST',
  headers: {
    cookie: 'fromenance.session_token=<fromenance.session_token>',
    'Content-Type': 'application/json'
  },
  body: '{"outcome":"fraud","note":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.fromenance.com/v1/submissions/sub_01J8Z9X0Q3K4M5N6P7R8S9T0V1/override \
  --header 'Content-Type: application/json' \
  --cookie fromenance.session_token=<fromenance.session_token> \
  --data '{ "outcome": "fraud", "note": "example" }'

Marking fraud adds the submission’s indicators and fingerprint to the tenant fraud list so later submissions resolve to Known fraud. Marking legitimate creates a registration retroactively and flags a coverage gap on the sending source.

Authorizations

Session
ApiKey

Parameters

Path Parameters

required

string

/^sub_[0-9A-Z]{26}$/

Example

sub_01J8Z9X0Q3K4M5N6P7R8S9T0V1

Request Body

application/json

object

outcome

required

string

Allowed values: fraud legitimate

note

string

<= 2000 characters

Responses

200

Updated submission

application/json

object

required

string

entry

required

string

status

required

string

received_at

required

string

processed_at

required

string | null

count

required

integer

verify_code_found

required

string | null

submitter_hash

required

string | null

recipient_hash_found

required

string | null

headers_present

required

boolean

dkim

required

string | null

arc

required

string | null

trust

required

string | null

from_domain

required

string | null

imitated_template_id

required

string | null

campaign_id

required

string | null

sandbox

required

boolean

verdict

required

object

submission_id

required

string

outcome

required

string

Allowed values: verified not_verified known_fraud

rule

required

string

replay

required

boolean

authoritative

required

boolean

matched

required

object

communication_id

required

string

sent_at

required

string | null

template_id

required

string | null

signals

required

object

key

additional properties

indicators

required

Array<object>

object

kind

required

string

value

required

string

replied_at

required

string | null

created_at

required

string

override

required

object

outcome

required

string

required

string | null

required

string

note

required

string | null

Example

{
  "verdict": {
    "outcome": "verified"
  }
}