Offering Manager API documentation

17 days ago

Modified: GET /projects/{project_id}/snapshots
- 200 response was modified
  - total_amount body attribute was added
Modified: GET /projects/{project_id}/snapshots/{id}
- 200 response was modified
  - total_amount body attribute was added

Mar 23, 2022

Modified: GET /projects/{id}/stats
- status query parameter was added

Mar 14, 2022

Modified: PATCH /users/{user_id}/kyc/identities/{id}
- body was modified
  - mifid_status body attribute was added
Modified: POST /users/{user_id}/kyc/identities
- body was modified
  - mifid_status body attribute was added

Mar 14, 2022

Added: GET /payouts/{payout_id}/user_payouts
Added: GET /payouts/{payout_id}/user_payouts/{id}
Added: GET /projects/{project_id}/payouts
Added: GET /projects/{project_id}/payouts/{id}
Added: GET /projects/{project_id}/snapshots
Added: GET /projects/{project_id}/snapshots/{id}
Added: GET /users/{user_id}/surveys
Modified: GET /users
- 200 response was modified
  - identities body attribute was modified
Modified: GET /users/projects/{project_id}/by_order_status/{status}
- 200 response was modified
  - identities body attribute was modified
Modified: GET /users/{id}
- 200 response was modified
  - identities body attribute was modified
Modified: GET /users/{user_id}/custody_account_holders
- 200 response was modified
  - kyc_data body attribute was modified
Modified: GET /users/{user_id}/custody_account_holders/{id}
- 200 response was modified
  - kyc_data body attribute was modified
Modified: GET /users/{user_id}/kyc/business_owners
- 200 response was modified
  - mifid_status body attribute was added
Modified: GET /users/{user_id}/kyc/business_owners/{id}
- 200 response was modified
  - mifid_status body attribute was added
Modified: GET /users/{user_id}/kyc/identities
- 200 response was modified
  - mifid_status body attribute was added
Modified: GET /users/{user_id}/kyc/identities/{id}
- 200 response was modified
  - mifid_status body attribute was added
Modified: GET /users/{user_id}/kyc/legal_representatives
- 200 response was modified
  - mifid_status body attribute was added
Modified: GET /users/{user_id}/kyc/legal_representatives/{id}
- 200 response was modified
  - mifid_status body attribute was added
Modified: PATCH /users/{user_id}/kyc/business_owners/{id}
- 201 response was modified
  - mifid_status body attribute was added
Modified: PATCH /users/{user_id}/kyc/identities/{id}
- 201 response was modified
  - mifid_status body attribute was added
Modified: PATCH /users/{user_id}/kyc/legal_representatives/{id}
- 201 response was modified
  - mifid_status body attribute was added
Modified: POST /users
- 201 response was modified
  - identities body attribute was modified
Modified: POST /users/{user_id}/custody_account_holders
- 201 response was modified
  - kyc_data body attribute was modified
Modified: POST /users/{user_id}/kyc/business_owners
- 201 response was modified
  - mifid_status body attribute was added
Modified: POST /users/{user_id}/kyc/identities
- 201 response was modified
  - mifid_status body attribute was added
Modified: POST /users/{user_id}/kyc/legal_representatives
- 201 response was modified
  - mifid_status body attribute was added
Modified: PUT /users/{id}
- 201 response was modified
  - identities body attribute was modified
Removed: GET /payouts
Removed: GET /users/{user_id}/surveys?name=${name}

Mar 2, 2022

Added: GET /orders

Mar 1, 2022

Modified: GET /users/{user_id}/projects/{project_id}/orders
- status, distributable, updated_at query parameters were added
- 200 response was modified
  - discount_code, discounted, discount body attributes were removed
    Breaking
Modified: GET /users/{user_id}/projects/{project_id}/orders/{id}
- 200 response was modified
  - discount_code, discounted, discount body attributes were removed
    Breaking
Modified: POST /users/{user_id}/projects/{project_id}/orders
- body was modified
  - order body attribute was modified
- 201 response was modified
  - discount_code, discounted, discount body attributes were removed
    Breaking
Modified: POST /users/{user_id}/projects/{project_id}/orders/{id}/cancel
- 201 response was modified
  - discount_code, discounted, discount body attributes were removed
    Breaking
Removed: GET /orders
Removed: POST /users/{user_id}/discount_codes/check

Feb 8, 2022

Added: GET /payouts

Dec 15, 2021

Modified: GET /users
- 200 response was modified
  - identities body attribute was added
Modified: GET /users/projects/{id}/by_order_status/{status}
- 200 response was modified
  - identities body attribute was added
Modified: GET /users/{id}
- 200 response was modified
  - identities body attribute was added
Modified: POST /users
- 201 response was modified
  - identities body attribute was added
Modified: PUT /users/{id}
- 201 response was modified
  - identities body attribute was added

Dec 9, 2021

Modified: GET /projects
- 200 response was modified
  - maturity_days, maturity_years body attributes were removed
    Breaking
Modified: GET /projects/by_code/{code}
- 200 response was modified
  - maturity_days, maturity_years body attributes were removed
    Breaking
Modified: GET /projects/{id}
- 200 response was modified
  - maturity_days, maturity_years body attributes were removed
    Breaking
Modified: GET /users
- 200 response was modified
  - name, phone_number body attributes were removed
    Breaking
Modified: GET /users/projects/{id}/by_order_status/{status}
- 200 response was modified
  - name, phone_number body attributes were removed
    Breaking
Modified: GET /users/{id}
- 200 response was modified
  - name, phone_number body attributes were removed
    Breaking
Modified: GET /users/{user_id}/custody_account_holders
- 200 response was modified
  - kyc_data body attribute was modified
Modified: GET /users/{user_id}/custody_account_holders/{id}
- 200 response was modified
  - kyc_data body attribute was modified
Modified: GET /users/{user_id}/kyc/business_owners
- 200 response was modified
  - phone_number body attribute was added
Modified: GET /users/{user_id}/kyc/business_owners/{id}
- 200 response was modified
  - phone_number body attribute was added
Modified: GET /users/{user_id}/kyc/identities
- 200 response was modified
  - phone_number body attribute was added
Modified: GET /users/{user_id}/kyc/identities/{id}
- 200 response was modified
  - phone_number body attribute was added
Modified: GET /users/{user_id}/kyc/legal_representatives
- 200 response was modified
  - phone_number body attribute was added
Modified: GET /users/{user_id}/kyc/legal_representatives/{id}
- 200 response was modified
  - phone_number body attribute was added
Modified: GET /users/{user_id}/projects
- 200 response was modified
  - maturity_days, maturity_years body attributes were removed
    Breaking
Modified: PATCH /users/{user_id}/kyc/business_owners/{id}
- 201 response was modified
  - phone_number body attribute was added
Modified: PATCH /users/{user_id}/kyc/identities/{id}
- body was modified
  - phone_number body attribute was added
- 201 response was modified
  - phone_number body attribute was added
Modified: PATCH /users/{user_id}/kyc/legal_representatives/{id}
- 201 response was modified
  - phone_number body attribute was added
Modified: POST /projects
- body was modified
  - project body attribute was modified
- 201 response was modified
  - maturity_days, maturity_years body attributes were removed
    Breaking
Modified: POST /users
- body was modified
  - name, phone_number body attributes were removed
    Breaking
- 201 response was modified
  - name, phone_number body attributes were removed
    Breaking
Modified: POST /users/{user_id}/custody_account_holders
- 201 response was modified
  - kyc_data body attribute was modified
Modified: POST /users/{user_id}/kyc/business_owners
- 201 response was modified
  - phone_number body attribute was added
Modified: POST /users/{user_id}/kyc/identities
- body was modified
  - phone_number body attribute was added
- 201 response was modified
  - phone_number body attribute was added
Modified: POST /users/{user_id}/kyc/legal_representatives
- 201 response was modified
  - phone_number body attribute was added
Modified: PUT /projects/{id}
- body was modified
  - project body attribute was modified
- 201 response was modified
  - maturity_days, maturity_years body attributes were removed
    Breaking
Modified: PUT /users/{id}
- body was modified
  - name, phone_number body attributes were removed
    Breaking
- 201 response was modified
  - name, phone_number body attributes were removed
    Breaking

Dec 3, 2021

Modified: GET /orders
- 200 response was modified
  - external_metadata body attribute was added
Modified: GET /users/{user_id}/projects/{project_id}/orders
- 200 response was modified
  - external_metadata body attribute was added
Modified: GET /users/{user_id}/projects/{project_id}/orders/{id}
- 200 response was modified
  - external_metadata body attribute was added
Modified: POST /users/{user_id}/projects/{project_id}/orders
- body was modified
  - order body attribute was modified
- 201 response was modified
  - external_metadata body attribute was added
Modified: POST /users/{user_id}/projects/{project_id}/orders/{id}/cancel
- 201 response was modified
  - external_metadata body attribute was added

Dec 3, 2021

Modified: GET /custody_assets
- 200 response was modified
  - partner_id body attribute was removed
    Breaking
Modified: GET /users
- 200 response was modified
  - signed_up_as, referral_channel body attributes were removed
    Breaking
Modified: GET /users/projects/{id}/by_order_status/{status}
- 200 response was modified
  - signed_up_as, referral_channel body attributes were removed
    Breaking
Modified: GET /users/{id}
- 200 response was modified
  - signed_up_as, referral_channel body attributes were removed
    Breaking
Modified: GET /users/{user_id}/custody_account_holders
- 200 response was modified
  - partner_id body attribute was removed
    Breaking
  - accounts body attribute was modified
Modified: GET /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts
- 200 response was modified
  - asset body attribute was modified
Modified: GET /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts/{id}
- 200 response was modified
  - asset body attribute was modified
Modified: GET /users/{user_id}/custody_account_holders/{id}
- 200 response was modified
  - partner_id body attribute was removed
    Breaking
  - accounts body attribute was modified
Modified: POST /users
- body was modified
  - signed_up_as, invitation_code, referral_channel, partner_attributes body attributes were removed
    Breaking
- 201 response was modified
  - signed_up_as, referral_channel body attributes were removed
    Breaking
Modified: POST /users/{user_id}/custody_account_holders
- 201 response was modified
  - partner_id body attribute was removed
    Breaking
  - accounts body attribute was modified
Modified: POST /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts
- 201 response was modified
  - asset body attribute was modified
Modified: PUT /users/{id}
- body was modified
  - signed_up_as, invitation_code, referral_channel, partner_attributes body attributes were removed
    Breaking
- 201 response was modified
  - signed_up_as, referral_channel body attributes were removed
    Breaking
Removed: GET /users/{user_id}/affiliate

Nov 29, 2021

Modified: GET /projects
- 200 response was modified
  - transferability body attribute was added
  - volume_limit body attribute was removed
    Breaking
Modified: GET /projects/by_code/{code}
- 200 response was modified
  - transferability body attribute was added
  - volume_limit body attribute was removed
    Breaking
Modified: GET /projects/{id}
- 200 response was modified
  - transferability body attribute was added
  - volume_limit body attribute was removed
    Breaking
Modified: GET /users/{user_id}/projects
- 200 response was modified
  - transferability body attribute was added
  - volume_limit body attribute was removed
    Breaking
Modified: POST /projects
- body was modified
  - project body attribute was modified
- 201 response was modified
  - transferability body attribute was added
  - volume_limit body attribute was removed
    Breaking
Modified: PUT /projects/{id}
- body was modified
  - project body attribute was modified
- 201 response was modified
  - transferability body attribute was added
  - volume_limit body attribute was removed
    Breaking

Nov 8, 2021

Modified: GET /projects
- 200 response was modified
  - asset_description body attribute was added
Modified: GET /projects/by_code/{code}
- 200 response was modified
  - asset_description body attribute was added
Modified: GET /projects/{id}
- 200 response was modified
  - asset_description body attribute was added
Modified: GET /users/{user_id}/projects
- 200 response was modified
  - asset_description body attribute was added
Modified: POST /projects
- 201 response was modified
  - asset_description body attribute was added
Modified: PUT /projects/{id}
- 201 response was modified
  - asset_description body attribute was added

Nov 5, 2021

Modified: GET /projects
- 200 response was modified
  - free_float_bps, number_of_tokens, minimum_subscription_bps, token_price, currency body attributes were added
Modified: GET /projects/by_code/{code}
- 200 response was modified
  - free_float_bps, number_of_tokens, minimum_subscription_bps, token_price, currency body attributes were added
Modified: GET /projects/{id}
- 200 response was modified
  - free_float_bps, number_of_tokens, minimum_subscription_bps, token_price, currency body attributes were added
Modified: GET /users/{user_id}/projects
- 200 response was modified
  - free_float_bps, number_of_tokens, minimum_subscription_bps, token_price, currency body attributes were added
Modified: POST /projects
- body was modified
  - project body attribute was modified
- 201 response was modified
  - free_float_bps, number_of_tokens, minimum_subscription_bps, token_price, currency body attributes were added
Modified: PUT /projects/{id}
- body was modified
  - project body attribute was modified
- 201 response was modified
  - free_float_bps, number_of_tokens, minimum_subscription_bps, token_price, currency body attributes were added

Oct 15, 2021

Modified: GET /orders
- 200 response was modified
  - payment_details body attribute was modified
Modified: GET /projects
- 200 response was modified
  - account_name, iban, bic body attributes were added
  - beneficiary_name, bvdh_iban, bvdh_bic body attributes were removed
    Breaking
Modified: GET /projects/by_code/{code}
- 200 response was modified
  - account_name, iban, bic body attributes were added
  - beneficiary_name, bvdh_iban, bvdh_bic body attributes were removed
    Breaking
Modified: GET /projects/{id}
- 200 response was modified
  - account_name, iban, bic body attributes were added
  - beneficiary_name, bvdh_iban, bvdh_bic body attributes were removed
    Breaking
Modified: GET /users/{user_id}/projects
- 200 response was modified
  - account_name, iban, bic body attributes were added
  - beneficiary_name, bvdh_iban, bvdh_bic body attributes were removed
    Breaking
Modified: GET /users/{user_id}/projects/{project_id}/orders
- 200 response was modified
  - payment_details body attribute was modified
Modified: GET /users/{user_id}/projects/{project_id}/orders/{id}
- 200 response was modified
  - payment_details body attribute was modified
Modified: POST /projects
- body was modified
  - project body attribute was modified
- 201 response was modified
  - account_name, iban, bic body attributes were added
  - beneficiary_name, bvdh_iban, bvdh_bic body attributes were removed
    Breaking
Modified: POST /users/{user_id}/projects/{project_id}/orders
- 201 response was modified
  - payment_details body attribute was modified
Modified: POST /users/{user_id}/projects/{project_id}/orders/{id}/cancel
- 201 response was modified
  - payment_details body attribute was modified
Modified: PUT /projects/{id}
- body was modified
  - project body attribute was modified
- 201 response was modified
  - account_name, iban, bic body attributes were added
  - beneficiary_name, bvdh_iban, bvdh_bic body attributes were removed
    Breaking

Oct 4, 2021

Added: GET /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts/{custody_account_id}/{id}

May 12, 2021

Modified: GET /users/projects/{id}/by_order_status/{status}
- status path parameter was added
- status query parameter was removed
  Breaking

May 12, 2021

Added: GET /users/projects/{id}/by_order_status/{status}
Modified: GET /investments
- 200 response was modified
  - order_status body attribute was added
Modified: GET /orders
- 200 response was modified
  - project_code body attribute was added
Modified: GET /users/{user_id}/affiliate
- 200 response was modified
  - stats body attribute was modified
Modified: GET /users/{user_id}/projects/{project_id}/investments
- 200 response was modified
  - order_status body attribute was added
Modified: GET /users/{user_id}/projects/{project_id}/investments/{id}
- 200 response was modified
  - order_status body attribute was added
Modified: GET /users/{user_id}/projects/{project_id}/orders
- 200 response was modified
  - project_code body attribute was added
Modified: GET /users/{user_id}/projects/{project_id}/orders/{id}
- 200 response was modified
  - project_code body attribute was added
Modified: POST /users/{user_id}/projects/{project_id}/orders
- 201 response was modified
  - project_code body attribute was added
Modified: POST /users/{user_id}/projects/{project_id}/orders/{id}/cancel
- 201 response was modified
  - project_code body attribute was added

May 4, 2021

Modified: GET /orders
- 200 response was modified
  - updated_at body attribute was added
Modified: GET /users/{user_id}/projects/{project_id}/orders
- 200 response was modified
  - updated_at body attribute was added
Modified: GET /users/{user_id}/projects/{project_id}/orders/{id}
- 200 response was modified
  - updated_at body attribute was added
Modified: POST /users/{user_id}/projects/{project_id}/orders
- 201 response was modified
  - updated_at body attribute was added
Modified: POST /users/{user_id}/projects/{project_id}/orders/{id}/cancel
- 201 response was modified
  - updated_at body attribute was added

May 4, 2021

Added: GET /orders

Offering Manager API changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed