Offering Manager API
Show Menu
Search…
Ctrl+K
ESC
Example searches: “200”, “success”, “boolean”, “Create an address for a personal investor”, “city”
Toggle dark mode
API Changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Topics
Introduction
Endpoints
bank_accounts
Fetch the bank accounts of the current user
GET
Create bank account for the current user
POST
Update the bank account for the current user
PATCH
businesses
Fetch the businesses for the current user
GET
Create a business entry for the current user
POST
Update the business information
PATCH
business_owners
Fetch the business owners for the current business user
GET
Create a business owner for the current business user
POST
Fetch the business owner for the current business user based on the id
GET
Delete the business owner for the current business user
DELETE
Update the business owner for the current business user
PATCH
addresses
Create an address for a personal investor
POST
Update the address for a personal investor
PATCH
Fetch the address of the business
GET
Create an address entry for the business
POST
Update the address for the business
PATCH
Fetch the address of a personal investor
GET
config
Fetch the configuration data
GET
custody
Assets
GET
User account holders
GET
User account holder
POST
User account holder
GET
User accounts
GET
User account
POST
User account
GET
Account balance
GET
Account transactions
GET
Transaction
POST
Account transaction with specific ID
GET
Withdrawable balance
GET
Estimated fee
GET
Balances
GET
files
Add a file attachment to the identity
POST
Fetch the list of the identity file attachments
GET
Add file attachment to the current business
POST
Fetch the list of business file attachments
GET
Delete the file attachment a business
DELETE
identities
Fetch the personal identities associated with the current user
GET
Create a personal identity for the current user
POST
Fetch the personal identity for the current user based on the id
GET
Delete the personal identity for the current user
DELETE
Update the personal identity for the current user
PATCH
identity_documents
Fetch the identity document associated with the kyc verification
GET
Create an identity document for the kyc verification
POST
identity_terms
Fetch the identity terms associated with the identity
GET
Create an identity term for the identity
POST
kyc
Fetch the status of the KYC flow of a personal investor
GET
Start the IDnow video identification session
POST
Fetch the IDnow video identification session data
GET
GET /users/{user_id}/kyc/identities/{identity_id}/kyc_verification
GET
POST /users/{user_id}/kyc/identities/{identity_id}/kyc_verification
POST
legal_representatives
Fetch the legal representatives for a business user
GET
Create an legal representative for the current business user
POST
Fetch the legal representative for the current business user based on the id
GET
Delete the legal representative for the current business user
DELETE
Update the legal representative for the current business user
PATCH
orders
Returns the orders list with a certain status received after a timestamp
GET
Fetch the orders list of a project for the current user
GET
Create an order for a project for the current user
POST
Fetch an order's details
GET
Cancel an order for a project
POST
pep_status
Fetch the pep status associated with the identity
GET
Create a PEP status for the identity
POST
projects
Returns the projects list
GET
Create a project
POST
Fetch a project's details based on the id
GET
Update the project information based on id
PUT
Delete the project
DELETE
Fetch a project's details based on the project code
GET
Fetch a project's distribution list as a `text/csv; charset=utf-8` response
GET
Start a background process that prepares the project for distribution
POST
Fetch a project's prepare for distribution status based on the id
GET
Fetch a project's statistical information based on the id
GET
surveys
Fetch the surveys filled in by the current user
GET
Create a named survey for the current user
POST
users
Returns the user information based on the email address
GET
Create a user
POST
Delete all user's payments
DELETE
Returns the users that have orders with a certain status in a project
GET
Fetch the current user information
GET
Update the current user information
PUT
Delete a user based on id
DELETE
Fetch the list of projects the current user has payments
GET
payouts
Returns the payouts list
GET
Fetch a project payouts's details based on the id
GET
snapshots
Fetch a project's snapshots
GET
Fetch a project snapshot details based on the id
GET
user_payouts
Fetch all User Payouts for given Payout
GET
Fetch a User Payout details based on the id
GET
payments
Returns payments for specific project
GET
Fetch the payments list of a order for the current user and project
GET
Create an payment for an order
POST
Fetch the payments details of an order for the user and project
GET
Delete the payment of an order for the user and project
DELETE
investment_terms
Fetch the investment terms of a project for the current user
GET
Create investment terms for a project for the current user
POST
Dismiss highlight
Show more
orders