# Identity transaction eligibility

Request transaction eligibility for a specific identity

Endpoint: POST /eapi/identities/transactions/eligibility
Version: 0 BETA
Security: HMACAuth

## Request fields (application/json):

  - `identityReference` (string)
    Partner identity reference.
    Example: "user-123"

  - `method` (string, required)
    Transaction method (partner-defined).
    Example: "payid-bank-transfer"

  - `transactionType` (string, required)
    Transaction type. Must be a valid value of TransactionTypeEnum.
(Populate the allowed values here if you want strict client validation.)
    Enum: "ONRAMP", "OFFRAMP"

  - `fiat` (string, required)
    Fiat currency code allowed for the partner (e.g., ISO 4217).
Enforced server-side validation for availbility
    Example: "AUD"

  - `crypto` (string, required)
    Crypto asset code. Enforced server-side validation for availbility
    Example: "BTC"

  - `fiatAmount` (string)
    Fiat amount as a decimal string.
Mutually exclusive with cryptoAmount.
    Example: "250.00"

  - `cryptoAmount` (string)
    Crypto amount as a decimal string.
Mutually exclusive with fiatAmount.
    Example: "0.125"

  - `blockchain` (string, required)
    Blockchain identifier.
    Example: "BITCOIN"

  - `email` (string)
    Required when identityReference is not provided.
    Example: "user@example.com"

  - `countryOfResidence` (string)
    Required when identityReference is not provided.
ISO 3166-1 alpha-2 country code.
    Example: "AU"

  - `dateOfBirth` (string)
    Optional when identityReference is not provided. (Format YYYY-MM-DD)"
    Example: "1990-01-30"

  - `state` (string)
    Required if countryOfResidence is US. (Enforced server-side.)
    Example: "CA"

## Response 202 fields (application/json):

  - `paymentReady` (boolean, required)
    Whether the identity is eligible and can proceed with payment/transaction. When true, there are no KYC requirements.

  - `requirements` (array, required)
    List of outstanding requirements that must be satisfied before payment can proceed.
If paymentReady is true, this will typically be an empty array.
    Enum: "US_TAX_ID", "PERSONAL_DETAILS", "DOCUMENT", "SELFIE", "SOURCE_FUNDS", "OCCUPATION", "PURPOSE_OF_TX"

## Response 400 fields (application/json):

  - `message` (string)
    Example: "Bad Request"

  - `status` (integer)
    Example: 400

  - `traceId` (string)
    Idempotency key for the error
    Example: "2b6fc5d0-57e4-4b5a-9e3c-6cfbb6d8023f"

## Response 401 fields (application/json):

  - `message` (string)
    Example: "Unauthenticated."

  - `status` (integer)
    Example: 401

## Response 404 fields (application/json):

  - `message` (string)
    Example: "Not Found"

  - `status` (integer)
    Example: 404

## Response 422 fields (application/json):

  - `message` (string)
    Example: "The given data was invalid."

  - `errors` (object)

  - `status` (integer)
    Example: 422

## Response 500 fields (application/json):

  - `message` (string)
    Example: "Server Error"

  - `status` (integer)
    Example: 500

  - `traceId` (string)
    Idempotency key for the error
    Example: "2b6fc5d0-57e4-4b5a-9e3c-6cfbb6d8023f"