# Get a financial instrument by ID

Retrieves one financial instrument associated with the specified identity.

In the current release, one instrument is retrieved at most because only a single instrument is allowed per identity.

Endpoint: GET /v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}
Version: 2026.03
Security: Bearer

## Path parameters:

  - `identity-id` (string, required)
    Unique identifier of the identity whose instruments you want to list.
    Example: "2f4ac57f-c5ba-4051-b51f-b3565778717b"

  - `financial-instrument-id` (string, required)
    The ID of the financial instrument of the identity.
    Example: "2f4ac57f-c5ba-4051-b51f-b3565778717b"

## Query parameters:

  - `version` (string)
    Version of the identity
    Example: "2"

  - `expand-identity` (boolean)
    Optional parameter to expand the financial instrument details.
If set to true, the details about the identity will be included in the response.
    Example: true

## Response 200 fields (application/json):

  - `financialInstrument` (object, required)
    Request to create a new financial instrument for an identity.

  - `financialInstrument.usAch` (object)
    Rails: RTP, ACH

Rail Definitions:

RTP:
  - Availability: 24/7/365
  - Limit: $5,000,000
  - Settlement: <5 minutes
  - Cut-off time: None
  - Banking holidays: Not applicable

ACH:
  - Availability: Business days only
  - Limit: $1,000,000
  - Settlement: Same-day
  - Cut-off time: 3:00 PM EST
  - Banking holidays: U.S. banking holidays apply

Routing Evaluation Order:

  1. RTP
     - Conditions: beneficiary account is RTP-addressable AND amount ≤ $5,000,000
  2. ACH
     - Conditions: otherwise applicable

  - `financialInstrument.usAch.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.usAch.bankRoutingNumber` (string, required)
    The identity's bank routing number

  - `financialInstrument.usAch.accountNumber` (string, required)
    The identity's account number into which the funds must be credited

  - `financialInstrument.usAch.accountType` (string, required)
    The identity's account type.

  - `financialInstrument.usFedwire` (object)
    Rails: FEDWIRE

Rail Definitions:

FEDWIRE:
  - Availability: U.S. business days and operating hours.
  - Limit: No limit
  - Settlement: Real-time gross settlement (typically within minutes).
  - Cut-off time: 5:00 p.m. ET; transfers submitted after cut-off queue for next business day.
  - Banking holidays: Follows the Federal Reserve holiday schedule.

  - `financialInstrument.usFedwire.bankName` (string, required)
    The name of the identity's bank.

  - `financialInstrument.usFedwire.bankRoutingNumber` (string, required)
    9-digit ABA Routing Transit Number (RTN) of the beneficiary's bank.

  - `financialInstrument.usFedwire.accountNumber` (string, required)
    The identity's account number to be credited.

  - `financialInstrument.mxSpei` (object)
    Rails: SPEI

Rail Definitions:

SPEI:
- Availability: 24/7/365
- Limit: None
- Settlement: Instant
- Cut-off time: None
- Banking holidays: Not applicable

Routing Evaluation Order: Not applicable

  - `financialInstrument.mxSpei.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.mxSpei.clabe` (string, required)
    The identity's CLABE account identification code

  - `financialInstrument.euSepa` (object)
    Rails: SCT Inst, SCT

Rail Definitions:

SCT Inst:
- Availability: 24/7/365
- Limit: €100,000 (bank-dependent)
- Settlement: Instant
- Cut-off time: None
- Banking holidays: Not applicable

SCT:
- Availability: Business days only
- Limit: No limit
- Settlement: T+2 to T+5 
- Cut-off time: 3:00PM GMT/BST
- Banking holidays: TARGET2 holidays apply

Routing Evaluation Order:

  1. SCT Inst  
     - Conditions: beneficiary account is SCT Inst-addressable AND amount ≤ €100,000
  2. SCT  
     - Conditions: otherwise applicable

  - `financialInstrument.euSepa.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.euSepa.iban` (string, required)
    The International Bank Account Number (IBAN) of the identity's account

  - `financialInstrument.gbFps` (object)
    Rails: FPS, CHAPS

Rail Definitions:

FPS:
- Availability: 24/7/365
- Limit: £1,000,000
- Settlement: Instant
- Cut-off time: None
- Banking holidays: Not applicable

CHAPS:
- Availability: Business days only
- Limit: No limit
- Settlement: Same-day
- Cut-off time: Typically 5:00 PM GMT/BST (bank-dependent)
- Banking holidays: UK banking holidays apply

Routing Evaluation Order:
  1. FPS  
     - Conditions: beneficiary account is FPS-addressable AND amount ≤ £1,000,000
  2. CHAPS  
     - Conditions: otherwise applicable

  - `financialInstrument.gbFps.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.gbFps.sortCode` (string, required)
    The sort code of the identity's bank account

  - `financialInstrument.gbFps.accountNumber` (string, required)
    The account number of the identity's bank account

  - `financialInstrument.ngBankPayout` (object)
    Rails: Bank Payout

Rail Definitions:

Bank Payout:
- Availability: Country-dependant
- Limit:
- Nigeria: ₦5,000,000
- Settlement: Real time to 48 hours
- Cut-off time: Real time
- Banking holidays: Nigeria banking holidays apply

Routing Evaluation Order: Not applicable

  - `financialInstrument.ngBankPayout.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.ngBankPayout.bankCode` (string, required)
    Ripple Bank Code (RBC) for the destination bank in Nigeria. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.

  - `financialInstrument.ngBankPayout.accountNumber` (string, required)
    The identity's account number associated with the Account Identification Scheme

  - `financialInstrument.ghBankPayout` (object)
    Rails: GIP

Rail Definitions:
  GIP:
    - Availability: 24/7/365
    - Limit: ₵100,000
    - Settlement: Real time to 48 hours
    - Cut-off time: Real time
    - Banking holidays: Applicable

Routing Evaluation Order:
  1. GIP – Conditions: Account addressability, amount ≤ ₵100,000

  - `financialInstrument.ghBankPayout.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.ghBankPayout.bankCode` (string, required)
    Ripple Bank Code (RBC) for the destination bank in Ghana. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.

  - `financialInstrument.ghBankPayout.accountNumber` (string, required)
    The identity's account number associated with the Account Identification Scheme

  - `financialInstrument.rwBankPayout` (object)
    Rails: RSwitch

Rail Definitions:
  RSwitch:
    - Availability: 24/7/365
    - Limit: RWF 10,000,000
    - Settlement: Real time to 48 hours
    - Cut-off time: Real time
    - Banking holidays: Applicable

Routing Evaluation Order:
  1. RSwitch – Conditions: Account addressability, amount ≤ RWF 10,000,000

  - `financialInstrument.rwBankPayout.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.rwBankPayout.bankCode` (string, required)
    Ripple Bank Code (RBC) for the destination bank in Rwanda. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.

  - `financialInstrument.rwBankPayout.accountNumber` (string, required)
    The identity's account number associated with the Account Identification Scheme

  - `financialInstrument.zaBankPayout` (object)
    Rails: Bank Payout

Rail Definitions:
  Bank Payout:
    - Availability: 24/7/365
    - Limit: R 300,000
    - Settlement: Real time to 48 hours
    - Cut-off time: Real time
    - Banking holidays: Applicable

Routing Evaluation Order:
  1. Bank Payout – Conditions: Account addressability, amount ≤ R 300,000

  - `financialInstrument.zaBankPayout.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.zaBankPayout.bankCode` (string, required)
    Ripple Bank Code (RBC) for the destination bank in South Africa. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.

  - `financialInstrument.zaBankPayout.accountNumber` (string, required)
    The identity's account number associated with the Account Identification Scheme

  - `financialInstrument.ugBankPayout` (object)
    Rails: Bank Payout

Rail Definitions:
  Bank Payout:
    - Availability: 24/7/365
    - Limit: UGX 20,000
    - Settlement: Real time to 48 hours
    - Cut-off time: Real time
    - Banking holidays: Applicable

Routing Evaluation Order:
  1. Bank Payout – Conditions: Account addressability, amount ≤ UGX 20,000

  - `financialInstrument.ugBankPayout.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.ugBankPayout.bankCode` (string, required)
    Ripple Bank Code (RBC) for the destination bank in Uganda. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.

  - `financialInstrument.ugBankPayout.accountNumber` (string, required)
    The identity's account number associated with the Account Identification Scheme

  - `financialInstrument.zmBankPayout` (object)
    Rails: Bank Payout

Rail Definitions:
  Bank Payout:
    - Availability: 24/7/365
    - Limit: ZK 150,000
    - Settlement: Real time to 48 hours
    - Cut-off time: Real time
    - Banking holidays: Applicable

Routing Evaluation Order:
  1. Bank Payout – Conditions: Account addressability, amount ≤ ZK 150,000

  - `financialInstrument.zmBankPayout.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.zmBankPayout.bankCode` (string, required)
    Ripple Bank Code (RBC) for the destination bank in Zambia. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.

  - `financialInstrument.zmBankPayout.accountNumber` (string, required)
    The identity's account number associated with the Account Identification Scheme

  - `financialInstrument.ethWallet` (object)
    Rails: CRYPTO

Rail Definitions:

CRYPTO:
  - Availability: 24/7/365
  - Limit: None
  - Settlement: Blockchain dependent
  - Cut-off time: None
  - Banking holidays: Not applicable

Routing Policy: Not applicable

  - `financialInstrument.ethWallet.walletAddress` (string, required)
    Receiving wallet address at the exchange
    Example: "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

  - `financialInstrument.ethWallet.cryptoInstitutionName` (string, required)
    Name of the crypto exchange
    Example: "Bitso"

  - `financialInstrument.ethWallet.network` (string)
    The default name of the blockchain network for this instrument

  - `financialInstrument.ethWallet.supportedCorridors` (array)
    The list of supported corridors for the payout method
    Enum: "ETH_USDT", "ETH_USDC", "ETH_RLUSD"

  - `financialInstrument.tronWallet` (object)
    Rails: CRYPTO

Rail Definitions:

CRYPTO:
  - Availability: 24/7/365
  - Limit: None
  - Settlement: Blockchain dependent
  - Cut-off time: None
  - Banking holidays: Not applicable

Routing Policy: Not applicable

  - `financialInstrument.tronWallet.walletAddress` (string, required)
    Receiving wallet address at the exchange
    Example: "T9yD14Nj9j7xAB4dbGeiX9h8unkKHxuWwb"

  - `financialInstrument.tronWallet.cryptoInstitutionName` (string, required)
    Name of the crypto exchange
    Example: "Bitso"

  - `financialInstrument.tronWallet.network` (string)
    The default name of the blockchain network for this instrument

  - `financialInstrument.tronWallet.supportedCorridors` (array)
    The list of supported corridors for the payout method
    Enum: "TRON_USDT"

  - `financialInstrument.solWallet` (object)
    Rails: CRYPTO

Rail Definitions:

CRYPTO:
  - Availability: 24/7/365
  - Limit: None
  - Settlement: Blockchain dependent
  - Cut-off time: None
  - Banking holidays: Not applicable

Routing Policy: Not applicable

  - `financialInstrument.solWallet.walletAddress` (string, required)
    Receiving wallet address at the exchange
    Example: "7EcDhSYGxXyscszYEp35KHN8vvw3svAuLKTzXwCFLtV"

  - `financialInstrument.solWallet.cryptoInstitutionName` (string, required)
    Name of the crypto exchange
    Example: "Bitso"

  - `financialInstrument.solWallet.network` (string)
    The default name of the blockchain network for this instrument

  - `financialInstrument.solWallet.supportedCorridors` (array)
    The list of supported corridors for the payout method
    Enum: "SOLANA_USDC"

  - `financialInstrument.brPix` (object)
    Rails: PIX

Rail Definitions:

PIX:
- Availability: 24/7/365
- Limit: No limit
- Settlement: Instant
- Cut-off time: None
- Banking holidays: Not applicable

Routing Evaluation Order: Not applicable

  - `financialInstrument.brPix.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.brPix.bankCode` (string, required)
    The code of the identity's bank (BICFI code)

  - `financialInstrument.brPix.branchNumber` (string, required)
    The identity's bank branch number

  - `financialInstrument.brPix.pixKey` (string, required)
    The identity's PIX key, which can be an email, phone number, or a hash

  - `financialInstrument.brPix.pixKeyType` (string, required)
    The type of PIX key used by the identity.

  - `financialInstrument.coPse` (object)
    Rails: PSE

Rail Definitions:

PSE:
- Availability: Business days and banking hours only
- Limit: None
- Settlement: 
	- Major banks (Bancolombia, Davivienda, Banco de Bogotá, BBVA, Grupo Aval, Nequi): 35–100 min
	- Other banks (via ACH): Same-day or T+1 depending on cutoff
- Cut-off time: 3PM COT
- Banking holidays: Colombia banking holidays apply

Routing Evaluation Order: Not applicable

  - `financialInstrument.coPse.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.coPse.bankCode` (string, required)
    The identity's bank identifier code

  - `financialInstrument.coPse.accountNumber` (string, required)
    The identity's account number associated with the Account Identification Scheme

  - `financialInstrument.coPse.accountType` (string, required)
    The type of account associated with the identity.

  - `financialInstrument.brTed` (object)
    Rails: TED

Rail Definitions:

TED:
- Availability: Business days only
- Limit: No limit
- Settlement: Same-day
- Cut-off time: ~5:00 PM BRT 
- Banking holidays: Brazil banking holidays apply

Routing Evaluation Order: Not applicable

  - `financialInstrument.brTed.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.brTed.bankCode` (string, required)
    The code of the identity's bank (BICFI code)

  - `financialInstrument.brTed.branchNumber` (string, required)
    The branch number of the identity's bank account

  - `financialInstrument.brTed.accountNumber` (string, required)
    The identity's account number associated with the Account Identification Scheme

  - `financialInstrument.brTed.accountType` (string, required)
    The identity's account type (Savings, Checking etc.)
    Example: "SAVINGS"

  - `financialInstrument.caEft` (object)
    Rails: EFT

Rail Definitions:

EFT:
- Availability: Business days only
- Limit: CAD 1,000,000
- Settlement: T+1
- Cut-off time: ~4:30 PM EST
- Banking holidays: Canadian banking holidays apply

Routing Evaluation Order: Not applicable

  - `financialInstrument.caEft.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.caEft.institutionNumber` (string, required)
    The institution number of the identity's bank

  - `financialInstrument.caEft.transitNumber` (string, required)
    The transit number of the identity's bank account

  - `financialInstrument.caEft.accountNumber` (string, required)
    The identity's account number associated with the Account Identification Scheme

  - `financialInstrument.caEft.accountType` (string, required)
    The identity's account type.

  - `financialInstrument.krKftc` (object)
    Rails: KFTC (Korea Financial Telecommunications and Clearings)

Rail Definitions:

KFTC:
- Availability: 24/7/365
- Limit: KRW 10,000,000 per transaction (varies)
- Settlement: Real-time
- Cut-off time: None
- Banking holidays: Not applicable

Routing Evaluation Order: Not applicable

  - `financialInstrument.krKftc.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.krKftc.bankCode` (string, required)
    KFTC-assigned Korean domestic clearing code. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.

  - `financialInstrument.krKftc.accountNumber` (string, required)
    The identity's bank account number

  - `financialInstrument.inNeft` (object)
    Rails: NEFT (National Electronic Funds Transfer)

Rail Definitions:

NEFT:
- Availability: Business days and banking hours only
- Limit: No limit
- Settlement: Same-day (by end of business day)
- Cut-off time: 7:00 PM IST (varies by bank)
- Banking holidays: India banking holidays apply

Routing Evaluation Order: Not applicable

  - `financialInstrument.inNeft.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.inNeft.ifscCode` (string, required)
    The 11-character IFSC code of the identity's bank branch

  - `financialInstrument.inNeft.accountNumber` (string, required)
    The identity's bank account number

  - `financialInstrument.peLbtr` (object)
    Rails: LBTR (Sistema de Liquidación Bruta en Tiempo Real)

Rail Definitions:

LBTR:
- Availability: Business days and banking hours only
- Limit: Minimum Transaction amount is 5 USD
- Settlement: Same-day
- Cut-off time: 3:00 PM PET
- Banking holidays: Peru banking holidays apply

Routing Evaluation Order: Not applicable

  - `financialInstrument.peLbtr.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.peLbtr.swiftCode` (string, required)
    SWIFT/BIC code of the identity's bank

  - `financialInstrument.peLbtr.accountNumber` (string, required)
    The identity's bank account number

  - `financialInstrument.peLbtr.accountType` (string, required)
    The identity's account type

  - `financialInstrument.auNpp` (object)
    Rails: NPP (New Payments Platform), Direct Entry (DE/BECS)

Rail Definitions:

NPP:
- Availability: 24/7/365
- Limit: AUD 20,000 per transaction (higher with arrangement)
- Settlement: Real-time (within 15 minutes)
- Cut-off time: None
- Banking holidays: Not applicable

Direct Entry (BECS):
- Availability: Business days only
- Limit: No limit
- Settlement: Same-day or next business day
- Cut-off time: Bank-dependent
- Banking holidays: Australian banking holidays apply

Routing Evaluation Order:
  1. NPP
     - Conditions: beneficiary account is NPP-addressable AND amount ≤ AUD 20,000
  2. Direct Entry
     - Conditions: otherwise applicable

  - `financialInstrument.auNpp.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.auNpp.bsbCode` (string, required)
    The 6-digit Bank-State-Branch (BSB) routing code

  - `financialInstrument.auNpp.accountNumber` (string, required)
    The identity's bank account number

  - `financialInstrument.jpZengin` (object)
    Rails: Zengin, Zengin Prompt Service

Rail Definitions:

Zengin:
- Availability: Business days and banking hours only
- Limit: No limit
- Settlement: Same-day or next business day
- Cut-off time: 9:00 PM JST (varies by bank)
- Banking holidays: Japan banking holidays apply

Zengin Prompt Service:
- Availability: 24/7/365
- Limit: JPY 1,000,000 (typically)
- Settlement: Real-time
- Cut-off time: None
- Banking holidays: Not applicable

Routing Evaluation Order:
  1. Zengin Prompt Service
     - Conditions: beneficiary account is ZPS-addressable AND amount ≤ JPY 1,000,000
  2. Zengin
     - Conditions: otherwise applicable

  - `financialInstrument.jpZengin.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.jpZengin.accountHolderName` (string, required)
    Name of the account holder in Japanese Katakana characters

  - `financialInstrument.jpZengin.bankCode` (string, required)
    Zengin-Net/BOJ-assigned 4-digit Japanese bank code (e.g. 0001 Mizuho Bank, 0005 MUFG Bank). See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.

  - `financialInstrument.jpZengin.branchCode` (string, required)
    Bank-assigned branch code identifying the specific branch

  - `financialInstrument.jpZengin.accountNumber` (string, required)
    The identity's bank account number

  - `financialInstrument.jpZengin.accountType` (string, required)
    The identity's account type

  - `financialInstrument.cnCfxps` (object)
    Rails: CFXPS (China Foreign Exchange Payment System)

Rail Definitions:

CFXPS:
- Availability: Business days and banking hours only
- Limit: No limit (institutional)
- Settlement: Same-day or next business day
- Cut-off time: 5:00 PM CST (varies by bank)
- Banking holidays: China banking holidays apply

  - `financialInstrument.cnCfxps.bankName` (string, required)
    Beneficiary Bank Name. Looked up from swiftCode.

  - `financialInstrument.cnCfxps.swiftCode` (string, required)
    Beneficiary Bank SWIFT/BIC Code. See the China entry in the bank code lookup in the integration resources for the supported list.

  - `financialInstrument.cnCfxps.accountNumber` (string, required)
    Beneficiary Account Number.

  - `financialInstrument.cnCfxps.accountHolderName` (string, required)
    Beneficiary Account Holder Name (English).

  - `financialInstrument.clTef` (object)
    Rails: TEF (Transferencia Electrónica de Fondos)

Rail Definitions:

TEF:
- Availability: Business days only
- Limit: No limit
- Settlement: Same-day or next business day
- Cut-off time: 3:00 PM CLT
- Banking holidays: Chile banking holidays apply

Routing Evaluation Order: Not applicable

  - `financialInstrument.clTef.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.clTef.swiftCode` (string, required)
    SWIFT/BIC code of the identity's bank

  - `financialInstrument.clTef.accountNumber` (string, required)
    The identity's bank account number

  - `financialInstrument.clTef.accountType` (string, required)
    The identity's account type

  - `financialInstrument.aeIpi` (object)
    Rails: IPI, FTS

Rail Definitions:

IPI:
- Availability: 24/7/365
- Limit: AED 25,000
- Settlement: Instant
- Cut-off time: None
- Banking holidays: Not applicable

FTS:
- Availability: Business days only
- Limit: No limit
- Settlement: Same-day
- Cut-off time: ~2:00 PM GST
- Banking holidays: UAE Central Bank holidays apply

Routing Evaluation Order:
  1. IPI  
     - Conditions: beneficiary account is IPI-addressable AND amount ≤ AED 25,000
  2. FTS  
     - Conditions: otherwise applicable

  - `financialInstrument.aeIpi.bankName` (string, required)
    The name of the identity's bank

  - `financialInstrument.aeIpi.iban` (string, required)
    The International Bank Account Number (IBAN) of the identity's account

  - `financialInstrument.thPromptpay` (object)
    Rails: PromptPay

Rail Definitions:

PromptPay (National ITMX):
  - Availability: 24/7/365
  - Limit: THB 500,000 per transaction
  - Settlement: Real-time (within seconds)
  - Cut-off time: None
  - Banking holidays: Not applicable

Routing Evaluation Order: Not applicable

  - `financialInstrument.thPromptpay.bankName` (string, required)
    The name of the identity's bank
    Example: "Bangkok Bank"

  - `financialInstrument.thPromptpay.bankCode` (string, required)
    Domestic bank code for the identity's bank in Thailand. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.
    Example: "002"

  - `financialInstrument.thPromptpay.accountNumber` (string, required)
    The identity's bank account number
    Example: "1234567890"

  - `financialInstrument.arInterbanking` (object)
    Rails: Interbanking

Rail Definitions:

Interbanking:
- Availability: Business days only
- Limit: ARS 10,000,000
- Settlement: Same-day or next business day
- Cut-off time: 3:00 PM ART
- Banking holidays: Argentina banking holidays apply

Routing Evaluation Order: AR_INTERBANKING has a single payment rail; no routing evaluation order applies.

  - `financialInstrument.arInterbanking.bankName` (string, required)
    The name of the identity's bank. Must begin and end with a letter or digit, and consecutive identical punctuation characters are not permitted.

  - `financialInstrument.arInterbanking.bankCode` (string, required)
    BCRA-assigned 3-digit Argentine bank code. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.

  - `financialInstrument.arInterbanking.accountNumber` (string, required)
    The identity's account number (CBU or CVU)

  - `financialInstrument.arInterbanking.accountType` (string, required)
    The identity's account type

  - `financialInstrument.currency` (string, required)
    The 3-letter ISO currency code of the financial instrument.
    Example: "MXN"

  - `financialInstrument.label` (string)
    A user-defined label for the financial instrument.
    Example: "mexico bank account"

  - `financialInstrument.financialInstrumentType` (string, required)
    The type of financial instrument or payment rail used for executing the transaction.
This determines the structure and validation of account details required for the payout.
    Example: "BR_PIX"

  - `financialInstrument.country` (string)
    The 2-letter ISO 3166-1 alpha-2 country code of the financial instrument. This field is omitted when no country jurisdiction applies (for example, crypto wallet instruments such as ETH_WALLET, TRON_WALLET, and SOL_WALLET). An absent country should be interpreted as "no applicable jurisdiction".
    Example: "MX"

  - `financialInstrument.financialInstrumentId` (string)
    The unique identifier of the financial instrument.
    Example: "3fc74743-e7f3-414a-9fcf-eb8c1d52356a"

  - `financialInstrument.createdAt` (string)
    The time at which the financial instrument was created
    Example: "2023-11-02T18:26:00.000Z"

  - `financialInstrument.updatedAt` (string)
    The time at which the financial instrument was last updated
    Example: "2023-11-03T18:26:00.000Z"

  - `identity` (object)

  - `identity.identityId` (string)
    Server-generated unique identifier of the identity.
    Example: "2f4ac57f-c5ba-4051-b51f-b3565778717b"

  - `identity.identityState` (string)
    The state of the identity
  * ACTIVE
  * DEACTIVATED
    Example: "ACTIVE"

  - `identity.nickName` (string)
    Optional human-readable alias set by the client.
    Example: "nickName"

  - `identity.tags` (array)
    Optional labels used to categorize or filter identities.
    Example: ["tag1"]

  - `identity.validatePayoutRails` (array)
    List of payout methods where this identity is considered valid. Use this to indicate which payout methods (for example, US_ACH, EU_SEPA) the identity can be used with in payments.
    Example: ["BR_PIX"]

  - `identity.version` (string)
    Sequential version number. Each successful PUT creates a higher version.
    Example: 2

  - `identity.schemaVersion` (string)
    Schema version used to validate this identity, for example 1.0.0.
    Example: "1.0.0"

  - `identity.createdAt` (string)
    RFC 3339 timestamp when the identity was created.
    Example: "2023-11-02T18:26:00.000Z"

  - `identity.updatedAt` (string)
    RFC 3339 timestamp when the identity was last updated.
    Example: "2023-11-03T18:26:00.000Z"

  - `identity.identityType` (string, required)
    The type of the identity
    Example: "BUSINESS"

  - `identity.paymentRole` (string, required)
    The payment role of the identity
    Example: "BENEFICIARY"

  - `identity.internalId` (string)
    Client-provided unique identifier for idempotency and deduplication. Required for
ORIGINATOR identities; optional for BENEFICIARY identities. Must be unique across
all active identities in your organization. Duplicate values will result in a 409
Conflict error.

This is your own reference key, not the originator's account number. Use
originatorAccountNumber for that.
    Example: "customer-12345-uuid"

  - `identity.originatorAccountNumber` (string)
    The originator's account number, or your customer identifier for the originator.
Required for ORIGINATOR identities on USD payments to China (CN_CFXPS); optional
elsewhere. Only sent to payout partners for ORIGINATOR identities.

Must be unique across all active identities in your organization, including
BENEFICIARY identities. Duplicate values return a 409 Conflict error.

Corridor length and character limits apply to this value but are not enforced on
this field. See the corridor's Integration resources page.
    Example: "6222021001125874"

  - `identity.business` (object)
    PII data to support business and institutional identities

  - `identity.business.businessName` (string, required)
    Business Legal Name
    Example: "Widgets Org"

  - `identity.business.address` (object, required)
    Holds general information about the business

  - `identity.business.address.streetAddress` (array, required)
    Allows the street address of the business to be held
    Example: ["123 Example St. Boston, MA"]

  - `identity.business.address.country` (string, required)
    Allows the country of the business to be held. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list.
    Example: "US"

  - `identity.business.address.city` (string, required)
    City
    Example: "Boston"

  - `identity.business.address.stateOrProvince` (string)
    State, province, or county of the business address, as defined by postal services.
    Example: "Massachusetts"

  - `identity.business.address.postalCode` (string)
    Postal code for the business
    Example: "12345"

  - `identity.business.email` (string)
    Address for electronic mail (e-mail).
    Example: "fake@example.com"

  - `identity.business.phone` (string)
    Phone Number
    Example: 1234567890

  - `identity.business.registration` (array)
    Unique and unambiguous way to identify a business or organization. An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.

  - `identity.business.registration.number` (string, required)
    The unique identifier of the organization
    Example: "123ABC"

  - `identity.business.registration.type` (string, required)
    Type of business identification document. Accepted values may vary by corridor and payment role. Some corridors accept only a subset of this list. See Ripple Docs for corridor-specific requirements.
    Example: "INCORPORATION_CERTIFICATE"

  - `identity.business.incorporationCountry` (string)
    Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.
    Example: "US"

  - `identity.business.incorporationDate` (string)
    The date when the business was incorporated.
    Example: "2020-01-15"

  - `identity.business.legalEntityType` (string)
    Type of legal entity to distinguish between Financial Institutions and Non-Financial Institutions.

This classification is used to determine regulatory treatment and compliance requirements for certain payment corridors.
    Example: "BANK_CENTRAL"

  - `identity.business.localized` (object)
    Identity fields supplied in a non-Latin script, in addition to the Latin-script values
elsewhere on the identity. Populate the script block that the destination corridor
requires.

  - `identity.business.localized.hanzi` (object)
    Localized identity fields in Chinese Hanzi characters (汉字).

  - `identity.business.localized.hanzi.businessName` (string)
    Business legal name in Chinese Hanzi characters.
    Example: "上海示例贸易有限公司"

  - `identity.individual` (object)
    Data for an individual

  - `identity.individual.firstName` (string, required)
    First name of the individual
    Example: "John"

  - `identity.individual.lastName` (string, required)
    Last name of the individual
    Example: "Smith"

  - `identity.individual.address` (object, required)
    Holds general information about the individual

  - `identity.individual.address.streetAddress` (array, required)
    Allows the street address of the individual to be held
    Example: ["123 Example St. Boston, MA"]

  - `identity.individual.address.country` (string, required)
    Allows the Country of the individual to be held. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list.
    Example: "US"

  - `identity.individual.address.city` (string, required)
    City
    Example: "Boston"

  - `identity.individual.address.stateOrProvince` (string)
    Information that locates and identifies the state / county for the party, as defined by postal services
    Example: "Massachusetts"

  - `identity.individual.address.postalCode` (string)
    Postal code for the individual's address
    Example: "12345"

  - `identity.individual.email` (string)
    Address for electronic mail (e-mail).
    Example: "fake@example.com"

  - `identity.individual.phone` (string)
    Phone Number.
    Example: 1234567890

  - `identity.individual.identityDocuments` (array)
    Identification documents for the identity, such as a passport, national ID, or tax ID. Required for ORIGINATOR and BENEFICIARY identities on some corridors and optional on others; see the Payload schema utility for the corridors that require it. Also required for ORIGINATOR identities when your organization is configured for the Brazil (BR) jurisdiction, on every corridor, including corridors that do not otherwise require it. Jurisdiction comes from your organization's configuration, not from a value in the request. Where the field is required, omitting it fails identity create and update with 400 Bad Request (USR_111).
For accepted document types per corridor and role, see Accepted document types by corridor.

  - `identity.individual.identityDocuments.idNumber` (string, required)
    Identification Number.
    Example: "123ABC"

  - `identity.individual.identityDocuments.idType` (string, required)
    The type of identification document used to identify the identity. Accepted values may vary by corridor and payment role. Some corridors accept only a subset of this list. See Ripple Docs for corridor-specific requirements.

  - `identity.individual.identityDocuments.expiryDate` (string)
    Expiration date of the identification document.
    Example: "2030-01-15"

  - `identity.individual.dateOfBirth` (string)
    Date of Birth.
    Example: "2001-01-24"

  - `identity.individual.countryOfBirth` (string)
    Country of Birth. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list.
    Example: "US"

  - `identity.individual.citizenship` (string)
    Alpha-2 country code for the nationality of the individual in ISO 3166-1 format.
    Example: "US"

  - `identity.individual.gender` (string)
    Gender of the identity.
    Example: "FEMALE"

  - `identity.individual.localized` (object)
    Identity fields supplied in a non-Latin script, in addition to the Latin-script values
elsewhere on the identity. Populate the script block that the destination corridor
requires.

  - `identity.individual.localized.hanzi` (object)
    Localized identity fields in Chinese Hanzi characters (汉字).

  - `identity.individual.localized.hanzi.firstName` (string)
    Individual given name in Chinese Hanzi characters.
    Example: "伟"

  - `identity.individual.localized.hanzi.lastName` (string)
    Individual family name in Chinese Hanzi characters.
    Example: "张"

  - `identity.individual.localized.hanzi.businessName` (string)
    Business name associated with the individual in Chinese Hanzi characters, for
trade payments.
    Example: "上海示例贸易有限公司"

## Response 400 fields (application/json):

  - `status` (integer, required)
    The HTTP status code of the error
    Example: 404

  - `errors` (array, required)

  - `errors.code` (string, required)
    Unique identifier of an error
    Example: "SYS_100"

  - `errors.title` (string, required)
    Error message providing a brief summary of the error
    Example: "No identity exists for identityId"

  - `errors.type` (string, required)
    Identifies the problem type
    Example: "USER_VALIDATION_ERROR"

  - `errors.description` (string, required)
    Provides more technical information
    Example: "Unable to get identity. Identity ID should be in UUID format"

  - `errors.timestamp` (string, required)
    The time when this error occurred, specified in UTC.
    Example: "2023-11-02T18:26:00.000123Z"

  - `timestamp` (string)
    The timestamp of the error
    Example: "2023-11-02T18:26:00.000Z"