--- title: "View the schema for a Recipient" method: GET path: "/v2.01/{ClientId}/recipients/schema" tags: ["Recipients"] --- # View the schema for a Recipient `GET /v2.01/{ClientId}/recipients/schema` Fetch the data requirements for a given currency, payout method type, and recipient type ## Path parameters - `ClientId` string, required ## Query parameters - `PayoutMethodType` string, required - `Currency` string, required - `Country` string, required - `RecipientType` string, required ## Headers - `Authorization` string, required ## Response `200` Success - ViewTheSchemaForARecipientResponse - `DisplayName` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `Currency` DataFormatFieldAllowedValues — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including allowed values. - `AllowedValues` string[] — The allowed values of the string. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `Country` DataFormatFieldAllowedValues — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including allowed values. - `AllowedValues` string[] — The allowed values of the string. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `RecipientType` DataFormatFieldAllowedValues — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including allowed values. - `AllowedValues` string[] — The allowed values of the string. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `PayoutMethodType` DataFormatFieldAllowedValues — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including allowed values. - `AllowedValues` string[] — The allowed values of the string. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `Tag` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `RecipientScope` DataFormatFieldAllowedValues — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including allowed values. - `AllowedValues` string[] — The allowed values of the string. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `IndividualRecipient` ViewTheSchemaForARecipientResponseIndividualRecipient — The schema of the `IndividualRecipient` property. - `FirstName` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `LastName` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `Address` AddressRecipientSchema — The schema of the `Address` object. - `AddressLine1` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `AddressLine2` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `City` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `Country` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `Region` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `PostalCode` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `BusinessRecipient` ViewTheSchemaForARecipientResponseBusinessRecipient — The schema of the `BusinessRecipient` property. - `BusinessName` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `Address` AddressRecipientSchema — The schema of the `Address` object. - `AddressLine1` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `AddressLine2` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `City` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `Country` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `Region` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `PostalCode` DataFormatField — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema). - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `InternationalBankTransfer` InternationalBankTransferRecipientSchema — The schema of the `InternationalBankTransfer` property. - `AccountNumber` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `BIC` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `LocalBankTransfer` union — The schema of the `LocalBankTransfer` property. - ViewTheSchemaForARecipientResponseLocalBankTransfer0 - `CAD` ViewTheSchemaForARecipientResponseLocalBankTransferOneOf0Cad, required — The schema of the `CAD` property. - `AccountNumber` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `InstitutionNumber` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `BranchCode` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `BankName` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - ViewTheSchemaForARecipientResponseLocalBankTransfer1 - `CHF` ViewTheSchemaForARecipientResponseLocalBankTransferOneOf1Chf, required — The schema of the `CHF` property. - `IBAN` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - ViewTheSchemaForARecipientResponseLocalBankTransfer2 - `CZK` ViewTheSchemaForARecipientResponseLocalBankTransferOneOf2Czk, required — The schema of the `CZK` property. - `IBAN` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - ViewTheSchemaForARecipientResponseLocalBankTransfer3 - `DKK` ViewTheSchemaForARecipientResponseLocalBankTransferOneOf3Dkk, required — The schema of the `DKK` property. - `IBAN` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - ViewTheSchemaForARecipientResponseLocalBankTransfer4 - `EUR` ViewTheSchemaForARecipientResponseLocalBankTransferOneOf4Eur, required — The schema of the `EUR` property. - `IBAN` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - ViewTheSchemaForARecipientResponseLocalBankTransfer5 - `GBP` ViewTheSchemaForARecipientResponseLocalBankTransferOneOf5Gbp, required — The schema of the `GBP` property. - `AccountNumber` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `SortCode` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - ViewTheSchemaForARecipientResponseLocalBankTransfer6 - `HUF` ViewTheSchemaForARecipientResponseLocalBankTransferOneOf6Huf, required — The schema of the `HUF` property. - `IBAN` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - ViewTheSchemaForARecipientResponseLocalBankTransfer7 - `NOK` ViewTheSchemaForARecipientResponseLocalBankTransferOneOf7Nok, required — The schema of the `NOK` property. - `IBAN` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - ViewTheSchemaForARecipientResponseLocalBankTransfer8 - `PLN` ViewTheSchemaForARecipientResponseLocalBankTransferOneOf8Pln, required — The schema of the `PLN` property. - `IBAN` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - ViewTheSchemaForARecipientResponseLocalBankTransfer9 - `RON` ViewTheSchemaForARecipientResponseLocalBankTransferOneOf9Ron, required — The schema of the `RON` property. - `IBAN` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - ViewTheSchemaForARecipientResponseLocalBankTransfer10 - `SEK` ViewTheSchemaForARecipientResponseLocalBankTransferOneOf10Sek, required — The schema of the `SEK` property. - `IBAN` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - ViewTheSchemaForARecipientResponseLocalBankTransfer11 - `USD` ViewTheSchemaForARecipientResponseLocalBankTransferOneOf11Usd, required — The schema of the `USD` property. - `AccountNumber` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `ABA` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. - `FFC` FieldMetadata — Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints. - `Required` boolean — Whether the field is required or not. - `MaxLength` integer — The maximum length of the string. - `MinLength` integer — The minimum length of the string. - `Pattern` string — The regex describing the accepted value of the string. - `Label` string — A label that platforms can use when displaying or requesting the field to the end user. - `EndUserDisplay` string — **Possible values:** `Show`, `Hide` Recommendation on whether to show or hide the field (and `Label`) to the end user. ## Other responses - `400` — Bad Request --- [API](https://skmtc.net/mangopay/apis/api-reference.md) · [All operations](https://skmtc.net/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mangopay/api-reference/versions/795281070285/schema)