Report API

Report API of Location-Based Fraud

Informations

Version

api/v1.0.5-5-gc944fcf

Contact

Fraud Support info@ironchip.com https://www.ironchip.com/products/location_based_fraud.html

Terms Of Service

https://www.ironchip.com/term_uses/terms.html

Content negotiation

URI Schemes

• http

Consumes

• application/json

Produces

• application/json

Access control

Security Schemes

ApiKeyAuth (header: Authorization)

All endpoints

report

Method	URI	Name	Summary
GET	/reports	get reports	This endpoint allows the client to obtain the application reports. The user should be allowed to query reports from the referenced Application.
GET	/reports/{transaction_id}	get reports transaction ID	This endpoint allows the client to obtain the application reports providing the transaction ID. The user should be allowed to query reports from the referenced Application.

feedback

Method	URI	Name	Summary
POST	/feedback/{transaction_id}	post feedback transaction ID	This endpoint allows the client to post feedback about the received report to improve the future fraud detections.

Reports

This endpoint allows the client to obtain the application reports. The user should be allowed to query reports from the referenced Application. (GetReports)

GET /reports

Get all the application reports. They will be paginated by default to 20 reports per page.

Produces

• application/json

Security Requirements

• ApiKeyAuth

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
limit	query	integer	int64			20	Limit number of reports
page	query	integer	int64			1	Page of reports

Example

curl -X 'GET' \
  'https://report.lbfraud.ironchip.com/reports?limit=20&page=1' \
  -H 'accept: application/json' \
  -H 'Authorization: example-api-key'

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
404	Not Found	Not Found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

[]ModelsReport

404 - Not Found

Status: Not Found

Schema

ModelsRestError

500 - Internal Server Error

Status: Internal Server Error

Schema

ModelsRestError

This endpoint allows the client to obtain the application reports providing the transaction ID. The user should be allowed to query reports from the referenced Application. (GetReportsTransactionID)

GET /reports/{transaction_id}

Get the application reports filtered by Transaction ID. The reports will be paginated by default to 20 per page. TImeout parameter is maximum time to wait for the report to be processed, it should be used if the report is requested before the transaction is done.

Produces

• application/json

Security Requirements

• ApiKeyAuth

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
transaction_id	path	string	string		✓		Transaction ID
limit	query	integer	int64			20	Limit number of reports
page	query	integer	int64			1	Page of reports
since	query	string	string			"30d"	Since report generation (numbers and a unit suffix)
timeout	query	string	string			"5s"	Timeout in second to wait

Example

curl -X 'GET' \
  'https://report.lbfraud.ironchip.com/reports/example-transaction-id?limit=1&page=1&since=30d&timeout=5s' \
  -H 'accept: application/json' \
  -H 'Authorization: example-api-key'

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
404	Not Found	Not Found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

[]ModelsReport

404 - Not Found

Status: Not Found

Schema

ModelsRestError

500 - Internal Server Error

Status: Internal Server Error

Schema

ModelsRestError

Feedback

This endpoint allows the client to post feedback about the received report to improve the future fraud detections. (PostFeedbackTransactionID)

POST /feedback/{transaction_id}

Report feedback about the about the received transaction to improve the future results on fraud detections.

Consumes

• application/json

Security Requirements

• ApiKeyAuth

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
transaction_id	path	string	string		✓		Transaction ID
feedback	body	ModelsFeedback	models.ModelsFeedback		✓		Feedback

Example

curl -X 'POST' \
  'https://report.lbfraud.ironchip.com/feedback/example-transaction-id' \
  -H 'accept: application/json' \
  -H 'Authorization: example-api-key' \
  -H 'Content-Type: application/json' \
  -d '{
  "behaviour": {
    "desired": {
      "fraud_cases": [
        "device swapping",
        "location swapping"
      ],
      "risk_assignment": "clear"
    }
  },
  "impact": {
    "description": "The transaction has been detected as fraud rather than low"
  },
  "reporter": {
    "email": "TatianaPrieto@ironchip.com",
    "name": "Tatiana",
    "surname": "Prieto"
  },
  "situation": {
    "description": "The customer has downloaded the APP to an unknown device located in a new country"
  },
  "valuation": {
    "annotations": "It is not possible to difference between real and fake client without client confirmation",
    "score": 8,
    "type": "Corrective"
  }
}'

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
404	Not Found	Not Found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

404 - Not Found

Status: Not Found

Schema

ModelsRestError

500 - Internal Server Error

Status: Internal Server Error

Schema

ModelsRestError

Models

models.Address

Properties

Name	Type	Go type	Required	Default	Description
city	string	string			City where the report occurred
country	string	string			Country name
country_code	string	string			Country codes are short alphabetic (ISO 3166)
latitude	number	float64			Coordinate that specifies the north south position of a point on the surface of the Earth
longitude	number	float64			Coordinate that specifies the east west position of a point on the surface of the Earth
region	string	string			Geographic region of a country used for administrative purposes
state	string	string			Geographical areas into which a particular country is divided

models.Behaviour

Properties

Name	Type	Go type	Required	Default	Description	Example
desired	ModelsDesiredBehaviour	ModelsDesiredBehaviour	✓		Desired behaviour

models.DesiredBehaviour

Properties

Name	Type	Go type	Required	Description	Example
fraud_cases	[]string	[]string		Report case, reason	["device swapping", "location swapping"]
risk_assignment	string	string	✓	Risk level (fraud, high, low, clear)

models.Device

Properties

Name	Type	Go type	Required	Default	Description	Example
id	string	string			Device Unique ID
integrity	ModelsIntegrity	ModelsIntegrity			Device integrity
model	string	string			Device model
sensors	ModelsSensors	ModelsSensors			Device sensors active

models.EmLocation

Properties

Name	Type	Go type	Required	Default	Description	Example
address	ModelsAddress	ModelsAddress			Location address
id	string	string			Location ID

models.Event

Properties

Name	Type	Go type	Required	Default	Description	Example
fraud_cases	[]string	[]string			Report case, reason
id	string	string			Application Transaction ID
risk_assignment	string	string			Risk level (fraud, high, low, clear)
timestamp	integer	int64			Event timestamp

models.Feedback

Properties

Name	Type	Go type	Required	Description
behaviour	ModelsBehaviour	ModelsBehaviour	✓	Behaviour of the product: expected
impact	ModelsImpact	ModelsImpact		Impact that has the results
reporter	ModelsReporter	ModelsReporter		Identifier data of the person that send the feedback
situation	ModelsSituation	ModelsSituation		The situation when the process was done
valuation	ModelsValuation	ModelsValuation		Valuation of the results

models.GeoLocation

Properties

Name	Type	Go type	Required	Default	Description	Example
address	ModelsAddress	ModelsAddress			Location address
id	string	string			Location ID

models.IP

Properties

Name	Type	Go type	Required	Default	Description	Example
address	ModelsAddress	ModelsAddress			Location Address
tor	boolean	bool			Is using TOR
vpn	boolean	bool			Is using VPN

models.Impact

Properties

Name	Type	Go type	Required	Description	Example
description	string	string		Description of the impact generated	The transaction has been detected as fraud rather than low

models.Integrity

Properties

Name	Type	Go type	Required	Default	Description	Example
debugged	boolean	bool			Is device open on debug mode or the app is not built
emulated	boolean	bool			Is device being emulated
gps_spoofed	boolean	bool			Is the GPS location or signal being spoofed
rooted	boolean	bool			Is the device rooted or Jailbreaked

models.Location

Properties

Name	Type	Go type	Required	Description
address	ModelsAddress	ModelsAddress		Location address
id	string	string		Location ID
location_type	string	string		Location type (ip, geo, wifi, lte, cdma, wcdma, gsm)

models.Report

Properties

Name	Type	Go type	Required	Description
application_id	string	string		Application ID
descriptive_report	string	string		Descriptive summary about the report data
device	ModelsDevice	ModelsDevice		Device Information
em_location	ModelsEmLocation	ModelsEmLocation		EM Location information
event	ModelsEvent	ModelsEvent		Report Event result
extra_data	interface{}	interface{}		Extra data provided on the transaction (JSON)
geo_location	ModelsGeoLocation	ModelsGeoLocation		GEO Location information
id	integer	int64		Report generated ID
ip	ModelsIP	ModelsIP		IP Information
location	ModelsLocation	ModelsLocation		Location Information
timestamp	integer	int64		Report generation timestamp in nanoseconds
transaction_id	string	string		Transaction ID
user	ModelsUser	ModelsUser		User Information

models.Reporter

Properties

Name	Type	Go type	Required	Default	Description	Example
email	string	string			Identifier email	TatianaPrieto@ironchip.com
name	string	string			Identifier name	Tatiana
surname	string	string			Identifier surname	Prieto

models.RestError

Properties

Name	Type	Go type	Required	Default	Description	Example
cause	string	string
error	string	string
error_code	string	string
traceability_id	string	string

models.Sensors

Properties

Name	Type	Go type	Required	Default	Description	Example
gps	boolean	bool			Is the GPS sensor activated
mobile_networks	boolean	bool			Is the device is able to get mobile networks
wifi	boolean	bool			Has the device WiFi sensor activated
wifi_connected	boolean	bool			Is the device connected to any WiFi network

models.Situation

Properties

Name	Type	Go type	Required	Description	Example
description	string	string		Description of the situation when the process was done	The customer has downloaded the APP to an unknown device located in a new country

models.User

Properties

Name	Type	Go type	Required	Default	Description	Example
id	string	string			User ID	useridexample

models.Valuation

Properties

Name	Type	Go type	Description	Example
annotations	string	string	Annotations	It is not possible to difference between real and fake client without client confirmation
score	integer	int64	Valuation score (0-10)	8
type	string	string	Feedback valoration type (Positive, Negative, Corrective)	Corrective

models.Version

Properties

Name	Type	Go type	Required	Default	Description	Example
build_date	string	string
commit	string	string
version	string	string				1.0.0