Download OpenAPI specification:
Our platform is is the central hub for managing the full lifecycle of tokenized assets - from creation and compliance to distribution and analytics. Our API will help you:
To make it easier to determine if your application is being rate-limited, or is approaching that level, we have the following HTTP headers on our successful responses:
X-RateLimit-Reset: The remaining window before the rate limit resets in UTC epoch seconds.X-RateLimit-Remaining: The number of requests left for the time window.X-RateLimit-Limit: Request limit per time window.The current limits are 100 API calls per 15 seconds.
We reserve the right to tune the limitations, but we promise to keep them high enough to allow a well-behaving interactive app to do it's job.
When you exceed the limit you will receive a HTTP 429 (Too Many Requests).
We don't usually have any trouble on our end, but when we do we'll let you know!
The Platform API uses the following error codes:
| Code | Text | Description |
|---|---|---|
400 |
Bad Request |
Your request may be malformed |
401 |
Unauthorized |
Your API key is wrong, or your user does not have access to this resource |
403 |
Forbidden |
The record requested is hidden for administrators only |
404 |
Not Found |
The specified record could not be found |
405 |
Method Not Allowed |
You tried to access a record with an invalid method |
406 |
Not Acceptable |
You requested a format that isn't JSON |
410 |
Gone |
The record requested has been removed from our servers |
422 |
Unprocessable Entity |
The requested method cannot process for the record in question |
429 |
Too Many Requests |
You're requesting too many records! Slow down! |
500 |
Internal Server Error |
We had a problem with our server. Try again later. |
502 |
Bad Gateway |
We had a different problem with our server. Try again later. |
503 |
Service Unavailable |
We're temporarily offline for maintenance, or you've exceeded the rate limit. Please try again later. |
504 |
Gateway Timeout |
Yep, you guessed it. We'll be back soon! |
Note that when API errors occur, it is up to you to retry your request - Platform does not keep track of failed calls.
Create a log and store it in timeline storage
| time | string <date-time> |
| message | string |
| severity | string |
| error | string |
| component | string |
Array of objects | |
object | |
Array of objects | |
object (ServiceContext) |
{- "time": "2019-08-24T14:15:22Z",
- "message": "string",
- "severity": "string",
- "error": "string",
- "component": "string",
- "caller": [
- {
- "property1": null,
- "property2": null
}
], - "data": {
- "property1": null,
- "property2": null
}, - "stack": [
- {
- "property1": null,
- "property2": null
}
], - "serviceContext": {
- "service_name": "string",
- "version": "string",
- "httpRequest": {
- "property1": null,
- "property2": null
}, - "sourceReference": {
- "property1": null,
- "property2": null
}, - "user": "string",
- "request_id": "string"
}
}{- "id": "string"
}Create a PageView log and store it in timeline storage
| time | string <date-time> |
| message | string |
| severity | string |
| error | string |
| component | string |
Array of objects | |
object | |
Array of objects | |
object (ServiceContext) |
{- "time": "2019-08-24T14:15:22Z",
- "message": "string",
- "severity": "string",
- "error": "string",
- "component": "string",
- "caller": [
- {
- "property1": null,
- "property2": null
}
], - "data": {
- "property1": null,
- "property2": null
}, - "stack": [
- {
- "property1": null,
- "property2": null
}
], - "serviceContext": {
- "service_name": "string",
- "version": "string",
- "httpRequest": {
- "property1": null,
- "property2": null
}, - "sourceReference": {
- "property1": null,
- "property2": null
}, - "user": "string",
- "request_id": "string"
}
}{- "id": "string"
}Create an investor’s initial commitment to an offering.
Workflow overview:
1. Validate investor eligibility (KYC/AML).
2. Verify offering availability and minimum investment amount.
3. Record the commitment, status, and allocation.
4. Return the created investment record with its unique identifier.
| offer_slug required | string |
| profile_id required | string |
| id | integer |
object (Offer) | |
| profile_id | integer |
| user_id | integer |
| price_per_share | number |
| number_of_shares | integer |
| amount | number |
| step | string |
| status | string |
| created_at | string |
| submited_at | string |
| funding_type | string |
| funding_status | string |
object | |
object | |
object (PaymentData) | |
| payment_type | string |
| escrow_type | string |
| entity_id | string |
| transaction_ref | string |
{- "id": 0,
- "offer": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string"
}
}, - "profile_id": 0,
- "user_id": 0,
- "price_per_share": 0,
- "number_of_shares": 0,
- "amount": 0,
- "step": "string",
- "status": "string",
- "created_at": "string",
- "submited_at": "string",
- "funding_type": "string",
- "funding_status": "string",
- "signature_data": {
- "property1": null,
- "property2": null
}, - "escrow_data": {
- "property1": null,
- "property2": null
}, - "payment_data": {
- "created_at": "string",
- "account_type": "string",
- "account_holder_name": "string",
- "funding_source_id": 0,
- "transaction_id": "string"
}, - "payment_type": "string",
- "escrow_type": "string",
- "entity_id": "string",
- "transaction_ref": "string"
}{- "id": 0,
- "offer": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string"
}
}, - "profile_id": 0,
- "user_id": 0,
- "price_per_share": 0,
- "number_of_shares": 0,
- "amount": 0,
- "step": "string",
- "status": "string",
- "created_at": "string",
- "submited_at": "string",
- "funding_type": "string",
- "funding_status": "string",
- "signature_data": {
- "property1": null,
- "property2": null
}, - "escrow_data": {
- "property1": null,
- "property2": null
}, - "payment_data": {
- "created_at": "string",
- "account_type": "string",
- "account_holder_name": "string",
- "funding_source_id": 0,
- "transaction_id": "string"
}, - "payment_type": "string",
- "escrow_type": "string",
- "entity_id": "string",
- "transaction_ref": "string"
}Set up investment amount
| offer_slug required | string |
| id required | string |
| profile_id required | string |
| number_of_shares required | integer |
{- "number_of_shares": 0
}{- "number_of_shares": 0
}Set up Ownership information
| offer_slug required | string |
| id required | string |
| profile_id required | string |
| first_name required | string >= 2 characters |
| last_name required | string >= 2 characters |
| dob required | string <date> |
| middle_name | string >= 2 characters |
| phone required | string >= 9 characters |
| ssn required | string = 9 characters |
| address1 required | string >= 4 characters |
| address2 | string >= 3 characters |
| citizenship required | string >= 3 characters |
| city required | string >= 2 characters |
| state required | string >= 2 characters |
| zip_code required | string >= 5 characters |
| country required | string >= 2 characters |
{- "first_name": "string",
- "last_name": "string",
- "dob": "2019-08-24",
- "middle_name": "string",
- "phone": "stringstr",
- "ssn": "stringstr",
- "address1": "string",
- "address2": "string",
- "citizenship": "string",
- "city": "string",
- "state": "string",
- "zip_code": "string",
- "country": "string"
}{- "first_name": "string",
- "last_name": "string",
- "dob": "2019-08-24",
- "middle_name": "string",
- "phone": "stringstr",
- "ssn": "stringstr",
- "address1": "string",
- "address2": "string",
- "citizenship": "string",
- "city": "string",
- "state": "string",
- "zip_code": "string",
- "country": "string"
}Create electronical signature document with legal binding
| offer_slug required | string |
| id required | string |
| profile_id required | string |
| signature_id required | string >= 2 characters |
| user_browser | string |
| ip_address | string |
{- "signature_id": "string",
- "user_browser": "string",
- "ip_address": "string"
}{- "signature_id": "string",
- "user_browser": "string",
- "ip_address": "string"
}Funding step
| offer_slug required | string |
| id required | string |
| profile_id required | string |
| funding_type required | string |
| funding_source_id | integer |
object |
{- "funding_type": "string",
- "funding_source_id": 0,
- "payment_data": {
- "property1": null,
- "property2": null
}
}{- "funding_type": "string",
- "funding_source_id": 0,
- "payment_data": {
- "property1": null,
- "property2": null
}
}Investment Confirmation Step
| offer_slug required | string |
| id required | string |
| profile_id required | string |
{ }{ }Get list of user confirmed investments
| profile_id required | string |
| id | integer |
object (Offer) | |
| profile_id | integer |
| user_id | integer |
| price_per_share | number |
| number_of_shares | integer |
| amount | number |
| step | string |
| status | string |
| created_at | string |
| submited_at | string |
| funding_type | string |
| funding_status | string |
object | |
object | |
object (PaymentData) | |
| payment_type | string |
| escrow_type | string |
| entity_id | string |
| transaction_ref | string |
{- "id": 0,
- "offer": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string"
}
}, - "profile_id": 0,
- "user_id": 0,
- "price_per_share": 0,
- "number_of_shares": 0,
- "amount": 0,
- "step": "string",
- "status": "string",
- "created_at": "string",
- "submited_at": "string",
- "funding_type": "string",
- "funding_status": "string",
- "signature_data": {
- "property1": null,
- "property2": null
}, - "escrow_data": {
- "property1": null,
- "property2": null
}, - "payment_data": {
- "created_at": "string",
- "account_type": "string",
- "account_holder_name": "string",
- "funding_source_id": 0,
- "transaction_id": "string"
}, - "payment_type": "string",
- "escrow_type": "string",
- "entity_id": "string",
- "transaction_ref": "string"
}{- "id": 0,
- "offer": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string"
}
}, - "profile_id": 0,
- "user_id": 0,
- "price_per_share": 0,
- "number_of_shares": 0,
- "amount": 0,
- "step": "string",
- "status": "string",
- "created_at": "string",
- "submited_at": "string",
- "funding_type": "string",
- "funding_status": "string",
- "signature_data": {
- "property1": null,
- "property2": null
}, - "escrow_data": {
- "property1": null,
- "property2": null
}, - "payment_data": {
- "created_at": "string",
- "account_type": "string",
- "account_holder_name": "string",
- "funding_source_id": 0,
- "transaction_id": "string"
}, - "payment_type": "string",
- "escrow_type": "string",
- "entity_id": "string",
- "transaction_ref": "string"
}Get list of user unconfirmed investments
| id | integer |
object (Offer) | |
| profile_id | integer |
| user_id | integer |
| price_per_share | number |
| number_of_shares | integer |
| amount | number |
| step | string |
| status | string |
| created_at | string |
| submited_at | string |
| funding_type | string |
| funding_status | string |
object | |
object | |
object (PaymentData) | |
| payment_type | string |
| escrow_type | string |
| entity_id | string |
| transaction_ref | string |
{- "id": 0,
- "offer": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string"
}
}, - "profile_id": 0,
- "user_id": 0,
- "price_per_share": 0,
- "number_of_shares": 0,
- "amount": 0,
- "step": "string",
- "status": "string",
- "created_at": "string",
- "submited_at": "string",
- "funding_type": "string",
- "funding_status": "string",
- "signature_data": {
- "property1": null,
- "property2": null
}, - "escrow_data": {
- "property1": null,
- "property2": null
}, - "payment_data": {
- "created_at": "string",
- "account_type": "string",
- "account_holder_name": "string",
- "funding_source_id": 0,
- "transaction_id": "string"
}, - "payment_type": "string",
- "escrow_type": "string",
- "entity_id": "string",
- "transaction_ref": "string"
}{- "id": 0,
- "offer": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string"
}
}, - "profile_id": 0,
- "user_id": 0,
- "price_per_share": 0,
- "number_of_shares": 0,
- "amount": 0,
- "step": "string",
- "status": "string",
- "created_at": "string",
- "submited_at": "string",
- "funding_type": "string",
- "funding_status": "string",
- "signature_data": {
- "property1": null,
- "property2": null
}, - "escrow_data": {
- "property1": null,
- "property2": null
}, - "payment_data": {
- "created_at": "string",
- "account_type": "string",
- "account_holder_name": "string",
- "funding_source_id": 0,
- "transaction_id": "string"
}, - "payment_type": "string",
- "escrow_type": "string",
- "entity_id": "string",
- "transaction_ref": "string"
}List of user bank accounts
| id | integer |
object (Offer) | |
| profile_id | integer |
| number_of_shares | integer |
| amount | number |
| step | string |
| payment_type | string |
| escrow_type | string |
| funding_type | string |
| funding_status | string |
object | |
| status | string |
| updated_at | string |
| submited_at | string |
object |
{- "id": 0,
- "offer": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string"
}
}, - "profile_id": 0,
- "number_of_shares": 0,
- "amount": 0,
- "step": "string",
- "payment_type": "string",
- "escrow_type": "string",
- "funding_type": "string",
- "funding_status": "string",
- "escrow_data": {
- "property1": null,
- "property2": null
}, - "status": "string",
- "updated_at": "string",
- "submited_at": "string",
- "signature_data": {
- "property1": null,
- "property2": null
}
}{- "id": 0,
- "offer": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string"
}
}, - "profile_id": 0,
- "number_of_shares": 0,
- "amount": 0,
- "step": "string",
- "payment_type": "string",
- "escrow_type": "string",
- "funding_type": "string",
- "funding_status": "string",
- "escrow_data": {
- "property1": null,
- "property2": null
}, - "status": "string",
- "updated_at": "string",
- "submited_at": "string",
- "signature_data": {
- "property1": null,
- "property2": null
}
}Get user investment by id
| id required | string |
| id | integer |
object (Offer) | |
| profile_id | integer |
| user_id | integer |
| price_per_share | number |
| number_of_shares | integer |
| amount | number |
| step | string |
| status | string |
| created_at | string |
| submited_at | string |
| funding_type | string |
| funding_status | string |
object | |
object | |
object (PaymentData) | |
| payment_type | string |
| escrow_type | string |
| entity_id | string |
| transaction_ref | string |
{- "id": 0,
- "offer": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string"
}
}, - "profile_id": 0,
- "user_id": 0,
- "price_per_share": 0,
- "number_of_shares": 0,
- "amount": 0,
- "step": "string",
- "status": "string",
- "created_at": "string",
- "submited_at": "string",
- "funding_type": "string",
- "funding_status": "string",
- "signature_data": {
- "property1": null,
- "property2": null
}, - "escrow_data": {
- "property1": null,
- "property2": null
}, - "payment_data": {
- "created_at": "string",
- "account_type": "string",
- "account_holder_name": "string",
- "funding_source_id": 0,
- "transaction_id": "string"
}, - "payment_type": "string",
- "escrow_type": "string",
- "entity_id": "string",
- "transaction_ref": "string"
}{- "id": 0,
- "offer": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string"
}
}, - "profile_id": 0,
- "user_id": 0,
- "price_per_share": 0,
- "number_of_shares": 0,
- "amount": 0,
- "step": "string",
- "status": "string",
- "created_at": "string",
- "submited_at": "string",
- "funding_type": "string",
- "funding_status": "string",
- "signature_data": {
- "property1": null,
- "property2": null
}, - "escrow_data": {
- "property1": null,
- "property2": null
}, - "payment_data": {
- "created_at": "string",
- "account_type": "string",
- "account_holder_name": "string",
- "funding_source_id": 0,
- "transaction_id": "string"
}, - "payment_type": "string",
- "escrow_type": "string",
- "entity_id": "string",
- "transaction_ref": "string"
}Cancel user investment by id
| id required | string |
| cancelation_reason required | string >= 4 characters |
{- "cancelation_reason": "string"
}{- "cancelation_reason": "string"
}Get investment by id without authorization and status check
| id required | any |
| id | integer |
object (Offer) | |
| profile_id | integer |
| user_id | integer |
| price_per_share | number |
| number_of_shares | integer |
| amount | number |
| step | string |
| status | string |
| created_at | string |
| submited_at | string |
| funding_type | string |
| funding_status | string |
object | |
object | |
object (PaymentData) | |
| payment_type | string |
| escrow_type | string |
| entity_id | string |
| transaction_ref | string |
{- "id": 0,
- "offer": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string"
}
}, - "profile_id": 0,
- "user_id": 0,
- "price_per_share": 0,
- "number_of_shares": 0,
- "amount": 0,
- "step": "string",
- "status": "string",
- "created_at": "string",
- "submited_at": "string",
- "funding_type": "string",
- "funding_status": "string",
- "signature_data": {
- "property1": null,
- "property2": null
}, - "escrow_data": {
- "property1": null,
- "property2": null
}, - "payment_data": {
- "created_at": "string",
- "account_type": "string",
- "account_holder_name": "string",
- "funding_source_id": 0,
- "transaction_id": "string"
}, - "payment_type": "string",
- "escrow_type": "string",
- "entity_id": "string",
- "transaction_ref": "string"
}{- "id": 0,
- "offer": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string"
}
}, - "profile_id": 0,
- "user_id": 0,
- "price_per_share": 0,
- "number_of_shares": 0,
- "amount": 0,
- "step": "string",
- "status": "string",
- "created_at": "string",
- "submited_at": "string",
- "funding_type": "string",
- "funding_status": "string",
- "signature_data": {
- "property1": null,
- "property2": null
}, - "escrow_data": {
- "property1": null,
- "property2": null
}, - "payment_data": {
- "created_at": "string",
- "account_type": "string",
- "account_holder_name": "string",
- "funding_source_id": 0,
- "transaction_id": "string"
}, - "payment_type": "string",
- "escrow_type": "string",
- "entity_id": "string",
- "transaction_ref": "string"
}List of public offers
| id | integer |
| name | string |
| legal_name | string |
| slug | string |
| title | string |
| security_type | string |
| price_per_share | number |
| min_investment | number |
| image_link_id | integer |
| total_shares | integer |
| valuation | number |
| subscribed_shares | integer |
| confirmed_shares | integer |
| status | string |
| approved_at | string |
| website | string |
| state | string |
| city | string |
object | |
| close_at | string <date-time> |
| seo_title | string |
| seo_description | string |
{- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "security_info": {
- "property1": null,
- "property2": null
}, - "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string"
}{- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "security_info": {
- "property1": null,
- "property2": null
}, - "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string"
}Get detail information about the offer
| slug required | string |
| id | integer |
| name | string |
| legal_name | string |
| slug | string |
| title | string |
| security_type | string |
| price_per_share | number |
| min_investment | number |
| image_link_id | integer |
| total_shares | integer |
| valuation | number |
| subscribed_shares | integer |
| confirmed_shares | integer |
| status | string |
| approved_at | string |
| website | string |
| state | string |
| city | string |
object | |
| close_at | string <date-time> |
| seo_title | string |
| seo_description | string |
| description | string |
| highlights | string |
| additional_details | string |
object (OfferOfferData) | |
string | |
string | |
string | |
| github | string |
string | |
| telegram | string |
| mastodon | string |
{- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "security_info": {
- "property1": null,
- "property2": null
}, - "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "description": "string",
- "highlights": "string",
- "additional_details": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string",
- "video": "string",
- "apy": "string",
- "distribution_frequency": "string",
- "property_type": "string",
- "investment_strategy": "string",
- "estimated_hold_period": "string"
}, - "linkedin": "string",
- "facebook": "string",
- "twitter": "string",
- "github": "string",
- "instagram": "string",
- "telegram": "string",
- "mastodon": "string"
}{- "id": 0,
- "name": "string",
- "legal_name": "string",
- "slug": "string",
- "title": "string",
- "security_type": "string",
- "price_per_share": 0,
- "min_investment": 0,
- "image_link_id": 0,
- "total_shares": 0,
- "valuation": 0,
- "subscribed_shares": 0,
- "confirmed_shares": 0,
- "status": "string",
- "approved_at": "string",
- "website": "string",
- "state": "string",
- "city": "string",
- "security_info": {
- "property1": null,
- "property2": null
}, - "close_at": "2019-08-24T14:15:22Z",
- "seo_title": "string",
- "seo_description": "string",
- "description": "string",
- "highlights": "string",
- "additional_details": "string",
- "data": {
- "wire_to": "string",
- "swift_id": "string",
- "custodian": "string",
- "account_number": "string",
- "routing_number": "string",
- "video": "string",
- "apy": "string",
- "distribution_frequency": "string",
- "property_type": "string",
- "investment_strategy": "string",
- "estimated_hold_period": "string"
}, - "linkedin": "string",
- "facebook": "string",
- "twitter": "string",
- "github": "string",
- "instagram": "string",
- "telegram": "string",
- "mastodon": "string"
}Get a list of published comments for the offer
| id required | string |
| created_at | string <date-time> |
| comment | string |
| related | string |
object (Author) |
{- "created_at": "2019-08-24T14:15:22Z",
- "comment": "string",
- "related": "string",
- "user": {
- "first_name": "string",
- "last_name": "string"
}
}{- "created_at": "2019-08-24T14:15:22Z",
- "comment": "string",
- "related": "string",
- "user": {
- "first_name": "string",
- "last_name": "string"
}
}Post question/answer for the offer
| comment required | string >= 10 characters |
| related | string Enum: "none" "adviser" "employee" "affiliated" "investor" |
| offer_id required | integer [ 0 .. 2147483647 ] |
{- "comment": "stringstri",
- "related": "none",
- "offer_id": 2147483647
}{- "comment": "stringstri",
- "related": "none",
- "offer_id": 2147483647
}Update offer information
| id required | string |
| image_link_id required | integer or null [ 0 .. 2147483647 ] |
{- "image_link_id": 2147483647
}{- "image_link_id": 2147483647
}{- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "citizenship": "U.S. Citizen",
- "dob": "2019-08-24",
- "phone": "stringstr",
- "ssn": "stringstr",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "state": "AL",
- "zip_code": "string",
- "country": "AF",
- "employment": {
- "type": "Employed (full-time)",
- "employer_name": "string",
- "title": "string",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "zip_code": "string"
}, - "finra_affiliated": {
- "member_association": true,
- "correspondence": true,
- "member_firm_name": "string",
- "compliance_contact_name": "string",
- "compliance_contant_email": "string"
}, - "ten_percent_shareholder": {
- "shareholder_association": true,
- "ticker_symbol_list": "string"
}, - "irs_backup_withholding": true,
- "educational_materials": true,
- "cancelation_restrictions": true,
- "resell_difficulties": true,
- "risk_involved": true,
- "no_legal_advices_from_company": true,
- "beneficiary": {
- "email": "string",
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "citizenship": "U.S. Citizen",
- "dob": "2019-08-24",
- "phone": "stringstr",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "zip_code": "string",
- "state": "AL",
- "country": "AF",
- "relationship_type": "string",
- "ssn": "stringstr"
}, - "limitation_rule": true,
- "limitation_rule_confirmation": true,
- "annual_income": 0,
- "net_worth": 0,
- "invested_external": 0,
- "reg_cf": {
- "limitation_rule": true,
- "limitation_rule_confirmation": true,
- "annual_income": 0,
- "net_worth": 0,
- "invested_external": 0
}, - "investment_objectives": {
- "objectives": "growth",
- "years_experience": 100,
- "duration": "1 to 3 years",
- "importance_of_access": "Very Important",
- "risk_comfort": "low risk"
}, - "accredited_investor": {
- "is_accredited": true,
- "explanation": "string"
}
}Update profile information
| type required | any |
| id required | any |
{- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "citizenship": "U.S. Citizen",
- "dob": "2019-08-24",
- "phone": "stringstr",
- "ssn": "stringstr",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "state": "AL",
- "zip_code": "string",
- "country": "AF",
- "employment": {
- "type": "Employed (full-time)",
- "employer_name": "string",
- "title": "string",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "zip_code": "string"
}, - "finra_affiliated": {
- "member_association": true,
- "correspondence": true,
- "member_firm_name": "string",
- "compliance_contact_name": "string",
- "compliance_contant_email": "string"
}, - "ten_percent_shareholder": {
- "shareholder_association": true,
- "ticker_symbol_list": "string"
}, - "irs_backup_withholding": true,
- "educational_materials": true,
- "cancelation_restrictions": true,
- "resell_difficulties": true,
- "risk_involved": true,
- "no_legal_advices_from_company": true,
- "beneficiary": {
- "email": "string",
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "citizenship": "U.S. Citizen",
- "dob": "2019-08-24",
- "phone": "stringstr",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "zip_code": "string",
- "state": "AL",
- "country": "AF",
- "relationship_type": "string",
- "ssn": "stringstr"
}, - "limitation_rule": true,
- "limitation_rule_confirmation": true,
- "annual_income": 0,
- "net_worth": 0,
- "invested_external": 0,
- "reg_cf": {
- "limitation_rule": true,
- "limitation_rule_confirmation": true,
- "annual_income": 0,
- "net_worth": 0,
- "invested_external": 0
}, - "investment_objectives": {
- "objectives": "growth",
- "years_experience": 100,
- "duration": "1 to 3 years",
- "importance_of_access": "Very Important",
- "risk_comfort": "low risk"
}, - "accredited_investor": {
- "is_accredited": true,
- "explanation": "string"
}
}Retrieve profile information
| type required | any |
| id required | any |
{- "id": 0,
- "first_name": "string",
- "last_name": "string",
- "phone": "stringstr",
- "image_link_id": 2147483647,
- "created_at": "string",
- "updated_at": "string"
}Exchange token between dwolla and plaid to get access_token
| ProfileID required | any Example: ProfileID=3 |
| Authorization required | any Example: f8a61466-8964-4ade-8ca5-fa452bceba3f |
| XRequestID required | any Example: 0191701c-da51-749a-a4fc-e96579ebc043 |
Generate public token from plaid to get a list of bank accounts
| ProfileID required | any Example: ProfileID=3 |
| Authorization required | any Example: f8a61466-8964-4ade-8ca5-fa452bceba3f |
| XRequestID required | any Example: 0191701c-da51-749a-a4fc-e96579ebc043 |
Create Pending Transaction
| 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 |
| Authorization required | any Example: f8a61466-8964-4ade-8ca5-fa452bceba3f |
| XRequestID required | any Example: 0191701c-da51-749a-a4fc-e96579ebc043 |