Bunq · Schema

TransferwiseRequirementFieldGroup

Banking

Properties

Name	Type	Description
key	string	The key of the field. This is the value to send as input.
type	string	The field's input type: "text", "select" or "radio".
name	string	The field name.
refresh_requirements_on_change	boolean	Indicates that any changes in this field affect the requirements, if this field is changed, the requirements endpoint must be called again to recheck if there are any additional requirements.
required	boolean	Whether or not the field is required.
display_format	string	Formatting mask to guide user input.
example	string	An example value for this field.
min_length	string	The minimum length of the field's value.
max_length	string	The maximum length of the field's value.
validation_regexp	string	A regular expression which may be used to validate the user input.
validation_async	object	Details of an endpoint which may be used to validate the user input.
values_allowed	object	Shows which values are allowed for fields of type "select" or "radio".

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TransferwiseRequirementFieldGroup",
  "title": "TransferwiseRequirementFieldGroup",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "The key of the field. This is the value to send as input.",
      "readOnly": true,
      "writeOnly": false
    },
    "type": {
      "type": "string",
      "description": "The field's input type: \"text\", \"select\" or \"radio\".",
      "readOnly": true,
      "writeOnly": false
    },
    "name": {
      "type": "string",
      "description": "The field name.",
      "readOnly": true,
      "writeOnly": false
    },
    "refresh_requirements_on_change": {
      "type": "boolean",
      "description": "Indicates that any changes in this field affect the requirements, if this field is changed, the requirements endpoint must be called again to recheck if there are any additional requirements.",
      "readOnly": true,
      "writeOnly": false
    },
    "required": {
      "type": "boolean",
      "description": "Whether or not the field is required.",
      "readOnly": true,
      "writeOnly": false
    },
    "display_format": {
      "type": "string",
      "description": "Formatting mask to guide user input.",
      "readOnly": true,
      "writeOnly": false
    },
    "example": {
      "type": "string",
      "description": "An example value for this field.",
      "readOnly": true,
      "writeOnly": false
    },
    "min_length": {
      "type": "string",
      "description": "The minimum length of the field's value.",
      "readOnly": true,
      "writeOnly": false
    },
    "max_length": {
      "type": "string",
      "description": "The maximum length of the field's value.",
      "readOnly": true,
      "writeOnly": false
    },
    "validation_regexp": {
      "type": "string",
      "description": "A regular expression which may be used to validate the user input.",
      "readOnly": true,
      "writeOnly": false
    },
    "validation_async": {
      "type": "object",
      "description": "Details of an endpoint which may be used to validate the user input.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/TransferwiseRequirementFieldGroupValidationAsync"
    },
    "values_allowed": {
      "type": "object",
      "description": "Shows which values are allowed for fields of type \"select\" or \"radio\".",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/TransferwiseRequirementFieldGroupValuesAllowed"
    }
  }
}