> This page is for version FRAML API (default).
> For other versions, use one of these documentation indexes:
> - FRAML API (default): https://docs.flagright.com/framl-api/llms.txt
> - Management API: https://docs.flagright.com/management-api/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.flagright.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.flagright.com/_mcp/server.

# Batch create consumer user events

POST https://sandbox.api.flagright.com/batch/events/consumer/user
Content-Type: application/json

Reference: https://docs.flagright.com/api-reference/api-reference/batch/create-consumer-user-events

## Authentication

- `x-api-key` header (required) — API keys are used to authenticate the requests.

## Servers

- `https://sandbox.api.flagright.com` (Sandbox API server (eu-1), default)
- `https://sandbox-asia-1.api.flagright.com` (Sandbox API server (asia-1))

## Request

### Query parameters

- `lockCraRiskLevel` (enum, optional) — Boolean string whether Flagright should lock the CRA risk level for the user.
  - Allowed values: `true`, `false`
- `lockKycRiskLevel` (enum, optional) — Boolean string whether Flagright should lock the KYC risk level for the user.
  - Allowed values: `true`, `false`

### Body (application/json)

This endpoint expects a ConsumerUserEventBatchRequest.

- `data` (list of ConsumerUserEvent, required)
- `batchId` (string, optional)

## Response

### 201

Created

- `status` (enum, required) — Status of the batch response
  - Allowed values: `SUCCESS`, `PARTIAL_FAILURE`, `FAILURE`
- `batchId` (string, required)
- `successful` (double, required)
- `failed` (double, required)
- `failedRecords` (list of BatchResponseFailedRecord, optional)
- `message` (string, optional)

## Errors

### 400 Bad Request Error

Bad Request

- `message` (string, required)
- `validationErrors` (string, optional)

### 401 Unauthorized Error

Unauthorized

- `message` (string, required)
- `validationErrors` (string, optional)

### 429 Too Many Requests Error

Too Many Requests

- `message` (string, required)
- `validationErrors` (string, optional)

## Types

### ConsumerUserEvent

Model for consumer user-related events

- `timestamp` (double, required) — Timestamp of the event
- `userId` (string, required) — Transaction ID the event pertains to
- `eventId` (string, optional) — Unique event ID
- `reason` (string, optional) — Reason for the event or a state change
- `eventDescription` (string, optional) — Event description
- `updatedConsumerUserAttributes` (UserOptional, optional) — Model for User details
- `newUserId` (string, optional) — New userId for the existing user (keep in mind all of the future requests for this user will now reference this userId). Requires the `changeUserId` queryparam to come in affect.
- `externalLinks` (list of string, optional) — External links related to the consumer user

### BatchResponseFailedRecord

Failed record in a batch response

- `id` (string, optional)
- `reasonCode` (string, optional)

### UserOptional

Model for User details

- `activatedTimestamp` (double, optional) — Timestamp when user was activated
- `userDetails` (UserDetails, optional) — Model for consumer user personal details
- `userStateDetails` (UserStateDetails, optional)
- `kycStatusDetails` (KYCStatusDetails, optional)
- `eoddDate` (double, optional)
- `employmentStatus` (enum, optional)
  - Allowed values: `UNEMPLOYED`, `EMPLOYED`, `SELF_EMPLOYED`, `FREELANCER`, `STUDENT`, `FULL_TIME`, `PART_TIME`, `SOLE_PROPRIETOR`, `PENSIONER`, `COMPANY_OWNER`, `OTHER`, `NA`
- `occupation` (string, optional)
- `legalDocuments` (list of LegalDocument, optional) — User's legal identity documents - See Document Model for details
- `contactDetails` (ContactDetails, optional) — Model for business user contact information details
- `employmentDetails` (EmploymentDetails, optional) — Details of User's employment
- `transactionLimits` (TransactionLimits, optional) — Model for transaction limits for a given user
- `expectedIncome` (ExpectedIncome, optional) — Model for expected income details
- `expectedTransactionCountries` (ExpectedTransactionCountries, optional) — Model for expected transaction countries
- `expectedTransactionCurrencies` (ExpectedTransactionCurrencies, optional) — Model for expected transaction currencies
- `riskLevel` (enum, optional)
  - Allowed values: `VERY_HIGH`, `HIGH`, `MEDIUM`, `LOW`, `VERY_LOW`
- `kycRiskLevel` (enum, optional)
  - Allowed values: `VERY_HIGH`, `HIGH`, `MEDIUM`, `LOW`, `VERY_LOW`
- `acquisitionChannel` (enum, optional) — Model for User acquisition channel
  - Allowed values: `ORGANIC`, `PAID`, `REFERRAL`, `OFFLINE`, `GATHERING`, `UNKNOWN`
- `reasonForAccountOpening` (list of string, optional)
- `sourceOfFunds` (list of enum, optional)
  - Allowed values: `Earnings`, `Savings`, `Investments/Deposits`, `Wealth`, `Gift`, `Pension`, `Inheritance`, `Gambling`, `Benefits`, `Passive`, `Family`, `Insurance`, `Legal`, `Sales`, `Rollover`, `Equity`, `Crypto`, `Business`, `Employment`, `Salary`, `Real Estate Sale`, `Real Estate Rental`, `Company Exit`, `Loan`, `Other`, `Dividends`
- `userSegment` (enum, optional)
  - Allowed values: `RETAIL`, `PROFESSIONAL`
- `pepStatus` (list of PEPStatus, optional)
- `sanctionsStatus` (boolean, optional)
- `adverseMediaStatus` (boolean, optional)
- `corporateEntities` (list of CorporateEntityDetails, optional) — Corporate entities of the user
- `linkedEntities` (UserEntityLink, optional)
- `savedPaymentDetails` (list of UserOptionalSavedPaymentDetailsItems, optional)
- `tags` (list of UserTag, optional) — Additional information that can be added via tags
- `attachments` (list of PersonAttachment, optional) — Uploaded user's attachment
- `metaData` (DeviceData, optional) — Model for device data
- `jurisdiction` (string, optional) — Legal authority or region governing the transaction
- `productsEnabled` (list of ProductsEnabled, optional)
- `externalLinks` (list of string, optional) — External links related to the consumer user
- `customObject` (UserOptionalCustomObject, optional) — Typed Object defined on the console for additional data

### UserDetails

Model for consumer user personal details

- `name` (ConsumerName, optional) — Model for a generic consumer name
- `dateOfBirth` (string, optional) — Date of birth of the user (YYYY-MM-DD)
- `userCategory` (string, optional) — Internal category of the user
- `countryOfResidence` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `countryOfTaxResidence` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `secondaryCountryOfTaxResidence` (list of enum, optional) — Additional tax residence countries of the user
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `countryOfNationality` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `secondaryCountryOfNationality` (list of enum, optional) — Additional nationalities of the user
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `gender` (enum, optional) — Gender of the individual - Male, Female or Non-Binary
  - Allowed values: `M`, `F`, `NB`
- `maritalStatus` (enum, optional) — Marital status of the individual
  - Allowed values: `DIVORCED`, `MARRIED`, `SINGLE`, `WIDOWED`, `NA`
- `placeOfBirth` (PlaceOfBirth, optional) — Place of birth of the individual
- `alias` (list of string, optional) — Alias names of the user

### UserStateDetails

- `state` (enum, required)
  - Allowed values: `UNACCEPTABLE`, `TERMINATED`, `ACTIVE`, `DORMANT`, `CREATED`, `SUSPENDED`, `BLOCKED`
- `reason` (string, optional)

### KYCStatusDetails

- `reason` (string, optional)
- `status` (enum, optional)
  - Allowed values: `SUCCESSFUL`, `FAILED`, `NOT_STARTED`, `IN_PROGRESS`, `EXPIRED`, `NEW`, `CANCELLED`, `MANUAL_REVIEW`, `EDD_IN_PROGRESS`

### LegalDocument

LegalDocument model generalizes User's identity document type (ex: Passport)

- `documentType` (string, required) — User's identity document type such as passport, national ID etc.
- `documentNumber` (string, required) — User's unique identity document number such as passport number
- `documentIssuedDate` (double, optional) — User's identity document issuance date (UNIX timestamp in milliseconds)
- `documentExpirationDate` (double, optional) — User's identity document expiration date (UNIX timestamp in milliseconds)
- `documentIssuedCountry` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `nameOnDocument` (ConsumerName, optional) — Model for a generic consumer name
- `documentIssuedState` (string, optional) — State or province that issued the user's identity document

### ContactDetails

Model for business user contact information details

- `emailIds` (list of string, optional) — Email addresses of the contacts for a given business customer
- `contactNumbers` (list of string, optional) — Phone numbers to contact a given business customer
- `faxNumbers` (list of string, optional) — Fax numbers to contact a business customer
- `websites` (list of string, optional) — Website of the company
- `addresses` (list of Address, optional) — Address(es) of the company
- `name` (ConsumerName, optional) — Model for a generic consumer name
- `tags` (list of Tag, optional) — Additional information that can be added via tags

### EmploymentDetails

Details of User's employment

- `employmentSector` (string, optional) — Sector of employment
- `employerName` (string, optional) — Name of the employer
- `businessIndustry` (list of string, optional) — The industry in which the business operates for a business customer

### TransactionLimits

Model for transaction limits for a given user

- `maximumDailyTransactionLimit` (Amount, optional) — Model for amount
- `maximumWeeklyTransactionLimit` (Amount, optional) — Model for amount
- `maximumMonthlyTransactionLimit` (Amount, optional) — Model for amount
- `maximumQuarterlyTransactionLimit` (Amount, optional) — Model for amount
- `maximumTransactionLimit` (Amount, optional) — Model for amount
- `maximumYearlyTransactionLimit` (Amount, optional) — Model for amount
- `paymentMethodLimits` (TransactionLimitsPaymentMethodLimits, optional)

### ExpectedIncome

Model for expected income details

- `dailyExpectedIncome` (Amount, optional) — Model for amount
- `weeklyExpectedIncome` (Amount, optional) — Model for amount
- `monthlyExpectedIncome` (Amount, optional) — Model for amount
- `quarterlyExpectedIncome` (Amount, optional) — Model for amount
- `yearlyExpectedIncome` (Amount, optional) — Model for amount

### ExpectedTransactionCountries

Model for expected transaction countries

- `incoming` (list of ExpectedTransactionCountry, optional) — Countries the user expects to receive transactions from
- `outgoing` (list of ExpectedTransactionCountry, optional) — Countries the user expects to send transactions to

### ExpectedTransactionCurrencies

Model for expected transaction currencies

- `incoming` (list of ExpectedTransactionCurrency, optional) — Currencies the user expects to receive transactions in
- `outgoing` (list of ExpectedTransactionCurrency, optional) — Currencies the user expects to send transactions to

### PEPStatus

- `isPepHit` (boolean, required)
- `pepCountry` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `pepRank` (enum, optional) — PEP rank
  - Allowed values: `LEVEL_1`, `LEVEL_2`, `LEVEL_3`
- `category` (string, optional)

### CorporateEntityDetails

Model for corporate entity details

- `legalName` (string, required) — Legal name of the corporate entity

### UserEntityLink

- `parentUserId` (string, optional)

### UserOptionalSavedPaymentDetailsItems

- CardDetails: CardDetails
- GenericBankAccountDetails: GenericBankAccountDetails
- IBANDetails: IBANDetails
- ACHDetails: ACHDetails
- SWIFTDetails: SWIFTDetails
- MpesaDetails: MpesaDetails
- UPIDetails: UPIDetails
- WalletDetails: WalletDetails
- CheckDetails: CheckDetails
- CashDetails: CashDetails
- NPPDetails: NPPDetails

### UserTag

- `key` (string, required) — Key value when you are creating a custom variable
- `value` (string, required) — Value for a given key when you are creating a custom variable
- `isTimestamp` (boolean, optional) — Flag to indicate if the tag value is a timestamp
- `isEditable` (boolean, optional) — Flag to indicate if the tag is editable over the console

### PersonAttachment

PersonAttachment model generalizes User's uploaded attachments

- `files` (list of Attachment, required)
- `userId` (string, required)
- `id` (string, optional)
- `comment` (string, optional) — User's comment on the attached file.
- `createdAt` (double, optional)
- `deletedAt` (double, optional)
- `tags` (list of string, optional)

### DeviceData

Model for device data

- `batteryLevel` (double, optional) — Battery level of the device used for a transaction or event at a given timestamp
- `deviceLatitude` (double, optional) — Device latitude at a give timestamp for an event or transaction
- `deviceLongitude` (double, optional) — Device longitude at a give timestamp for an event or transaction
- `ipAddress` (string, optional) — IP address of the device at a given timestamp for an event or transaction. Overwritten with a verified value when `deviceIntelligenceSealedResult` is provided and decrypts successfully
- `ipCountry` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `deviceIdentifier` (string, optional) — Device identifier number. Overwritten with a verified value when `deviceIntelligenceSealedResult` is provided and decrypts successfully
- `vpnUsed` (boolean, optional) — Whether VPN was used at a given timestamp for an event or transaction. Overwritten when `deviceIntelligenceSealedResult` is provided and decrypts successfully, with the configured provider's own aggregate VPN detection verdict
- `operatingSystem` (string, optional) — Operating system of the device at a given timestamp for an event or transaction
- `deviceMaker` (string, optional) — The maker of the device at a given timestamp for an event or transaction
- `deviceModel` (string, optional) — The model of the device at a given timestamp for an event or transaction
- `deviceYear` (string, optional) — The year the device was manufactured at a given timestamp for an event or transaction
- `appVersion` (string, optional) — The version of the app your user is using on their device at a given timestamp for an event or transaction
- `deviceIntelligenceSealedResult` (string, optional) — Base64-encoded encrypted sealed result blob from your configured device intelligence provider. When provided, Flagright decrypts it server-side and populates the device intelligence fields below (and `deviceIdentifier`, `ipAddress`, `ipCountry`, `vpnUsed` above) with the resulting verified signals; any value passed directly in those fields is ignored when this field is present
- `tor` (boolean, optional) — Whether the request originated from a known TOR exit node
- `confidence` (double, optional) — Confidence score (0 to 1) that the device identity is correctly identified
- `incognito` (boolean, optional) — Whether the browser was in incognito/private mode
- `proxy` (boolean, optional) — Whether the request originated from a known public or residential proxy
- `tampering` (boolean, optional) — Whether browser tampering (e.g. anti-detect browser) was detected
- `botDetection` (enum, optional)
  - Allowed values: `bad`, `good`, `not_detected`
- `privacySettings` (boolean, optional) — Whether privacy-focused browser settings were detected
- `suspectScore` (integer, optional) — Weighted risk score (0 and up, no fixed upper bound)
- `velocity5mEvents` (integer, optional) — Number of events from this device in the last 5 minutes
- `velocity5mIps` (integer, optional) — Number of distinct IPs used by this device in the last 5 minutes
- `velocity5mCountries` (integer, optional) — Number of distinct countries used by this device in the last 5 minutes
- `velocity1hEvents` (integer, optional) — Number of events from this device in the last 1 hour
- `velocity1hIps` (integer, optional) — Number of distinct IPs used by this device in the last 1 hour
- `velocity1hCountries` (integer, optional) — Number of distinct countries used by this device in the last 1 hour
- `velocity24hEvents` (integer, optional) — Number of events from this device in the last 24 hours
- `velocity24hIps` (integer, optional) — Number of distinct IPs used by this device in the last 24 hours
- `velocity24hCountries` (integer, optional) — Number of distinct countries used by this device in the last 24 hours
- `requestId` (string, optional) — Device intelligence provider's request identifier for the event, ties back to the provider's event for audit purposes
- `osVersion` (string, optional) — Operating system version of the device (e.g. "10.15.7")
- `browser` (string, optional) — Browser name (e.g. "Chrome", "Safari")
- `browserVersion` (string, optional) — Browser version (e.g. "148.0.0")
- `rooted` (boolean, optional) — Android-specific rooted device detection (root management apps). False when checked and clean; unset if not evaluated
- `jailbroken` (boolean, optional) — iOS-specific jailbreak detection. False when checked and clean; unset if not evaluated
- `frida` (boolean, optional) — Frida instrumentation framework detection. False when checked and clean; unset if not evaluated
- `clonedApp` (boolean, optional) — Android-specific cloned application detection. False when checked and clean; unset if not evaluated
- `emulator` (boolean, optional) — Android-specific emulator detection. False when checked and clean; unset if not evaluated
- `simulator` (boolean, optional) — iOS-specific simulator detection. False when checked and clean; unset if not evaluated
- `developerTools` (boolean, optional) — Whether the browser DevTools (or mobile Developer Tools) were open
- `mitmAttack` (boolean, optional) — Android-specific man-in-the-middle attack detection
- `ipAttackSource` (boolean, optional) — Whether the IP address was part of a known network attack (SSH/HTTPS)
- `ipEmailSpam` (boolean, optional) — Whether the IP address was part of a known email spam attack (SMTP)
- `replayed` (boolean, optional) — Whether the device intelligence provider determined this identification payload was replayed rather than freshly captured
- `virtualMachine` (boolean, optional) — Whether the request came from a browser running inside a virtual machine (e.g. VMWare)
- `virtualMachineConfidenceScore` (double, optional) — Confidence score (0 to 1) for the virtualMachine detection result
- `locationSpoofing` (boolean, optional) — Mobile-specific GPS location spoofing detection
- `factoryResetTimestamp` (integer, optional) — Unix epoch time of the most recent factory reset detected on a mobile device; 0 if not detected or not a mobile device
- `highActivityDevice` (boolean, optional) — Whether the request came from a device with unusually high identification activity
- `rareDevice` (boolean, optional) — Whether the device is considered rare based on its combination of hardware and software attributes
- `rareDevicePercentileBucket` (string, optional) — Rarity percentile bucket of the device (e.g. "\<p95", "p99.9+", "not\_seen")
- `vpnConfidence` (string, optional) — Confidence level of the VPN detection result (e.g. "low", "medium", "high")
- `vpnOriginCountry` (string, optional) — Country the request appears to originate from per VPN detection (ISO 3166 format, or "unknown")
- `vpnOriginTimezone` (string, optional) — Local timezone used by the VPN detection's timezone-mismatch method
- `botType` (string, optional) — Additional classification of the bot type, if botDetection found one
- `proxyConfidence` (string, optional) — Confidence level of the proxy detection result (e.g. "low", "medium", "high")
- `proxyConfidenceScore` (double, optional) — Confidence score (0 to 1) for the proxy detection result
- `tamperingConfidence` (string, optional) — Confidence level of the tampering detection result (e.g. "low", "medium", "high")
- `tamperingConfidenceScore` (double, optional) — Confidence score (0 to 1) for the tampering detection result
- `tags` (list of Tag, optional) — Additional information that can be added via tags

### ProductsEnabled

- `productName` (string, optional)
- `details` (ProductsEnabledDetails, optional) — Structured product lifecycle details attached to a product enabled for the user.

### UserOptionalCustomObject

Typed Object defined on the console for additional data

### ConsumerName

Model for a generic consumer name

- `firstName` (string, required) — First name of the user
- `middleName` (string, optional) — Middle name of the user
- `fatherName` (string, optional) — Name of the father of the user
- `lastName` (string, optional) — Last name of the user

### PlaceOfBirth

Place of birth of the individual

- `country` (enum, required)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `city` (string, optional)
- `state` (string, optional)

### Tag

Generic key-value pair model to append a custom variable being sent to Flagright API

- `key` (string, required) — Key value when you are creating a custom variable
- `value` (string, required) — Value for a given key when you are creating a custom variable
- `isTimestamp` (boolean, optional) — Flag to indicate if the tag value is a timestamp

### Address

Model for standardized address

- `addressLines` (list of string, required) — Address lines of the user's residence address
- `postcode` (string, optional) — Post code of the user's residence address
- `city` (string, optional) — City of the user's residence address
- `state` (string, optional) — State of the user's residence address
- `country` (string, optional) — User's country of residence
- `addressType` (string, optional) — Type of the address (ex - Residential, Postal, etc.)
- `tags` (list of Tag, optional) — Additional information that can be added via tags

### Amount

Model for amount

- `amountValue` (double, required) — Numerical value of the transaction in major currency units (within IEEE 754 safe integer range for exact JSON representation)
- `amountCurrency` (enum, required)
  - Allowed values: `1INCH`, `AAVE`, `ABT`, `ACH`, `ACS`, `ADA`, `AED`, `AERGO`, `AERO`, `AFN`, `AGLD`, `AIOZ`, `ALCX`, `ALEPH`, `ALGO`, `ALICE`, `ALL`, `AMD`, `AMP`, `ANG`, `ANKR`, `ANT`, `AOA`, `APE`, `API3`, `APT`, `ARB`, `ARPA`, `ARS`, `ASM`, `AST`, `ATA`, `ATOM`, `AUCTION`, `AUD`, `AUDIO`, `AURORA`, `AVAX`, `AVT`, `AWG`, `AXL`, `AXS`, `AZN`, `BADGER`, `BAL`, `BAM`, `BAND`, `BASE`, `BAT`, `BBD`, `BCH`, `BDT`, `BGN`, `BHD`, `BICO`, `BIF`, `BIGTIME`, `BIT`, `BLUR`, `BLZ`, `BMD`, `BND`, `BNT`, `BOB`, `BOBA`, `BOND`, `BONK`, `BRL`, `BSD`, `BSV`, `BTC`, `BTN`, `BTRST`, `BUSD`, `BWP`, `BYN`, `BYR`, `BZD`, `C98`, `CAD`, `CBETH`, `CDF`, `CELR`, `CGLD`, `CHF`, `CHZ`, `CLF`, `CLP`, `CLV`, `CNH`, `CNY`, `COMP`, `COP`, `COTI`, `COVAL`, `CRC`, `CRO`, `CRPT`, `CRV`, `CTSI`, `CTX`, `CUC`, `CUP`, `CVC`, `CVE`, `CVX`, `CZK`, `DAI`, `DAR`, `DASH`, `DDX`, `DESO`, `DEXT`, `DIA`, `DIMO`, `DJF`, `DKK`, `DNT`, `DOGE`, `DOP`, `DOT`, `DREP`, `DYDX`, `DYP`, `DZD`, `EEK`, `EGLD`, `EGP`, `ELA`, `ENJ`, `ENS`, `EOS`, `ERN`, `ETB`, `ETC`, `ETH`, `ETH2`, `ETHB`, `EUR`, `EURA`, `EURC`, `EURT`, `EUROC`, `ETHFI`, `FARM`, `FET`, `FIDA`, `FIL`, `FIS`, `FJD`, `FKP`, `FLOW`, `FLR`, `FORT`, `FORTH`, `FOX`, `FX`, `FTM`, `GAL`, `GALA`, `GBP`, `GBPA`, `GEL`, `GFI`, `GGP`, `GHS`, `GHST`, `GIP`, `GLM`, `GMD`, `GMT`, `GNF`, `GNO`, `GNT`, `GODS`, `GRT`, `GST`, `GTC`, `GTQ`, `GUSD`, `GYD`, `GYEN`, `HBAR`, `HFT`, `HIGH`, `HKD`, `HNL`, `HNT`, `HONEY`, `HOPR`, `HRK`, `HTG`, `HUF`, `HYPE`, `ICP`, `IDEX`, `IDR`, `ILS`, `ILV`, `IMP`, `IMX`, `INDEX`, `INJ`, `INR`, `INV`, `IOTA`, `IOTX`, `ISLM`, `IQD`, `IRR`, `ISK`, `JASMY`, `JEP`, `JMD`, `JOD`, `JPY`, `JTO`, `JUP`, `KAVA`, `KEEP`, `KES`, `KGS`, `KHR`, `KLAY`, `KMF`, `KNC`, `KPW`, `KRL`, `KRW`, `KSM`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LCX`, `LDO`, `LINK`, `LIT`, `LKR`, `LOKA`, `LOOM`, `LPT`, `LQTY`, `LRC`, `LRD`, `LSETH`, `LSL`, `LTC`, `LTL`, `LUNA2`, `LVL`, `LYD`, `MAD`, `MAGIC`, `MANA`, `MASK`, `MATH`, `MATIC`, `MCO2`, `MDL`, `MDT`, `MEDIA`, `METIS`, `MGA`, `MINA`, `MIR`, `MKD`, `MKR`, `MLN`, `MMK`, `MNDE`, `MNT`, `MOBILE`, `MONA`, `MOP`, `MPL`, `MRO`, `MRU`, `MSOL`, `MTL`, `MULTI`, `MUR`, `MUSE`, `MVR`, `MWK`, `MXC`, `MXN`, `MXNB`, `MXND`, `MYR`, `MZN`, `NAD`, `NCT`, `NEAR`, `NEO`, `NEST`, `NGN`, `NIO`, `NKN`, `NMR`, `NOK`, `NPC`, `NPR`, `NU`, `NZD`, `OCEAN`, `OGN`, `OMG`, `OMR`, `ONDO`, `OOKI`, `OP`, `ORCA`, `ORN`, `OSMO`, `OXT`, `PAB`, `PAX`, `PEN`, `PENGU`, `PEPE`, `PERP`, `PGK`, `PHP`, `PKR`, `PLA`, `PLN`, `PLU`, `PNG`, `POL`, `POLS`, `POLY`, `POND`, `POWR`, `PRIME`, `PRO`, `PRQ`, `PUNDIX`, `PYG`, `PYR`, `PYUSD`, `QAR`, `QI`, `QNT`, `QSP`, `QUICK`, `RAD`, `RAI`, `RARE`, `RARI`, `RBN`, `REN`, `RENDER`, `REP`, `REPV2`, `REQ`, `RGT`, `RLC`, `RLY`, `RLUSD`, `RNDR`, `RON`, `ROSE`, `RPL`, `RSD`, `RUB`, `RUNE`, `RWF`, `SAND`, `SAR`, `SBD`, `SCR`, `SDG`, `SEAM`, `SEI`, `SEK`, `SGD`, `SHIB`, `SHP`, `SHPING`, `SKK`, `SKL`, `SLL`, `SNT`, `SNX`, `SOL`, `SOS`, `SPA`, `SPELL`, `SRD`, `SSP`, `STD`, `STG`, `STORJ`, `STRK`, `STX`, `SUI`, `SUKU`, `SUPER`, `SUSHI`, `SVC`, `SWFTC`, `SYLO`, `SYN`, `SYP`, `SYRUPUSDC`, `SZL`, `T`, `THB`, `THETA`, `TIA`, `TIME`, `TJS`, `TMM`, `TMT`, `TND`, `TONE`, `TON`, `TOP`, `TRAC`, `TRB`, `TRIBE`, `TRU`, `TRUMP`, `TRY`, `TTD`, `TVK`, `TWD`, `TZS`, `UAH`, `UGX`, `UMA`, `UNFI`, `UNI`, `UPI`, `USD`, `USDG`, `USDAI`, `USDE`, `USDH`, `USDC`, `USDT`, `USYC`, `UST`, `UYU`, `UZS`, `VARA`, `VEF`, `VELO`, `VES`, `VET`, `VGX`, `VND`, `VOXEL`, `VTHO`, `VUV`, `WAMPL`, `WAVES`, `WAXL`, `WBTC`, `WCFG`, `WLUNA`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XCN`, `XDR`, `XLM`, `XMON`, `XOF`, `XPD`, `XPF`, `XPT`, `XRP`, `XTZ`, `XYO`, `YER`, `YFI`, `YFII`, `ZAR`, `ZEC`, `ZEN`, `ZETA`, `ZIL`, `ZMK`, `ZMW`, `ZRX`, `ZWD`, `FDUSD`, `AGX`, `AUX`, `BNB`, `CUBE`, `EMON`, `FDGT`, `KGLD`, `LODE`, `PASS`, `PREMIA`, `TAB1`, `TD-USD`, `TRX`, `TYUGA`, `VIC`, `XAI`, `SLE`, `UDI`

### TransactionLimitsPaymentMethodLimits

- `ACH` (TransactionLimit, optional)
- `CARD` (TransactionLimit, optional)
- `IBAN` (TransactionLimit, optional)
- `UPI` (TransactionLimit, optional)
- `GENERIC_BANK_ACCOUNT` (TransactionLimit, optional)
- `MPESA` (TransactionLimit, optional)
- `SWIFT` (TransactionLimit, optional)
- `WALLET` (TransactionLimit, optional)
- `CHECK` (TransactionLimit, optional)
- `CASH` (TransactionLimit, optional)
- `NPP` (TransactionLimit, optional)

### ExpectedTransactionCountry

Model for a single expected transaction country

- `countryCode` (enum, required)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`

### ExpectedTransactionCurrency

Model for a single expected transaction currency

- `currencyCode` (enum, required)
  - Allowed values: `1INCH`, `AAVE`, `ABT`, `ACH`, `ACS`, `ADA`, `AED`, `AERGO`, `AERO`, `AFN`, `AGLD`, `AIOZ`, `ALCX`, `ALEPH`, `ALGO`, `ALICE`, `ALL`, `AMD`, `AMP`, `ANG`, `ANKR`, `ANT`, `AOA`, `APE`, `API3`, `APT`, `ARB`, `ARPA`, `ARS`, `ASM`, `AST`, `ATA`, `ATOM`, `AUCTION`, `AUD`, `AUDIO`, `AURORA`, `AVAX`, `AVT`, `AWG`, `AXL`, `AXS`, `AZN`, `BADGER`, `BAL`, `BAM`, `BAND`, `BASE`, `BAT`, `BBD`, `BCH`, `BDT`, `BGN`, `BHD`, `BICO`, `BIF`, `BIGTIME`, `BIT`, `BLUR`, `BLZ`, `BMD`, `BND`, `BNT`, `BOB`, `BOBA`, `BOND`, `BONK`, `BRL`, `BSD`, `BSV`, `BTC`, `BTN`, `BTRST`, `BUSD`, `BWP`, `BYN`, `BYR`, `BZD`, `C98`, `CAD`, `CBETH`, `CDF`, `CELR`, `CGLD`, `CHF`, `CHZ`, `CLF`, `CLP`, `CLV`, `CNH`, `CNY`, `COMP`, `COP`, `COTI`, `COVAL`, `CRC`, `CRO`, `CRPT`, `CRV`, `CTSI`, `CTX`, `CUC`, `CUP`, `CVC`, `CVE`, `CVX`, `CZK`, `DAI`, `DAR`, `DASH`, `DDX`, `DESO`, `DEXT`, `DIA`, `DIMO`, `DJF`, `DKK`, `DNT`, `DOGE`, `DOP`, `DOT`, `DREP`, `DYDX`, `DYP`, `DZD`, `EEK`, `EGLD`, `EGP`, `ELA`, `ENJ`, `ENS`, `EOS`, `ERN`, `ETB`, `ETC`, `ETH`, `ETH2`, `ETHB`, `EUR`, `EURA`, `EURC`, `EURT`, `EUROC`, `ETHFI`, `FARM`, `FET`, `FIDA`, `FIL`, `FIS`, `FJD`, `FKP`, `FLOW`, `FLR`, `FORT`, `FORTH`, `FOX`, `FX`, `FTM`, `GAL`, `GALA`, `GBP`, `GBPA`, `GEL`, `GFI`, `GGP`, `GHS`, `GHST`, `GIP`, `GLM`, `GMD`, `GMT`, `GNF`, `GNO`, `GNT`, `GODS`, `GRT`, `GST`, `GTC`, `GTQ`, `GUSD`, `GYD`, `GYEN`, `HBAR`, `HFT`, `HIGH`, `HKD`, `HNL`, `HNT`, `HONEY`, `HOPR`, `HRK`, `HTG`, `HUF`, `HYPE`, `ICP`, `IDEX`, `IDR`, `ILS`, `ILV`, `IMP`, `IMX`, `INDEX`, `INJ`, `INR`, `INV`, `IOTA`, `IOTX`, `ISLM`, `IQD`, `IRR`, `ISK`, `JASMY`, `JEP`, `JMD`, `JOD`, `JPY`, `JTO`, `JUP`, `KAVA`, `KEEP`, `KES`, `KGS`, `KHR`, `KLAY`, `KMF`, `KNC`, `KPW`, `KRL`, `KRW`, `KSM`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LCX`, `LDO`, `LINK`, `LIT`, `LKR`, `LOKA`, `LOOM`, `LPT`, `LQTY`, `LRC`, `LRD`, `LSETH`, `LSL`, `LTC`, `LTL`, `LUNA2`, `LVL`, `LYD`, `MAD`, `MAGIC`, `MANA`, `MASK`, `MATH`, `MATIC`, `MCO2`, `MDL`, `MDT`, `MEDIA`, `METIS`, `MGA`, `MINA`, `MIR`, `MKD`, `MKR`, `MLN`, `MMK`, `MNDE`, `MNT`, `MOBILE`, `MONA`, `MOP`, `MPL`, `MRO`, `MRU`, `MSOL`, `MTL`, `MULTI`, `MUR`, `MUSE`, `MVR`, `MWK`, `MXC`, `MXN`, `MXNB`, `MXND`, `MYR`, `MZN`, `NAD`, `NCT`, `NEAR`, `NEO`, `NEST`, `NGN`, `NIO`, `NKN`, `NMR`, `NOK`, `NPC`, `NPR`, `NU`, `NZD`, `OCEAN`, `OGN`, `OMG`, `OMR`, `ONDO`, `OOKI`, `OP`, `ORCA`, `ORN`, `OSMO`, `OXT`, `PAB`, `PAX`, `PEN`, `PENGU`, `PEPE`, `PERP`, `PGK`, `PHP`, `PKR`, `PLA`, `PLN`, `PLU`, `PNG`, `POL`, `POLS`, `POLY`, `POND`, `POWR`, `PRIME`, `PRO`, `PRQ`, `PUNDIX`, `PYG`, `PYR`, `PYUSD`, `QAR`, `QI`, `QNT`, `QSP`, `QUICK`, `RAD`, `RAI`, `RARE`, `RARI`, `RBN`, `REN`, `RENDER`, `REP`, `REPV2`, `REQ`, `RGT`, `RLC`, `RLY`, `RLUSD`, `RNDR`, `RON`, `ROSE`, `RPL`, `RSD`, `RUB`, `RUNE`, `RWF`, `SAND`, `SAR`, `SBD`, `SCR`, `SDG`, `SEAM`, `SEI`, `SEK`, `SGD`, `SHIB`, `SHP`, `SHPING`, `SKK`, `SKL`, `SLL`, `SNT`, `SNX`, `SOL`, `SOS`, `SPA`, `SPELL`, `SRD`, `SSP`, `STD`, `STG`, `STORJ`, `STRK`, `STX`, `SUI`, `SUKU`, `SUPER`, `SUSHI`, `SVC`, `SWFTC`, `SYLO`, `SYN`, `SYP`, `SYRUPUSDC`, `SZL`, `T`, `THB`, `THETA`, `TIA`, `TIME`, `TJS`, `TMM`, `TMT`, `TND`, `TONE`, `TON`, `TOP`, `TRAC`, `TRB`, `TRIBE`, `TRU`, `TRUMP`, `TRY`, `TTD`, `TVK`, `TWD`, `TZS`, `UAH`, `UGX`, `UMA`, `UNFI`, `UNI`, `UPI`, `USD`, `USDG`, `USDAI`, `USDE`, `USDH`, `USDC`, `USDT`, `USYC`, `UST`, `UYU`, `UZS`, `VARA`, `VEF`, `VELO`, `VES`, `VET`, `VGX`, `VND`, `VOXEL`, `VTHO`, `VUV`, `WAMPL`, `WAVES`, `WAXL`, `WBTC`, `WCFG`, `WLUNA`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XCN`, `XDR`, `XLM`, `XMON`, `XOF`, `XPD`, `XPF`, `XPT`, `XRP`, `XTZ`, `XYO`, `YER`, `YFI`, `YFII`, `ZAR`, `ZEC`, `ZEN`, `ZETA`, `ZIL`, `ZMK`, `ZMW`, `ZRX`, `ZWD`, `FDUSD`, `AGX`, `AUX`, `BNB`, `CUBE`, `EMON`, `FDGT`, `KGLD`, `LODE`, `PASS`, `PREMIA`, `TAB1`, `TD-USD`, `TRX`, `TYUGA`, `VIC`, `XAI`, `SLE`, `UDI`

### CardDetails

Model for credit or debit card details

- `method` (enum, required) — Classify the method of payment as "Card" for CardDetails
  - Allowed values: `CARD`
- `counterpartyType` (enum, optional)
  - Allowed values: `INDIVIDUAL`, `LEGAL_ENTITY`
- `cardFingerprint` (string, optional) — Unique card fingerprint that helps identify a specific card without having to use explicit card number. This is likely available at your card payment scheme provider
- `emailId` (string, optional) — Email ID format. Ex: baran@flagright.com
- `cardStatus` (enum, optional) — Status of the card
  - Allowed values: `ACTIVE`, `FROZEN`, `BLOCKED`, `SUSPECTED_FRAUD`, `STOLEN`, `LOST`, `CLOSED`, `OTHER`
- `cardIssuedCountry` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `transactionReferenceField` (string, optional) — Reference for the transaction
- `3dsDone` (boolean, optional) — Whether 3ds was successfully enforced for the transaction
- `nameOnCard` (ConsumerName, optional) — Model for a generic consumer name
- `cardExpiry` (CardExpiry, optional)
- `posDetails` (POSDetails, optional)
- `cardLast4Digits` (string, optional) — Last 4 digits of Card
- `cardFirst6Digits` (string, optional) — First 6 digits of Card
- `cardBrand` (enum, optional) — Brand of Card
  - Allowed values: `VISA`, `MASTERCARD`, `AMERICAN_EXPRESS`, `DISCOVER`, `UNIONPAY`, `RUPAY`, `JCB`, `DINERS_CLUB`
- `cardFunding` (enum, optional) — Funding of Card
  - Allowed values: `CREDIT`, `DEBIT`, `PREPAID`
- `cardAuthenticated` (boolean, optional) — Authentication of Card
- `cardTokenized` (boolean, optional) — Was the card tokenized
- `cardPresent` (boolean, optional) — Card Present
- `paymentChannel` (string, optional)
- `cardType` (enum, optional) — Type of card
  - Allowed values: `VIRTUAL`, `PHYSICAL`
- `cardBalance` (Amount, optional) — Model for amount
- `merchantDetails` (CardMerchantDetails, optional)
- `networkProviderRiskScore` (double, optional) — Risk score of the card from your network provider
- `address` (Address, optional) — Model for standardized address
- `countryOfNationality` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `countryOfResidence` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `bankAddress` (Address, optional) — Model for standardized address
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `jointEntity` (list of string, optional) — List of joint entities

### GenericBankAccountDetails

Model for any generic bank account

- `method` (enum, required) — Classify the method of payment as "GENERIC_BANK_ACCOUNT" for GenericBankAccountDetails
  - Allowed values: `GENERIC_BANK_ACCOUNT`
- `counterpartyType` (enum, optional)
  - Allowed values: `INDIVIDUAL`, `LEGAL_ENTITY`
- `accountNumber` (string, optional) — Bank account number
- `accountType` (string, optional) — Bank account type. E.g. Checking, Savings etc.
- `accountBalance` (Amount, optional) — Model for amount
- `bankName` (string, optional) — Name of the bank
- `bankCode` (string, optional) — Unique identifier of the bank. In some countries, this can be the same as the bank's SWIFT code
- `country` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `name` (string, optional) — Name of the account holder
- `countryOfNationality` (enum, optional) — Country of nationality of the account holder
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `countryOfResidence` (enum, optional) — Country of residence of the account holder
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `dateOfBirth` (string, optional) — Date of birth of the account holder (YYYY-MM-DD)
- `bankAddress` (Address, optional) — Model for standardized address
- `emailId` (string, optional) — Email ID format. Ex: baran@flagright.com
- `specialInstructions` (string, optional) — Special instructions to be specified if any
- `paymentChannel` (string, optional)
- `beneficiaryName` (string, optional) — Beneficiary name of the account
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `transitNumber` (string, optional) — Transit number of the bank account
- `address` (Address, optional) — Model for standardized address
- `routingNumber` (string, optional) — Routing number of the bank
- `correspondentBankDetails` (list of CorrespondentGenericBankDetails, optional)
- `jointEntity` (list of string, optional) — List of joint entities

### IBANDetails

Standardized model for Bank Details

- `method` (enum, required) — Classify the method of payment as "IBAN" for IBANDetails
  - Allowed values: `IBAN`
- `counterpartyType` (enum, optional)
  - Allowed values: `INDIVIDUAL`, `LEGAL_ENTITY`
- `BIC` (string, optional) — Identifier for the bank. Can be routing number, BIK number, SWIFT code, BIC number etc.
- `bankName` (string, optional) — Name of the bank
- `bankAddress` (Address, optional) — Model for standardized address
- `address` (Address, optional) — Address of the account holder
- `country` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `IBAN` (string, optional) — Account number of the user. Can be account number, IBAN number etc.
- `accountBalance` (Amount, optional) — Model for amount
- `name` (string, optional) — Name of the bank account holder
- `emailId` (string, optional) — Email ID format. Ex: baran@flagright.com
- `bankBranchCode` (string, optional) — Branch code of the bank. In some countries, this can be the same as the bank's SWIFT code
- `beneficiaryName` (string, optional) — Beneficiary name of the account
- `paymentChannel` (string, optional)
- `countryOfNationality` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `countryOfResidence` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `jointEntity` (list of string, optional) — List of joint entities

### ACHDetails

Model for ACH payment method

- `method` (enum, required) — Classify the method of payment as "ACH" for ACHDetails
  - Allowed values: `ACH`
- `counterpartyType` (enum, optional)
  - Allowed values: `INDIVIDUAL`, `LEGAL_ENTITY`
- `routingNumber` (string, optional) — Routing number of the bank
- `accountNumber` (string, optional) — Bank account number of the individual
- `accountBalance` (Amount, optional) — Model for amount
- `bankName` (string, optional) — Name of the bank
- `name` (string, optional) — Name of the account holder
- `bankAddress` (Address, optional) — Model for standardized address
- `address` (Address, optional) — Address of the account holder
- `countryOfNationality` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `countryOfResidence` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `beneficiaryName` (string, optional) — Beneficiary name of the account
- `emailId` (string, optional) — Email ID format. Ex: baran@flagright.com
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `jointEntity` (list of string, optional) — List of joint entities

### SWIFTDetails

Model for SWIFT payment method

- `method` (enum, required) — Classify the method of payment as "SWIFT" for SWIFTDetails
  - Allowed values: `SWIFT`
- `counterpartyType` (enum, optional)
  - Allowed values: `INDIVIDUAL`, `LEGAL_ENTITY`
- `swiftCode` (string, optional) — SWIFT code of the financial institution
- `accountNumber` (string, optional) — Account number
- `routingNumber` (string, optional) — Routing number of the bank
- `accountBalance` (Amount, optional) — Model for amount
- `accountType` (string, optional) — Account type. E.g. Checking, Savings etc.
- `bankName` (string, optional) — Name of the bank
- `name` (string, optional) — Name of the account holder
- `bankAddress` (Address, optional) — Model for standardized address
- `countryOfNationality` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `countryOfResidence` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `emailId` (string, optional) — Email ID format. Ex: baran@flagright.com
- `beneficiaryName` (string, optional) — Beneficiary name of the account
- `specialInstructions` (string, optional) — Special instructions if any
- `address` (Address, optional) — Model for standardized address
- `correspondentBankDetails` (list of CorrespondentBankDetails, optional)
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `jointEntity` (list of string, optional) — List of joint entities

### MpesaDetails

Model for Mpesa payment method

- `method` (enum, required) — Classify the method of payment as "Mpesa" for MpesaDetails
  - Allowed values: `MPESA`
- `businessShortCode` (string, required) — Business code
- `transactionType` (enum, required) — Type of transaction
  - Allowed values: `CustomerPayBillOnline`, `CustomerBuyGoodsOnline`, `SalaryPayment`, `BusinessPayment`, `PromotionPayment`
- `phoneNumber` (string, required) — Contact Number of the account holder
- `counterpartyType` (enum, optional)
  - Allowed values: `INDIVIDUAL`, `LEGAL_ENTITY`
- `emailId` (string, optional) — Email ID format. Ex: baran@flagright.com
- `name` (string, optional) — Name of the account holder
- `address` (Address, optional) — Model for standardized address
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `jointEntity` (list of string, optional) — List of joint entities

### UPIDetails

Model for UPI payment method

- `method` (enum, required) — Classify the method of payment as "UPI" for UPIDetails
  - Allowed values: `UPI`
- `upiID` (string, required) — UPI Id number
- `counterpartyType` (enum, optional)
  - Allowed values: `INDIVIDUAL`, `LEGAL_ENTITY`
- `bankProvider` (string, optional) — Bank provider name
- `interfaceProvider` (string, optional) — Interface provider name
- `name` (string, optional) — Name of the account holder
- `address` (Address, optional) — Model for standardized address
- `emailId` (string, optional) — Email ID format. Ex: baran@flagright.com
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `jointEntity` (list of string, optional) — List of joint entities

### WalletDetails

Standardized model for a Generic wallet transaction

- `method` (enum, required) — Classify the method of payment as "Wallet" for WalletDetails
  - Allowed values: `WALLET`
- `counterpartyType` (enum, optional)
  - Allowed values: `INDIVIDUAL`, `LEGAL_ENTITY`
- `walletType` (string, optional) — Wallet type if there are various types of wallets belonging to the same user. E.g. Checking, savings, vault, different currency wallets etc.
- `walletId` (string, optional) — Unique ID of the wallet
- `paymentChannel` (string, optional) — Payment Channel used through wallet
- `name` (string, optional) — Name of the account holder for a specific wallet
- `emailId` (string, optional) — Email ID format. Ex: baran@flagright.com
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `walletPhoneNumber` (string, optional) — Phone number associated with the wallet, if any
- `walletBalance` (Amount, optional) — Model for amount
- `network` (enum, optional) — Network of the wallet
  - Allowed values: `BITCOIN`, `ETHEREUM`, `POLYGON`, `BNB_SMART_CHAIN`, `BNB_BEACON_CHAIN`, `ARBITRUM_L2`, `SOLANA`, `AVALANCHE_C_CHAIN`, `TEZOS`, `VICTION`, `LITECOIN`, `BITCOIN_CASH`, `RIPPLE`, `HYPERLIQUID`, `STELLAR`, `EOS_PUBLIC`, `TRON`, `CARDANO`, `POLKADOT`, `NEAR_PROTOCOL`, `COSMOS`, `DOGECOIN`, `OPTIMISM_MAINNET`, `FANTOM`, `HEDERA`, `ALGORAND`, `CELESTIA`, `BASE`, `SUI`, `TEMPO`, `TEMPO_TESTNET`
- `address` (Address, optional) — Model for standardized address
- `countryOfNationality` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `countryOfResidence` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `beneficiaryName` (string, optional) — Beneficiary name of the account
- `bankAddress` (Address, optional) — Model for standardized address
- `authorizedRepresentative` (list of UserDetails, optional)
- `dateOfBirth` (string, optional) — Date of birth of the account holder (YYYY-MM-DD)
- `transactionHash` (string, optional) — A hash is a cryptographic fingerprint that uniquely identifies a blockchain transaction on the network, whereas a transactionId is just an internal reference used by a wallet or platform to track the transaction in its own system.
- `jointEntity` (list of string, optional) — List of joint entities

### CheckDetails

- `method` (enum, required) — Classify the method of payment as "CHECK" for CheckDetails
  - Allowed values: `CHECK`
- `counterpartyType` (enum, optional)
  - Allowed values: `INDIVIDUAL`, `LEGAL_ENTITY`
- `checkNumber` (string, optional)
- `checkIdentifier` (string, optional)
- `routingNumber` (string, optional) — Routing number of the bank
- `name` (string, optional)
- `deliveryStatus` (enum, optional)
  - Allowed values: `COMPLETED`, `PENDING`, `SETTLED`, `CANCELED`, `REFUND`, `DECLINED`
- `etaTimestamp` (double, optional)
- `shippingAddress` (Address, optional) — Model for standardized address
- `address` (Address, optional) — Address of the account holder
- `accountNumber` (string, optional)
- `emailId` (string, optional) — Email ID of the account holder
- `countryOfNationality` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `countryOfResidence` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `bankAddress` (Address, optional) — Model for standardized address
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `jointEntity` (list of string, optional) — List of joint entities

### CashDetails

- `method` (enum, required) — Classify the method of payment as "CASH" for Details
  - Allowed values: `CASH`
- `counterpartyType` (enum, optional)
  - Allowed values: `INDIVIDUAL`, `LEGAL_ENTITY`
- `identifier` (string, optional) — Identifier for the cash transaction
- `address` (Address, optional) — Model for standardized address
- `name` (string, optional)
- `emailId` (string, optional) — Email ID format. Ex: baran@flagright.com
- `accountBalance` (Amount, optional) — Model for amount
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `jointEntity` (list of string, optional) — List of joint entities

### NPPDetails

New Payment Platform Details for Australia

- `method` (enum, required) — Classify the method of payment as "NPP" for NPPDetails (New Payment Platform Details for Australia)
  - Allowed values: `NPP`
- `counterpartyType` (enum, optional)
  - Allowed values: `INDIVIDUAL`, `LEGAL_ENTITY`
- `accountNumber` (string, optional) — Account number
- `name` (ConsumerName, optional) — Model for a generic consumer name
- `emailId` (string, optional) — Email ID format. Ex: baran@flagright.com
- `contactNumber` (string, optional) — Contact number
- `bsb` (string, optional) — BSB number
- `payId` (string, optional) — PayID
- `endToEndId` (string, optional) — End to End ID
- `oskoReference` (string, optional) — OSKO reference
- `payIdReference` (string, optional) — PayID reference
- `isInstant` (boolean, optional) — Whether the payment is instant
- `remittanceInformation` (string, optional) — Remittance information
- `remittanceAdvice` (string, optional) — Remittance advice
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `processingDate` (double, optional) — Timestamp of the event
- `settlementDate` (double, optional) — Timestamp of the event
- `referenceNumber` (string, optional) — Unique reference number for transaction reconciliation
- `traceNumber` (string, optional) — Trace number for tracking the payment through the NPP system
- `messageFormat` (string, optional) — Format of the NPP message (e.g., JSON, XML)
- `bankName` (string, optional) — Name of the bank associated with the account
- `address` (Address, optional) — Model for standardized address
- `jointEntity` (list of string, optional) — List of joint entities

### Attachment

- `s3Key` (string, required)
- `filename` (string, required)
- `size` (double, required) — File size in bytes
- `bucket` (string, optional)
- `downloadLink` (string, optional)
- `aiSummary` (string, optional)

### ProductsEnabledDetails

Structured product lifecycle details attached to a product enabled for the user.

- `account` (AccountProductDetails, optional) — Structured lifecycle details for an account product.
- `loan` (LoanProductDetails, optional) — Structured lifecycle details for a loan product.

### TransactionLimit

- `transactionCountLimit` (TransactionCountLimit, optional)
- `transactionAmountLimit` (TransactionAmountLimit, optional)
- `averageTransactionAmountLimit` (TransactionAmountLimit, optional)

### CardExpiry

- `month` (integer, optional)
- `year` (double, optional)

### POSDetails

- `entryMode` (enum, optional)
  - Allowed values: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `79`, `80`, `81`, `82`, `85`, `90`, `91`, `95`, `97`

### CardMerchantDetails

- `id` (string, optional)
- `name` (string, optional)
- `category` (string, optional)
- `MCC` (string, optional)
- `city` (string, optional)
- `country` (enum, optional)
  - Allowed values: `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TM`, `TC`, `TV`, `TR`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX`, `XA`, `XB`, `XC`, `XD`, `XE`, `XF`, `XG`, `XH`, `XI`, `XJ`, `XK`, `XL`, `XM`, `XN`, `XO`, `XP`, `XQ`, `XR`, `XS`, `XT`, `XU`, `XV`, `XW`, `XY`, `XZ`, `N/A`
- `state` (string, optional)
- `postCode` (string, optional)

### CorrespondentGenericBankDetails

Model for Correspondent bank details for generic bank account

- `bankName` (string, optional) — Name of the bank
- `bankAddress` (Address, optional) — Model for standardized address
- `bankCode` (string, optional) — Unique identifier of the correspondent bank
- `tags` (list of Tag, optional) — Additional information that can be added via tags

### CorrespondentBankDetails

Model for Correspondent bank details

- `bankName` (string, optional) — Name of the bank
- `bankAddress` (Address, optional) — Model for standardized address
- `swiftCode` (string, optional) — SWIFT code of the correspondent bank
- `tags` (list of Tag, optional) — Additional information that can be added via tags

### AccountProductDetails

Structured lifecycle details for an account product.

- `accountNumber` (string, optional) — Account or product number associated with the enabled product.
- `openingDate` (string, optional) — Product opening date (YYYY-MM-DD).
- `status` (enum, optional) — Current lifecycle status of the product.
  - Allowed values: `ACTIVE`, `INACTIVE`
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `jointEntity` (list of string, optional) — List of joint entities

### LoanProductDetails

Structured lifecycle details for a loan product.

- `accountNumber` (string, optional) — Account or loan number associated with the enabled product.
- `openingDate` (string, optional) — Loan opening date (YYYY-MM-DD).
- `status` (enum, optional) — Current lifecycle status of the loan.
  - Allowed values: `ACTIVE`, `INACTIVE`
- `maturityDate` (string, optional) — Loan maturity date (YYYY-MM-DD).
- `loanAmount` (double, optional) — Total loan amount in major currency units.
- `disbursedAmount` (double, optional) — Total amount disbursed in major currency units.
- `balance` (double, optional) — Current outstanding balance in major currency units.
- `tags` (list of Tag, optional) — Additional information that can be added via tags
- `jointEntity` (list of string, optional) — List of joint entities

### TransactionCountLimit

- `day` (double, optional) — Maximum transaction count allowed per calendar day
- `week` (double, optional) — Maximum transaction count allowed per calendar week
- `month` (double, optional) — Maximum transaction count allowed per calendar month
- `year` (double, optional) — Maximum transaction count allowed per calendar year

### TransactionAmountLimit

- `day` (Amount, optional) — Model for amount
- `week` (Amount, optional) — Model for amount
- `month` (Amount, optional) — Model for amount
- `year` (Amount, optional) — Model for amount

## Examples

**Request**

```json
{
  "data": [
    {
      "timestamp": 2220000000000,
      "userId": "string"
    }
  ]
}
```

**Response**

```json
{
  "status": "SUCCESS",
  "batchId": "string",
  "successful": 1.1,
  "failed": 1.1,
  "failedRecords": [
    {
      "id": "string",
      "reasonCode": "string"
    }
  ],
  "message": "string"
}
```

**SDK Code**

```python
import requests

url = "https://sandbox.api.flagright.com/batch/events/consumer/user"

payload = { "data": [
        {
            "timestamp": 2220000000000,
            "userId": "string"
        }
    ] }
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://sandbox.api.flagright.com/batch/events/consumer/user';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"data":[{"timestamp":2220000000000,"userId":"string"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.api.flagright.com/batch/events/consumer/user"

	payload := strings.NewReader("{\n  \"data\": [\n    {\n      \"timestamp\": 2220000000000,\n      \"userId\": \"string\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://sandbox.api.flagright.com/batch/events/consumer/user")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": [\n    {\n      \"timestamp\": 2220000000000,\n      \"userId\": \"string\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://sandbox.api.flagright.com/batch/events/consumer/user")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": [\n    {\n      \"timestamp\": 2220000000000,\n      \"userId\": \"string\"\n    }\n  ]\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://sandbox.api.flagright.com/batch/events/consumer/user', [
  'body' => '{
  "data": [
    {
      "timestamp": 2220000000000,
      "userId": "string"
    }
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://sandbox.api.flagright.com/batch/events/consumer/user");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"data\": [\n    {\n      \"timestamp\": 2220000000000,\n      \"userId\": \"string\"\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["data": [
    [
      "timestamp": 2220000000000,
      "userId": "string"
    ]
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox.api.flagright.com/batch/events/consumer/user")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```