-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Emiliano Suñé <emiliano.sune@gmail.com>
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# OrgBook BC | ||
|
||
[OrgBook BC](https://orgbook.gov.bc.ca) is a public repository of credentials representing public information. The foundational credential for OrgBook is a company registration credential issued by [BC Registries](https://www.bcregistry.gov.bc.ca). Credentials are also issued for relevant events such as name changes, amalgamations, etc. | ||
|
||
Third party issuers can issue credentials such as licenses and permits to OrgBook and bind them to the relevant receiving entity for public discovery and consumption. | ||
|
||
## Accessing OrgBook Data | ||
|
||
There are two ways of accessing data stored in OrgBook: | ||
|
||
- The user interface allows the search and discovery of credentials from a web UI. This is useful for end-users trying to gather information about a known entity. | ||
- The [OrgBook API](https://orgbook.gov.bc.ca/api) | ||
|
||
The API is openly accessible (for reasonably/fair use) and allows systems to integrate with OrgBook to look-up company registration records and associated data. | ||
|
||
The swagger interface provides an easy way to discover the API endpoints, and there are [API docs](https://bcgov.github.io/orgbook-bc-api-docs) with code snippets providing examples for common use cases. | ||
|
||
## Becoming an Issuer | ||
|
||
If you have a good candidate for a credential to be publicly issued to an organization (such as a license or permit), you can become an issuer and integrate and push the information to OrgBook. | ||
|
||
The current version of OrgBook is in evolution, the best way to get the conversation started is by [contacting us](../about-us.md). |