openapi: 3.0.2 info: title: BIV filers information API description: Provides information which can be used for a delivery to the BIV. version: '2020.3.0' x-api-id: 41dee6b6-e0bc-4daa-a2f8-8fa6fae0059d x-audience: external-public servers: - url: '{server}' paths: /filers-information/messagetypes-details: get: summary: Retrieve a list of message types (berichtsoorten) and organizations (ontvangers) which can be used for a delivery. description: This API can be used to retrieve message types and organizations which can be used for a delivery. responses: '200': description: OK content: application/json;api-version=2020.3.0: schema: type: array items: $ref: "#/components/schemas/Messagetype" '406': description: Version in Accept-header is not supported content: "application/problem+json": schema: $ref: "#/components/schemas/Problem" '500': $ref: "#/components/schemas/Problem" default: $ref: "#/components/schemas/Problem" components: schemas: Messagetype: description: Represents 'Berichtsoort' in the BIV service type: object required: - name - allowedReceivers - maximumNumberOfAttachments - allowedAttachments properties: name: type: string description: type: string maximumNumberOfAttachments: type: integer allowedReceivers: type: array items: $ref: "#/components/schemas/Receiver" allowedEntrypoints: type: array items: $ref: "#/components/schemas/AllowedEntrypoint" allowedAttachments: type: array items: $ref: "#/components/schemas/AllowedAttachment" Receiver: description: Represents 'Ontvanger' in the BIV service type: object required: - name - identityType - identityNumber properties: name: type: string identityType: description: Represents 'IdentiteitType.type' in the BIV service type: string identityNumber: description: Represents 'IdentiteitType.nummer' in the BIV service type: string AllowedEntrypoint: description: The entrypoint that is allowed to be delivered for the messagetype type: object required: - name - entrypoint - expirationDate - allowedAsContent - allowedAsAttachment properties: name: type: string entrypoint: description: The url of the entrypoint of the instance type: string expirationDate: description: the date-time notation conforms to ISO 8601, for example, 2025-07-21T17:32:28Z pattern: '\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)' type: string allowedAsContent: type: boolean allowedAsAttachment: type: boolean AllowedAttachment: description: attachment information about the maximimum and minimum of allowed attachments of the given attachment type. type: object required: - dataType - minimumNumberOfAttachments - maximumNumberOfAttachments properties: dataType: description: The specified concerned data type type: string enum: - XBRL - XML x-enum-varnames: - XBRL - XML minimumNumberOfAttachments: type: integer maximumNumberOfAttachments: type: integer Problem: description: A generic problem response describing a client or server problem. required: - title - status properties: title: description: > A short summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized). type: string example: Service Unavailable status: description: The HTTP status code generated by the origin server for this occurrence of the problem. type: integer format: int32 minimum: 100 maximum: 600 exclusiveMaximum: true example: 503 detail: description: A human readable explanation specific to this occurrence of the problem. type: string example: Connection to database timed out