{"openapi":"3.0.0","info":{"title":"NL Organizations","description":"The NL Organizations API provides search and profiling capabilities for organizations and their branches.\n","version":"v0.1.0"},"servers":[{"url":"https://api.company.info","description":"Production Server"}],"security":[{"authToken":[]},{"jwtAuth":[]}],"tags":[{"name":"Entities","description":"Operations related to searching for different entity types."},{"name":"Organizations","description":"Operations related to managing organizations and their profiles."},{"name":"Branches","description":"Operations related to managing individual branch profiles."}],"paths":{"/nl/organizations/profiles/v1/entities":{"get":{"operationId":"searchOrganizationEntities","tags":["Entities"],"summary":"Search for branches, legal entities, and transitioned organizations.","description":"Use this endpoint to perform full-text searches, structured filtering, prefix matching, sorting, and aggregations across all entity types.","parameters":[{"$ref":"#/components/parameters/query"},{"$ref":"#/components/parameters/entityFilter"},{"$ref":"#/components/parameters/entityMatch"},{"$ref":"#/components/parameters/entitySort"},{"$ref":"#/components/parameters/aggregate"},{"$ref":"#/components/parameters/Fuzziness"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"}},"content":{"application/vnd.api+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseList"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["branches","organizations"]},"id":{"type":"string"},"attributes":{"oneOf":[{"$ref":"#/components/schemas/BranchAttributes"},{"$ref":"#/components/schemas/LegalEntityAttributes"},{"$ref":"#/components/schemas/TransitionedOrganizationAttributes"}]},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference"}}},"relationships":{"type":"object","required":["organization"],"properties":{"organization":{"$ref":"#/components/schemas/RelationshipToOne"}}}}}},"included":{"type":"array","uniqueItems":true,"items":{"type":"object","properties":{"type":{"type":"string","example":"organizations"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"name":{"type":"string","example":"Company A"}}},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference"}}}}}},"meta":{"allOf":[{"$ref":"#/components/schemas/meta"},{"type":"object","properties":{"aggregations":{"$ref":"#/components/schemas/aggregationResult"}}}]},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference"},"first":{"type":"string","format":"uri-reference"},"last":{"type":"string","format":"uri-reference"},"prev":{"type":"string","format":"uri-reference"},"next":{"type":"string","format":"uri-reference"}}}}}]}}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/nl/organizations/profiles/v1/organizations/{organization_id}":{"get":{"operationId":"getOrganization","tags":["Organizations"],"summary":"Retrieve a full organization profile.","description":"This endpoint returns a detailed profile for a specific organization, including identifiers, legal form, contact details, lifecycle events, activities (SBI), and optional extensions such as financials, ownership structure, management, etc.","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/organizationIdParam"},{"$ref":"#/components/parameters/extensions"}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"}},"content":{"application/vnd.api+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Response"},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","example":"organizations"},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/OrganizationAttributes"},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference"}}}}}}}]}}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"}}}},"/nl/organizations/profiles/v1/organizations/{organization_id}/branches":{"get":{"operationId":"getOrganizationBranches","tags":["Branches"],"summary":"Retrieve all branches for a given organization.","description":"This endpoint returns a list of branches belonging to the specified organization. You can use include to retrieve related resources in the included section, following JSON:API conventions.","parameters":[{"$ref":"#/components/parameters/organizationIdParam"},{"$ref":"#/components/parameters/include"}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"}},"content":{"application/vnd.api+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseList"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"branches"},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/OrganizationBranchesAttributes"},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference"}}},"relationships":{"type":"object","required":["organization"],"properties":{"organization":{"$ref":"#/components/schemas/RelationshipToOne"}}}}}},"included":{"type":"array","uniqueItems":true,"items":{"type":"object","properties":{"type":{"type":"string","example":"organizations"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"country":{"type":"string","example":"NLD"},"name":{"type":"string","example":"Company A"}}},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference"}}}}}},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference"}}}}}]}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/nl/organizations/profiles/v1/organizations/{organization_id}/branches/{branch_id}":{"get":{"operationId":"getOrganizationBranch","tags":["Branches"],"summary":"Retrieve one branch profile in detail.","deprecated":true,"description":"Fetches detailed information for a single branch, including identification, lifecycle, personnel, contact, and activities. Optional include allows compound documents with related resources.","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/organizationIdParam"},{"$ref":"#/components/parameters/branchIdParam"},{"$ref":"#/components/parameters/include"}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"}},"content":{"application/vnd.api+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Response"},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","example":"branches"},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/BranchesAttributes"},"relationships":{"type":"object","required":["organization"],"properties":{"organization":{"$ref":"#/components/schemas/RelationshipToOne"}}},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference"}}}}},"included":{"type":"array","uniqueItems":true,"items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","example":"organizations"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"name":{"type":"string","example":"Company A"},"country":{"type":"string","description":"The country code (e.g., NLD).","example":"NLD"}}},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference"}}}}}}}}]}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/nl/organizations/profiles/v1/branches/{branch_id}":{"get":{"operationId":"getBranch","tags":["Branches"],"summary":"Retrieve one branch profile in detail.","description":"Fetches detailed information for a single branch, including identification, lifecycle, personnel, contact, and activities. Optional include allows compound documents with related resources.","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/branchIdParam"},{"$ref":"#/components/parameters/include"}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"}},"content":{"application/vnd.api+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Response"},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","example":"branches"},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/BranchesAttributes"},"relationships":{"type":"object","required":["organization"],"properties":{"organization":{"$ref":"#/components/schemas/RelationshipToOne"}}},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference"}}}}},"included":{"type":"array","uniqueItems":true,"items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","example":"organizations"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"name":{"type":"string","example":"Company A"},"country":{"type":"string","description":"The country code (e.g., NLD).","example":"NLD"}}},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference"}}}}}}}}]}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}},"components":{"securitySchemes":{"authToken":{"description":"API Key Authentication","type":"apiKey","in":"header","name":"X-API-KEY"},"jwtAuth":{"description":"JWT Authentication","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"entityFilterQuery":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"tradeRegister":{"type":"string","example":"332292790000","description":"The branch numbers."}}},"name":{"type":"string","example":"company.info","description":"The registered name of the entity."},"isActive":{"type":"boolean","example":true,"description":"Indicates if the branch is currently active."},"isMain":{"type":"boolean","example":true,"description":"Indicates if the branch is the main."},"legalForm":{"description":"The legal form of the organization.","type":"string","example":"Besloten Vennootschap"},"tradeNames":{"description":"Filter by active and/or expired trade names.","oneOf":[{"type":"string","example":"company.info"},{"type":"object","properties":{"active":{"type":"string","example":"company.info"},"expired":{"type":"string","example":"company.info"}}}]},"organization":{"type":"object","properties":{"name":{"type":"string","example":"company.info","description":"The primary name or display name of the organization."},"identifiers":{"type":"object","properties":{"tradeRegister":{"type":"string","example":"33229279","description":"The trade register IDs."}}}}},"type":{"description":"Type of the organization or unit.","type":"string","enum":["branch","legalEntity","transitionedOrganization"]},"ownershipStructures":{"type":"object","properties":{"hasNationalUltimateParent":{"type":"boolean","example":true},"hasInternationalUltimateParent":{"type":"boolean","example":false},"ultimateParentIsNaturalPerson":{"type":"boolean","example":true,"description":"Indicates if the ultimate parent is a natural person."}}},"activities":{"type":"object","properties":{"sbi":{"type":"object","properties":{"code":{"description":"Filter on main and/or secondary SBI codes.","oneOf":[{"type":"string","example":"78202"},{"type":"object","properties":{"main":{"type":"string","example":"70102"},"secondary":{"type":"string","example":"78202"}}}]}}}}},"contact":{"type":"object","properties":{"address":{"type":"object","description":"Filter by elements of the visiting address.","properties":{"province":{"type":"string","example":"Zuid-Holland"},"city":{"type":"string","example":"Amsterdam"},"municipality":{"type":"string","example":"Amsterdam"},"postalCode":{"oneOf":[{"type":"string","example":"1231RV"},{"type":"object","properties":{"range":{"type":"string","example":"1231RV,1431RV"}}}]},"street":{"type":"string","example":"Veilingstraat"},"houseNumber":{"type":"integer","example":12},"houseNumberAddition":{"type":"string","example":"A"}}},"excludeFromMailing":{"type":"boolean","example":true,"description":"True if the address should not be used for mailing."},"excludeFromMarketing":{"type":"boolean","example":true,"description":"True if the organization opted out of marketing."},"website":{"type":"string","example":"company.info"}}},"lifecycle":{"type":"object","properties":{"firstRegistration":{"description":"Date of registration or a date range.","oneOf":[{"type":"string","example":"2002-02-05"},{"type":"object","properties":{"range":{"type":"string","example":"2002-02-05,2003-02-05"}}}]}}},"personnel":{"type":"object","properties":{"tradeRegister":{"type":"object","properties":{"class":{"type":"integer","example":5}}},"companyInfo":{"type":"object","properties":{"class":{"type":"integer","example":5}}}}},"financials":{"type":"object","properties":{"bankGroup":{"type":"string","example":"RaboBank"},"profit":{"type":"object","properties":{"range":{"type":"string","example":"3000000,4000000"}}},"assets":{"type":"object","properties":{"range":{"type":"string","example":"580000,590000"}}},"turnover":{"type":"object","properties":{"range":{"type":"string","example":"1000000,2000000"}}}}}}},"entityMatchQuery":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"tradeRegister":{"type":"string","example":"332292790000","description":"The branch numbers."}}},"name":{"type":"string","example":"company.info","description":"The registered name of the entity."},"legalForm":{"description":"The legal form of the organization.","type":"string","example":"Besloten Vennootschap"},"tradeNames":{"description":"Filter by active and/or expired trade names.","oneOf":[{"type":"string","example":"company.info"},{"type":"object","properties":{"active":{"type":"string","example":"company.info"},"expired":{"type":"string","example":"company.info"}}}]},"organization":{"type":"object","properties":{"name":{"type":"string","example":"company.info","description":"The primary name or display name of the organization."},"identifiers":{"type":"object","properties":{"tradeRegister":{"type":"string","example":"33229279","description":"The trade register IDs."}}}}},"activities":{"type":"object","properties":{"sbi":{"type":"object","properties":{"code":{"description":"Filter on main and/or secondary SBI codes.","oneOf":[{"type":"string","example":"78202"},{"type":"object","properties":{"main":{"type":"string","example":"70102"},"secondary":{"type":"string","example":"78202"}}}]}}}}},"contact":{"type":"object","properties":{"address":{"type":"object","description":"Filter by elements of the visiting address.","properties":{"province":{"type":"string","example":"Zuid-Holland"},"city":{"type":"string","example":"Amsterdam"},"municipality":{"type":"string","example":"Amsterdam"},"postalCode":{"type":"string","example":"1231RV"},"street":{"type":"string","example":"Veilingstraat"}}},"website":{"type":"string","example":"company.info"}}},"lifecycle":{"type":"object","properties":{"firstRegistration":{"description":"Date of registration or a date range.","type":"string","example":"2002-02-05"}}},"financials":{"type":"object","properties":{"bankGroup":{"type":"string","example":"RaboBank"}}}}},"aggregationQuery":{"type":"object","description":"Defines fields and size buckets for aggregation.","properties":{"fields":{"type":"array","description":"Comma-separated list of fields to aggregate.","items":{"$ref":"#/components/schemas/aggregationType"}},"size":{"type":"object","description":"Aggregation result bucket sizes per dimension.","properties":{"contact":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"integer"},"street":{"type":"integer"},"province":{"type":"integer"},"municipality":{"type":"integer"}}}}},"legalForm":{"type":"integer"},"financials":{"type":"object","properties":{"bankGroups":{"type":"integer"}}}}}},"example":{"fields":["contact.address.city","contact.address.street","contact.address.province","contact.address.municipality","legalForm","financials.bankGroup"],"size":{"contact":{"address":{"city":10,"street":10,"province":10,"municipality":10}},"legalForm":5,"financials":{"bankGroups":20}}}},"sortType":{"type":"string","enum":["type","organization.identifiers.tradeRegister","identifiers.tradeRegister","name","tradeNames.active","tradeNames.expired","organization.name","lifecycle.firstRegistration","contact.address.postalCode","contact.address.city","activities.sbi.code.main","activities.sbi.code.secondary","personnel.tradeRegister.class","personnel.companyInfo.class","legalForm","financials.bankGroup","financials.profit","financials.assets","financials.turnover"]},"aggregationType":{"type":"string","enum":["contact.address.city","legalForm","financials.bankGroup","contact.address.street","contact.address.province","contact.address.municipality"]},"extensionType":{"type":"string","enum":["sizeIndicators","activities","financials","ownershipStructures","management"]},"aggregationResult":{"description":"Aggregated search results for organization-related fields.\n","type":"object","properties":{"contact.address.city":{"type":"array","items":{"$ref":"#/components/schemas/valueCount"}},"legalForm":{"type":"array","items":{"$ref":"#/components/schemas/valueCount"}},"financials.bankGroup":{"type":"array","items":{"$ref":"#/components/schemas/valueCount"}}}},"BranchAttributes":{"type":"object","properties":{"name":{"type":"string","example":"Company A"},"type":{"type":"string","enum":["branch"],"example":"branch"},"isMain":{"type":"boolean","example":true},"identifiers":{"type":"object","properties":{"tradeRegister":{"type":"object","properties":{"system":{"type":"string","example":"tradeRegister"},"value":{"type":"string","example":"138579830001"}}}}},"organization":{"type":"object","properties":{"name":{"type":"string","example":"Company A"},"identifiers":{"type":"object","properties":{"tradeRegister":{"type":"object","properties":{"system":{"type":"string","example":"tradeRegister"},"value":{"type":"string","example":"13857983"}}}}}}},"contact":{"$ref":"#/components/schemas/visitingAddress"}},"additionalProperties":false},"LegalEntityAttributes":{"type":"object","properties":{"name":{"type":"string","example":"Company A"},"type":{"type":"string","enum":["legalEntity"],"example":"legalEntity"},"organization":{"type":"object","properties":{"name":{"type":"string","example":"Company A"},"identifiers":{"type":"object","properties":{"tradeRegister":{"type":"object","properties":{"system":{"type":"string","example":"tradeRegister"},"value":{"type":"string","example":"13857983"}}}}}}},"contact":{"$ref":"#/components/schemas/visitingAddress"}}},"TransitionedOrganizationAttributes":{"type":"object","properties":{"name":{"type":"string","example":"Company A"},"type":{"type":"string","enum":["transitionedOrganization"],"example":"transitionedOrganization"},"organization":{"type":"object","properties":{"name":{"type":"string","example":"Company A"},"identifiers":{"type":"object","properties":{"tradeRegister":{"type":"object","properties":{"system":{"type":"string","example":"tradeRegister"},"value":{"type":"string","example":"13857983"}}}}}}}}},"OrganizationAttributes":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"tradeRegister":{"type":"object","properties":{"system":{"type":"string","description":"The source system of the identifier.","example":"tradeRegister"},"value":{"type":"string","example":"12345678"}}},"rsin":{"type":"object","properties":{"system":{"type":"string","description":"The source system of the identifier.","example":"taxOffice"},"value":{"type":"string","example":"110011000"}}}}},"name":{"type":"string","example":"Company A"},"statutorySeat":{"type":"string","example":"Amsterdam"},"logoURL":{"type":"string","example":"https://company.info/1.png"},"legalForm":{"type":"object","properties":{"code":{"type":"string","example":"private-limited-company"},"description":{"type":"string","example":"Besloten Vennootschap (blijkens statuten structuurvennootschap)"},"shortDescription":{"type":"string","example":"Besloten Vennootschap"}}},"contact":{"type":"object","properties":{"excludeFromMailing":{"type":"boolean","example":false},"excludeFromMarketing":{"type":"boolean","example":false},"address":{"type":"object","properties":{"formatted":{"type":"string","description":"The full, formatted address string.","example":"Postbus 123456 1111AB Amsterdam"},"street":{"type":"string","description":"The street name.","example":"Postbus 123456"},"houseNumber":{"type":"integer","description":"The house number.","example":12},"houseNumberAddition":{"type":"string","description":"The house number addition (e.g., 'A', '1').","nullable":true,"example":null},"houseLetter":{"type":"string","description":"The house letter (e.g., 'A', 'B').","nullable":true,"example":null},"postalCode":{"type":"string","description":"The postal code.","example":"1111AB"},"city":{"type":"string","description":"The city name.","example":"Amsterdam"},"province":{"type":"string","description":"The province name.","example":"Noord-Holland"},"municipality":{"type":"string","description":"The municipality name.","example":"Amsterdam"},"country":{"type":"string","description":"The country code (e.g., NLD).","example":"NLD"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number","format":"float","description":"The latitude coordinate.","example":123.456},"longitude":{"type":"number","format":"float","description":"The longitude coordinate.","example":456.123}}},"countrySpecific":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"bag":{"type":"object","properties":{"system":{"type":"string","description":"The system from which the identifier originates (e.g., BAG).","example":"BAG"},"value":{"type":"object","properties":{"addressableObjectID":{"type":"integer","format":"int64","description":"The addressable object ID.","example":123},"numberIndicationID":{"type":"integer","format":"int64","description":"The number indication ID.","example":456}}}}}}}}},"registrationDate":{"type":"string","format":"date","description":"The date the address was registered.","example":"1979-01-01"},"visibilityStatus":{"type":"string","description":"The visibility status of the address.","enum":["visible","protected"],"example":"visible"}}},"correspondenceAddress":{"type":"object","properties":{"formatted":{"type":"string","description":"The full, formatted address string.","example":"Postbus 123456 1111AB Amsterdam"},"street":{"type":"string","description":"The street name.","example":"Postbus 123456"},"houseNumber":{"type":"integer","description":"The house number.","example":12},"houseNumberAddition":{"type":"string","description":"The house number addition (e.g., 'A', '1').","nullable":true,"example":null},"houseLetter":{"type":"string","description":"The house letter (e.g., 'A', 'B').","nullable":true,"example":null},"postalCode":{"type":"string","description":"The postal code.","example":"1111AB"},"city":{"type":"string","description":"The city name.","example":"Amsterdam"},"province":{"type":"string","description":"The province name.","example":"Noord-Holland"},"municipality":{"type":"string","description":"The municipality name.","example":"Amsterdam"},"country":{"type":"string","description":"The country code (e.g., NLD).","example":"NLD"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number","format":"float","description":"The latitude coordinate.","example":123.456},"longitude":{"type":"number","format":"float","description":"The longitude coordinate.","example":456.123}}},"countrySpecific":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"bag":{"type":"object","properties":{"system":{"type":"string","description":"The system from which the identifier originates (e.g., BAG).","example":"BAG"},"value":{"type":"object","properties":{"addressableObjectID":{"type":"integer","format":"int64","description":"The addressable object ID.","example":123},"numberIndicationID":{"type":"integer","format":"int64","description":"The number indication ID.","example":456}}}}}}}}},"registrationDate":{"type":"string","format":"date","description":"The date the address was registered.","example":"1979-01-01"},"visibilityStatus":{"type":"string","description":"The visibility status of the address.","enum":["visible","protected"],"example":"visible"}}},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"number":{"type":"string"}}}},"websites":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"value":{"type":"string"}}}},"emails":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"value":{"type":"string"}}}}}},"activities":{"type":"object","properties":{"sbi":{"type":"array","items":{"type":"object","properties":{"isMain":{"type":"boolean","description":"Indicates if this is the main source.","example":false},"source":{"type":"string","description":"The data sources.","example":"tradeRegister"},"system":{"type":"string","description":"The system from which the data originates.","example":"SBI"},"code":{"type":"string","description":"The unique code for the classification.","example":"1071"},"description":{"type":"string","example":"Manufacture of bread and fresh pastry"}}}}}},"lifecycle":{"type":"object","properties":{"registration":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"type":{"type":"string","example":"registration"},"startDate":{"type":"string","format":"date","description":"The date when the event started or occurred","example":"1234-05-06"},"endDate":{"type":"string","format":"date","description":"Optional end date, e.g. for insolvency cases","example":"1234-05-06"}}},"liquidation":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"type":{"type":"string","example":"registration"},"startDate":{"type":"string","format":"date","description":"The date when the event started or occurred","example":"1234-05-06"},"endDate":{"type":"string","format":"date","description":"Optional end date, e.g. for insolvency cases","example":"1234-05-06"}}},"dissolution":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"type":{"type":"string","example":"registration"},"startDate":{"type":"string","format":"date","description":"The date when the event started or occurred","example":"1234-05-06"},"endDate":{"type":"string","format":"date","description":"Optional end date, e.g. for insolvency cases","example":"1234-05-06"},"description":{"type":"string"}}},"events":{"type":"object","properties":{"firstRegistration":{"type":"object","properties":{"date":{"type":"string","example":"1234-05-06"},"type":{"type":"string","example":"registration"}}},"deedOfIncorporation":{"type":"object","properties":{"date":{"type":"string","example":"1234-05-06"},"type":{"type":"string","example":"registration"}}}}},"insolvency":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"debtRestructuring":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"type":{"type":"string","example":"registration"},"startDate":{"type":"string","format":"date","description":"The date when the event started or occurred","example":"1234-05-06"},"endDate":{"type":"string","format":"date","description":"Optional end date, e.g. for insolvency cases","example":"1234-05-06"}}},"suspensionOfPayments":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"type":{"type":"string","example":"registration"},"startDate":{"type":"string","format":"date","description":"The date when the event started or occurred","example":"1234-05-06"},"endDate":{"type":"string","format":"date","description":"Optional end date, e.g. for insolvency cases","example":"1234-05-06"}}},"bankrupt":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"type":{"type":"string","example":"registration"},"startDate":{"type":"string","format":"date","description":"The date when the event started or occurred","example":"1234-05-06"},"endDate":{"type":"string","format":"date","description":"Optional end date, e.g. for insolvency cases","example":"1234-05-06"}}},"publications":{"type":"array","description":"List of related insolvency publications (if any)","items":{"type":"object","properties":{"identifier":{"type":"object","properties":{"system":{"type":"string","description":"The source system of the identifier."},"value":{"type":"string"}}},"court":{"type":"object","properties":{"name":{"type":"string","example":"Rechtbank Noord-Nederland"},"code":{"type":"string","example":"43"}}},"description":{"type":"string"},"availableUntil":{"type":"string","format":"date","nullable":true}}}}}}}},"capital":{"type":"object","properties":{"issued":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}}},"authorized":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}}},"contributed":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}}}}},"branch":{"type":"object","properties":{"id":{"type":"string","example":"123456780000"},"isMain":{"type":"boolean","example":true},"names":{"type":"object","properties":{"main":{"type":"string","example":"Test B.V."},"tradeNames":{"type":"array","items":{"type":"object","properties":{"isActive":{"type":"boolean","description":"Indicates if the tradename is currently in use.","example":false},"isMain":{"type":"boolean","description":"Indicates if this is the primary tradename.","example":false},"name":{"type":"string","description":"The tradename string.","example":"Test B.V."}}}}}},"lifecycle":{"type":"object","properties":{"registration":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"type":{"type":"string","example":"registration"},"startDate":{"type":"string","format":"date","description":"The date when the event started or occurred","example":"1234-05-06"},"endDate":{"type":"string","format":"date","description":"Optional end date, e.g. for insolvency cases","example":"1234-05-06"}}},"events":{"type":"object","properties":{"continuation":{"type":"object","properties":{"date":{"type":"string","example":"1234-05-06"},"type":{"type":"string","example":"continuation"}}}}}}},"personnel":{"type":"object","properties":{"fulltime":{"type":"object","properties":{"value":{"type":"integer","example":23},"class":{"type":"object","properties":{"code":{"type":"string","example":"6"},"description":{"type":"string"}}}}},"parttime":{"type":"object","properties":{"value":{"type":"integer","example":23},"class":{"type":"object","properties":{"code":{"type":"string","example":"6"},"description":{"type":"string"}}}}},"total":{"type":"object","properties":{"value":{"type":"integer","example":23},"class":{"type":"object","properties":{"code":{"type":"string","example":"6"},"description":{"type":"string"}}}}},"source":{"type":"string","description":"Source system from which employee data is retrieved.","example":"tradeRegister"}}},"contact":{"type":"object","properties":{"excludeFromMailing":{"type":"boolean","example":false},"excludeFromMarketing":{"type":"boolean","example":false},"address":{"type":"object","properties":{"formatted":{"type":"string","description":"The full, formatted address string.","example":"Postbus 123456 1111AB Amsterdam"},"street":{"type":"string","description":"The street name.","example":"Postbus 123456"},"houseNumber":{"type":"integer","description":"The house number.","example":12},"houseNumberAddition":{"type":"string","description":"The house number addition (e.g., 'A', '1').","nullable":true,"example":null},"houseLetter":{"type":"string","description":"The house letter (e.g., 'A', 'B').","nullable":true,"example":null},"postalCode":{"type":"string","description":"The postal code.","example":"1111AB"},"city":{"type":"string","description":"The city name.","example":"Amsterdam"},"province":{"type":"string","description":"The province name.","example":"Noord-Holland"},"municipality":{"type":"string","description":"The municipality name.","example":"Amsterdam"},"country":{"type":"string","description":"The country code (e.g., NLD).","example":"NLD"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number","format":"float","description":"The latitude coordinate.","example":123.456},"longitude":{"type":"number","format":"float","description":"The longitude coordinate.","example":456.123}}},"countrySpecific":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"bag":{"type":"object","properties":{"system":{"type":"string","description":"The system from which the identifier originates (e.g., BAG).","example":"BAG"},"value":{"type":"object","properties":{"addressableObjectID":{"type":"integer","format":"int64","description":"The addressable object ID.","example":123},"numberIndicationID":{"type":"integer","format":"int64","description":"The number indication ID.","example":456}}}}}}}}},"registrationDate":{"type":"string","format":"date","description":"The date the address was registered.","example":"1979-01-01"},"visibilityStatus":{"type":"string","description":"The visibility status of the address.","enum":["visible","protected"],"example":"visible"}}},"correspondenceAddress":{"type":"object","properties":{"formatted":{"type":"string","description":"The full, formatted address string.","example":"Postbus 123456 1111AB Amsterdam"},"street":{"type":"string","description":"The street name.","example":"Postbus 123456"},"houseNumber":{"type":"integer","description":"The house number.","example":12},"houseNumberAddition":{"type":"string","description":"The house number addition (e.g., 'A', '1').","nullable":true,"example":null},"houseLetter":{"type":"string","description":"The house letter (e.g., 'A', 'B').","nullable":true,"example":null},"postalCode":{"type":"string","description":"The postal code.","example":"1111AB"},"city":{"type":"string","description":"The city name.","example":"Amsterdam"},"province":{"type":"string","description":"The province name.","example":"Noord-Holland"},"municipality":{"type":"string","description":"The municipality name.","example":"Amsterdam"},"country":{"type":"string","description":"The country code (e.g., NLD).","example":"NLD"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number","format":"float","description":"The latitude coordinate.","example":123.456},"longitude":{"type":"number","format":"float","description":"The longitude coordinate.","example":456.123}}},"countrySpecific":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"bag":{"type":"object","properties":{"system":{"type":"string","description":"The system from which the identifier originates (e.g., BAG).","example":"BAG"},"value":{"type":"object","properties":{"addressableObjectID":{"type":"integer","format":"int64","description":"The addressable object ID.","example":123},"numberIndicationID":{"type":"integer","format":"int64","description":"The number indication ID.","example":456}}}}}}}}},"registrationDate":{"type":"string","format":"date","description":"The date the address was registered.","example":"1979-01-01"},"visibilityStatus":{"type":"string","description":"The visibility status of the address.","enum":["visible","protected"],"example":"visible"}}},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"number":{"type":"string"}}}},"websites":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"value":{"type":"string"}}}},"emails":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"value":{"type":"string"}}}}}},"activities":{"type":"object","properties":{"sbi":{"type":"array","items":{"type":"object","properties":{"isMain":{"type":"boolean","description":"Indicates if this is the main source.","example":false},"source":{"type":"string","description":"The data sources.","example":"tradeRegister"},"system":{"type":"string","description":"The system from which the data originates.","example":"SBI"},"code":{"type":"string","description":"The unique code for the classification.","example":"1071"},"description":{"type":"string","example":"Manufacture of bread and fresh pastry"}}}}}}}},"profiles":{"type":"object","properties":{"linkedIn":{"type":"string"}}},"extensions":{"type":"object","properties":{"sizeIndicators":{"$ref":"#/components/schemas/SizeIndicators"},"activities":{"$ref":"#/components/schemas/ActivitiesExtension"},"financials":{"$ref":"#/components/schemas/FinancialsExtension"},"ownershipStructures":{"$ref":"#/components/schemas/OwnershipStructures"},"management":{"$ref":"#/components/schemas/Management"}}}}},"SizeIndicators":{"type":"object","properties":{"personnel":{"type":"array","items":{"$ref":"#/components/schemas/PersonnelIndicator"}},"profit":{"type":"array","items":{"$ref":"#/components/schemas/ProfitIndicator"}},"turnover":{"type":"array","items":{"$ref":"#/components/schemas/TurnoverIndicator"}},"numberOfBranches":{"type":"integer","format":"int32"}},"additionalProperties":false},"PersonnelIndicator":{"type":"object","properties":{"year":{"type":"integer","format":"int32","description":"Year that the personnel figure applies to."},"total":{"$ref":"#/components/schemas/PersonnelTotal"},"source":{"type":"string","description":"Source of the personnel information (e.g. tradeRegister, companyInfo, annualAccount)."}},"required":["total","source"],"additionalProperties":false},"ProfitIndicator":{"type":"object","properties":{"year":{"type":"integer","format":"int32"},"value":{"$ref":"#/components/schemas/MoneyValue"},"source":{"type":"string","description":"Source of the profit information."}},"required":["value","source"],"additionalProperties":false},"PersonnelTotal":{"type":"object","properties":{"value":{"type":"integer","format":"int32","description":"Number of personnel."},"class":{"$ref":"#/components/schemas/ClassCode"}},"required":["value"],"additionalProperties":false},"TurnoverIndicator":{"type":"object","properties":{"year":{"type":"integer","format":"int32"},"source":{"type":"string","description":"Source of turnover information."},"value":{"$ref":"#/components/schemas/MoneyValue"},"class":{"$ref":"#/components/schemas/ClassCode"}},"required":["source"],"additionalProperties":false},"ClassCode":{"type":"object","properties":{"code":{"type":"string","description":"Code representing the size class."},"description":{"type":"string"}},"required":["code"],"additionalProperties":false},"ActivitiesExtension":{"type":"object","properties":{"summary":{"type":"string"},"sbi":{"type":"array","items":{"$ref":"#/components/schemas/ActivityCode"}},"nace":{"type":"array","items":{"$ref":"#/components/schemas/ActivityCode"}}},"additionalProperties":false},"ActivityCode":{"type":"object","properties":{"code":{"type":"string"},"isMain":{"type":"boolean"},"system":{"type":"string","description":"Classification system (e.g. SBI, NACE)."},"source":{"type":"string"},"description":{"type":"string"}},"required":["code","isMain","system","source"],"additionalProperties":false},"FinancialsExtension":{"type":"object","properties":{"identifiers":{"$ref":"#/components/schemas/FinancialIdentifiers"},"financialStatements":{"$ref":"#/components/schemas/FinancialStatements"},"figures":{"$ref":"#/components/schemas/FinancialFigures"},"creditFlag":{"type":"string","description":"Credit risk flag (e.g. GREEN, AMBER, RED)."},"bankGroups":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"FinancialIdentifiers":{"type":"object","properties":{"rsin":{"$ref":"#/components/schemas/Identifier"},"lei":{"$ref":"#/components/schemas/Identifier"},"vat":{"$ref":"#/components/schemas/Identifier"}},"additionalProperties":false},"Identifier":{"type":"object","properties":{"system":{"type":"string","description":"System issuing the identifier (e.g. taxOffice, tradeRegister)."},"value":{"type":"string"}},"required":["system","value"],"additionalProperties":false},"FinancialStatements":{"type":"object","properties":{"latestFiling":{"type":"object","properties":{"year":{"type":"integer","format":"int32"},"status":{"type":"string"}},"required":["year"],"additionalProperties":false},"history":{"type":"array","items":{"$ref":"#/components/schemas/FinancialStatementHistoryItem"}}},"additionalProperties":false},"FinancialStatementHistoryItem":{"type":"object","properties":{"year":{"type":"integer","format":"int32"},"figures":{"$ref":"#/components/schemas/FinancialStatementFigures"}},"required":["year","figures"],"additionalProperties":false},"FinancialStatementFigures":{"type":"object","properties":{"turnover":{"$ref":"#/components/schemas/FinancialFigureWithClass"},"profit":{"$ref":"#/components/schemas/FinancialFigure"},"assets":{"$ref":"#/components/schemas/FinancialFigure"},"grossMargin":{"$ref":"#/components/schemas/FinancialFigure"}},"additionalProperties":false},"FinancialFigureWithClass":{"type":"object","properties":{"source":{"type":"string"},"value":{"$ref":"#/components/schemas/MoneyValue"},"class":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"}}}},"required":["source","value"],"additionalProperties":false},"FinancialFigure":{"type":"object","properties":{"source":{"type":"string"},"value":{"$ref":"#/components/schemas/MoneyValue"}},"required":["source","value"],"additionalProperties":false},"MoneyValue":{"type":"object","properties":{"amount":{"type":"string","description":"Monetary amount as a string to avoid precision issues."},"currency":{"type":"string","description":"ISO 4217 currency code (e.g. EUR)."}},"required":["currency"],"additionalProperties":false},"FinancialFigures":{"type":"object","properties":{"turnover":{"type":"array","items":{"$ref":"#/components/schemas/TurnoverIndicator"}}},"additionalProperties":false},"OwnershipStructures":{"type":"object","properties":{"directParent":{"$ref":"#/components/schemas/OwnershipParty"},"ultimateNationalParent":{"$ref":"#/components/schemas/OwnershipParty"},"firstInternationalParent":{"$ref":"#/components/schemas/OwnershipIntParty"},"numberOfChildren":{"type":"integer"},"concern":{"$ref":"#/components/schemas/Concern"}},"additionalProperties":false},"OwnershipParty":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"identifiers":{"type":"object","properties":{"tradeRegister":{"$ref":"#/components/schemas/Identifier"}},"additionalProperties":false}},"required":["id","name"],"additionalProperties":false},"OwnershipIntParty":{"type":"object","properties":{"name":{"type":"string"},"country":{"type":"string"}},"required":["country","name"],"additionalProperties":false},"Concern":{"description":"The group (concern) the organization belongs to, expressed as a graph of\nentities and the relationships between them. Every entity carries an `id`\nthat is unique within the concern and is referenced by the relationships.\n","type":"object","properties":{"entities":{"$ref":"#/components/schemas/ConcernEntities"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/ConcernRelationship"}}},"additionalProperties":false},"ConcernEntities":{"description":"The members of the concern, grouped by entity type.\n","type":"object","properties":{"domesticOrganizations":{"type":"array","items":{"$ref":"#/components/schemas/ConcernDomesticOrganization"}},"foreignOrganizations":{"type":"array","items":{"$ref":"#/components/schemas/ConcernForeignOrganization"}},"naturalPersons":{"type":"array","items":{"$ref":"#/components/schemas/ConcernNaturalPerson"}}},"additionalProperties":false},"ConcernDomesticOrganization":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Identifier of the entity within the concern, referenced by the relationships.","example":1},"type":{"type":"string","description":"The role of the entity within the concern.","example":"domesticOrganization"},"entity":{"$ref":"#/components/schemas/OwnershipParty"}},"required":["id","type","entity"],"additionalProperties":false},"ConcernForeignOrganization":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Identifier of the entity within the concern, referenced by the relationships.","example":2},"type":{"type":"string","description":"The role of the entity within the concern.","example":"foreignOrganization"},"entity":{"$ref":"#/components/schemas/OwnershipIntParty"}},"required":["id","type","entity"],"additionalProperties":false},"ConcernNaturalPerson":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Identifier of the entity within the concern, referenced by the relationships.","example":3},"type":{"type":"string","description":"The role of the entity within the concern.","example":"naturalPerson"},"entity":{"$ref":"#/components/schemas/ManagementPerson"}},"required":["id","type","entity"],"additionalProperties":false},"ConcernRelationship":{"description":"A parent-child ownership relation between two entities of the concern,\nreferencing them by their `id`.\n","type":"object","properties":{"from":{"type":"integer","format":"int64","description":"The id of the owning (parent) entity.","example":1},"to":{"type":"integer","format":"int64","description":"The id of the owned (child) entity.","example":2}},"required":["from","to"],"additionalProperties":false},"Management":{"type":"object","properties":{"individuals":{"type":"array","items":{"$ref":"#/components/schemas/ManagementIndividual"}},"organizations":{"type":"array","items":{"$ref":"#/components/schemas/ManagementOrganization"}},"others":{"type":"array","items":{"$ref":"#/components/schemas/ManagementOthers"}},"lastSeenDate":{"type":"string","format":"date"},"status":{"type":"string"}},"additionalProperties":false},"ManagementIndividual":{"type":"object","properties":{"subject":{"$ref":"#/components/schemas/ManagementPerson"},"type":{"type":"string","enum":["individual"]},"startDate":{"type":"string","format":"date"},"function":{"$ref":"#/components/schemas/ManagementFunction"}},"required":["subject","type","startDate"],"additionalProperties":false},"ManagementOrganization":{"type":"object","properties":{"subject":{"$ref":"#/components/schemas/OrganizationSubject"},"type":{"type":"string","enum":["organization"]},"startDate":{"type":"string","format":"date"},"function":{"$ref":"#/components/schemas/ManagementFunction"}},"required":["subject","type","startDate"],"additionalProperties":false},"ManagementOthers":{"type":"object","properties":{"subject":{"$ref":"#/components/schemas/OthersSubject"},"type":{"type":"string","enum":["other"]},"startDate":{"type":"string","format":"date"},"function":{"$ref":"#/components/schemas/ManagementFunction"}},"required":["subject","type","startDate"],"additionalProperties":false},"ManagementPerson":{"type":"object","properties":{"fullName":{"type":"string"},"firstNames":{"type":"string"},"lastName":{"type":"string"},"dateOfBirth":{"type":"string","format":"date"}},"additionalProperties":false},"OrganizationSubject":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","description":"The organization's identifier (usually the KVK\ntrade-register number). Only present when the management\norganization can be linked to a known record; omitted for\nforeign or unresolved parties.\n"}},"required":["name"],"additionalProperties":false},"OthersSubject":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false},"ManagementFunction":{"type":"object","properties":{"title":{"type":"string"},"type":{"type":"string"},"powers":{"$ref":"#/components/schemas/ManagementPowers"}},"required":["type"],"additionalProperties":false},"ManagementPowers":{"type":"object","properties":{"authority":{"$ref":"#/components/schemas/Authority"}},"additionalProperties":false},"Authority":{"type":"object","properties":{"limit":{"$ref":"#/components/schemas/AuthorityLimit"},"description":{"type":"string"}},"additionalProperties":false},"AuthorityLimit":{"type":"object","properties":{"amount":{"type":"string","description":"Monetary limit as a string to avoid precision issues."},"currency":{"type":"string"}},"required":["amount","currency"],"additionalProperties":false},"BranchesAttributes":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"tradeRegister":{"type":"object","properties":{"system":{"type":"string","description":"The source system of the identifier.","example":"tradeRegister"},"value":{"type":"string","example":"123456780000"}}}}},"isMain":{"type":"boolean","example":true},"names":{"type":"object","properties":{"main":{"type":"string","example":"Test B.V."},"tradeNames":{"type":"array","items":{"type":"object","properties":{"isActive":{"type":"boolean","description":"Indicates if the tradename is currently in use.","example":false},"isMain":{"type":"boolean","description":"Indicates if this is the primary tradename.","example":false},"name":{"type":"string","description":"The tradename string.","example":"Test B.V."}}}}}},"lifecycle":{"type":"object","properties":{"registration":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"type":{"type":"string","example":"registration"},"startDate":{"type":"string","format":"date","description":"The date when the event started or occurred","example":"1234-05-06"},"endDate":{"type":"string","format":"date","description":"Optional end date, e.g. for insolvency cases","example":"1234-05-06"}}},"events":{"type":"object","properties":{"continuation":{"type":"object","properties":{"date":{"type":"string","example":"1234-05-06"},"type":{"type":"string","example":"continuation"}}}}}}},"personnel":{"type":"object","properties":{"fulltime":{"type":"object","properties":{"value":{"type":"integer","example":23},"class":{"type":"object","properties":{"code":{"type":"string","example":"6"},"description":{"type":"string"}}}}},"parttime":{"type":"object","properties":{"value":{"type":"integer","example":23},"class":{"type":"object","properties":{"code":{"type":"string","example":"6"},"description":{"type":"string"}}}}},"total":{"type":"object","properties":{"value":{"type":"integer","example":23},"class":{"type":"object","properties":{"code":{"type":"string","example":"6"},"description":{"type":"string"}}}}},"source":{"type":"string","description":"Source system from which employee data is retrieved.","example":"tradeRegister"}}},"contact":{"type":"object","properties":{"excludeFromMailing":{"type":"boolean","example":false},"excludeFromMarketing":{"type":"boolean","example":false},"address":{"type":"object","properties":{"formatted":{"type":"string","description":"The full, formatted address string.","example":"Postbus 123456 1111AB Amsterdam"},"street":{"type":"string","description":"The street name.","example":"Postbus 123456"},"houseNumber":{"type":"integer","description":"The house number.","example":12},"houseNumberAddition":{"type":"string","description":"The house number addition (e.g., 'A', '1').","nullable":true,"example":null},"houseLetter":{"type":"string","description":"The house letter (e.g., 'A', 'B').","nullable":true,"example":null},"postalCode":{"type":"string","description":"The postal code.","example":"1111AB"},"city":{"type":"string","description":"The city name.","example":"Amsterdam"},"province":{"type":"string","description":"The province name.","example":"Noord-Holland"},"municipality":{"type":"string","description":"The municipality name.","example":"Amsterdam"},"country":{"type":"string","description":"The country code (e.g., NLD).","example":"NLD"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number","format":"float","description":"The latitude coordinate.","example":123.456},"longitude":{"type":"number","format":"float","description":"The longitude coordinate.","example":456.123}}},"countrySpecific":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"bag":{"type":"object","properties":{"system":{"type":"string","description":"The system from which the identifier originates (e.g., BAG).","example":"BAG"},"value":{"type":"object","properties":{"addressableObjectID":{"type":"integer","format":"int64","description":"The addressable object ID.","example":123},"numberIndicationID":{"type":"integer","format":"int64","description":"The number indication ID.","example":456}}}}}}}}},"registrationDate":{"type":"string","format":"date","description":"The date the address was registered.","example":"1979-01-01"},"visibilityStatus":{"type":"string","description":"The visibility status of the address.","enum":["visible","protected"],"example":"visible"}}},"correspondenceAddress":{"type":"object","properties":{"formatted":{"type":"string","description":"The full, formatted address string.","example":"Postbus 123456 1111AB Amsterdam"},"street":{"type":"string","description":"The street name.","example":"Postbus 123456"},"houseNumber":{"type":"integer","description":"The house number.","example":12},"houseNumberAddition":{"type":"string","description":"The house number addition (e.g., 'A', '1').","nullable":true,"example":null},"houseLetter":{"type":"string","description":"The house letter (e.g., 'A', 'B').","nullable":true,"example":null},"postalCode":{"type":"string","description":"The postal code.","example":"1111AB"},"city":{"type":"string","description":"The city name.","example":"Amsterdam"},"province":{"type":"string","description":"The province name.","example":"Noord-Holland"},"municipality":{"type":"string","description":"The municipality name.","example":"Amsterdam"},"country":{"type":"string","description":"The country code (e.g., NLD).","example":"NLD"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number","format":"float","description":"The latitude coordinate.","example":123.456},"longitude":{"type":"number","format":"float","description":"The longitude coordinate.","example":456.123}}},"countrySpecific":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"bag":{"type":"object","properties":{"system":{"type":"string","description":"The system from which the identifier originates (e.g., BAG).","example":"BAG"},"value":{"type":"object","properties":{"addressableObjectID":{"type":"integer","format":"int64","description":"The addressable object ID.","example":123},"numberIndicationID":{"type":"integer","format":"int64","description":"The number indication ID.","example":456}}}}}}}}},"registrationDate":{"type":"string","format":"date","description":"The date the address was registered.","example":"1979-01-01"},"visibilityStatus":{"type":"string","description":"The visibility status of the address.","enum":["visible","protected"],"example":"visible"}}},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"number":{"type":"string"}}}},"websites":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"value":{"type":"string"}}}},"emails":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"value":{"type":"string"}}}}}},"activities":{"type":"object","properties":{"sbi":{"type":"array","items":{"type":"object","properties":{"isMain":{"type":"boolean","description":"Indicates if this is the main source.","example":false},"source":{"type":"string","description":"The data sources.","example":"tradeRegister"},"system":{"type":"string","description":"The system from which the data originates.","example":"SBI"},"code":{"type":"string","description":"The unique code for the classification.","example":"1071"},"description":{"type":"string","example":"Manufacture of bread and fresh pastry"}}}}}},"extensions":{"type":"object","properties":{"transfers":{"type":"array","items":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"fromTradeRegister":{"type":"object","properties":{"system":{"type":"string","description":"The source system of the identifier.","example":"tradeRegister"},"value":{"type":"string","example":"12345678"}}},"toTradeRegister":{"type":"object","properties":{"system":{"type":"string","description":"The source system of the identifier.","example":"tradeRegister"},"value":{"type":"string","example":"12345679"}}}}},"date":{"type":"string","format":"date","example":"1979-01-01"}}}}}}}},"OrganizationBranchesAttributes":{"type":"object","properties":{"isMain":{"type":"boolean"},"names":{"type":"object","properties":{"main":{"type":"string"}}},"lifecycle":{"type":"object","properties":{"registration":{"type":"object","properties":{"isActive":{"type":"boolean"},"startDate":{"type":"string"},"type":{"type":"string"}}}}},"contact":{"type":"object","properties":{"address":{"type":"object","properties":{"street":{"type":"string"},"houseNumber":{"type":"integer","format":"int32"},"houseNumberAddition":{"type":"string"},"houseLetter":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"visibilityStatus":{"type":"string","description":"The visibility status of the address.","enum":["visible","protected"],"example":"visible"}}}}}}},"visitingAddress":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"string","example":"Harlingen"},"street":{"type":"string","example":"Voorstraat"}}}}},"valueCount":{"description":"Represents a single aggregation bucket with a value and its count.\n","type":"object","properties":{"value":{"type":"string","example":"Haarlem"},"count":{"type":"integer","example":125,"minimum":0}}},"meta":{"type":"object","properties":{"totalResults":{"type":"integer","description":"The total number of results found across all pages.","example":500,"minimum":0},"totalPages":{"type":"integer","description":"The total number of pages available based on the current page size."}},"additionalProperties":false},"Resource":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"}}},"ResponseList":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}}}},"RelationshipToOne":{"type":"object","properties":{"data":{"type":"object","oneOf":[{"$ref":"#/components/schemas/Resource"}],"nullable":true}},"minProperties":1},"ErrorResource":{"type":"object","required":["errors"],"properties":{"errors":{"title":"An array of Error objects","type":"array","minItems":1,"items":{"type":"object","required":["status","code","title","detail"],"properties":{"status":{"description":"the HTTP status code applicable to this problem","type":"string","minLength":3,"maxLength":3},"code":{"description":"an application-specific error code. It can be the same as 'status'","type":"string"},"title":{"description":"a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization","type":"string"},"detail":{"description":"a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized","type":"string"}}}}}},"Response":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Resource"}},"additionalProperties":false}},"parameters":{"acceptLanguage":{"name":"Accept-Language","in":"header","description":"determines the language of descriptions in the response. If you do not specify the language, the en description will be returned.\n","required":false,"schema":{"type":"string","example":"nl","enum":["nl","en"]}},"query":{"name":"query","in":"query","description":"Searches across multiple fields. Results are ranked by relevance, with exact identifier and company name matches prioritized over phrase, full-text, and prefix matches. Supports fuzzy matching for text fields. Minimum length: 2 characters.\n","required":false,"schema":{"type":"string","example":"company"}},"entityFilter":{"name":"filter","in":"query","description":"Enables filtering of entities based on exact values and range conditions. Supports structured fields such as address, financials, and metadata.\n","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/entityFilterQuery"},"example":{"name":"company.info","isActive":true,"legalForm":"Besloten Vennootschap","type":"branch","identifiers":{"tradeRegister":"332292790000"},"organization":{"identifiers":{"tradeRegister":"33229279"}},"contact":{"address":{"province":"Zuid-Holland","city":"Amsterdam","postalCode":"1231RV"}},"activities":{"sbi":{"code":{"main":"70102"}}},"financials":{"bankGroup":"RaboBank","turnover":{"range":"1000000,2000000"}}}},"entityMatch":{"name":"match","in":"query","description":"Supports partial or prefix-based text matching across key entity attributes. Prefix search is applied to fields like `city` and `identifiers`, while general matching is used for `postalCode`, `street`, `name`, and `tradeNames`. Supports fuzzy matching for text fields.\n","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/entityMatchQuery"},"example":{"name":"company.info","legalForm":"Besloten Vennootschap","identifiers":{"tradeRegister":"332292790000"},"organization":{"name":"company.info"},"contact":{"address":{"city":"Amsterdam","postalCode":"1231RV","street":"Veilingstraat"}},"lifecycle":{"firstRegistration":"2002-02-05"}}},"entitySort":{"name":"sort","in":"query","description":"Comma-separated list of fields used to sort the results, following JSON:API sorting conventions. Prefix a field with `-` to sort in descending order (default is ascending). <br>Defaults to sorting by `-id` (descending).\n","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/sortType"}},"example":["financials.turnover","name"]},"aggregate":{"name":"aggregate","in":"query","description":"A query parameter that defines the data aggregation to be performed on the search results. It allows you to specify a comma-separated list of fields to group by and to define the size of each aggregation bucket.\n","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/aggregationQuery"},"example":{"fields":["contact.address.city","contact.address.province","legalForm","financials.bankGroup"],"size":{"contact":{"address":{"city":10,"province":10}},"legalForm":5,"financials":{"bankGroups":20}}}},"include":{"name":"include","in":"query","description":"A comma-separated list of relationship paths to be included as a compound document. This allows you to request that related resources be returned with the primary data in the `included` array.\n","required":false,"allowEmptyValue":true,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"},"example":["organizations"]}},"extensions":{"name":"extensions","in":"query","description":"Obtain a profile featuring specified blocks, delineated by commas.\n","schema":{"type":"array","items":{"$ref":"#/components/schemas/extensionType"}},"style":"form","explode":false},"organizationIdParam":{"name":"organization_id","in":"path","description":"Specifies Organization id\n","required":true,"schema":{"type":"string"}},"branchIdParam":{"name":"branch_id","in":"path","description":"Specifies branch id\n","required":true,"schema":{"type":"string"}},"Fuzziness":{"name":"fuzziness","in":"query","description":"Enables fuzzy search when set to `true`.\n","required":false,"example":true,"schema":{"type":"boolean"}},"Page":{"name":"page","in":"query","description":"Controls pagination for a collection of resources, allowing clients to request a specific page and specify the number of resources per page.","required":false,"allowEmptyValue":false,"style":"deepObject","explode":true,"allowReserved":false,"schema":{"type":"object","properties":{"number":{"type":"integer","description":"The page number to retrieve.","default":1,"minimum":1},"size":{"type":"integer","description":"The number of records per page.","default":10,"maximum":20}}}}},"headers":{"X-Correlation-Id":{"description":"Unique request identifier","schema":{"type":"string","format":"uuid"}}},"examples":{"BadRequestExample":{"value":{"errors":[{"status":"400","code":"bad-request","title":"Bad Request","detail":"The request payload contains an invalid or missing field."}]}},"ForbiddenExample":{"value":{"errors":[{"status":"403","code":"forbidden","title":"Forbidden","detail":"You do not have permission to access this resource."}]}},"NotFoundExample":{"value":{"errors":[{"status":"404","code":"not-found","title":"Resource Not Found","detail":"The requested resource does not exist."}]}},"InternalServerErrorExample":{"value":{"errors":[{"status":"500","code":"internal-server-error","title":"Internal Server Error","detail":"An unexpected server error occurred."}]}}},"responses":{"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorResource"},"examples":{"badRequest":{"$ref":"#/components/examples/BadRequestExample"}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorResource"},"examples":{"forbidden":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorResource"},"examples":{"notFound":{"$ref":"#/components/examples/NotFoundExample"}}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorResource"},"examples":{"internalServerError":{"$ref":"#/components/examples/InternalServerErrorExample"}}}}}}},"x-readme":{"proxy-enabled":false}}