Businesses API
Businesses API
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |
Search businesses
Search and return a paginated list of businesses
Create business
Create a business object in the storage and return the id of the created object. If the configuration is enabled for KYC a KYC process will be started.
Get business by id
Get a business from the storage and return the object.
Update business
Update a business object in the storage. If the configuration is enabled and a KYB process is needed then it will be started.
Delete Business
Remove a business object in the storage.
Get business documents
Get all the documents of a business
Create business document
Add a document for a business
Get business document
Get a specific document of a business
Update business document
Update a document for a business
Delete business document
Remove a business document from the storage.
Get business metadatas
Get all the metadata of a business
Create Business metadata
Add a metadata for a Business
Get business metadata
Get a specific metadata of a business
Update Business metadata
Update a metadata for a Business
Delete Business metadata
Remove a Business metadata from the storage.
Get business beneficial owners
Get all the beneficial owners of a business
Create Business beneficial owner
Add a beneficial owner for a Business
Get business beneficial owner
Get a specific beneficial owner of a business
Update Business beneficial owner
Update a beneficial owner for a Business
Delete Business beneficial owner
Remove a Business beneficial owner from the storage.
Get business stores
Get all the stores of a business
Create business store
Add a store for a business
Get business store
Get a specific store of a business
Update business store
Update a store for a business
Delete business store
Remove a business store from the storage
Update business store cover image
Update a cover image for a store
Update business store logo image
Update a logo image for a store