Fraud Analytics

Introducing our Fraud Analytics API, designed to enhance your security measures and protect your business from fraudulent activities. This powerful tool evaluates the risk associated with user-provided information, including IP address, phone number, email, name, and address. By leveraging advanced algorithms and real-time data analysis, our API returns a comprehensive risk assessment, enabling you to make informed decisions and mitigate potential threats.

POST Create and run a fraud analytic against user's info

---

API

Description: Create a new Fraud Analytic check

Endpoint: POST /api/v4/fraud_analytics

Properties:

Property	Sub-property	Type	Required	Notes
reference		String	true	Verification reference. A name to recognise the verification
email		String	true	Must be in valid email format.
firstname		String	false
lastname		String	false
ip_address		String	false
contact_phone		String	true	Must be in valid format, including the country code.
address_payload		Object	false
	address_line_1	String	false
	address_line_2	String	false
	city	String	false
	state	String	false
	postcode	String	false

Sample Response:

{
    "id": 40,
    "fullname": "John Doe",
    "ip_address": "203.118.134.125",
    "contact_phone": "64210123456",
    "email": "example@gmail.com",
    "address": "22 Pollen Street, Auckland, 1022",
    "errors": null,
    "results": {
        "risk_indicators": [
            {
                "type": "Identity Network Score",
                "indicator": "There is a HIGH risk associated with this digital interaction",
                "score": 0.988,
                "risk_value": "HIGH"
            },
            {
                "type": "Identity Risk Score",
                "indicator": "The identity risk score suggests a HIGH level of risk for this user",
                "score": 493,
                "risk_value": "HIGH"
            },
            {
                "type": "IP Risk Score",
                "indicator": "There is a MEDIUM risk associated with this IP address",
                "score": 0.994,
                "risk_value": "MEDIUM"
            }
        ],
        "other_indicators": [
            {
                "type": "Phone to Name Match",
                "value": "no-match",
                "risk_value": "MEDIUM"
            },
            {
                "type": "Email to Name Match",
                "value": "no-match",
                "risk_value": "MEDIUM"
            },
            {
                "type": "Address to Name Match",
                "value": "not-found",
                "risk_value": "NEUTRAL"
            },
            {
                "type": "IP Risk Found",
                "value": true,
                "risk_value": "HIGH"
            }
        ],
        "network_activity": [
            {
                "type": "Days since the email was first seen in the network",
                "value": 5805,
                "risk_value": "LOW"
            },
            {
                "type": "Days since the phone number was last seen in the network",
                "value": 264,
                "risk_value": "LOW"
            },
            {
                "type": "Days since the IP address was last seen in the network",
                "value": 2,
                "risk_value": "HIGH"
            }
        ]
    }
}

Examples

Create Fraud Analytic

const http = require('axios')

http.post('https://integration.aplyid.com/api/v4/fraud_analytics', {
  reference: "TEST-123",
  address_payload: {
      address_line_1: "22 Pollen Street",
      city: "Auckland",
      postcode: "1022"
  },
  ip_address: "203.118.134.125",
  email: "example@gmail.com",
  firstname: "John",
  lastname: "Doe",
  contact_phone: "64210123456"
}, {
  headers: {
    'Aply-API-Key': 'YOUR_API_KEY',
    'Aply-Date': 'YOUR_DATE',
    'Aply-Signature': 'YOUR_GENERATED_SIGNATURE'
  }
}).then(response => {
  // Do some stuff
}).catch(error => {
  console.log(error.response.data.message)
})

Error Codes

401 Unauthorized

{
  "error_code": "AUTH_FAILED",
  "message": "Bad credentials"
}

403 Forbidden

// Not subscribed to the Fraud Analytic product
{
  "error_code" : "FORBIDDEN",
  "message" : "You're not authorized to access this resource"
}

403 Forbidden

// Subscribed to Fraud Analytic product but not standalone type
{
  "error_code" : "FORBIDDEN",
  "message" : "Access to this resource requires a standalone product subscription."
}

422 Unprocessable Entity

// For validation failures
{
  "error_code" : "NOT_CREATED",
  "message" : "Contact phone can't be blank"
}