Skip to main content
POST
fraud.transaction.assess

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
eventKey
string
required

Your stable event key.

Required string length: 1 - 255
action
string
required

Event action, for example purchase.

Required string length: 1 - 100
subjectKey
string
required

Your stable subject key.

Required string length: 1 - 256
affiliateKey
string

Affiliate key.

Required string length: 1 - 100
affiliateName
string

Affiliate name.

Required string length: 1 - 100
orderMemo
string

Order memo.

Required string length: 1 - 100
emailDomain
string

Email domain.

Required string length: 1 - 100
paymentKey
string

Payment key.

Required string length: 1 - 100
passwordHash
string

Password hash.

Required string length: 1 - 100
username
string

Username.

Required string length: 1 - 100
firstName
string

First name.

Required string length: 1 - 100
middleName
string

Middle name.

Required string length: 1 - 100
lastName
string

Last name.

Required string length: 1 - 100
birthPlace
string

Birth place.

Required string length: 1 - 100
identityValue
string

Identity value.

Required string length: 1 - 100
photoIdentityNumber
string

Photo identity number.

Required string length: 1 - 100
accountCategory
string

Account category.

Required string length: 1 - 100
accountStatus
string

Account status.

Required string length: 1 - 100
accountBankName
string

Account bank name.

Required string length: 1 - 100
accountBankAccount
string

Account bank account.

Required string length: 1 - 100
accountBankSwift
string

Account bank swift.

Required string length: 1 - 100
verificationStatus
string

Verification status.

Required string length: 1 - 100
verificationLevel
string

Verification level.

Required string length: 1 - 100
sessionKey
string

Session key.

Required string length: 1 - 256
paymentMethod
string

Payment method.

Required string length: 1 - 100
paymentService
string

Payment service.

Required string length: 1 - 100
cardholderName
string

Cardholder name.

Required string length: 1 - 100
cardExpiry
string

Card expiry.

Required string length: 1 - 100
addressVerificationResult
string

Address verification result.

Required string length: 1 - 100
cardAuthenticationStatus
string

Card authentication status.

Required string length: 1 - 100
authenticationMethod
string

Authentication method.

Required string length: 1 - 100
eventText
string

Event text.

Required string length: 1 - 4000
shippingPhone
string

International phone number with country code, without spaces.

Maximum string length: 19
Pattern: ^\+?[0-9]{7,18}$
shippingFullName
string

Shipping full name.

Required string length: 1 - 100
shippingMethod
string

Shipping method.

Required string length: 1 - 50
billingPhone
string

International phone number with country code, without spaces.

Maximum string length: 19
Pattern: ^\+?[0-9]{7,18}$
discountCode
string

Discount code.

Required string length: 1 - 50
merchantCategory
string

Merchant category.

Required string length: 1 - 100
merchantKey
string

Merchant key.

Required string length: 1 - 256
merchantName
string

Merchant name.

Required string length: 1 - 100
receiverFullName
string

Receiver full name.

Required string length: 1 - 100
receiverFirstName
string

Receiver first name.

Required string length: 1 - 100
receiverMiddleName
string

Receiver middle name.

Required string length: 1 - 100
receiverLastName
string

Receiver last name.

Required string length: 1 - 100
receiverBirthPlace
string

Receiver birth place.

Required string length: 1 - 100
receiverKey
string

Receiver key.

Required string length: 1 - 256
receiverPhotoIdentityNumber
string

Receiver photo identity number.

Required string length: 1 - 100
receiverBankAccount
string

Receiver bank account.

Required string length: 1 - 100
receiverBankSwift
string

Receiver bank swift.

Required string length: 1 - 100
receiverBankName
string

Receiver bank name.

Required string length: 1 - 100
campaignKey
string

Campaign key.

Required string length: 1 - 256
brandKey
string

Brand key.

Required string length: 1 - 256
market
string

Market.

Required string length: 1 - 100
accountCreatedAt
integer

accountCreatedAt numeric fact.

Required range: 0 <= x <= 9007199254740991
accountBalance
number

accountBalance numeric fact.

merchantCreatedAt
number

merchantCreatedAt numeric fact.

cardSecurityCodeMatched
boolean

cardSecurityCodeMatched fact.

gift
boolean

gift fact.

giftMessage
boolean

giftMessage fact.

accountBankCountry
string

Two-letter country code.

Pattern: ^[A-Za-z]{2}$
merchantCountry
string

Two-letter country code.

Pattern: ^[A-Za-z]{2}$
receiverCountry
string

Two-letter country code.

Pattern: ^[A-Za-z]{2}$
receiverBankCountry
string

Two-letter country code.

Pattern: ^[A-Za-z]{2}$
receiverDateOfBirth
string

Calendar date, YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
pointOfSale
object

Submitted coordinates.

customLocation
object

Submitted coordinates.

items
object[]

Order items, at most 100.

Maximum array length: 100
customFields
object

Bounded custom facts: text, number or boolean only.

ip
string

Public event IP.

Minimum string length: 1
email
string
Required string length: 1 - 320
phone
string

International phone number with country code, without spaces.

Maximum string length: 19
Pattern: ^\+?[0-9]{7,18}$
amount
number

Event amount.

Required range: x >= 0
currency
string

Currency code.

Required string length: 1 - 4
eventType
string

Event kind.

Required string length: 1 - 100
fullName
string

Submitted account name.

Required string length: 1 - 100
dateOfBirth
string

Calendar date, YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
session
string

Authentic session from your own client.

Required string length: 1 - 100000
userAddress
object

Postal address; country and street are required.

billingAddress
object

Postal address; country and street are required.

shippingAddress
object

Postal address; country and street are required.

card
object

Non-secret card facts.

signals
enum<string>[]

Explicit factual result groups; default none.

Maximum array length: 9
Available options:
ip,
email,
phone,
card,
device,
addresses,
geodistances,
string-analysis,
model

Response

The result

state
enum<string>

Decision about this event.

Available options:
approve,
review,
decline
fraudProbability
number

Estimated fraud probability for the submitted event, not the person.

Required range: 0 <= x <= 1
modelProbability
number

Optional model probability for this event.

Required range: 0 <= x <= 1
addressSignals
object[]

Requested address facts.

Maximum array length: 3
ipSignals
object

Requested IP facts.

emailSignals
object

Requested mailbox facts.

phoneSignals
object

Requested phone facts.

cardSignals
object

Requested card facts.

deviceSignals
object

Requested device facts.

distances
object[]

Requested distances.

stringStatistics
object[]

Requested string statistics; no person rating.

ref
string

Reference to what this call created. Pass it as ref to Follow-up calls for fraud_transaction..