# Add a financial instrument

Create a financial instrument for the specified identity. The request body must include
the payment rail (financialInstrumentType), currency or asset code, and the rail-specific
details (for example, US ACH account numbers or a wallet address).
In the current release, each identity can have **one** financial instrument.
Future releases will support multiple instruments per identity.

Endpoint: POST /v3/identities/{identity-id}/financial-instruments
Version: 2026.04
Security: Bearer

## Security:

  - `Bearer` (unknown)
    http bearer JWT

## Path parameters:

  - `identity-id` (string, required)
    Unique identifier of the identity that will own the financial instrument.

## Request fields (application/json):

  - `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

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

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

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

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

  - `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.

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

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

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

  - `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

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

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

  - `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

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

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

  - `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

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

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

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

  - `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

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

  - `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.

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

  - `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

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

  - `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.

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

  - `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

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

  - `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.

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

  - `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

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

  - `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.

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

  - `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

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

  - `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.

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

  - `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

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

  - `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.

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

  - `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

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

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

  - `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

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

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

  - `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

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

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

  - `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

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

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

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

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

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

  - `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

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

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

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

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

  - `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

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

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

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

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

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

  - `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

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

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

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

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

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

  - `idBifast` (object)
    Rails: BI-FAST
Rail Definitions:
BI-FAST:
- Availability: 24/7/365
- Limit: IDR 100,000,000 per transaction
- Settlement: Real-time
- Cut-off time: None
- Banking holidays: Not applicable

Routing Evaluation Order: Not applicable

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

  - `idBifast.bankBranchCity` (string)
    The city of the identity's bank branch. Optional on every bank payout corridor and not enforced by the API. If your organization works with Ripple's Australian entity, supply it on every financial instrument you create, whatever the destination corridor. Omitting it does not return an error. However, a value that does not match the permitted characters, or exceeds 50 characters, fails financial instrument create and update with 400 Bad Request (USR_109). An update replaces the stored financial instrument, so include this field in every update, not only at creation.

  - `idBifast.bankCode` (string, required)
    Legacy Bank Indonesia-assigned domestic clearing code or Ripple Bank Code (RBC) for the destination bank in Indonesia. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.
    Example: RPL:ID:CENAIDJA:BNK

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

  - `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

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

  - `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.

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

  - `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

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

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

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

  - `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

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

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

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

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

  - `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

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

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

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

  - `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

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

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

  - `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.

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

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

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

  - `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

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

  - `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.

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

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

  - `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

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

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

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

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

  - `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

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

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

  - `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

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

  - `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

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

  - `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.

  - `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.

  - `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.

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

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

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

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

  - `financialInstrumentType` (string)
    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

## Request examples:

  - `US_ACH bank account` (unknown)

## Response 201:

  - `201` (unknown)
    Financial instrument created.

## Response 201 fields (application/json):

  - `financialInstrumentId` (string, required)
    The unique ID of the financial instrument
    Example: 2f4ac57f-c5ba-4051-b51f-b3565778717b

## Response 400:

  - `400` (unknown)
    Invalid request.

## 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

## Response 404:

  - `404` (unknown)
    Identity not found.

## Response 404 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

## Response 500:

  - `500` (unknown)
    Internal processing error

## Response 500 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

## Response 400 examples:

  - `error-response-400` (unknown)

## Response 404 examples:

  - `error-response-404` (unknown)

## Response 500 examples:

  - `error-response-500` (unknown)

