API reference · Protection & control

Fraud

Allow, review or block before anything posts, with case management. About fraud scoring Live

POST Report fraud on your own account

POST /fraud/report

Opens a case and returns its reference immediately. Nigerian authorised-push-payment guidance gives the customer 24 hours to report (72 with justification) and obliges the institution to acknowledge within 24 hours quoting a unique case reference, then conclude the investigation within 14 days. The reference in this response is that acknowledgement, and both deadlines are returned with it.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Example

Request body: CustomerFraudReportRequest · Response: CustomerFraudReportResponse

curl -X POST "https://api.bridgemoni.com/fraud/report" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "caseType": "APP_FRAUD",
    "narrative": "March payroll",
    "reportChannel": "text",
    "disputedTransactionReferences": [
      "text"
    ]
  }'

Responses

StatusWhen
200Fraud report received

POST Screen a subject against third-party lists now

POST /fraud/screening/{userReference}

Runs synchronously, for an analyst who needs an answer during an investigation. Every account holder is already screened automatically at registration and rescreened on a schedule - this is for when that is not soon enough.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
userReference

Example

Response: ScreeningResultResponse

curl -X POST "https://api.bridgemoni.com/fraud/screening/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200Screening completed

GET A subject's screening history

GET /fraud/screening/{userReference}/history

Append-only and newest first, so what was known at any past moment can be established rather than inferred from the current state.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
userReference

Example

Response: List<ScreeningResultResponse>

curl -X GET "https://api.bridgemoni.com/fraud/screening/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/history" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200Screening history retrieved successfully

GET The current screening verdict the engine reads for this subject

GET /fraud/screening/{userReference}/risk-state

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
userReference

Example

Response: SubjectRiskStateResponse

curl -X GET "https://api.bridgemoni.com/fraud/screening/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/risk-state" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200Risk state retrieved successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors