openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 93.8 kB
JSON
{"openapi":"3.0.0","info":{"description":"# Introduction\nThe Business Registries API is built on HTTP. The API is RESTful. It has predictable resource URIs.\n\n The API is documented in <a target=\"_blank\" href=\"https://github.com/OAI/OpenAPI-Specification\">OpenAPI</a> format.\n In addition to the standard OpenAPI syntax we use a few\n <a target=\"_blank\" href=\"https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md\">vendor extensions</a>.\n\n# Overview\nThe following sections describe the resources that make up the Business Registries REST API.\n## Current Version\nBy default, all requests to https://api.abr.ato.gov.au receive the `v1` version of the REST API. We encourage you to explicitly request this version via the `Accept` header.\n\n Accept: application/vnd.abr-ato.v1+json\n\n## Schema\nAll API access is over HTTPS, and accessed from https://api.abr.ato.gov.au. All data is sent and received as JSON. Blank fields are included.\n\n All dates use the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format:\n\n YYYY-MM-DD\n\n For example: `2017-07-01` (the 1st of July 2017)\n\n All timestamps use the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format:\n\n YYYY-MM-DDTHH:MM:SSZ\n\n For example: `2017-07-01T11:05:06+10:00`\n\n## Timezones\nSome requests allow for specifying timestamps or generate timestamps with time zone information. We apply the following rules, in order of priority, to determine timezone information for API calls.\n### Explicitly provide an ISO 8601 timestamp with timezone information\nFor API calls that allow for a timestamp to be specified, we use that exact timestamp.\n\n For example: `2017-07-01T11:05:06+10:00`\n\n## Pagination\nInformation about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\n\n For example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n## Parameters\nMany API methods take optional parameters:\n\n GET /individuals/1234/addresses/?addressType='Mailing'\n\nIn this example, the '1234' value is provided for the `:partyId` parameter in the path while `:addressType` is passed in the query string.\nFor POST, PATCH, PUT, and DELETE requests, parameters not included in the URL should be encoded as JSON with a Content-Type of 'application/json'.\n## Metadata\nThe API provides **metadata services** that you can use to discover information about the classifcation schemes and values used by the Registry.\n\n For example:\n\n GET /classifications/roles\n\n Sample response:\n\n [\n {\n \"id\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"role\": \"Director\",\n \"roleDescription\": \"An individual responsible for managing a company's ...\",\n \"relationship\": \"Directorship\",\n \"reciprocalRole\": \"Company\",\n \"reciprocalRoleDescription\": \"An incorporated legal entity.\"\n },\n {\n ...\n }\n ]\n\n## Root Endpoint\nYou can issue a GET request to the root endpoint (also known as the service root) to get all the endpoint categories that the REST API supports:\n\n curl https://api.abr.ato.gov.au\n\n## Authentication\nThe Business Registries API supports API Key authentication.\n\n When you sign up for an account, you are given your first API key. You can generate additional API keys, and delete\n API keys (as you may need to rotate your keys in the future). You authenticate to the Business Registries API by\n providing your secret key in the request header.\n\n **Note:** Some requests will return `404 Not Found`, instead of `403 Permission Denied`. This is to prevent the\n accidental leakage of information to unauthorised users.\n","license":{"name":"Creative Commons Attribution 3.0 Australia","url":"https://creativecommons.org/licenses/by/3.0/au/"},"termsOfService":"https://ato.gov.au/terms-of-service/","title":"Business Registries","version":"0.0.6","x-apisguru-categories":["financial"],"x-logo":{"backgroundColor":"#D3D3D3","url":"https://www.ato.gov.au/uploadedImages/Content/_DEM/Images/logo-ato.png"},"x-origin":[{"format":"swagger","url":"https://ato-team.github.io/business-registries-rest-api-specification/swagger.yaml","version":"2.0"}],"x-providerName":"ato.gov.au"},"tags":[{"description":"An individual is a person about whom the registry wishes to maintain information.\n\n For example, the individual's date and place of birth (for the purposes of identification) and the individual's\n residential address (which is used for administrative purposes).\n","name":"Individuals"},{"description":"A role defines the characteristics of a relationship between parties.\nAn Individual can participate in a relationship with other individuals and organisations.\n\nFor example:\n\n| Party | Role | Relationship | Role | Party |\n| ------------- | -------------- | ---------------- | ------------- | ------------------------------- |\n| Homer Simpson | Husband | Marriage | Wife | Marge Simpson |\n| Homer Simpson | Employee | Employment | Employer | Springfield Nuclear Power Plant |\n| Homer Simpson | Safety Officer | Colleague | Supervisor | Carl Carlson |\n| Homer Simpson | Director | Directorship | Company | Compu Global Hyper Mega Net |\n| Homer Simpson | Employee | Employment | Employer | Compu Global Hyper Mega Net |\n| Homer Simpson | Member | Membership | Organisation | The Stonecutters |\n| Homer Simpson | Partner | Partnership | Partnership | The Be Sharps |\n| Homer Simpson | Trustee | Trusteeship | Trust | The Simpson Family Trust |\n| Homer Simpson | Member | Membership | Association | Mensa International |\n\nYou can use the API's **metadata services** to retrieve information about the classifcation schemes and\nvalues used by the Registry.\n","name":"Individuals Roles"},{"description":"The registry maintains information about an individual's contact details for administrative purposes.\n\n Including:\n - an address for the service of documents\n - a principal place of business address\n","name":"Individuals Addresses"},{"description":"The registry maintains information about an individual's contact details for administrative purposes.\n\n Including:\n - an email address\n - a mobile number\n","name":"Individuals Electronic Addresses"},{"description":"A business name is a name or title under which a person conducts a business.\n","name":"Individuals Business Names"},{"description":"If you carry on a business you may need to hold a licence.\n\n For example, if you provide financial services, you are required to hold an Australian Financial\n Services (AFS) licence.\n","name":"Individuals Licenses"},{"description":"An organisation usually consists of a number of individuals or groups bound by a common purpose about whom the\nregistry wishes to maintain information.\n\n For example, the organisation's legal entity type (e.g., Incorporated Entity, Unincorporated Entity,\n Partnership or Joint Venture).\n","name":"Organisations"},{"description":"A role defines the characteristics of a relationship between parties.\nAn Organisation can participate in a relationship with other organisations and indiviuals.\n\nFor example:\n\n| Party | Role | Relationship | Role | Party |\n| ------------------------------- | -------- | -------------| ------------ | ----------------- |\n| Springfield Nuclear Power Plant | Employer | Employment | Employee | Homer Simpson |\n| Springfield Nuclear Power Plant | Company | Directorship | Director | Mr Burns |\n| Springfield Nuclear Power Plant | Employer | Employment | Employee | Mr Burns |\n| Springfield Nuclear Power Plant | Sponsor | Sponsorship | Organisation | The Stonecutters |\n\nYou can use the API's **metadata services** to retrieve information about the classifcation schemes and\nvalues used by the Registry.\n","name":"Organisations Roles"},{"description":"The registry maintains information about an organisation's contact details for administrative purposes.\n\n Including:\n - an address for the service of documents\n - a principal place of business address\n","name":"Organisations Addresses"},{"description":"The registry maintains information about an organisation's contact details for administrative purposes.\n\n Including:\n - an email address\n - a mobile number\n","name":"Organisations Electronic Addresses"},{"description":"A business name is a name or title under which an organisation conducts a business.\n","name":"Organisations Business Names"},{"description":"If you carry on a business you may need to hold a licence.\n\n For example, if you provide financial services, you are required to hold an Australian Financial\n Services (AFS) licence.\n","name":"Organisations Licenses"},{"description":"A business name is a name or title under which a person or organisation conducts a business.\n","name":"Business Names"},{"description":"If you carry on a business you may need to hold a licence.\n\n For example, if you provide financial services, you are required to hold an Australian Financial\n Services (AFS) licence.\n","name":"Licenses"},{"description":"A classification scheme for business names.\n","name":"Business Name Lifecycle States"},{"description":"A classification scheme for names.\n","name":"Name Directions"},{"description":"A classification scheme for names.\n","name":"Name Prefixes"},{"description":"A classification scheme for names.\n","name":"Name Types"},{"description":"A classification scheme for addresses.\n","name":"Address Types"},{"description":"A classification scheme for electronic addresses.\n","name":"Electronic Address Types"},{"description":"A classification scheme for the representation of human sexes.\n","name":"Genders"},{"description":"A classification scheme for parties (individuals and organisations).\n","name":"Legal Entity Types"},{"description":"A classification scheme for licenses.\n","name":"License Lifecycle States"},{"description":"A classification scheme for licenses.\n","name":"License Types"},{"description":"A classification scheme for registered identifiers.\n","name":"Registered Identifier Types"},{"description":"A classification scheme for the characteristics of relationships between parties (individuals and organisations).\n","name":"Roles"}],"paths":{"/business-names":{"get":{"description":"Retrieve a list of business names\n","parameters":[{"$ref":"#/components/parameters/apiKey"}],"responses":{"200":{"description":"A list of business names was retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/business-name"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of business names","tags":["Business Names"]}},"/classifications/address-types":{"get":{"responses":{"200":{"description":"Address types were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"example":[{"description":"The address at which an individual or organisation receives letters or packages.","id":"123e4567-e89b-12d3-a456-426655440001","name":"Mailing"},{"description":"The main location where work is conducted.","id":"123e4567-e89b-12d3-a456-426655440002","name":"Principal Place of Business"}],"items":{"$ref":"#/components/schemas/address-type"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of address types","tags":["Address Types"]},"parameters":[{"$ref":"#/components/parameters/apiKey"}]},"/classifications/business-name-lifecycle-states":{"get":{"responses":{"200":{"description":"Business name lifecycle states were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"example":[{"description":"The Business Name has been approved.","id":"123e4567-e89b-12d3-a456-426655440001","name":"Approved"},{"description":"The Business Name has expired.","id":"123e4567-e89b-12d3-a456-426655440002","name":"Expired"},{"description":"The Business Name has been issued.","id":"123e4567-e89b-12d3-a456-426655440003","name":"Issued"},{"description":"The Business Name is pending approval.","id":"123e4567-e89b-12d3-a456-426655440004","name":"Pending Approval"},{"description":"The Business Name has been suspended.","id":"123e4567-e89b-12d3-a456-426655440005","name":"Suspended"}],"items":{"$ref":"#/components/schemas/business-name-lifecycle-state"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of business name lifecycle states","tags":["Business Name Lifecycle States"]},"parameters":[{"$ref":"#/components/parameters/apiKey"}]},"/classifications/electronic-address-types":{"get":{"responses":{"200":{"description":"Electronic address types were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"example":[{"description":"An address used to send and receive emails.","id":"123e4567-e89b-12d3-a456-426655440001","name":"Email"},{"description":"A number used to send and receive faxes.","id":"123e4567-e89b-12d3-a456-426655440002","name":"Fax"}],"items":{"$ref":"#/components/schemas/electronic-address-type"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of electronic address types","tags":["Electronic Address Types"]},"parameters":[{"$ref":"#/components/parameters/apiKey"}]},"/classifications/genders":{"get":{"responses":{"200":{"description":"Genders were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"example":[{"gender":"Not Known","id":"123e4567-e89b-12d3-a456-426655440001"},{"gender":"Male","id":"123e4567-e89b-12d3-a456-426655440002"},{"gender":"Female","id":"123e4567-e89b-12d3-a456-426655440003"},{"gender":"Not Applicable","id":"123e4567-e89b-12d3-a456-426655440004"}],"items":{"$ref":"#/components/schemas/gender"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of genders","tags":["Genders"]},"parameters":[{"$ref":"#/components/parameters/apiKey"}]},"/classifications/legal-entity-types":{"get":{"responses":{"200":{"description":"Legal entity types were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"example":[{"description":"If you operate as a sole trader, you're responsible for all aspects of the business, including any debts the business incurs.","id":"123e4567-e89b-12d3-a456-426655440001","name":"Sole Trader"},{"description":"A partnership is two or more individuals or organisations who do business as partners or receive income jointly.","id":"123e4567-e89b-12d3-a456-426655440002","name":"Partnership"},{"description":"A joint venture is two or more people or entities who join to do business together for a particular purpose, usually a single project, rather than as an ongoing business.","id":"123e4567-e89b-12d3-a456-426655440003","name":"Joint Venture"},{"description":"A company is a separate legal entity. This means it has the same rights as a natural person and can incur debt, sue and be sued.","id":"123e4567-e89b-12d3-a456-426655440004","name":"Company"},{"description":"A trust is an obligation imposed on a person – the trustee – to hold property or assets (e.g. business assets) for the benefit of others (known as beneficiaries).","id":"123e4567-e89b-12d3-a456-426655440005","name":"Trust"}],"items":{"$ref":"#/components/schemas/legal-entity-type"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of legal entity types","tags":["Legal Entity Types"]},"parameters":[{"$ref":"#/components/parameters/apiKey"}]},"/classifications/license-lifecycle-states":{"get":{"responses":{"200":{"description":"License lifecycle states were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"example":[{"description":"The License has been approved.","id":"123e4567-e89b-12d3-a456-426655440001","name":"Approved"},{"description":"The License has expired.","id":"123e4567-e89b-12d3-a456-426655440002","name":"Expired"},{"description":"The License has been issued.","id":"123e4567-e89b-12d3-a456-426655440003","name":"Issued"},{"description":"The License is pending approval.","id":"123e4567-e89b-12d3-a456-426655440004","name":"Pending Approval"},{"description":"The License has been suspended.","id":"123e4567-e89b-12d3-a456-426655440005","name":"Suspended"}],"items":{"$ref":"#/components/schemas/license-lifecycle-state"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of license lifecycle states","tags":["License Lifecycle States"]},"parameters":[{"$ref":"#/components/parameters/apiKey"}]},"/classifications/license-types":{"get":{"responses":{"200":{"description":"License types were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"example":[{"description":"To conduct a financial services business in Australia, you must have an Australian Financial Services (AFS) licence.","id":"123e4567-e89b-12d3-a456-426655440001","name":"Australian Financial Services License"},{"description":"To conduct a <insert-name-here> business you must have a 2B licence.","id":"123e4567-e89b-12d3-a456-426655440002","name":"2B License"}],"items":{"$ref":"#/components/schemas/license-type"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of license types","tags":["License Types"]},"parameters":[{"$ref":"#/components/parameters/apiKey"}]},"/classifications/name-directions":{"get":{"responses":{"200":{"description":"Name directions were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"example":[{"description":"The full name or formal salutation is rendered left to right.","id":"123e4567-e89b-12d3-a456-426655440001","name":"left-to-right"},{"description":"The full name or formal salutation is rendered right to left.","id":"123e4567-e89b-12d3-a456-426655440002","name":"right-to-left"}],"items":{"$ref":"#/components/schemas/name-direction"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of name directions","tags":["Name Directions"]},"parameters":[{"$ref":"#/components/parameters/apiKey"}]},"/classifications/name-prefixes":{"get":{"responses":{"200":{"description":"Name prefixes were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"example":[{"description":"A title used before a family name or formal salutation to address a man.","id":"123e4567-e89b-12d3-a456-426655440001","name":"Mr"},{"description":"A title used before a family name or formal salutation to address a woman.","id":"123e4567-e89b-12d3-a456-426655440002","name":"Ms"}],"items":{"$ref":"#/components/schemas/name-prefix"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of name prefixes","tags":["Name Prefixes"]},"parameters":[{"$ref":"#/components/parameters/apiKey"}]},"/classifications/name-types":{"get":{"responses":{"200":{"description":"Name types were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"example":[{"description":"An alternate name used by a party.","id":"123e4567-e89b-12d3-a456-426655440001","name":"Alias"},{"description":"The primary name used by a party.","id":"123e4567-e89b-12d3-a456-426655440002","name":"Principal Name"}],"items":{"$ref":"#/components/schemas/name-type"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of name types","tags":["Name Types"]},"parameters":[{"$ref":"#/components/parameters/apiKey"}]},"/classifications/registered-identifier-types":{"get":{"responses":{"200":{"description":"Registered identifier types were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"example":[{"description":"An Australian Business Number (ABN) is a unique eleven-character number issued by the Australian Business Register (ABR).","id":"123e4567-e89b-12d3-a456-426655440001","name":"ABN"},{"description":"An Australian Company Number (ACN) is a unique nine-character number issued by the Australian Securities and Investments Commission (ASIC).","id":"123e4567-e89b-12d3-a456-426655440002","name":"ACN"}],"items":{"$ref":"#/components/schemas/registered-identifier-type"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of registered identifier types","tags":["Registered Identifier Types"]},"parameters":[{"$ref":"#/components/parameters/apiKey"}]},"/classifications/roles":{"get":{"responses":{"200":{"description":"Roles were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"example":[{"id":"123e4567-e89b-12d3-a456-426655440001","reciprocalRole":"Company","reciprocalRoleDescription":"An incorporated legal entity.","relationship":"Directorship","role":"Director","roleDescription":"An individual responsible for managing a company's business activities."},{"id":"123e4567-e89b-12d3-a456-426655440002","reciprocalRole":"Employer","reciprocalRoleDescription":"An individual or organisation that employs people.","relationship":"Employment","role":"Employee","roleDescription":"An individual employed for wages or salary."}],"items":{"$ref":"#/components/schemas/role"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of roles","tags":["Roles"]},"parameters":[{"$ref":"#/components/parameters/apiKey"}]},"/individuals":{"get":{"description":"Retrieve a list of individuals\n","parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/dateOfBirth"},{"$ref":"#/components/parameters/placeOfBirth"}],"responses":{"200":{"description":"A list of individuals was retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/individual"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of individuals","tags":["Individuals"]},"post":{"description":"Create an individual\n","parameters":[{"$ref":"#/components/parameters/apiKey"}],"requestBody":{"$ref":"#/components/requestBodies/individual"},"responses":{"201":{"description":"Individual was created","headers":{"Location":{"description":"A [Location](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30) header pointing to the location of the new resource.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/individual"}}}},"400":{"$ref":"#/components/responses/InvalidArgument"},"401":{"$ref":"#/components/responses/Unauthenticated"}},"summary":"Create an individual","tags":["Individuals"]}},"/individuals/{partyId}":{"delete":{"description":"Delete an individual with the specified identifier\n","responses":{"204":{"description":"Individual was deleted"},"400":{"$ref":"#/components/responses/FailedPrecondition"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Delete an individual","tags":["Individuals"]},"get":{"description":"Retrieve an individual with the specified identifier\n","responses":{"200":{"description":"Individual was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/individual"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve an individual","tags":["Individuals"]},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/partyId"}],"put":{"description":"Update an individual\n","requestBody":{"$ref":"#/components/requestBodies/individual"},"responses":{"200":{"description":"Individual was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/individual"}}}},"400":{"$ref":"#/components/responses/InvalidArgument"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Update an individual","tags":["Individuals"]}},"/individuals/{partyId}/addresses":{"get":{"responses":{"200":{"description":"Addresses were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/address"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of addresses","tags":["Individuals Addresses"]},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/partyId"}],"post":{"description":"Create an address\n","requestBody":{"$ref":"#/components/requestBodies/address"},"responses":{"201":{"description":"Address was created","headers":{"Location":{"description":"A [Location](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30) header pointing to the location of the new resource.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/address"}}}},"400":{"$ref":"#/components/responses/InvalidArgument"},"401":{"$ref":"#/components/responses/Unauthenticated"}},"summary":"Create an address","tags":["Individuals Addresses"]}},"/individuals/{partyId}/addresses/{addressId}":{"delete":{"description":"Delete an address\n","responses":{"204":{"description":"Address was deleted"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Delete an address","tags":["Individuals Addresses"]},"get":{"description":"Retrieve an address\n","responses":{"200":{"description":"Address was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/address"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve an address","tags":["Individuals Addresses"]},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/partyId"},{"$ref":"#/components/parameters/addressId"}],"put":{"description":"Update an address\n","requestBody":{"$ref":"#/components/requestBodies/address"},"responses":{"200":{"description":"Address was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/address"}}}},"400":{"$ref":"#/components/responses/InvalidArgument"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Update an address","tags":["Individuals Addresses"]}},"/individuals/{partyId}/business-names":{"get":{"responses":{"200":{"description":"Business Names were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/business-name"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of business names","tags":["Individuals Business Names"]},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/partyId"}],"post":{"description":"Create a business name\n","requestBody":{"$ref":"#/components/requestBodies/business-name"},"responses":{"201":{"description":"Business Name was created","headers":{"Location":{"description":"A [Location](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30) header pointing to the location of the new resource.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/business-name"}}}},"400":{"$ref":"#/components/responses/InvalidArgument"},"401":{"$ref":"#/components/responses/Unauthenticated"}},"summary":"Create a business name","tags":["Individuals Business Names"]}},"/individuals/{partyId}/business-names/{productId}":{"delete":{"description":"Delete a business name\n","responses":{"204":{"description":"Address was deleted"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Delete a business name","tags":["Individuals Business Names"]},"get":{"description":"Retrieve a business name\n","responses":{"200":{"description":"Business Name was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/business-name"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a business name","tags":["Individuals Business Names"]},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/partyId"},{"$ref":"#/components/parameters/productId"}],"put":{"description":"Update a business name\n","requestBody":{"$ref":"#/components/requestBodies/business-name"},"responses":{"200":{"description":"Address was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/business-name"}}}},"400":{"$ref":"#/components/responses/InvalidArgument"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Update a business name","tags":["Individuals Business Names"]}},"/individuals/{partyId}/electronic-addresses":{"get":{"responses":{"200":{"description":"Electronic addresses were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/electronic-address"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of electronic addresses","tags":["Individuals Electronic Addresses"]},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/partyId"}],"post":{"description":"Create an electronic address\n","requestBody":{"$ref":"#/components/requestBodies/electronic-address"},"responses":{"201":{"description":"Electronic Address was created","headers":{"Location":{"description":"A [Location](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30) header pointing to the location of the new resource.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/electronic-address"}}}},"400":{"$ref":"#/components/responses/InvalidArgument"},"401":{"$ref":"#/components/responses/Unauthenticated"}},"summary":"Create an electronic address","tags":["Individuals Electronic Addresses"]}},"/individuals/{partyId}/electronic-addresses/{addressId}":{"delete":{"description":"Delete an electronic address\n","responses":{"204":{"description":"Electronic Address was deleted"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Delete an electronic address","tags":["Individuals Electronic Addresses"]},"get":{"description":"Retrieve an electronic address\n","responses":{"200":{"description":"Electronic Address was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/electronic-address"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve an electronic address","tags":["Individuals Electronic Addresses"]},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/partyId"},{"$ref":"#/components/parameters/addressId"}],"put":{"description":"Update an electronic address\n","requestBody":{"$ref":"#/components/requestBodies/electronic-address"},"responses":{"200":{"description":"Electronic Address was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/electronic-address"}}}},"400":{"$ref":"#/components/responses/InvalidArgument"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Update an electronic address","tags":["Individuals Electronic Addresses"]}},"/individuals/{partyId}/licenses":{"get":{"responses":{"200":{"description":"Licenses were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/license"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of licenses","tags":["Individuals Licenses"]},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/partyId"}],"post":{"description":"Create a license\n","requestBody":{"$ref":"#/components/requestBodies/license"},"responses":{"201":{"description":"License was created","headers":{"Location":{"description":"A [Location](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30) header pointing to the location of the new resource.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/license"}}}},"400":{"$ref":"#/components/responses/InvalidArgument"},"401":{"$ref":"#/components/responses/Unauthenticated"}},"summary":"Create a license","tags":["Individuals Licenses"]}},"/individuals/{partyId}/licenses/{productId}":{"delete":{"description":"Delete a license\n","responses":{"204":{"description":"License was deleted"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Delete a license","tags":["Individuals Licenses"]},"get":{"description":"Retrieve a license\n","responses":{"200":{"description":"License was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/license"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a license","tags":["Individuals Licenses"]},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/partyId"},{"$ref":"#/components/parameters/productId"}],"put":{"description":"Update a license\n","requestBody":{"$ref":"#/components/requestBodies/license"},"responses":{"200":{"description":"License was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/license"}}}},"400":{"$ref":"#/components/responses/InvalidArgument"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Update a license","tags":["Individuals Licenses"]}},"/individuals/{partyId}/roles":{"get":{"responses":{"200":{"description":"Roles were retrieved successfully","headers":{"Link":{"description":"Information about pagination is provided in the [Link](https://tools.ietf.org/html/rfc5988#page-6) header.\nFor example:\n\n Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel=\"next\",\n <https://api.abr.ato.gov.au/individuals?page=34>; rel=\"last\"\n\n`rel=\"next\"` states that the next page is `page=2`. This makes sense, since by default, all paginated queries start at page `1`. `rel=\"last\"` provides some more information, stating that the last page of results is on `page 34`. Accordingly, we have 33 more pages of information that we can consume.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/party-role"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a list of roles","tags":["Individuals Roles"]},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/partyId"}],"post":{"description":"Create a role\n","requestBody":{"$ref":"#/components/requestBodies/party-role"},"responses":{"201":{"description":"Role was created","headers":{"Location":{"description":"A [Location](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30) header pointing to the location of the new resource.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/party-role"}}}},"400":{"$ref":"#/components/responses/InvalidArgument"},"401":{"$ref":"#/components/responses/Unauthenticated"}},"summary":"Create a role","tags":["Individuals Roles"]}},"/individuals/{partyId}/roles/{roleId}":{"delete":{"description":"Delete a role\n","responses":{"204":{"description":"Role was deleted"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Delete a role","tags":["Individuals Roles"]},"get":{"description":"Retrieve a role\n","responses":{"200":{"description":"Role was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/party-role"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a role","tags":["Individuals Roles"]},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/partyId"},{"$ref":"#/components/parameters/roleId"}],"put":{"description":"Update a role\n","requestBody":{"$ref":"#/components/requestBodies/party-role"},"responses":{"200":{"description":"Role was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/party-role"}}}},"400":{"$ref":"#/components/responses/InvalidArgument"},"401":{"$ref":