Skip to main content
POST
finance.payment-address.verify

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-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$
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
address
string

Payment address to verify. Send this or bank.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9._-]{2,80}@[A-Za-z0-9.-]{2,30}$
bank
object

Bank account to verify and look up the holder name for, typed by scheme. Send this or address. Sources decline schemes they cannot check.

expectedName
string

Optional holder name sent for comparison; no numeric score is returned. Some bank checks require it.

Required string length: 1 - 100
includeHolderName
boolean
default:false

Return the holder name when available.

Response

The result

active
boolean
required

Whether this payment address or bank account is valid and can receive money.

holderName
string

Holder name, only when requested.