Skip to main content
POST
Run an APP scam check (V2)

Headers

Authorization
string
required

The access token.

Query Parameters

client_id
string
required

The identifier of a client.

Body

application/json

The prospective beneficiary's details.

The prospective beneficiary's details to check for a potential Authorised Push Payment (APP) scam.

beneficiary_name
string
required

The name of the prospective beneficiary.

Minimum string length: 1
bank_country_code
string
required

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

Required string length: 2

Response

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

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

possible_app_scam_detected
boolean
required

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