Skip to main content
POST
fraud.address.check

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
subjectKey
string
required

Your stable subject key.

Required string length: 1 - 256
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.

includeGeocoding
boolean

Return coordinates; default off.

includePostalDetails
boolean

Return postal delivery facts; default off.

includeEnhancedMatch
boolean

Return match diagnostics; default off.

includeFreightForwarder
boolean

Return forwarding-facility facts; default off.

Response

The result

addresses
object[]
required

Verification facts for each requested address.

Maximum array length: 3
ref
string

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