SMsmileidentity
Users

Flag or clear fraud status for a user

Records a fraud report (or fraud-clearance) for a previously enrolled user.

Use is_fraud: true to flag a user as fraudulent, or is_fraud: false to clear a previous flag. Flagging propagates the user's face, device, and biometric clusters to the relevant block lists so that subsequent verifications matching them are rejected. Clearing the flag reverses these effects.

The response is 202 Accepted once the request has been validated and handled.

post/v3/users/{user_id}/report_fraud

Request

Path parameters

user_idstring required

The partner-scoped user identifier of the enrolled user being reported. This is the user_id value originally provided during enrollment.

Request body multipart/form-data

is_fraudboolean required

true to flag the user as fraudulent, false to clear a previous fraud flag.

reason'FIRST_PARTY_FRAUD' | 'SECOND_PARTY_FRAUD' | 'THIRD_PARTY_FRAUD' | 'SYNTHETIC_IDENTITY' | 'ACCOUNT_TAKEOVER' | 'DOCUMENT_FORGERY' | 'IDENTITY_FARMING' | 'MULE_ACCOUNT' | 'OTHER'

Reason for the fraud report. Required when is_fraud is true; ignored when is_fraud is false. If OTHER is selected, notes becomes required.

notesstring

Free-form notes describing the fraud report. Required when either is_fraud is false or reason is OTHER. Optional in all other cases. Capped at 500 characters.

reported_bystring email required

Email address of the person submitting the report.

Response

Fraud report accepted and queued for processing.

status'accepted' required

Always accepted when the request was queued for processing.

messagestring

Human-readable result message.

user_idstring required

The user_id that was reported.

Changes

No recorded changes to this operation across all 1 revision of this API.