Beneficiaries V2

Run an APP scam check (V2)

Checks a prospective beneficiary against the client's existing beneficiaries for a potential Authorised Push Payment (APP) scam. Intended to be called before a beneficiary is created.

post/v2/beneficiaries/app-scam-checks

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/v2/beneficiaries/app-scam-checks
  • Auth: API key in header x-api-key

Request body

beneficiary_namestring required

The name of the prospective beneficiary.

bank_country_codestring required

The ISO 3166-1 alpha-2 country code of the prospective beneficiary's bank.

Response

The result of an APP scam check for a prospective beneficiary.

possible_app_scam_detectedboolean required

Whether a potential APP scam was detected for the prospective beneficiary.

Changes

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