Offering Manager API

Jan 23, 2023

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

Dec 12, 2022

Added: DELETE /users/{user_id}/projects/{project_id}/orders/{order_id}/payments/{id}
Added: GET /projects/{id}/distribution_list
Added: GET /projects/{id}/prepare_for_distribution_status
Added: POST /projects/{project_id}/prepare_for_distribution
Modified: GET /payments
- 200, 404 responses were added
Modified: GET /projects
- 200 response was modified
  - chain, description attributes were added
  - asset_description attribute was removed
    Breaking
Modified: GET /projects/by_code/{code}
- 200 response was modified
  - chain, description attributes were added
  - asset_description attribute was removed
    Breaking
Modified: GET /projects/{id}
- 200 response was modified
  - chain, description attributes were added
  - asset_description attribute was removed
    Breaking
Modified: GET /users/{user_id}/projects
- 200 response was modified
  - chain, description attributes were added
  - asset_description attribute was removed
    Breaking
Modified: POST /projects
- body was modified
  - project attribute was modified
- 201 response was modified
  - chain, description attributes were added
  - asset_description attribute was removed
    Breaking
Modified: PUT /projects/{id}
- body was modified
  - project attribute was modified
- 201 response was modified
  - chain, description attributes were added
  - asset_description attribute was removed
    Breaking

Oct 17, 2022

Modified: GET /payments
- project_id, user_id query parameters were added
- user_id, project_id path parameters were removed
  Breaking

Oct 13, 2022

Added: DELETE /users/{id}/destroy_payments
Added: GET /payments
Added: GET /users/{user_id}/kyc/identities/{identity_id}/kyc_verification/identity_document
Added: POST /users/{user_id}/kyc/identities/{identity_id}/kyc_verification/identity_document
Modified: POST /users/{user_id}/kyc/identities/{identity_id}/kyc_verification
- body was modified
  - date attribute was added
- 201 response was modified
  - date attribute was added

Oct 10, 2022

Added: GET /users/{user_id}/kyc/identities/{identity_id}/kyc_verification
Added: GET /users/{user_id}/kyc/identities/{identity_id}/pep_status
Added: POST /users/{user_id}/kyc/identities/{identity_id}/kyc_verification
Added: POST /users/{user_id}/kyc/identities/{identity_id}/pep_status
Modified: GET /users
- 200 response was modified
  - identities attribute was modified
Modified: GET /users/projects/{project_id}/by_order_status/{status}
- 200 response was modified
  - identities attribute was modified
Modified: GET /users/{id}
- 200 response was modified
  - identities attribute was modified
Modified: GET /users/{user_id}/custody_account_holders
- 200 response was modified
  - kyc_data attribute was modified
Modified: GET /users/{user_id}/custody_account_holders/{id}
- 200 response was modified
  - kyc_data attribute was modified
Modified: GET /users/{user_id}/kyc/business_owners
- 200 response was modified
  - not_pep attribute was removed
    Breaking
Modified: GET /users/{user_id}/kyc/business_owners/{id}
- 200 response was modified
  - not_pep attribute was removed
    Breaking
Modified: GET /users/{user_id}/kyc/identities
- 200 response was modified
  - not_pep attribute was removed
    Breaking
Modified: GET /users/{user_id}/kyc/identities/{id}
- 200 response was modified
  - not_pep attribute was removed
    Breaking
Modified: GET /users/{user_id}/kyc/legal_representatives
- 200 response was modified
  - not_pep attribute was removed
    Breaking
Modified: GET /users/{user_id}/kyc/legal_representatives/{id}
- 200 response was modified
  - not_pep attribute was removed
    Breaking
Modified: PATCH /users/{user_id}/kyc/business_owners/{id}
- body was modified
  - not_pep attribute was removed
    Breaking
- 201 response was modified
  - not_pep attribute was removed
    Breaking
Modified: PATCH /users/{user_id}/kyc/identities/{id}
- body was modified
  - not_pep attribute was removed
    Breaking
- 201 response was modified
  - not_pep attribute was removed
    Breaking
Modified: PATCH /users/{user_id}/kyc/legal_representatives/{id}
- body was modified
  - not_pep attribute was removed
    Breaking
- 201 response was modified
  - not_pep attribute was removed
    Breaking
Modified: POST /users
- 201 response was modified
  - identities attribute was modified
Modified: POST /users/{user_id}/custody_account_holders
- 201 response was modified
  - kyc_data attribute was modified
Modified: POST /users/{user_id}/kyc/business_owners
- body was modified
  - not_pep attribute was removed
    Breaking
- 201 response was modified
  - not_pep attribute was removed
    Breaking
Modified: POST /users/{user_id}/kyc/identities
- body was modified
  - not_pep attribute was removed
    Breaking
- 201 response was modified
  - not_pep attribute was removed
    Breaking
Modified: POST /users/{user_id}/kyc/legal_representatives
- body was modified
  - not_pep attribute was removed
    Breaking
- 201 response was modified
  - not_pep attribute was removed
    Breaking
Modified: PUT /users/{id}
- 201 response was modified
  - identities attribute was modified

Sep 16, 2022

Added: GET /users/{user_id}/projects/{project_id}/investment_terms
Added: GET /users/{user_id}/projects/{project_id}/orders/{order_id}/payments
Added: GET /users/{user_id}/projects/{project_id}/orders/{order_id}/payments/{id}
Added: POST /users/{user_id}/projects/{project_id}/investment_terms
Added: POST /users/{user_id}/projects/{project_id}/orders/{order_id}/payments
Modified: GET /custody_assets
- 200 response was modified
  - protocol attribute was removed
    Breaking
Modified: GET /orders
- 200 response was modified
  - investment_id attribute was removed
    Breaking
  - cancelled_at, sender_iban, disposable_capital, suitable_income, status attributes were modified
Modified: GET /projects
- 200 response was modified
  - number_of_tokens, token_price attributes were modified
    Breaking
Modified: GET /projects/by_code/{code}
- 200 response was modified
  - number_of_tokens, token_price attributes were modified
    Breaking
Modified: GET /projects/{id}
- 200 response was modified
  - number_of_tokens, token_price attributes were modified
    Breaking
Modified: GET /users/{user_id}/custody_account_holders
- 200 response was modified
  - accounts attribute was modified
Modified: GET /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts
- 200 response was modified
  - asset attribute was modified
Modified: GET /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts/{id}
- 200 response was modified
  - asset attribute was modified
Modified: GET /users/{user_id}/custody_account_holders/{id}
- 200 response was modified
  - accounts attribute was modified
Modified: GET /users/{user_id}/projects
- 200 response was modified
  - number_of_tokens, token_price attributes were modified
    Breaking
Modified: GET /users/{user_id}/projects/{project_id}/orders
- order_code query parameter was added
- 200 response was modified
  - investment_id attribute was removed
    Breaking
  - cancelled_at, sender_iban, disposable_capital, suitable_income, status attributes were modified
Modified: GET /users/{user_id}/projects/{project_id}/orders/{id}
- 200 response was modified
  - investment_id attribute was removed
    Breaking
  - cancelled_at, sender_iban, disposable_capital, suitable_income, status attributes were modified
Modified: POST /projects
- 201 response was modified
  - number_of_tokens, token_price attributes were modified
    Breaking
Modified: POST /users/{user_id}/custody_account_holders
- 201 response was modified
  - accounts attribute was modified
Modified: POST /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts
- 201 response was modified
  - asset attribute was modified
Modified: POST /users/{user_id}/projects/{project_id}/orders
- 201 response was modified
  - investment_id attribute was removed
    Breaking
  - cancelled_at, sender_iban, disposable_capital, suitable_income, status attributes were modified
Modified: POST /users/{user_id}/projects/{project_id}/orders/{id}/cancel
- 201 response was modified
  - investment_id attribute was removed
    Breaking
  - cancelled_at, sender_iban, disposable_capital, suitable_income, status attributes were modified
Modified: PUT /projects/{id}
- 201 response was modified
  - number_of_tokens, token_price attributes were modified
    Breaking
Removed: GET /investments
Breaking
Removed: GET /users/{user_id}/credits
Breaking
Removed: GET /users/{user_id}/credits/redeem/{project_id}
Breaking
Removed: GET /users/{user_id}/projects/{project_id}/investment_terms
Breaking
Removed: GET /users/{user_id}/projects/{project_id}/investments
Breaking
Removed: GET /users/{user_id}/projects/{project_id}/investments/{id}
Breaking
Removed: POST /users/{user_id}/projects/{project_id}/investment_terms
Breaking

May 4, 2022

Modified: GET /projects/{project_id}/snapshots
- 200 response was modified
  - total_amount attribute was added
Modified: GET /projects/{project_id}/snapshots/{id}
- 200 response was modified
  - total_amount 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 attribute was added
Modified: POST /users/{user_id}/kyc/identities
- body was modified
  - mifid_status 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 attribute was modified
Modified: GET /users/projects/{project_id}/by_order_status/{status}
- 200 response was modified
  - identities attribute was modified
Modified: GET /users/{id}
- 200 response was modified
  - identities attribute was modified
Modified: GET /users/{user_id}/custody_account_holders
- 200 response was modified
  - kyc_data attribute was modified
Modified: GET /users/{user_id}/custody_account_holders/{id}
- 200 response was modified
  - kyc_data attribute was modified
Modified: GET /users/{user_id}/kyc/business_owners
- 200 response was modified
  - mifid_status attribute was added
Modified: GET /users/{user_id}/kyc/business_owners/{id}
- 200 response was modified
  - mifid_status attribute was added
Modified: GET /users/{user_id}/kyc/identities
- 200 response was modified
  - mifid_status attribute was added
Modified: GET /users/{user_id}/kyc/identities/{id}
- 200 response was modified
  - mifid_status attribute was added
Modified: GET /users/{user_id}/kyc/legal_representatives
- 200 response was modified
  - mifid_status attribute was added
Modified: GET /users/{user_id}/kyc/legal_representatives/{id}
- 200 response was modified
  - mifid_status attribute was added
Modified: PATCH /users/{user_id}/kyc/business_owners/{id}
- 201 response was modified
  - mifid_status attribute was added
Modified: PATCH /users/{user_id}/kyc/identities/{id}
- 201 response was modified
  - mifid_status attribute was added
Modified: PATCH /users/{user_id}/kyc/legal_representatives/{id}
- 201 response was modified
  - mifid_status attribute was added
Modified: POST /users
- 201 response was modified
  - identities attribute was modified
Modified: POST /users/{user_id}/custody_account_holders
- 201 response was modified
  - kyc_data attribute was modified
Modified: POST /users/{user_id}/kyc/business_owners
- 201 response was modified
  - mifid_status attribute was added
Modified: POST /users/{user_id}/kyc/identities
- 201 response was modified
  - mifid_status attribute was added
Modified: POST /users/{user_id}/kyc/legal_representatives
- 201 response was modified
  - mifid_status attribute was added
Modified: PUT /users/{id}
- 201 response was modified
  - identities attribute was modified
Removed: GET /payouts
Breaking
Removed: GET /users/{user_id}/surveys?name=${name}
Breaking

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 attributes were removed
    Breaking
Modified: GET /users/{user_id}/projects/{project_id}/orders/{id}
- 200 response was modified
  - discount_code, discounted, discount attributes were removed
    Breaking
Modified: POST /users/{user_id}/projects/{project_id}/orders
- body was modified
  - order attribute was modified
- 201 response was modified
  - discount_code, discounted, discount attributes were removed
    Breaking
Modified: POST /users/{user_id}/projects/{project_id}/orders/{id}/cancel
- 201 response was modified
  - discount_code, discounted, discount attributes were removed
    Breaking
Removed: GET /orders
Breaking
Removed: POST /users/{user_id}/discount_codes/check
Breaking

Feb 8, 2022

Added: GET /payouts

Dec 15, 2021

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

Dec 9, 2021

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

Dec 3, 2021

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

Dec 3, 2021

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

Nov 29, 2021

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

Nov 8, 2021

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

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