Offering Manager API

Changelog

Last update:
Compare
1.3.4

API structure has changed

Modified 5
GET /orders
  • Response
  • 200 response Modified
    • wallet_address attribute Added
GET /users/{user_id}/projects/{project_id}/orders
  • Response
  • 200 response Modified
    • wallet_address attribute Added
GET /users/{user_id}/projects/{project_id}/orders/{id}
  • Response
  • 200 response Modified
    • wallet_address attribute Added
POST /users/{user_id}/projects/{project_id}/orders
  • Response
  • 201 response Modified
    • wallet_address attribute Added
POST /users/{user_id}/projects/{project_id}/orders/{id}/cancel
  • Response
  • 201 response Modified
    • wallet_address attribute Added
1.2.1

API structure has changed

Modified 7 Breaking
GET /payments
  • Response
  • 200, 404 responses Added
GET /projects
  • Response
  • 200 response Modified
    • asset_description attribute Removed
    • chain, description attributes Added
GET /projects/by_code/{code}
  • Response
  • 200 response Modified
    • asset_description attribute Removed
    • chain, description attributes Added
GET /projects/{id}
  • Response
  • 200 response Modified
    • asset_description attribute Removed
    • chain, description attributes Added
GET /users/{user_id}/projects
  • Response
  • 200 response Modified
    • asset_description attribute Removed
    • chain, description attributes Added
POST /projects
  • Body
  • content type Modified
    • project attribute Modified
  • Response
  • 201 response Modified
    • asset_description attribute Removed
    • chain, description attributes Added
PUT /projects/{id}
  • Body
  • content type Modified
    • project attribute Modified
  • Response
  • 201 response Modified
    • asset_description attribute Removed
    • chain, description attributes Added
Added 4
DELETE /users/{user_id}/projects/{project_id}/orders/{order_id}/payments/{id}
GET /projects/{id}/distribution_list
GET /projects/{id}/prepare_for_distribution_status
POST /projects/{project_id}/prepare_for_distribution

API structure has changed

Modified 1 Breaking
GET /payments
  • Path
  • user_id, project_id path parameters Removed
  • Query
  • project_id, user_id query parameters Added

API structure has changed

Modified 1
POST /users/{user_id}/kyc/identities/{identity_id}/kyc_verification
  • Body
  • content type Modified
    • date attribute Added
  • Response
  • 201 response Modified
    • date attribute Added
Added 4
DELETE /users/{id}/destroy_payments
GET /payments
GET /users/{user_id}/kyc/identities/{identity_id}/kyc_verification/identity_document
POST /users/{user_id}/kyc/identities/{identity_id}/kyc_verification/identity_document

API structure has changed

Modified 20 Breaking
GET /users
  • Response
  • 200 response Modified
    • identities attribute Modified
GET /users/projects/{project_id}/by_order_status/{status}
  • Response
  • 200 response Modified
    • identities attribute Modified
GET /users/{id}
  • Response
  • 200 response Modified
    • identities attribute Modified
GET /users/{user_id}/custody_account_holders
  • Response
  • 200 response Modified
    • kyc_data attribute Modified
GET /users/{user_id}/custody_account_holders/{id}
  • Response
  • 200 response Modified
    • kyc_data attribute Modified
GET /users/{user_id}/kyc/business_owners
  • Response
  • 200 response Modified
    • not_pep attribute Removed
GET /users/{user_id}/kyc/business_owners/{id}
  • Response
  • 200 response Modified
    • not_pep attribute Removed
GET /users/{user_id}/kyc/identities
  • Response
  • 200 response Modified
    • not_pep attribute Removed
GET /users/{user_id}/kyc/identities/{id}
  • Response
  • 200 response Modified
    • not_pep attribute Removed
GET /users/{user_id}/kyc/legal_representatives
  • Response
  • 200 response Modified
    • not_pep attribute Removed
GET /users/{user_id}/kyc/legal_representatives/{id}
  • Response
  • 200 response Modified
    • not_pep attribute Removed
PATCH /users/{user_id}/kyc/business_owners/{id}
  • Body
  • content type Modified
    • not_pep attribute Removed
  • Response
  • 201 response Modified
    • not_pep attribute Removed
PATCH /users/{user_id}/kyc/identities/{id}
  • Body
  • content type Modified
    • not_pep attribute Removed
  • Response
  • 201 response Modified
    • not_pep attribute Removed
PATCH /users/{user_id}/kyc/legal_representatives/{id}
  • Body
  • content type Modified
    • not_pep attribute Removed
  • Response
  • 201 response Modified
    • not_pep attribute Removed
POST /users
  • Response
  • 201 response Modified
    • identities attribute Modified
POST /users/{user_id}/custody_account_holders
  • Response
  • 201 response Modified
    • kyc_data attribute Modified
POST /users/{user_id}/kyc/business_owners
  • Body
  • content type Modified
    • not_pep attribute Removed
  • Response
  • 201 response Modified
    • not_pep attribute Removed
POST /users/{user_id}/kyc/identities
  • Body
  • content type Modified
    • not_pep attribute Removed
  • Response
  • 201 response Modified
    • not_pep attribute Removed
POST /users/{user_id}/kyc/legal_representatives
  • Body
  • content type Modified
    • not_pep attribute Removed
  • Response
  • 201 response Modified
    • not_pep attribute Removed
PUT /users/{id}
  • Response
  • 201 response Modified
    • identities attribute Modified
Added 4
GET /users/{user_id}/kyc/identities/{identity_id}/kyc_verification
GET /users/{user_id}/kyc/identities/{identity_id}/pep_status
POST /users/{user_id}/kyc/identities/{identity_id}/kyc_verification
POST /users/{user_id}/kyc/identities/{identity_id}/pep_status

API structure has changed

Modified 18 Breaking
GET /custody_assets
  • Response
  • 200 response Modified
    • protocol attribute Removed
GET /orders
  • Response
  • 200 response Modified
    • cancelled_at, sender_iban, disposable_capital, suitable_income, status attributes Modified
    • investment_id attribute Removed
GET /projects
  • Response
  • 200 response Modified
    • number_of_tokens, token_price attributes Modified
GET /projects/by_code/{code}
  • Response
  • 200 response Modified
    • number_of_tokens, token_price attributes Modified
GET /projects/{id}
  • Response
  • 200 response Modified
    • number_of_tokens, token_price attributes Modified
GET /users/{user_id}/custody_account_holders
  • Response
  • 200 response Modified
    • accounts attribute Modified
GET /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts
  • Response
  • 200 response Modified
    • asset attribute Modified
GET /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts/{id}
  • Response
  • 200 response Modified
    • asset attribute Modified
GET /users/{user_id}/custody_account_holders/{id}
  • Response
  • 200 response Modified
    • accounts attribute Modified
GET /users/{user_id}/projects
  • Response
  • 200 response Modified
    • number_of_tokens, token_price attributes Modified
GET /users/{user_id}/projects/{project_id}/orders
  • Response
  • 200 response Modified
    • cancelled_at, sender_iban, disposable_capital, suitable_income, status attributes Modified
    • investment_id attribute Removed
  • Query
  • order_code query parameter Added
GET /users/{user_id}/projects/{project_id}/orders/{id}
  • Response
  • 200 response Modified
    • cancelled_at, sender_iban, disposable_capital, suitable_income, status attributes Modified
    • investment_id attribute Removed
POST /projects
  • Response
  • 201 response Modified
    • number_of_tokens, token_price attributes Modified
POST /users/{user_id}/custody_account_holders
  • Response
  • 201 response Modified
    • accounts attribute Modified
POST /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts
  • Response
  • 201 response Modified
    • asset attribute Modified
POST /users/{user_id}/projects/{project_id}/orders
  • Response
  • 201 response Modified
    • cancelled_at, sender_iban, disposable_capital, suitable_income, status attributes Modified
    • investment_id attribute Removed
POST /users/{user_id}/projects/{project_id}/orders/{id}/cancel
  • Response
  • 201 response Modified
    • cancelled_at, sender_iban, disposable_capital, suitable_income, status attributes Modified
    • investment_id attribute Removed
PUT /projects/{id}
  • Response
  • 201 response Modified
    • number_of_tokens, token_price attributes Modified
Removed 7 Breaking
GET /investments
GET /users/{user_id}/credits
GET /users/{user_id}/credits/redeem/{project_id}
GET /users/{user_id}/projects/{project_id}/investment_terms
GET /users/{user_id}/projects/{project_id}/investments
GET /users/{user_id}/projects/{project_id}/investments/{id}
POST /users/{user_id}/projects/{project_id}/investment_terms
Added 5
GET /users/{user_id}/projects/{project_id}/investment_terms
GET /users/{user_id}/projects/{project_id}/orders/{order_id}/payments
GET /users/{user_id}/projects/{project_id}/orders/{order_id}/payments/{id}
POST /users/{user_id}/projects/{project_id}/investment_terms
POST /users/{user_id}/projects/{project_id}/orders/{order_id}/payments

API structure has changed

Modified 2
GET /projects/{project_id}/snapshots
  • Response
  • 200 response Modified
    • total_amount attribute Added
GET /projects/{project_id}/snapshots/{id}
  • Response
  • 200 response Modified
    • total_amount attribute Added

API structure has changed

Modified 1
GET /projects/{id}/stats
  • Query
  • status query parameter Added

API structure has changed

Modified 2
PATCH /users/{user_id}/kyc/identities/{id}
  • Body
  • content type Modified
    • mifid_status attribute Added
POST /users/{user_id}/kyc/identities
  • Body
  • content type Modified
    • mifid_status attribute Added

API structure has changed

Modified 20
GET /users
  • Response
  • 200 response Modified
    • identities attribute Modified
GET /users/projects/{project_id}/by_order_status/{status}
  • Response
  • 200 response Modified
    • identities attribute Modified
GET /users/{id}
  • Response
  • 200 response Modified
    • identities attribute Modified
GET /users/{user_id}/custody_account_holders
  • Response
  • 200 response Modified
    • kyc_data attribute Modified
GET /users/{user_id}/custody_account_holders/{id}
  • Response
  • 200 response Modified
    • kyc_data attribute Modified
GET /users/{user_id}/kyc/business_owners
  • Response
  • 200 response Modified
    • mifid_status attribute Added
GET /users/{user_id}/kyc/business_owners/{id}
  • Response
  • 200 response Modified
    • mifid_status attribute Added
GET /users/{user_id}/kyc/identities
  • Response
  • 200 response Modified
    • mifid_status attribute Added
GET /users/{user_id}/kyc/identities/{id}
  • Response
  • 200 response Modified
    • mifid_status attribute Added
GET /users/{user_id}/kyc/legal_representatives
  • Response
  • 200 response Modified
    • mifid_status attribute Added
GET /users/{user_id}/kyc/legal_representatives/{id}
  • Response
  • 200 response Modified
    • mifid_status attribute Added
PATCH /users/{user_id}/kyc/business_owners/{id}
  • Response
  • 201 response Modified
    • mifid_status attribute Added
PATCH /users/{user_id}/kyc/identities/{id}
  • Response
  • 201 response Modified
    • mifid_status attribute Added
PATCH /users/{user_id}/kyc/legal_representatives/{id}
  • Response
  • 201 response Modified
    • mifid_status attribute Added
POST /users
  • Response
  • 201 response Modified
    • identities attribute Modified
POST /users/{user_id}/custody_account_holders
  • Response
  • 201 response Modified
    • kyc_data attribute Modified
POST /users/{user_id}/kyc/business_owners
  • Response
  • 201 response Modified
    • mifid_status attribute Added
POST /users/{user_id}/kyc/identities
  • Response
  • 201 response Modified
    • mifid_status attribute Added
POST /users/{user_id}/kyc/legal_representatives
  • Response
  • 201 response Modified
    • mifid_status attribute Added
PUT /users/{id}
  • Response
  • 201 response Modified
    • identities attribute Modified
Removed 2 Breaking
GET /payouts
GET /users/{user_id}/surveys?name=${name}
Added 7
GET /payouts/{payout_id}/user_payouts
GET /payouts/{payout_id}/user_payouts/{id}
GET /projects/{project_id}/payouts
GET /projects/{project_id}/payouts/{id}
GET /projects/{project_id}/snapshots
GET /projects/{project_id}/snapshots/{id}
GET /users/{user_id}/surveys

API structure has changed

Added 1
GET /orders

API structure has changed

Modified 4 Breaking
GET /users/{user_id}/projects/{project_id}/orders
  • Response
  • 200 response Modified
    • discount_code, discounted, discount attributes Removed
  • Query
  • status, distributable, updated_at query parameters Added
GET /users/{user_id}/projects/{project_id}/orders/{id}
  • Response
  • 200 response Modified
    • discount_code, discounted, discount attributes Removed
POST /users/{user_id}/projects/{project_id}/orders
  • Body
  • content type Modified
    • order attribute Modified
  • Response
  • 201 response Modified
    • discount_code, discounted, discount attributes Removed
POST /users/{user_id}/projects/{project_id}/orders/{id}/cancel
  • Response
  • 201 response Modified
    • discount_code, discounted, discount attributes Removed
Removed 2 Breaking
GET /orders
POST /users/{user_id}/discount_codes/check

API structure has changed

Added 1
GET /payouts

API structure has changed

Modified 5
GET /users
  • Response
  • 200 response Modified
    • identities attribute Added
GET /users/projects/{id}/by_order_status/{status}
  • Response
  • 200 response Modified
    • identities attribute Added
GET /users/{id}
  • Response
  • 200 response Modified
    • identities attribute Added
POST /users
  • Response
  • 201 response Modified
    • identities attribute Added
PUT /users/{id}
  • Response
  • 201 response Modified
    • identities attribute Added

API structure has changed

Modified 26 Breaking
GET /projects
  • Response
  • 200 response Modified
    • maturity_days, maturity_years attributes Removed
GET /projects/by_code/{code}
  • Response
  • 200 response Modified
    • maturity_days, maturity_years attributes Removed
GET /projects/{id}
  • Response
  • 200 response Modified
    • maturity_days, maturity_years attributes Removed
GET /users
  • Response
  • 200 response Modified
    • name, phone_number attributes Removed
GET /users/projects/{id}/by_order_status/{status}
  • Response
  • 200 response Modified
    • name, phone_number attributes Removed
GET /users/{id}
  • Response
  • 200 response Modified
    • name, phone_number attributes Removed
GET /users/{user_id}/custody_account_holders
  • Response
  • 200 response Modified
    • kyc_data attribute Modified
GET /users/{user_id}/custody_account_holders/{id}
  • Response
  • 200 response Modified
    • kyc_data attribute Modified
GET /users/{user_id}/kyc/business_owners
  • Response
  • 200 response Modified
    • phone_number attribute Added
GET /users/{user_id}/kyc/business_owners/{id}
  • Response
  • 200 response Modified
    • phone_number attribute Added
GET /users/{user_id}/kyc/identities
  • Response
  • 200 response Modified
    • phone_number attribute Added
GET /users/{user_id}/kyc/identities/{id}
  • Response
  • 200 response Modified
    • phone_number attribute Added
GET /users/{user_id}/kyc/legal_representatives
  • Response
  • 200 response Modified
    • phone_number attribute Added
GET /users/{user_id}/kyc/legal_representatives/{id}
  • Response
  • 200 response Modified
    • phone_number attribute Added
GET /users/{user_id}/projects
  • Response
  • 200 response Modified
    • maturity_days, maturity_years attributes Removed
PATCH /users/{user_id}/kyc/business_owners/{id}
  • Response
  • 201 response Modified
    • phone_number attribute Added
PATCH /users/{user_id}/kyc/identities/{id}
  • Body
  • content type Modified
    • phone_number attribute Added
  • Response
  • 201 response Modified
    • phone_number attribute Added
PATCH /users/{user_id}/kyc/legal_representatives/{id}
  • Response
  • 201 response Modified
    • phone_number attribute Added
POST /projects
  • Body
  • content type Modified
    • project attribute Modified
  • Response
  • 201 response Modified
    • maturity_days, maturity_years attributes Removed
POST /users
  • Body
  • content type Modified
    • name, phone_number attributes Removed
  • Response
  • 201 response Modified
    • name, phone_number attributes Removed
POST /users/{user_id}/custody_account_holders
  • Response
  • 201 response Modified
    • kyc_data attribute Modified
POST /users/{user_id}/kyc/business_owners
  • Response
  • 201 response Modified
    • phone_number attribute Added
POST /users/{user_id}/kyc/identities
  • Body
  • content type Modified
    • phone_number attribute Added
  • Response
  • 201 response Modified
    • phone_number attribute Added
POST /users/{user_id}/kyc/legal_representatives
  • Response
  • 201 response Modified
    • phone_number attribute Added
PUT /projects/{id}
  • Body
  • content type Modified
    • project attribute Modified
  • Response
  • 201 response Modified
    • maturity_days, maturity_years attributes Removed
PUT /users/{id}
  • Body
  • content type Modified
    • name, phone_number attributes Removed
  • Response
  • 201 response Modified
    • name, phone_number attributes Removed

API structure has changed

Modified 5
GET /orders
  • Response
  • 200 response Modified
    • external_metadata attribute Added
GET /users/{user_id}/projects/{project_id}/orders
  • Response
  • 200 response Modified
    • external_metadata attribute Added
GET /users/{user_id}/projects/{project_id}/orders/{id}
  • Response
  • 200 response Modified
    • external_metadata attribute Added
POST /users/{user_id}/projects/{project_id}/orders
  • Body
  • content type Modified
    • order attribute Modified
  • Response
  • 201 response Modified
    • external_metadata attribute Added
POST /users/{user_id}/projects/{project_id}/orders/{id}/cancel
  • Response
  • 201 response Modified
    • external_metadata attribute Added

API structure has changed

Modified 12 Breaking
GET /custody_assets
  • Response
  • 200 response Modified
    • partner_id attribute Removed
GET /users
  • Response
  • 200 response Modified
    • signed_up_as, referral_channel attributes Removed
GET /users/projects/{id}/by_order_status/{status}
  • Response
  • 200 response Modified
    • signed_up_as, referral_channel attributes Removed
GET /users/{id}
  • Response
  • 200 response Modified
    • signed_up_as, referral_channel attributes Removed
GET /users/{user_id}/custody_account_holders
  • Response
  • 200 response Modified
    • accounts attribute Modified
    • partner_id attribute Removed
GET /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts
  • Response
  • 200 response Modified
    • asset attribute Modified
GET /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts/{id}
  • Response
  • 200 response Modified
    • asset attribute Modified
GET /users/{user_id}/custody_account_holders/{id}
  • Response
  • 200 response Modified
    • accounts attribute Modified
    • partner_id attribute Removed
POST /users
  • Body
  • content type Modified
    • signed_up_as, invitation_code, referral_channel, partner_attributes attributes Removed
  • Response
  • 201 response Modified
    • signed_up_as, referral_channel attributes Removed
POST /users/{user_id}/custody_account_holders
  • Response
  • 201 response Modified
    • accounts attribute Modified
    • partner_id attribute Removed
POST /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts
  • Response
  • 201 response Modified
    • asset attribute Modified
PUT /users/{id}
  • Body
  • content type Modified
    • signed_up_as, invitation_code, referral_channel, partner_attributes attributes Removed
  • Response
  • 201 response Modified
    • signed_up_as, referral_channel attributes Removed
Removed 1 Breaking
GET /users/{user_id}/affiliate

API structure has changed

Modified 6 Breaking
GET /projects
  • Response
  • 200 response Modified
    • volume_limit attribute Removed
    • transferability attribute Added
GET /projects/by_code/{code}
  • Response
  • 200 response Modified
    • volume_limit attribute Removed
    • transferability attribute Added
GET /projects/{id}
  • Response
  • 200 response Modified
    • volume_limit attribute Removed
    • transferability attribute Added
GET /users/{user_id}/projects
  • Response
  • 200 response Modified
    • volume_limit attribute Removed
    • transferability attribute Added
POST /projects
  • Body
  • content type Modified
    • project attribute Modified
  • Response
  • 201 response Modified
    • volume_limit attribute Removed
    • transferability attribute Added
PUT /projects/{id}
  • Body
  • content type Modified
    • project attribute Modified
  • Response
  • 201 response Modified
    • volume_limit attribute Removed
    • transferability attribute Added

API structure has changed

Modified 6
GET /projects
  • Response
  • 200 response Modified
    • asset_description attribute Added
GET /projects/by_code/{code}
  • Response
  • 200 response Modified
    • asset_description attribute Added
GET /projects/{id}
  • Response
  • 200 response Modified
    • asset_description attribute Added
GET /users/{user_id}/projects
  • Response
  • 200 response Modified
    • asset_description attribute Added
POST /projects
  • Response
  • 201 response Modified
    • asset_description attribute Added
PUT /projects/{id}
  • Response
  • 201 response Modified
    • asset_description attribute Added

API structure has changed

Modified 6
GET /projects
  • Response
  • 200 response Modified
    • free_float_bps, number_of_tokens, minimum_subscription_bps, token_price, currency attributes Added
GET /projects/by_code/{code}
  • Response
  • 200 response Modified
    • free_float_bps, number_of_tokens, minimum_subscription_bps, token_price, currency attributes Added
GET /projects/{id}
  • Response
  • 200 response Modified
    • free_float_bps, number_of_tokens, minimum_subscription_bps, token_price, currency attributes Added
GET /users/{user_id}/projects
  • Response
  • 200 response Modified
    • free_float_bps, number_of_tokens, minimum_subscription_bps, token_price, currency attributes Added
POST /projects
  • Body
  • content type Modified
    • project attribute Modified
  • Response
  • 201 response Modified
    • free_float_bps, number_of_tokens, minimum_subscription_bps, token_price, currency attributes Added
PUT /projects/{id}
  • Body
  • content type Modified
    • project attribute Modified
  • Response
  • 201 response Modified
    • free_float_bps, number_of_tokens, minimum_subscription_bps, token_price, currency attributes Added