Skip to content
Eligibility (Pre-checks)/
Identity transaction elig...

Identity transaction eligibility

Request

Request transaction eligibility for a specific identity

Security
HMACAuth
Bodyapplication/jsonrequired
Any of:

Request payload for transaction eligibility.

Identification rules:

  • Provide identityReference, OR provide all of email, countryOfResidence.
  • Responses containg 422 status codes can vary based on the restrcitions found for the profile for example:
    • limit breach (daily, weekly, monthly, annual)
    • age restrictions
    • unsupported asset or fiat currency
    • Locality restrictions

Amount rules:

  • Provide exactly one of fiatAmount or cryptoAmount.

Conditional:

  • state is required when countryOfResidence is US.
One of:
curl -i -X POST \
  https://docs.banxa.com/_mock/products/native-api/openapi/eapi/v0/identities/transactions/eligibility \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "identityReference": "customer-12345",
    "method": "payid-bank-transfer",
    "transactionType": "ONRAMP",
    "fiat": "AUD",
    "crypto": "BTC",
    "blockchain": "BTC",
    "fiatAmount": "100.00"
  }'

Responses

Eligibility check result

Bodyapplication/json
paymentReadybooleanrequired

Whether the identity is eligible and can proceed with payment/transaction. When true, there are no KYC requirements.

Example:false
kycRequirementsArray of strings, uniquerequired

List of outstanding requirements that must be satisfied before payment can proceed. If paymentReady is true, this will typically be an empty array.

Items Enum:"TIN""NAME""DOB""ADDRESS""POA""DOCUMENT""SELFIE""SOURCE_FUNDS""OCCUPATION""PURPOSE_OF_TX"
Example:
[
  "TIN",
  "NAME",
  "DOB",
  "ADDRESS",
  "POA",
  "DOCUMENT",
  "SELFIE",
  "SOURCE_FUNDS",
  "OCCUPATION",
  "PURPOSE_OF_TX"
]
Response
Customer has completed all KYC requirements and can proceed
{
  "paymentReady": true,
  "requirements": []
}
© Banxa 2026