Distribution API (1.0.0)

Download OpenAPI specification:

An example of a multi-file OpenAPI definition.

distribution

getDistributions

Create Distribution of profile

Responses

createDistribution

Create Distribution for profile

Responses

accreditation

accreditationCreate

Initialize accreditation request in escrow account

query Parameters

user_id required	any user id
profile_id required	any profile id

Responses

accreditationUpdate

Start accreditation process

query Parameters

profile_id

required

any

profile id

Responses

accreditationUploadDocument

Send accreditation document for verification

query Parameters

user_id required	any user id
profile_id required	any profile id

Responses

accreditationManual

Manually update user accreditation status. Use only in case of emergency

query Parameters

user_id required	any user id
profile_id required	any profile id

Responses

accreditationSync

Synchronize accreditation status with accreditation partner

query Parameters

user_id required	any user id
profile_id required	any profile id

Responses

accreditationUpdateStatus

Handle accreditation provider status change webhook

query Parameters

api_key

required

any

request api key

Responses

escrow

escrowCreate

Create escrow account in escrow partner

query Parameters

user_id required	any user id
profile_id required	any profile id

Responses

offeringCreate

Create offer in escrow provider

query Parameters

user_id required	any user id
offer_id required	any profile id

Responses

issuer

issuerCreate

Create issuer in escrow provider

query Parameters

user_id required	any user id
profile_id required	any profile id

Responses

Esignature

documentCreate

Create esignature document for investment. In order to display iframe signature form, use entity_id from response together with iframe and docuseal document path

Request Body schema: application/json
required

The request body for embedding an esign link

investment_id

required

integer <int64> >= 1

The unique identifier for the investment.

Responses

Request samples

Payload

Content type

application/json

{"investment_id": 45921
}

AuthCryptoWallet

exchangeToken

Exchange tokens

query Parameters

wallet_id	integer <int64>
amount	number <double>
from	string
to	string

Responses

walletInfo

Get Wallet Information

query Parameters

ProfileID	integer <int64>
TokenAddress	string

Responses

withdrawalToken

Withdraw token from a wallet

query Parameters

wallet_id	integer <int64>
to	string
token	string
amount	number <double>

Responses

InternalCryptoWallet

deployContract

Deploy smart contract

query Parameters

offer_id

integer <int64>

Responses

transferTokens

Exchange tokens

query Parameters

investment_id

integer <int64>

Responses

createWallet

Create Wallet

query Parameters

object_id	integer <int64>
type	string

Responses

auth

delete file by ID

path Parameters

id

required

any

File ID

header Parameters

Authorization

required

any

IdentityID

Responses

get file by ID

path Parameters

id

required

any

File ID

query Parameters

size

any

Size

header Parameters

Authorization

required

any

IdentityID

Responses

returns url for file downloading

path Parameters

id

required

any

File ID

header Parameters

Authorization

required

any

IdentityID

Responses

returns url for file uploading

header Parameters

Authorization

required

any

IdentityID

Responses

returns metadata by object ID and object Name

path Parameters

object_path

required

any

Object Name

header Parameters

Authorization

required

any

IdentityID

Responses

returns user's files

header Parameters

Authorization

required

any

IdentityID

Responses

internal

delete file by ID

path Parameters

id

required

any

File ID

Responses

get file by ID

path Parameters

id

required

any

File ID

query Parameters

size

any

Size

Responses

returns url for file downloading

path Parameters

id

required

any

File ID

query Parameters

size

any

Size

Responses

returns url for file uploading

Responses

returns metadata by object ID and object Name

path Parameters

object_path

required

any

Object Name

Responses

public

get file by ID

path Parameters

id

required

any

File ID

query Parameters

size

any

Size

Responses

returns metadata by object ID and object Name

path Parameters

object_path

required

any

Object Name

Responses

kyc

Create a link for the KYC verification process

Responses

Manually update KYC

Responses

Sync KYC status with kyc-provider

Responses

other

Get all notifications

Responses

mark notification as read

Responses

mark all notification as read

Responses

funding

AccountLink

Connect bank account

query Parameters

user_id required	any user id
profile_id required	any profile id

Responses

LinkInvestment

Link investment with escrow provider

query Parameters

investment_id

required

any

investment id

Responses

FundingTransfer

Transfer funding from linked bank account to escrow account

query Parameters

investment_id

required

any

investment id

Responses

FundingUpdate

Update funding transfer status

query Parameters

investment_id

required

any

investment id

Responses

account

AccountSync

Check if account created in escrow but not in our system

query Parameters

user_id required	any user id
profile_id required	any profile id

Responses

queue

Process an event and send it to the queue

path Parameters

service required	any Service Name
topic required	any Topic Name

Responses

bankAccount

bankAccountDelete

Delete connected bank account

query Parameters

ProfileID

required

any

Example: ProfileID=3

header Parameters

Authorization required	any Example: f8a61466-8964-4ade-8ca5-fa452bceba3f
XRequestID required	any Example: 0191701c-da51-749a-a4fc-e96579ebc043

Responses

bankAccountExchangeToken

Exchange token between dwolla and plaid to get access_token

query Parameters

ProfileID

required

any

Example: ProfileID=3

header Parameters

Authorization required	any Example: f8a61466-8964-4ade-8ca5-fa452bceba3f
XRequestID required	any Example: 0191701c-da51-749a-a4fc-e96579ebc043

Responses

bankAccountCreateLink

Generate public token from plaid to get a list of bank accounts

query Parameters

ProfileID

required

any

Example: ProfileID=3

header Parameters

Authorization required	any Example: f8a61466-8964-4ade-8ca5-fa452bceba3f
XRequestID required	any Example: 0191701c-da51-749a-a4fc-e96579ebc043

Responses

bankAccountProcessToken

Connect bank account using access token

query Parameters

ProfileID

required

any

Example: ProfileID=3

header Parameters

Authorization required	any Example: f8a61466-8964-4ade-8ca5-fa452bceba3f
XRequestID required	any Example: 0191701c-da51-749a-a4fc-e96579ebc043

Responses

wallet

getWalletDetail

Get Wallet Info

query Parameters

ProfileID

required

any

Example: ProfileID=3

header Parameters

Authorization required	any Example: f8a61466-8964-4ade-8ca5-fa452bceba3f
XRequestID required	any Example: 0191701c-da51-749a-a4fc-e96579ebc043

Responses

getTransactionList

Get Transaction list

query Parameters

WalletID

any

Example: WalletID=3

header Parameters

Authorization required	any Example: f8a61466-8964-4ade-8ca5-fa452bceba3f
XRequestID required	any Example: 0191701c-da51-749a-a4fc-e96579ebc043

Responses

createPendingTransaction

Create Pending Transaction

query Parameters

type required	any Example: type=3
amount required	any Example: amount=12.2
funding_source_id required	any Example: funding_source_id=3
WalletID required	any Example: WalletID=3

header Parameters

Authorization required	any Example: f8a61466-8964-4ade-8ca5-fa452bceba3f
XRequestID required	any Example: 0191701c-da51-749a-a4fc-e96579ebc043

Responses

adminWallet

internalSyncTransaction

Sync transaction status with dwolla

query Parameters

TransID

required

any

Example: TransID=1

Responses

internalReCreateWallet

Create wallet in dwolla if it does not exist

query Parameters

WalletID

required

any

Example: WalletID=3

Responses

internalWalletSync

Sync wallet status with dwolla

query Parameters

WalletID

required

any

Example: WalletID=3

Responses

webhook

Sync transaction status with dwolla

webhookSetTransactionErrorStatus

Update Transaction Failed Status

webhookProcessTransaction

Update Transaction Status

query Parameters

amount required	any Example: amount=12.2
funding_source_id required	any Example: funding_source_id=3

header Parameters

XRequestID

any

Example: 0191701c-da51-749a-a4fc-e96579ebc043

webhookUpdateWalletStatus

Update Wallet Status

transfer

webhookSetTransactionErrorStatus

Update Transaction Failed Status

webhookProcessTransaction

Update Transaction Status

query Parameters

amount required	any Example: amount=12.2
funding_source_id required	any Example: funding_source_id=3

header Parameters

XRequestID

any

Example: 0191701c-da51-749a-a4fc-e96579ebc043

webhookUpdateWalletStatus

Update Wallet Status

Distribution API (1.0.0)

distribution

getDistributions

Responses

createDistribution

Responses

accreditation

accreditationCreate

query Parameters

Responses

accreditationUpdate

query Parameters

Responses

accreditationUploadDocument

query Parameters

Responses

accreditationManual

query Parameters

Responses

accreditationSync

query Parameters

Responses

accreditationUpdateStatus

query Parameters

Responses

escrow

escrowCreate

query Parameters

Responses

offeringCreate

query Parameters

Responses

issuer

issuerCreate

query Parameters

Responses

Esignature

documentCreate

Request Body schema: application/jsonrequired

Responses

Request samples

AuthCryptoWallet

exchangeToken

query Parameters

Responses

walletInfo

query Parameters

Responses

withdrawalToken

query Parameters

Responses

InternalCryptoWallet

deployContract

query Parameters

Responses

transferTokens

query Parameters

Responses

createWallet

query Parameters

Responses

auth

delete file by ID

path Parameters

header Parameters

Responses

get file by ID

path Parameters

query Parameters

header Parameters

Responses

returns url for file downloading

path Parameters

header Parameters

Responses

returns url for file uploading

header Parameters

Responses

returns metadata by object ID and object Name

path Parameters

Request Body schema: application/json
required