Bunq · Schema

UserPersonRead

Banking

Properties

Name Type Description
id integer The id of the modified person object.
created string The timestamp of the person object's creation.
updated string The timestamp of the person object's last update.
public_uuid string The person's public UUID.
first_name string The person's first name.
middle_name string The person's middle name.
last_name string The person's last name.
legal_name string The person's legal name.
display_name string The display name for the person.
public_nick_name string The public nick name for the person.
alias array The aliases of the user.
tax_resident array The user's tax residence numbers for different countries.
address_main object The person's main address.
address_postal object The person's postal address.
date_of_birth string The person's date of birth. Accepts ISO8601 date formats.
place_of_birth string The person's place of birth.
country_of_birth string The person's country of birth. Formatted as a SO 3166-1 alpha-2 country code.
nationality string The person's nationality. Formatted as a SO 3166-1 alpha-2 country code.
language string The person's preferred language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.
region string The person's preferred region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.
gender string The person's gender. Can be MALE, FEMALE or UNKNOWN.
avatar object The user's avatar.
version_terms_of_service string The version of the terms of service accepted by the user.
status string The user status. The user status. Can be: ACTIVE, BLOCKED, SIGNUP, RECOVERY, DENIED or ABORTED.
sub_status string The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT.
session_timeout integer The setting for the session timeout of the user in seconds.
daily_limit_without_confirmation_login object The amount the user can pay in the session without asking for credentials.
notification_filters array The types of notifications that will result in a push notification or URL callback for this UserPerson.
relations array The relations for this user.
View JSON Schema on GitHub

JSON Schema

bunq-userpersonread-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserPersonRead",
  "title": "UserPersonRead",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The id of the modified person object.",
      "readOnly": true,
      "writeOnly": false
    },
    "created": {
      "type": "string",
      "description": "The timestamp of the person object's creation.",
      "readOnly": true,
      "writeOnly": false
    },
    "updated": {
      "type": "string",
      "description": "The timestamp of the person object's last update.",
      "readOnly": true,
      "writeOnly": false
    },
    "public_uuid": {
      "type": "string",
      "description": "The person's public UUID.",
      "readOnly": true,
      "writeOnly": false
    },
    "first_name": {
      "type": "string",
      "description": "The person's first name.",
      "readOnly": true,
      "writeOnly": false
    },
    "middle_name": {
      "type": "string",
      "description": "The person's middle name.",
      "readOnly": true,
      "writeOnly": false
    },
    "last_name": {
      "type": "string",
      "description": "The person's last name.",
      "readOnly": true,
      "writeOnly": false
    },
    "legal_name": {
      "type": "string",
      "description": "The person's legal name.",
      "readOnly": true,
      "writeOnly": false
    },
    "display_name": {
      "type": "string",
      "description": "The display name for the person.",
      "readOnly": true,
      "writeOnly": false
    },
    "public_nick_name": {
      "type": "string",
      "description": "The public nick name for the person.",
      "readOnly": true,
      "writeOnly": false
    },
    "alias": {
      "type": "array",
      "description": "The aliases of the user.",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/Pointer"
      }
    },
    "tax_resident": {
      "type": "array",
      "description": "The user's tax residence numbers for different countries.",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/TaxResident"
      }
    },
    "address_main": {
      "type": "object",
      "description": "The person's main address.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Address"
    },
    "address_postal": {
      "type": "object",
      "description": "The person's postal address.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Address"
    },
    "date_of_birth": {
      "type": "string",
      "description": "The person's date of birth. Accepts ISO8601 date formats.",
      "readOnly": true,
      "writeOnly": false
    },
    "place_of_birth": {
      "type": "string",
      "description": "The person's place of birth.",
      "readOnly": true,
      "writeOnly": false
    },
    "country_of_birth": {
      "type": "string",
      "description": "The person's country of birth. Formatted as a SO 3166-1 alpha-2 country code.",
      "readOnly": true,
      "writeOnly": false
    },
    "nationality": {
      "type": "string",
      "description": "The person's nationality. Formatted as a SO 3166-1 alpha-2 country code.",
      "readOnly": true,
      "writeOnly": false
    },
    "language": {
      "type": "string",
      "description": "The person's preferred language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.",
      "readOnly": true,
      "writeOnly": false
    },
    "region": {
      "type": "string",
      "description": "The person's preferred region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.",
      "readOnly": true,
      "writeOnly": false
    },
    "gender": {
      "type": "string",
      "description": "The person's gender. Can be MALE, FEMALE or UNKNOWN.",
      "readOnly": true,
      "writeOnly": false
    },
    "avatar": {
      "type": "object",
      "description": "The user's avatar.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Avatar"
    },
    "version_terms_of_service": {
      "type": "string",
      "description": "The version of the terms of service accepted by the user.",
      "readOnly": true,
      "writeOnly": false
    },
    "status": {
      "type": "string",
      "description": "The user status. The user status. Can be: ACTIVE, BLOCKED, SIGNUP, RECOVERY, DENIED or ABORTED.",
      "readOnly": true,
      "writeOnly": false
    },
    "sub_status": {
      "type": "string",
      "description": "The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT.",
      "readOnly": true,
      "writeOnly": false
    },
    "session_timeout": {
      "type": "integer",
      "description": "The setting for the session timeout of the user in seconds.",
      "readOnly": true,
      "writeOnly": false
    },
    "daily_limit_without_confirmation_login": {
      "type": "object",
      "description": "The amount the user can pay in the session without asking for credentials.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "notification_filters": {
      "type": "array",
      "description": "The types of notifications that will result in a push notification or URL callback for this UserPerson.",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/NotificationFilter"
      }
    },
    "relations": {
      "type": "array",
      "description": "The relations for this user.",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/RelationUser"
      }
    }
  }
}