# Introduction The Business Registries API is built on HTTP. The API is RESTful. It has predictable resource URIs. The API is documented in OpenAPI format. In addition to the standard OpenAPI syntax we use a few vendor extensions. # Overview The following sections describe the resources that
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
# Introduction The Business Registries API is built on HTTP. The API is RESTful. It has predictable resource URIs. The API is documented in OpenAPI format. In addition to the standard OpenAPI syntax we use a few vendor extensions. # Overview The following sections describe the resources that make up the Business Registries REST API. ## Current Version By default, all requests to...
| method | path | what the vendor says it does |
|---|---|---|
GET | /business-names | Retrieve a list of business names Retrieve a list of business names Business Names |
GET | /classifications/address-types | Retrieve a list of address types Address Types |
GET | /classifications/business-name-lifecycle-states | Retrieve a list of business name lifecycle states Business Name Lifecycle States |
GET | /classifications/electronic-address-types | Retrieve a list of electronic address types Electronic Address Types |
GET | /classifications/genders | Retrieve a list of genders Genders |
GET | /classifications/legal-entity-types | Retrieve a list of legal entity types Legal Entity Types |
GET | /classifications/license-lifecycle-states | Retrieve a list of license lifecycle states License Lifecycle States |
GET | /classifications/license-types | Retrieve a list of license types License Types |
GET | /classifications/name-directions | Retrieve a list of name directions Name Directions |
GET | /classifications/name-prefixes | Retrieve a list of name prefixes Name Prefixes |
GET | /classifications/name-types | Retrieve a list of name types Name Types |
GET | /classifications/registered-identifier-types | Retrieve a list of registered identifier types Registered Identifier Types |
GET | /classifications/roles | Retrieve a list of roles Roles |
GET | /individuals | Retrieve a list of individuals Retrieve a list of individuals Individuals |
POST | /individuals | Create an individual Create an individual Individuals |
GET | /individuals/{partyId} | Retrieve an individual Retrieve an individual with the specified identifier Individuals |
PUT | /individuals/{partyId} | Update an individual Update an individual Individuals |
DELETE | /individuals/{partyId} | Delete an individual Delete an individual with the specified identifier Individuals |
GET | /individuals/{partyId}/addresses | Retrieve a list of addresses Individuals Addresses |
POST | /individuals/{partyId}/addresses | Create an address Create an address Individuals Addresses |
GET | /individuals/{partyId}/addresses/{addressId} | Retrieve an address Retrieve an address Individuals Addresses |
PUT | /individuals/{partyId}/addresses/{addressId} | Update an address Update an address Individuals Addresses |
DELETE | /individuals/{partyId}/addresses/{addressId} | Delete an address Delete an address Individuals Addresses |
GET | /individuals/{partyId}/business-names | Retrieve a list of business names Individuals Business Names |
POST | /individuals/{partyId}/business-names | Create a business name Create a business name Individuals Business Names |
GET | /individuals/{partyId}/business-names/{productId} | Retrieve a business name Retrieve a business name Individuals Business Names |
PUT | /individuals/{partyId}/business-names/{productId} | Update a business name Update a business name Individuals Business Names |
DELETE | /individuals/{partyId}/business-names/{productId} | Delete a business name Delete a business name Individuals Business Names |
GET | /individuals/{partyId}/electronic-addresses | Retrieve a list of electronic addresses Individuals Electronic Addresses |
POST | /individuals/{partyId}/electronic-addresses | Create an electronic address Create an electronic address Individuals Electronic Addresses |
GET | /individuals/{partyId}/electronic-addresses/{addressId} | Retrieve an electronic address Retrieve an electronic address Individuals Electronic Addresses |
PUT | /individuals/{partyId}/electronic-addresses/{addressId} | Update an electronic address Update an electronic address Individuals Electronic Addresses |
DELETE | /individuals/{partyId}/electronic-addresses/{addressId} | Delete an electronic address Delete an electronic address Individuals Electronic Addresses |
GET | /individuals/{partyId}/licenses | Retrieve a list of licenses Individuals Licenses |
POST | /individuals/{partyId}/licenses | Create a license Create a license Individuals Licenses |
GET | /individuals/{partyId}/licenses/{productId} | Retrieve a license Retrieve a license Individuals Licenses |
PUT | /individuals/{partyId}/licenses/{productId} | Update a license Update a license Individuals Licenses |
DELETE | /individuals/{partyId}/licenses/{productId} | Delete a license Delete a license Individuals Licenses |
GET | /individuals/{partyId}/roles | Retrieve a list of roles Individuals Roles |
POST | /individuals/{partyId}/roles | Create a role Create a role Individuals Roles |
and 34 more operation(s) in this specification, all searchable.
specification origin: https://ato-team.github.io/business-registries-rest-api-specification/swagger.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.