{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/UserCompany",
"title": "UserCompany",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The company name.",
"readOnly": false,
"writeOnly": false
},
"public_nick_name": {
"type": "string",
"description": "The company's public nick name.",
"readOnly": false,
"writeOnly": false
},
"avatar_uuid": {
"type": "string",
"description": "The public UUID of the company's avatar.",
"readOnly": false,
"writeOnly": true
},
"address_main": {
"type": "object",
"description": "The company's main address.",
"readOnly": false,
"writeOnly": false,
"$ref": "#/components/schemas/Address"
},
"address_postal": {
"type": "object",
"description": "The company's postal address.",
"readOnly": false,
"writeOnly": false,
"$ref": "#/components/schemas/Address"
},
"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": false,
"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": false,
"writeOnly": false
},
"country": {
"type": "string",
"description": "The country as an ISO 3166-1 alpha-2 country code.",
"readOnly": false,
"writeOnly": false
},
"ubo": {
"type": "array",
"description": "The names of the company's ultimate beneficiary owners. Minimum zero, maximum four.",
"readOnly": false,
"writeOnly": false,
"items": {
"$ref": "#/components/schemas/Ubo"
}
},
"chamber_of_commerce_number": {
"type": "string",
"description": "The company's chamber of commerce number.",
"readOnly": false,
"writeOnly": false
},
"legal_form": {
"type": "string",
"description": "The company's legal form.",
"readOnly": false,
"writeOnly": false
},
"status": {
"type": "string",
"description": "The user status. Can be: ACTIVE, SIGNUP, RECOVERY.",
"readOnly": false,
"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": false,
"writeOnly": false
},
"session_timeout": {
"type": "integer",
"description": "The setting for the session timeout of the company in seconds.",
"readOnly": false,
"writeOnly": false
},
"daily_limit_without_confirmation_login": {
"type": "object",
"description": "The amount the company can pay in the session without asking for credentials.",
"readOnly": false,
"writeOnly": false,
"$ref": "#/components/schemas/Amount"
},
"id": {
"type": "integer",
"description": "The id of the modified company.",
"readOnly": true,
"writeOnly": false
},
"created": {
"type": "string",
"description": "The timestamp of the company object's creation.",
"readOnly": true,
"writeOnly": false
},
"updated": {
"type": "string",
"description": "The timestamp of the company object's last update.",
"readOnly": true,
"writeOnly": false
},
"public_uuid": {
"type": "string",
"description": "The company's public UUID.",
"readOnly": true,
"writeOnly": false
},
"display_name": {
"type": "string",
"description": "The company's display name.",
"readOnly": true,
"writeOnly": false
},
"alias": {
"type": "array",
"description": "The aliases of the account.",
"readOnly": true,
"writeOnly": false,
"items": {
"$ref": "#/components/schemas/Pointer"
}
},
"type_of_business_entity": {
"type": "string",
"description": "The type of business entity.",
"readOnly": true,
"writeOnly": false
},
"sector_of_industry": {
"type": "string",
"description": "The sector of industry.",
"readOnly": true,
"writeOnly": false
},
"counter_bank_iban": {
"type": "string",
"description": "The company's other bank account IBAN, through which we verify it.",
"readOnly": true,
"writeOnly": false
},
"avatar": {
"type": "object",
"description": "The company'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
},
"directors": {
"type": "array",
"description": "The existing bunq aliases for the company's directors.",
"readOnly": true,
"writeOnly": false,
"items": {
"$ref": "#/components/schemas/LabelUser"
}
},
"notification_filters": {
"type": "array",
"description": "The types of notifications that will result in a push notification or URL callback for this UserCompany.",
"readOnly": true,
"writeOnly": false,
"items": {
"$ref": "#/components/schemas/NotificationFilter"
}
},
"customer": {
"type": "object",
"description": "The customer profile of the company.",
"readOnly": true,
"writeOnly": false,
"$ref": "#/components/schemas/Customer"
},
"customer_limit": {
"type": "object",
"description": "The customer limits of the company.",
"readOnly": true,
"writeOnly": false,
"$ref": "#/components/schemas/CustomerLimit"
},
"billing_contract": {
"type": "array",
"description": "The subscription of the company.",
"readOnly": true,
"writeOnly": false,
"items": {
"$ref": "#/components/schemas/BillingContractSubscription"
}
},
"deny_reason": {
"type": "string",
"description": "The user deny reason.",
"readOnly": true,
"writeOnly": false
},
"relations": {
"type": "array",
"description": "The relations for this user.",
"readOnly": true,
"writeOnly": false,
"items": {
"$ref": "#/components/schemas/RelationUser"
}
},
"tax_resident": {
"type": "array",
"description": "The user's tax residence numbers for different countries.",
"readOnly": true,
"writeOnly": false,
"items": {
"$ref": "#/components/schemas/TaxResident"
}
}
}
}