Third Party API | Issuance Documentation

Management of the Token Creation/Refresh.

Authorizations

Body

emailstring · emailRequired

passwordstringRequired

Responses

200Success

application/json

post

POST /api_third_party/auth/login/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "email": "[email protected]",
  "password": "text"
}

200Success

{
  "token": "text",
  "expiry": "2025-07-25T14:28:10.580Z"
}

post

Authorizations

Responses

200

No response body

post

POST /api_third_party/auth/logout/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

post

Log the user out of all sessions I.E. deletes all auth tokens for the user

Authorizations

Responses

200

No response body

post

POST /api_third_party/auth/logoutall/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Management of investments.

Authorizations

Query parameters

amountnumberOptional

amount__gtnumberOptional

amount__gtenumberOptional

amount__innumber[]Optional

Multiple values may be separated by commas.

amount__ltnumberOptional

amount__ltenumberOptional

approvable_investmentsanyOptional

created_atstring · date-timeOptional

created_at__gtestring · date-timeOptional

created_at__instring · date-time[]Optional

Multiple values may be separated by commas.

created_at__ltestring · date-timeOptional

dispute_document_investmentsanyOptional

dispute_document_required_investmentsanyOptional

idintegerOptional

id__ininteger[]Optional

Multiple values may be separated by commas.

individual_id_review_investmentsanyOptional

individual_id_uploaded_investmentsanyOptional

investmentapproval__is_approvedbooleanOptional

investmentapproval__is_approved__inboolean[]Optional

Multiple values may be separated by commas.

investorintegerOptional

investor__entityintegerOptional

investor__entity__emailstringOptional

investor__entity__email__instring[]Optional

Multiple values may be separated by commas.

investor__entity__isnullbooleanOptional

investor__entity__kyc_statusstring · enumOptional

unverified - Unverified
processing - Processing
passed - Passed
failed - Failed

Possible values:

investor__entity__kyc_status__instring[]Optional

Multiple values may be separated by commas.

investor__idintegerOptional

investor__id__ininteger[]Optional

Multiple values may be separated by commas.

investor__ininteger[]Optional

Multiple values may be separated by commas.

investor__typestring · enumOptional

person - Person
company - Company
trust - Trust
trust_ira - Trust Ira

Possible values:

investor__type__instring[]Optional

Multiple values may be separated by commas.

investor__userintegerOptional

investor__user__emailstringOptional

investor__user__email__instring[]Optional

Multiple values may be separated by commas.

investor__user__entity__entityperson__first_namestringOptional

investor__user__entity__entityperson__first_name__instring[]Optional

Multiple values may be separated by commas.

investor__user__entity__entityperson__last_namestringOptional

investor__user__entity__entityperson__last_name__instring[]Optional

Multiple values may be separated by commas.

investor__user__ininteger[]Optional

Multiple values may be separated by commas.

investor_verify_process_statusstringOptional

investor_verify_process_status__containsstringOptional

investor_verify_process_status__instring[]Optional

Multiple values may be separated by commas.

investor_verify_process_status__startswithstringOptional

invoice__amount_paidnumberOptional

invoice__amount_paid__gtnumberOptional

invoice__amount_paid__gtenumberOptional

invoice__amount_paid__innumber[]Optional

Multiple values may be separated by commas.

invoice__amount_paid__ltnumberOptional

invoice__amount_paid__ltenumberOptional

last_payment_error_messagestringOptional

last_payment_error_message__instring[]Optional

Multiple values may be separated by commas.

offering__archivedbooleanOptional

offering__archived__inboolean[]Optional

Multiple values may be separated by commas.

offering__idintegerOptional

offering__id__ininteger[]Optional

Multiple values may be separated by commas.

offering__issuerintegerOptional

offering__issuer__ininteger[]Optional

Multiple values may be separated by commas.

offering__namestringOptional

offering__name__instring[]Optional

Multiple values may be separated by commas.

offering__slugstringOptional

offering__slug__instring[]Optional

Multiple values may be separated by commas.

offering__typestring · enumOptional

reg_a - Regulation A
reg_d_506b - Regulation D 506(b)
reg_d_506c - Regulation D 506(c)
reg_s - Regulation S
reg_cf - Regulation Crowdfunding
test_the_waters - Test The Waters

Possible values:

offering__type__instring[]Optional

Multiple values may be separated by commas.

orderingstringOptional

Which field to use when ordering the results.

overdue_investmentsanyOptional

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

payment_intent_idstringOptional

payment_intent_id__instring[]Optional

Multiple values may be separated by commas.

payment_methodstringOptional

payment_method__instring[]Optional

Multiple values may be separated by commas.

processed_atstring · date-timeOptional

processed_at__gtestring · date-timeOptional

processed_at__instring · date-time[]Optional

Multiple values may be separated by commas.

processed_at__isnullbooleanOptional

processed_at__ltestring · date-timeOptional

processing_issue_investmentsanyOptional

processing_issue_statusesstringOptional

processing_issue_statuses__containsstringOptional

processing_issue_statuses__instring[]Optional

Multiple values may be separated by commas.

processing_issue_statuses__notcontainstringOptional

processing_issue_statuses__startswithstringOptional

quantityintegerOptional

quantity__ininteger[]Optional

Multiple values may be separated by commas.

reference_idstringOptional

reference_id__instring[]Optional

Multiple values may be separated by commas.

searchstringOptional

A search term.

shares_amountnumberOptional

shares_amount__gtnumberOptional

shares_amount__gtenumberOptional

shares_amount__innumber[]Optional

Multiple values may be separated by commas.

shares_amount__ltnumberOptional

shares_amount__ltenumberOptional

statusstring · enumOptional

started - Started
not_received - Not Received
payment_failed - Payment Failed
received - Received
cancelled - Cancelled
refunded - Refunded
invested - Invested
approved - Approved
not_approved - Not Approved
accepted - Accepted
accepted_escrow_closed - Accepted Escrow Closed

Possible values:

status__excludestring[]Optional

Multiple values may be separated by commas.

status__instring[]Optional

Multiple values may be separated by commas.

updated_atstring · date-timeOptional

updated_at__date__gtestring · dateOptional

updated_at__date__ltestring · dateOptional

updated_at__gtestring · date-timeOptional

updated_at__instring · date-time[]Optional

Multiple values may be separated by commas.

updated_at__isnullbooleanOptional

updated_at__ltestring · date-timeOptional

upload_offering_documentanyOptional

user_documents_to_approveanyOptional

watchlistentityinteger[]Optional

watchlistentity__entity__investor__typestring · enumOptional

person - Person
company - Company
trust - Trust
trust_ira - Trust Ira

Possible values:

watchlistentity__has_hitsbooleanOptional

watchlistentity__has_hits__isnullbooleanOptional

watchlistentity__isnullbooleanOptional

Responses

200Success

application/json

get

GET /api_third_party/investments/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "quantity": 1,
      "price": "text",
      "price_fees": "text",
      "price_payment_processing_fees": "text",
      "amount": "text",
      "status": "started",
      "payment_intent_id": "text",
      "offering": {
        "id": 1,
        "name": "text",
        "type": "reg_a",
        "slug": "text",
        "dollar_amount_investment": true,
        "share_or_unit": "Shares",
        "upload_id_required": true,
        "issuer_broker_control": true
      },
      "reference_id": "text",
      "investor_individual_name": "text",
      "investor": {
        "id": 1,
        "user": {
          "id": 1,
          "email": "[email protected]",
          "is_investor": true,
          "is_issuer": true,
          "is_broker": true,
          "is_staff": true,
          "first_name": "text",
          "last_name": "text",
          "company_name": "text",
          "phone": "text",
          "default_offering_id": 1,
          "default_issuer_id": 1,
          "date_joined": "2025-07-25T14:28:10.580Z",
          "last_login": "2025-07-25T14:28:10.580Z"
        },
        "entity": {
          "id": 1,
          "email": "[email protected]",
          "phone": "text",
          "street_address_1": "text",
          "street_address_2": "text",
          "city": "text",
          "state": "AL",
          "region": "text",
          "postal_code": "text",
          "country": "US",
          "kyc_status": "unverified",
          "number_kyc_failed": 1,
          "current_frozen_kyc_fields": [
            "text"
          ],
          "first_name": "text",
          "last_name": "text",
          "date_of_birth": "2025-07-25",
          "tax_id_number": "text",
          "accredited_investor": true,
          "net_worth": "text",
          "annual_income": "text",
          "citizenship": "United States",
          "us_person": true,
          "exempt_from_backup_withholding": true,
          "amount_invested_in_reg_cf_offering_this_year": "text",
          "accredited_investor_type": "net_worth",
          "attorney_or_cpa_email": "[email protected]",
          "generic_accredited_investor": true
        },
        "individual_entity": {
          "id": 1,
          "first_name": "text",
          "last_name": "text",
          "email": "[email protected]",
          "phone": "text",
          "kyc_status": "unverified"
        },
        "type": "person",
        "receive_sms": true,
        "receive_emails": true,
        "last_failed_payment_investment": 1
      },
      "payment_method": "text",
      "created_at": "2025-07-25T14:28:10.580Z",
      "updated_at": "2025-07-25T14:28:10.580Z",
      "has_investor_signed": true,
      "watchlist": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "is_entity_submitted": true,
      "from_invoice": true,
      "accredited_investor": true,
      "net_worth": "text",
      "annual_income": "text",
      "us_person": true,
      "exempt_from_backup_withholding": true,
      "amount_invested_in_reg_cf_offering_this_year": "text",
      "generic_accredited_investor": true,
      "reg_cf_disclosure_acknowledged_at": "2025-07-25T14:28:10.580Z",
      "user_browser_type": "text",
      "accredited_investor_type": "net_worth",
      "attorney_or_cpa_email": "[email protected]",
      "processed_at": "2025-07-25T14:28:10.580Z",
      "last_payment_error_message": "text",
      "accredited_investor_verification": {
        "id": 1,
        "type": "net_assets",
        "verification_choice": "upload_documentation",
        "cpa_email": "[email protected]",
        "license_number": "text",
        "status": "text",
        "entity": 1,
        "entity_person": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "created_at": "2025-07-25T14:28:10.580Z",
        "ai_request_status": "text",
        "ai_request_sent_at": "2025-07-25T14:28:10.580Z",
        "accreditedinvestornote_set": [
          {
            "id": 1,
            "text": "text",
            "created_at": "2025-07-25T14:28:10.580Z"
          }
        ],
        "accredited_at": "2025-07-25T14:28:10.580Z",
        "cpa_sent_emails": [
          {
            "id": 1,
            "recipient": 1,
            "recipients": "text",
            "subject": "text",
            "created_at": "2025-07-25T14:28:10.580Z",
            "template_name": "text"
          }
        ],
        "public_profile_url": "https://example.com",
        "accreditedinvestorcparejection_set": [
          {
            "id": 1,
            "accredited_investor_verification": 1,
            "type": "missing_information",
            "ip_address": "text",
            "user_agent": "text",
            "cpa_email": "[email protected]",
            "created_at": "2025-07-25T14:28:10.580Z"
          }
        ],
        "license_search_results": null
      },
      "dispute_status": "text",
      "bonus_shares": 1,
      "refund_status": "text",
      "canadian_eligible_investor_type": "eligible_net_income",
      "requested_payment_method": "card",
      "receive_sms": true,
      "upload_id_required": true,
      "offering_receive_sms": true,
      "processing_issue_statuses": "text",
      "wirepayment": 1,
      "shares_amount": "text",
      "watchlistentity_set": [
        {
          "id": 1,
          "entity": 1,
          "has_hits": true,
          "watchlist_hits": null,
          "ofac_fincen_status": "text",
          "updated_at": "2025-07-25T14:28:10.580Z",
          "aml_provider": "text"
        }
      ],
      "bonus_shares_code": "text",
      "bonus_shares_percentage_tier": "text",
      "bonus_shares_quantity_tier": "text",
      "ai_trade_id": "text",
      "dashboard_url": "text",
      "display_refund_button": "text",
      "display_refund_button_message": "text",
      "quantity_qualified_shares": 1,
      "price_qualified_shares": "text"
    }
  ]
}

post

Management of investments.

Authorizations

Body

one ofOptional

or

Responses

201Success

application/json

post

POST /api_third_party/investments/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 685

{
  "quantity": 1,
  "offering": 1,
  "investor": 1,
  "accredited_investor": true,
  "net_worth": "text",
  "annual_income": "text",
  "us_person": true,
  "exempt_from_backup_withholding": true,
  "amount_invested_in_reg_cf_offering_this_year": "text",
  "amount_invested_in_reg_cf_offering_this_year_other_platforms": "text",
  "is_entity_submitted": true,
  "user_browser_type": "text",
  "accredited_investor_type": "net_worth",
  "attorney_or_cpa_email": "[email protected]",
  "reg_cf_disclosure_acknowledged_at": "2025-07-25T14:28:10.580Z",
  "household_w9": true,
  "bonus_shares_code": "text",
  "canadian_eligible_investor_type": "eligible_net_income",
  "requested_payment_method": "card",
  "receive_sms": true,
  "utm_parameters": null,
  "user_agreements": [
    1
  ]
}

201Success

{
  "id": 1,
  "quantity": 1,
  "offering": 1,
  "investor": {
    "id": 1,
    "user": {
      "id": 1,
      "email": "[email protected]",
      "is_investor": true,
      "is_issuer": true,
      "is_broker": true,
      "is_staff": true,
      "first_name": "text",
      "last_name": "text",
      "company_name": "text",
      "default_offering_id": 1,
      "default_issuer_id": 1,
      "date_joined": "2025-07-25T14:28:10.580Z",
      "last_login": "2025-07-25T14:28:10.580Z",
      "phone": "text",
      "is_us_citizen": true,
      "country": "text",
      "has_ip_country_changed": true,
      "is_country_authorized": true,
      "offering_set": [
        1
      ],
      "tax_id_number_update_sponsor_id": 1,
      "receive_sms": true,
      "private_program_signup_at": "2025-07-25T14:28:10.580Z",
      "private_program_initial_promotion_code": "text",
      "private_program_home_page": true
    },
    "entity": {
      "first_name": "text",
      "last_name": "text",
      "date_of_birth": "2025-07-25",
      "tax_id_number": "text",
      "accredited_investor": true,
      "net_worth": "text",
      "annual_income": "text",
      "citizenship": "United States",
      "us_person": true,
      "exempt_from_backup_withholding": true,
      "amount_invested_in_reg_cf_offering_this_year": "text",
      "amount_invested_in_reg_cf_offering_this_year_other_platforms": "text",
      "accredited_investor_type": "net_worth",
      "attorney_or_cpa_email": "[email protected]",
      "canadian_eligible_investor_type": "eligible_net_income",
      "household_w9": true,
      "generic_accredited_investor": true,
      "id": 1,
      "email": "[email protected]",
      "phone": "text",
      "street_address_1": "text",
      "street_address_2": "text",
      "city": "text",
      "state": "AL",
      "region": "text",
      "postal_code": "text",
      "country": "US",
      "kyc_status": "unverified",
      "number_kyc_failed": 1,
      "current_frozen_kyc_fields": [
        "text"
      ],
      "frozen_field_update_sponsor": 1,
      "north_capital_investor_custodial_account_request_id": "text"
    },
    "type": "person",
    "receive_sms": true,
    "receive_emails": true,
    "utm_parameters": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "last_failed_payment_investment": 1,
    "note_set": [
      {
        "id": 1,
        "user": {
          "id": 1,
          "email": "[email protected]"
        },
        "text": "text",
        "investor": 1,
        "investment": 1,
        "created_at": "2025-07-25T14:28:10.580Z",
        "updated_at": "2025-07-25T14:28:10.580Z"
      }
    ],
    "individual_entity": {
      "id": 1,
      "first_name": "text",
      "last_name": "text",
      "email": "[email protected]",
      "phone": "text",
      "kyc_status": "unverified"
    }
  },
  "payment_intent_client_secret": "text",
  "accredited_investor": true,
  "net_worth": "text",
  "annual_income": "text",
  "us_person": true,
  "exempt_from_backup_withholding": true,
  "amount_invested_in_reg_cf_offering_this_year": "text",
  "amount_invested_in_reg_cf_offering_this_year_other_platforms": "text",
  "is_entity_submitted": true,
  "user_browser_type": "text",
  "accredited_investor_type": "net_worth",
  "attorney_or_cpa_email": "[email protected]",
  "reg_cf_disclosure_acknowledged_at": "2025-07-25T14:28:10.580Z",
  "household_w9": true,
  "bonus_shares_code": "text",
  "bonus_shares": 1,
  "canadian_eligible_investor_type": "eligible_net_income",
  "requested_payment_method": "card",
  "amount": "text",
  "price_fees": "text",
  "price_payment_processing_fees": "text",
  "receive_sms": true,
  "utm_parameters": null,
  "shares_amount": "text",
  "quantity_qualified_shares": 1,
  "price_qualified_shares": "text"
}

get

Management of investments.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this investment.

Responses

200Success

application/json

get

GET /api_third_party/investments/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "quantity": 1,
  "price": "text",
  "price_fees": "text",
  "price_payment_processing_fees": "text",
  "amount": "text",
  "status": "started",
  "payment_intent_id": "text",
  "offering": {
    "id": 1,
    "issuer": {
      "id": 1,
      "entity": {
        "id": 1,
        "email": "[email protected]",
        "phone": "text",
        "company_name": "text"
      },
      "third_party_management": true
    },
    "name": "text",
    "type": "reg_a",
    "description": "text",
    "security_type": "text",
    "share_or_unit": "Shares",
    "share_or_unit_details": "text",
    "warrant_per_unit": 1,
    "warrant_expiration_date_delta_year": 1,
    "warrant_expiration_date_delta_month": 1,
    "dollar_amount_investment": true,
    "unit_price": "text",
    "administrative_fees": "text",
    "administrative_fees_paid_by_investor": true,
    "number_of_shares": 1,
    "max_investment_amount": "text",
    "min_investment_amount": "text",
    "investment_increment_amount": "text",
    "minimum_wire_transfer_amount": "text",
    "contact_name": "text",
    "contact_title": "text",
    "contact_phone": "text",
    "contact_email": "[email protected]",
    "us_investors": true,
    "non_us_investors": true,
    "accredited_investors": true,
    "non_accredited_investors": true,
    "slug": "text",
    "logo": "https://example.com",
    "favicon": "https://example.com",
    "circular_link": "text",
    "circular_file": "https://example.com",
    "circular_type": "offering_circular",
    "display_circular": true,
    "display_circular_in_investment_flow": true,
    "displayed_number_of_shares": null,
    "signing_full_name": "text",
    "signing_title": "text",
    "signing_email": "text",
    "support_email": "[email protected]",
    "support_phone": "text",
    "daily_summary_emails": true,
    "daily_summary_recipients": "text",
    "weekly_summary_emails": true,
    "weekly_summary_recipients": "text",
    "wire_email_reminder_period": 1,
    "wire_email_reminder_max_sent": 1,
    "investment_email_reminder_period": 1,
    "investment_email_reminder_max_sent": 1,
    "messaging_consent_text": "text",
    "email_sender_name": "text",
    "default_timezone": "US/Pacific",
    "segment_dataset_id": "text",
    "auto_approve_investments": true,
    "auto_accept_investments": true,
    "auto_accept_max_amount": "text",
    "auto_accept_min_amount": "text",
    "email_investment_started_high_value": true,
    "email_investment_started_threshold": "text",
    "enable_test_the_waters": true,
    "displayed_test_the_waters_amounts": null,
    "accent_color": "text",
    "background_accent_color": "text",
    "activity_accent_color": "text",
    "per_investment_summary_emails": true,
    "per_investment_summary_recipients": "text",
    "user_sent_max_monitoring_emails": true,
    "user_sent_max_monitoring_recipients": "text",
    "other_platform_investment_notice": true,
    "other_platform_investment_notice_text": "text",
    "segment_key_server": "text",
    "segment_key_client": "text",
    "investor_phone_number_required": true,
    "related_reg_s_offering": 1,
    "non_eligible_redirect_url": "https://example.com",
    "minimum_amount_raised": "text",
    "reg_cf_amount_raised_tier": "text",
    "maximum_amount_raised": "text",
    "reg_cf_oversubscription": "text",
    "landing_page_url": "https://example.com",
    "zendesk_chat_widget_id": "text",
    "request_user_data_at_login": true,
    "new_account_created_emails": true,
    "new_account_created_recipients": "text",
    "archived": true,
    "subscription_agreement_ordering": null,
    "investors_excluded_countries": [
      "US"
    ],
    "investors_included_countries": [
      "US"
    ],
    "display_logo_during_investment": "center",
    "display_logo_on_dashboard": true,
    "deadline_date": "2025-07-25",
    "canadian_investor_type_required_provinces": "text",
    "investors_excluded_us_states": "text",
    "upload_id_required": true,
    "upload_id_excluded_countries": [
      "US"
    ],
    "upload_kyb_document_required": true,
    "upload_kyb_document_excluded_countries": [
      "US"
    ],
    "invested_investment_email_recipients": "text",
    "google_analytics_measurement_id": "text",
    "meta_pixel_id": "text",
    "linkedin_pixel_id": "text",
    "reddit_pixel_id": "text",
    "twitter_pixel_id": "text",
    "tiktok_pixel_id": "text",
    "bing_pixel_id": "text",
    "upload_id_required_aml_watchlist_hits": true,
    "north_capital_custodial_account_required": true,
    "crypto_payment_allowed": true,
    "excluded_payment_methods": null,
    "excluded_requested_payment_methods": null,
    "crypto_maximum_per_investment_amount": 1,
    "crypto_maximum_per_investment_quantity": 1,
    "crypto_maximum_per_investment_amount_ex_fee": 1,
    "crypto_maximum_per_investor_rolling_amount": 1,
    "crypto_maximum_per_investor_rolling_days_count": 1,
    "industry_group": "text",
    "qualified_equity_financing_share_unit_price": "text",
    "qualified_equity_financing_share_discounted_price": "text",
    "private_program_name": "text",
    "private_program_subtitle": "text",
    "subscription_agreement_templates": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "new_authorized_brokers": [
      {
        "id": 1,
        "name": "text",
        "archived": true
      }
    ],
    "related_offerings": [
      {
        "id": 1,
        "issuer": 1,
        "name": "text",
        "slug": "text",
        "circular_link": "text",
        "type": "reg_a"
      }
    ],
    "related_non_reg_s_offering": 1,
    "created_at": "2025-07-25T14:28:10.580Z",
    "opened_at": "2025-07-25T14:28:10.580Z",
    "reg_cf_fee_percentage": "text",
    "status": "incomplete",
    "fee_disclosure_statement": "text",
    "reg_cf_minimum_escrow_closing_start_date": "2025-07-25T14:28:10.580Z",
    "reg_cf_minimum_escrow_release_date": "2025-07-25T14:28:10.580Z",
    "current_bonus_shares": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "offeringbonusshare_set": [
      {
        "id": 1,
        "value": "text",
        "type": "amount",
        "offering": 1,
        "start_datetime": "text",
        "end_datetime": "text",
        "activated": true,
        "code": "text",
        "minimum_amount": "text",
        "maximum_amount": "text"
      }
    ],
    "closing_initiated_at": "2025-07-25T14:28:10.580Z",
    "ai_offering_id": "text",
    "ai_account_marked_ready_at": "2025-07-25T14:28:10.580Z",
    "escrow_provider": "fortress",
    "investor_credit_card_fee_percentage": "text",
    "trust_etc_isin": "text",
    "issuer_broker_control": true,
    "trust_etc_isin_creation_id": "text",
    "offeringuserdocument_set": [
      {
        "type": {
          "id": 1,
          "name": "australian_sophisticated_investor_certificate",
          "description": "text",
          "excluded_countries": [
            "US"
          ],
          "included_countries": [
            "US"
          ],
          "required_investor_type": "person"
        },
        "offering": 1
      }
    ],
    "private_program": true,
    "private_program_description": "text",
    "private_program_link": "https://example.com",
    "private_program_featured": true,
    "private_program_display_if_not_private": true,
    "private_program_external_raised_amount": "text",
    "mark_as_for_issuer_message": "text"
  },
  "reference_id": "text",
  "investor_individual_name": "text",
  "investor": {
    "id": 1,
    "user": {
      "id": 1,
      "email": "[email protected]",
      "is_investor": true,
      "is_issuer": true,
      "is_broker": true,
      "is_staff": true,
      "first_name": "text",
      "last_name": "text",
      "company_name": "text",
      "default_offering_id": 1,
      "default_issuer_id": 1,
      "date_joined": "2025-07-25T14:28:10.580Z",
      "last_login": "2025-07-25T14:28:10.580Z",
      "phone": "text",
      "is_us_citizen": true,
      "country": "text",
      "has_ip_country_changed": true,
      "is_country_authorized": true,
      "offering_set": [
        1
      ],
      "tax_id_number_update_sponsor_id": 1,
      "receive_sms": true,
      "private_program_signup_at": "2025-07-25T14:28:10.580Z",
      "private_program_initial_promotion_code": "text",
      "private_program_home_page": true
    },
    "entity": {
      "first_name": "text",
      "last_name": "text",
      "date_of_birth": "2025-07-25",
      "tax_id_number": "text",
      "accredited_investor": true,
      "net_worth": "text",
      "annual_income": "text",
      "citizenship": "United States",
      "us_person": true,
      "exempt_from_backup_withholding": true,
      "amount_invested_in_reg_cf_offering_this_year": "text",
      "amount_invested_in_reg_cf_offering_this_year_other_platforms": "text",
      "accredited_investor_type": "net_worth",
      "attorney_or_cpa_email": "[email protected]",
      "canadian_eligible_investor_type": "eligible_net_income",
      "household_w9": true,
      "generic_accredited_investor": true,
      "id": 1,
      "email": "[email protected]",
      "phone": "text",
      "street_address_1": "text",
      "street_address_2": "text",
      "city": "text",
      "state": "AL",
      "region": "text",
      "postal_code": "text",
      "country": "US",
      "kyc_status": "unverified",
      "number_kyc_failed": 1,
      "current_frozen_kyc_fields": [
        "text"
      ],
      "frozen_field_update_sponsor": 1,
      "north_capital_investor_custodial_account_request_id": "text"
    },
    "type": "person",
    "receive_sms": true,
    "receive_emails": true,
    "utm_parameters": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "last_failed_payment_investment": 1,
    "note_set": [
      {
        "id": 1,
        "user": {
          "id": 1,
          "email": "[email protected]"
        },
        "text": "text",
        "investor": 1,
        "investment": 1,
        "created_at": "2025-07-25T14:28:10.580Z",
        "updated_at": "2025-07-25T14:28:10.580Z"
      }
    ],
    "individual_entity": {
      "id": 1,
      "first_name": "text",
      "last_name": "text",
      "email": "[email protected]",
      "phone": "text",
      "kyc_status": "unverified"
    }
  },
  "payment_method": "text",
  "created_at": "2025-07-25T14:28:10.580Z",
  "updated_at": "2025-07-25T14:28:10.580Z",
  "has_investor_signed": true,
  "watchlist": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_entity_submitted": true,
  "from_invoice": true,
  "accredited_investor": true,
  "net_worth": "text",
  "annual_income": "text",
  "us_person": true,
  "exempt_from_backup_withholding": true,
  "amount_invested_in_reg_cf_offering_this_year": "text",
  "amount_invested_in_reg_cf_offering_this_year_other_platforms": "text",
  "generic_accredited_investor": true,
  "reg_cf_disclosure_acknowledged_at": "2025-07-25T14:28:10.580Z",
  "user_browser_type": "text",
  "accredited_investor_type": "net_worth",
  "attorney_or_cpa_email": "[email protected]",
  "processed_at": "2025-07-25T14:28:10.580Z",
  "last_payment_error_message": "text",
  "accredited_investor_verification": {
    "id": 1,
    "type": "net_assets",
    "verification_choice": "upload_documentation",
    "cpa_email": "[email protected]",
    "license_number": "text",
    "status": "text",
    "entity": 1,
    "entity_person": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": "2025-07-25T14:28:10.580Z",
    "ai_request_status": "text",
    "ai_request_sent_at": "2025-07-25T14:28:10.580Z",
    "accreditedinvestornote_set": [
      {
        "id": 1,
        "text": "text",
        "created_at": "2025-07-25T14:28:10.580Z"
      }
    ],
    "accredited_at": "2025-07-25T14:28:10.580Z",
    "cpa_sent_emails": [
      {
        "id": 1,
        "recipient": 1,
        "recipients": "text",
        "subject": "text",
        "created_at": "2025-07-25T14:28:10.580Z",
        "template_name": "text"
      }
    ],
    "public_profile_url": "https://example.com",
    "accreditedinvestorcparejection_set": [
      {
        "id": 1,
        "accredited_investor_verification": 1,
        "type": "missing_information",
        "ip_address": "text",
        "user_agent": "text",
        "cpa_email": "[email protected]",
        "created_at": "2025-07-25T14:28:10.580Z"
      }
    ],
    "license_search_results": null
  },
  "note_set": [
    {
      "id": 1,
      "user": {
        "id": 1,
        "email": "[email protected]"
      },
      "text": "text",
      "investor": 1,
      "investment": 1,
      "created_at": "2025-07-25T14:28:10.580Z",
      "updated_at": "2025-07-25T14:28:10.580Z"
    }
  ],
  "household_w9": true,
  "dispute_status": "text",
  "bonus_shares": 1,
  "refund_status": "text",
  "canadian_eligible_investor_type": "eligible_net_income",
  "requested_payment_method": "card",
  "receive_sms": true,
  "upload_id_required": true,
  "offering_receive_sms": true,
  "processing_issue_statuses": "text",
  "wirepayment": 1,
  "shares_amount": "text",
  "watchlistentity_set": [
    {
      "id": 1,
      "entity": 1,
      "has_hits": true,
      "watchlist_hits": null,
      "ofac_fincen_status": "text",
      "updated_at": "2025-07-25T14:28:10.580Z",
      "aml_provider": "text"
    }
  ],
  "bonus_shares_code": "text",
  "bonus_shares_percentage_tier": "text",
  "bonus_shares_quantity_tier": "text",
  "ai_trade_id": "text",
  "dashboard_url": "text",
  "display_refund_button": "text",
  "display_refund_button_message": "text",
  "quantity_qualified_shares": 1,
  "price_qualified_shares": "text"
}

post

Return a payment intent secret.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this investment.

Responses

200Success

application/json

post

POST /api_third_party/investments/{id}/get_payment_intent_secret/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "payment_intent_secret": "text",
    "charges_count": 1
  },
  "success": true,
  "message": "text"
}

get

Return the issuer-signed subscription agreement PDF.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this investment.

Responses

200Success

application/json

get

GET /api_third_party/investments/{id}/pdf_subscription_agreements/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "pdf_subscription_agreements": [
      {
        "name": "text",
        "version": 1,
        "document": "text"
      }
    ]
  },
  "success": true,
  "message": "text"
}

get

Return the current investment subscription agreements PDF.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this investment.

Responses

200Success

application/json

get

GET /api_third_party/investments/{id}/temp_pdf_subscription_agreements/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "pdf_subscription_agreements": [
      {
        "name": "text",
        "version": 1,
        "pdf": "text",
        "e-signature": true
      }
    ]
  },
  "success": true,
  "message": "text"
}

get

Return the processing issue statuses.

Authorizations

Responses

200Success

application/json

get

GET /api_third_party/investments/processing_issue_statuses/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "statuses": [
      {
        "value": "text",
        "label": "text"
      }
    ]
  },
  "success": true,
  "message": "text"
}

get

Return the investment Statuses.

Example response: { "success": true, "message": "", "data": { "statuses": [ { "value": "received", "label": "Received", } ] } }

Authorizations

Responses

200Success

application/json

get

GET /api_third_party/investments/statuses/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "statuses": [
      {
        "value": "text",
        "label": "text"
      }
    ]
  },
  "success": true,
  "message": "text"
}

get

List all the values of the provided fields.

Query Parameters: field: the comma-separated list of fields to query.

Authorizations

Query parameters

Responses

200Success

application/json

get

GET /api_third_party/investments/values/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "values": [
      {
        "investor": 1,
        "offering__issuer__entity": 1,
        "offering__archived": true,
        "created_at": "2025-07-25T14:28:10.580Z",
        "processed_at": "2025-07-25T14:28:10.580Z",
        "investor__user__email": "[email protected]",
        "offering__issuer": 1,
        "upload_offering_document": true,
        "processing_issue_statuses": "text",
        "price_fees": "text",
        "investor__entity__north_capital_investor_custodial_account_data_recorded_at": "2025-07-25T14:28:10.580Z",
        "investor__entity__entityperson__first_name": null,
        "investor__user": 1,
        "investor__entity": 1,
        "amount": "text",
        "offering__name": "text",
        "investor__type": "person",
        "offering__type": "reg_a",
        "investor__user__last_name": "text",
        "status": "started",
        "investor__entity__baseentitycompany__company_name": null,
        "offering": 1,
        "is_entity_submitted": true,
        "investor__entity__entityperson__last_name": null,
        "requested_payment_method": "card",
        "offering__north_capital_custodial_account_required": true,
        "investor__created_at": "2025-07-25T14:28:10.580Z",
        "offering__status": "incomplete",
        "investor__user__first_name": "text",
        "offering__issuer__entity__company_name": "text",
        "price_payment_processing_fees": "text",
        "reference_id": "text",
        "offering__slug": "text",
        "investor_verify_process_status": "text",
        "id": 1
      }
    ],
    "count": 1
  },
  "success": true,
  "message": "text"
}

get

Management of investors.

Authorizations

Query parameters

created_atstring · date-timeOptional

created_at__instring · date-time[]Optional

Multiple values may be separated by commas.

entityintegerOptional

entity__emailstringOptional

entity__email__containsstringOptional

entity__email__instring[]Optional

Multiple values may be separated by commas.

entity__frozen_field_update_sponsorintegerOptional

entity__frozen_field_update_sponsor__isnullbooleanOptional

entity__ininteger[]Optional

Multiple values may be separated by commas.

idintegerOptional

id__ininteger[]Optional

Multiple values may be separated by commas.

number_kyc_failednumberOptional

number_kyc_failed__gtnumberOptional

number_kyc_failed__gtenumberOptional

number_kyc_failed__ltnumberOptional

number_kyc_failed__ltenumberOptional

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

typestring · enumOptional

person - Person
company - Company
trust - Trust
trust_ira - Trust Ira

Possible values:

type__containsstringOptional

type__instring[]Optional

Multiple values may be separated by commas.

upload_documentbooleanOptional

userintegerOptional

user__emailstringOptional

user__email__containsstringOptional

user__email__instring[]Optional

Multiple values may be separated by commas.

user__entity__entityperson__first_namestringOptional

user__entity__entityperson__first_name__containsstringOptional

user__entity__entityperson__first_name__instring[]Optional

Multiple values may be separated by commas.

user__entity__entityperson__last_namestringOptional

user__entity__entityperson__last_name__containsstringOptional

user__entity__entityperson__last_name__instring[]Optional

Multiple values may be separated by commas.

user__ininteger[]Optional

Multiple values may be separated by commas.

Responses

200Success

application/json

get

GET /api_third_party/investors/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "user": {
        "id": 1,
        "email": "[email protected]",
        "is_investor": true,
        "is_issuer": true,
        "is_broker": true,
        "is_staff": true,
        "first_name": "text",
        "last_name": "text",
        "company_name": "text",
        "default_offering_id": 1,
        "default_issuer_id": 1,
        "date_joined": "2025-07-25T14:28:10.580Z",
        "last_login": "2025-07-25T14:28:10.580Z",
        "phone": "text",
        "is_us_citizen": true,
        "country": "text",
        "has_ip_country_changed": true,
        "is_country_authorized": true,
        "offering_set": [
          1
        ],
        "tax_id_number_update_sponsor_id": 1,
        "receive_sms": true,
        "private_program_signup_at": "2025-07-25T14:28:10.580Z",
        "private_program_initial_promotion_code": "text",
        "private_program_home_page": true
      },
      "entity": {
        "first_name": "text",
        "last_name": "text",
        "date_of_birth": "2025-07-25",
        "tax_id_number": "text",
        "accredited_investor": true,
        "net_worth": "text",
        "annual_income": "text",
        "citizenship": "United States",
        "us_person": true,
        "exempt_from_backup_withholding": true,
        "amount_invested_in_reg_cf_offering_this_year": "text",
        "amount_invested_in_reg_cf_offering_this_year_other_platforms": "text",
        "accredited_investor_type": "net_worth",
        "attorney_or_cpa_email": "[email protected]",
        "canadian_eligible_investor_type": "eligible_net_income",
        "household_w9": true,
        "generic_accredited_investor": true,
        "id": 1,
        "email": "[email protected]",
        "phone": "text",
        "street_address_1": "text",
        "street_address_2": "text",
        "city": "text",
        "state": "AL",
        "region": "text",
        "postal_code": "text",
        "country": "US",
        "kyc_status": "unverified",
        "number_kyc_failed": 1,
        "current_frozen_kyc_fields": [
          "text"
        ],
        "frozen_field_update_sponsor": 1,
        "north_capital_investor_custodial_account_request_id": "text"
      },
      "type": "person",
      "receive_sms": true,
      "receive_emails": true,
      "utm_parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "last_failed_payment_investment": 1,
      "note_set": [
        {
          "id": 1,
          "user": {
            "id": 1,
            "email": "[email protected]"
          },
          "text": "text",
          "investor": 1,
          "investment": 1,
          "created_at": "2025-07-25T14:28:10.580Z",
          "updated_at": "2025-07-25T14:28:10.580Z"
        }
      ],
      "individual_entity": {
        "id": 1,
        "first_name": "text",
        "last_name": "text",
        "email": "[email protected]",
        "phone": "text",
        "kyc_status": "unverified"
      }
    }
  ]
}

post

Management of investors.

Authorizations

Body

one ofOptional

or

Responses

201Success

application/json

Responseone of

or

post

POST /api_third_party/investors/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 765

{
  "entity": {
    "first_name": "text",
    "last_name": "text",
    "date_of_birth": "2025-07-25",
    "tax_id_number": "text",
    "accredited_investor": true,
    "net_worth": "text",
    "annual_income": "text",
    "citizenship": "United States",
    "us_person": true,
    "exempt_from_backup_withholding": true,
    "amount_invested_in_reg_cf_offering_this_year": "text",
    "amount_invested_in_reg_cf_offering_this_year_other_platforms": "text",
    "accredited_investor_type": "net_worth",
    "attorney_or_cpa_email": "[email protected]",
    "canadian_eligible_investor_type": "eligible_net_income",
    "household_w9": true,
    "email": "[email protected]",
    "phone": "text",
    "street_address_1": "text",
    "street_address_2": "text",
    "city": "text",
    "state": "AL",
    "region": "text",
    "postal_code": "text",
    "country": "US"
  },
  "type": "person",
  "receive_sms": true,
  "receive_emails": true
}

201Success

{
  "id": 1,
  "user": {
    "id": 1,
    "email": "[email protected]",
    "is_investor": true,
    "is_issuer": true,
    "is_broker": true,
    "is_staff": true,
    "first_name": "text",
    "last_name": "text",
    "company_name": "text",
    "default_offering_id": 1,
    "default_issuer_id": 1,
    "date_joined": "2025-07-25T14:28:10.580Z",
    "last_login": "2025-07-25T14:28:10.580Z",
    "phone": "text",
    "is_us_citizen": true,
    "country": "text",
    "has_ip_country_changed": true,
    "is_country_authorized": true,
    "offering_set": [
      1
    ],
    "tax_id_number_update_sponsor_id": 1,
    "receive_sms": true,
    "private_program_signup_at": "2025-07-25T14:28:10.580Z",
    "private_program_initial_promotion_code": "text",
    "private_program_home_page": true
  },
  "entity": {
    "first_name": "text",
    "last_name": "text",
    "date_of_birth": "2025-07-25",
    "tax_id_number": "text",
    "accredited_investor": true,
    "net_worth": "text",
    "annual_income": "text",
    "citizenship": "United States",
    "us_person": true,
    "exempt_from_backup_withholding": true,
    "amount_invested_in_reg_cf_offering_this_year": "text",
    "amount_invested_in_reg_cf_offering_this_year_other_platforms": "text",
    "accredited_investor_type": "net_worth",
    "attorney_or_cpa_email": "[email protected]",
    "canadian_eligible_investor_type": "eligible_net_income",
    "household_w9": true,
    "generic_accredited_investor": true,
    "id": 1,
    "email": "[email protected]",
    "phone": "text",
    "street_address_1": "text",
    "street_address_2": "text",
    "city": "text",
    "state": "AL",
    "region": "text",
    "postal_code": "text",
    "country": "US",
    "kyc_status": "unverified",
    "number_kyc_failed": 1,
    "current_frozen_kyc_fields": [
      "text"
    ],
    "frozen_field_update_sponsor": 1,
    "north_capital_investor_custodial_account_request_id": "text"
  },
  "type": "person",
  "receive_sms": true,
  "receive_emails": true,
  "utm_parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "last_failed_payment_investment": 1,
  "note_set": [
    {
      "id": 1,
      "user": {
        "id": 1,
        "email": "[email protected]"
      },
      "text": "text",
      "investor": 1,
      "investment": 1,
      "created_at": "2025-07-25T14:28:10.580Z",
      "updated_at": "2025-07-25T14:28:10.580Z"
    }
  ],
  "individual_entity": {
    "id": 1,
    "first_name": "text",
    "last_name": "text",
    "email": "[email protected]",
    "phone": "text",
    "kyc_status": "unverified"
  }
}

get

Management of investors.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this investor.

Responses

200Success

application/json

Responseone of

or

get

GET /api_third_party/investors/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "user": {
    "id": 1,
    "email": "[email protected]",
    "is_investor": true,
    "is_issuer": true,
    "is_broker": true,
    "is_staff": true,
    "first_name": "text",
    "last_name": "text",
    "company_name": "text",
    "default_offering_id": 1,
    "default_issuer_id": 1,
    "date_joined": "2025-07-25T14:28:10.580Z",
    "last_login": "2025-07-25T14:28:10.580Z",
    "phone": "text",
    "is_us_citizen": true,
    "country": "text",
    "has_ip_country_changed": true,
    "is_country_authorized": true,
    "offering_set": [
      1
    ],
    "tax_id_number_update_sponsor_id": 1,
    "receive_sms": true,
    "private_program_signup_at": "2025-07-25T14:28:10.580Z",
    "private_program_initial_promotion_code": "text",
    "private_program_home_page": true
  },
  "entity": {
    "first_name": "text",
    "last_name": "text",
    "date_of_birth": "2025-07-25",
    "tax_id_number": "text",
    "accredited_investor": true,
    "net_worth": "text",
    "annual_income": "text",
    "citizenship": "United States",
    "us_person": true,
    "exempt_from_backup_withholding": true,
    "amount_invested_in_reg_cf_offering_this_year": "text",
    "amount_invested_in_reg_cf_offering_this_year_other_platforms": "text",
    "accredited_investor_type": "net_worth",
    "attorney_or_cpa_email": "[email protected]",
    "canadian_eligible_investor_type": "eligible_net_income",
    "household_w9": true,
    "generic_accredited_investor": true,
    "id": 1,
    "email": "[email protected]",
    "phone": "text",
    "street_address_1": "text",
    "street_address_2": "text",
    "city": "text",
    "state": "AL",
    "region": "text",
    "postal_code": "text",
    "country": "US",
    "kyc_status": "unverified",
    "number_kyc_failed": 1,
    "current_frozen_kyc_fields": [
      "text"
    ],
    "frozen_field_update_sponsor": 1,
    "north_capital_investor_custodial_account_request_id": "text"
  },
  "type": "person",
  "receive_sms": true,
  "receive_emails": true,
  "utm_parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "last_failed_payment_investment": 1,
  "note_set": [
    {
      "id": 1,
      "user": {
        "id": 1,
        "email": "[email protected]"
      },
      "text": "text",
      "investor": 1,
      "investment": 1,
      "created_at": "2025-07-25T14:28:10.580Z",
      "updated_at": "2025-07-25T14:28:10.580Z"
    }
  ],
  "individual_entity": {
    "id": 1,
    "first_name": "text",
    "last_name": "text",
    "email": "[email protected]",
    "phone": "text",
    "kyc_status": "unverified"
  }
}

get

Return the information for a wire payment to be made by the investor.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this investor.

Responses

200Success

application/json

get

GET /api_third_party/investors/{id}/get_ach_credit_transfer/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "ach_credit_transfer": {
      "source_id": "text",
      "bank_address": "text",
      "account_number": "text",
      "bank_name": "text",
      "fingerprint": "text",
      "refund_account_holder_name": "text",
      "refund_account_holder_type": "text",
      "refund_routing_number": "text",
      "routing_number": "text",
      "swift_code": "text"
    }
  },
  "success": true,
  "message": "text"
}

post

Run a second time the KYC / KYB for a provided investor.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this investor.

Responses

200Success

application/json

post

POST /api_third_party/investors/{id}/run_second_kyc/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "verification_entity": {
      "id": 1,
      "entity": 1,
      "status": "text",
      "provider": "text"
    }
  },
  "success": true,
  "message": "text"
}

post

Check whether a Tax ID Number is valid.

Return a 400 Error Response if the tax ID is not valid.

Authorizations

Body

Input to check valid tax ID numbers.

tax_id_numberstring · max: 255Required

The Tax ID Number to check

country_codeall ofRequired

The 2-letter country code

US - United States of America
CA - Canada
AF - Afghanistan
AX - Åland Islands
AL - Albania
DZ - Algeria
AS - American Samoa
AD - Andorra
AO - Angola
AI - Anguilla
AQ - Antarctica
AG - Antigua and Barbuda
AR - Argentina
AM - Armenia
AW - Aruba
AU - Australia
AT - Austria
AZ - Azerbaijan
BS - Bahamas
BH - Bahrain
BD - Bangladesh
BB - Barbados
BY - Belarus
BE - Belgium
BZ - Belize
BJ - Benin
BM - Bermuda
BT - Bhutan
BO - Bolivia
BQ - Bonaire, Sint Eustatius and Saba
BA - Bosnia and Herzegovina
BW - Botswana
BV - Bouvet Island
BR - Brazil
IO - British Indian Ocean Territory
BN - Brunei
BG - Bulgaria
BF - Burkina Faso
BI - Burundi
CV - Cabo Verde
KH - Cambodia
CM - Cameroon
KY - Cayman Islands
CF - Central African Republic
TD - Chad
CL - Chile
CN - China
CX - Christmas Island
CC - Cocos (Keeling) Islands
CO - Colombia
KM - Comoros
CG - Congo
CD - Congo (the Democratic Republic of the)
CK - Cook Islands
CR - Costa Rica
CI - Côte d'Ivoire
HR - Croatia
CU - Cuba
CW - Curaçao
CY - Cyprus
CZ - Czechia
DK - Denmark
DJ - Djibouti
DM - Dominica
DO - Dominican Republic
EC - Ecuador
EG - Egypt
SV - El Salvador
GQ - Equatorial Guinea
ER - Eritrea
EE - Estonia
SZ - Eswatini
ET - Ethiopia
FK - Falkland Islands (Malvinas)
FO - Faroe Islands
FJ - Fiji
FI - Finland
FR - France
GF - French Guiana
PF - French Polynesia
TF - French Southern Territories
GA - Gabon
GM - Gambia
GE - Georgia
DE - Germany
GH - Ghana
GI - Gibraltar
GR - Greece
GL - Greenland
GD - Grenada
GP - Guadeloupe
GU - Guam
GT - Guatemala
GG - Guernsey
GN - Guinea
GW - Guinea-Bissau
GY - Guyana
HT - Haiti
HM - Heard Island and McDonald Islands
VA - Holy See
HN - Honduras
HK - Hong Kong
HU - Hungary
IS - Iceland
IN - India
ID - Indonesia
IR - Iran
IQ - Iraq
IE - Ireland
IM - Isle of Man
IL - Israel
IT - Italy
JM - Jamaica
JP - Japan
JE - Jersey
JO - Jordan
KZ - Kazakhstan
KE - Kenya
KI - Kiribati
KW - Kuwait
KG - Kyrgyzstan
LA - Laos
LV - Latvia
LB - Lebanon
LS - Lesotho
LR - Liberia
LY - Libya
LI - Liechtenstein
LT - Lithuania
LU - Luxembourg
MO - Macao
MG - Madagascar
MW - Malawi
MY - Malaysia
MV - Maldives
ML - Mali
MT - Malta
MH - Marshall Islands
MQ - Martinique
MR - Mauritania
MU - Mauritius
YT - Mayotte
MX - Mexico
FM - Micronesia
MD - Moldova
MC - Monaco
MN - Mongolia
ME - Montenegro
MS - Montserrat
MA - Morocco
MZ - Mozambique
MM - Myanmar
NA - Namibia
NR - Nauru
NP - Nepal
NL - Netherlands
NC - New Caledonia
NZ - New Zealand
NI - Nicaragua
NE - Niger
NG - Nigeria
NU - Niue
NF - Norfolk Island
KP - North Korea
MK - North Macedonia
MP - Northern Mariana Islands
NO - Norway
OM - Oman
PK - Pakistan
PW - Palau
PS - Palestine, State of
PA - Panama
PG - Papua New Guinea
PY - Paraguay
PE - Peru
PH - Philippines
PN - Pitcairn
PL - Poland
PT - Portugal
PR - Puerto Rico
QA - Qatar
RE - Réunion
RO - Romania
RU - Russia
RW - Rwanda
BL - Saint Barthélemy
SH - Saint Helena, Ascension and Tristan da Cunha
KN - Saint Kitts and Nevis
LC - Saint Lucia
MF - Saint Martin (French part)
PM - Saint Pierre and Miquelon
VC - Saint Vincent and the Grenadines
WS - Samoa
SM - San Marino
ST - Sao Tome and Principe
SA - Saudi Arabia
SN - Senegal
RS - Serbia
SC - Seychelles
SL - Sierra Leone
SG - Singapore
SX - Sint Maarten (Dutch part)
SK - Slovakia
SI - Slovenia
SB - Solomon Islands
SO - Somalia
ZA - South Africa
GS - South Georgia and the South Sandwich Islands
KR - South Korea
SS - South Sudan
ES - Spain
LK - Sri Lanka
SD - Sudan
SR - Suriname
SJ - Svalbard and Jan Mayen
SE - Sweden
CH - Switzerland
SY - Syria
TW - Taiwan
TJ - Tajikistan
TZ - Tanzania
TH - Thailand
TL - Timor-Leste
TG - Togo
TK - Tokelau
TO - Tonga
TT - Trinidad and Tobago
TN - Tunisia
TR - Türkiye
TM - Turkmenistan
TC - Turks and Caicos Islands
TV - Tuvalu
UG - Uganda
UA - Ukraine
AE - United Arab Emirates
GB - United Kingdom
UM - United States Minor Outlying Islands
UY - Uruguay
UZ - Uzbekistan
VU - Vanuatu
VE - Venezuela
VN - Vietnam
VG - Virgin Islands (British)
VI - Virgin Islands (U.S.)
WF - Wallis and Futuna
EH - Western Sahara
YE - Yemen
ZM - Zambia
ZW - Zimbabwe

string · enumOptional

US - United States of America
CA - Canada
AF - Afghanistan
AX - Åland Islands
AL - Albania
DZ - Algeria
AS - American Samoa
AD - Andorra
AO - Angola
AI - Anguilla
AQ - Antarctica
AG - Antigua and Barbuda
AR - Argentina
AM - Armenia
AW - Aruba
AU - Australia
AT - Austria
AZ - Azerbaijan
BS - Bahamas
BH - Bahrain
BD - Bangladesh
BB - Barbados
BY - Belarus
BE - Belgium
BZ - Belize
BJ - Benin
BM - Bermuda
BT - Bhutan
BO - Bolivia
BQ - Bonaire, Sint Eustatius and Saba
BA - Bosnia and Herzegovina
BW - Botswana
BV - Bouvet Island
BR - Brazil
IO - British Indian Ocean Territory
BN - Brunei
BG - Bulgaria
BF - Burkina Faso
BI - Burundi
CV - Cabo Verde
KH - Cambodia
CM - Cameroon
KY - Cayman Islands
CF - Central African Republic
TD - Chad
CL - Chile
CN - China
CX - Christmas Island
CC - Cocos (Keeling) Islands
CO - Colombia
KM - Comoros
CG - Congo
CD - Congo (the Democratic Republic of the)
CK - Cook Islands
CR - Costa Rica
CI - Côte d'Ivoire
HR - Croatia
CU - Cuba
CW - Curaçao
CY - Cyprus
CZ - Czechia
DK - Denmark
DJ - Djibouti
DM - Dominica
DO - Dominican Republic
EC - Ecuador
EG - Egypt
SV - El Salvador
GQ - Equatorial Guinea
ER - Eritrea
EE - Estonia
SZ - Eswatini
ET - Ethiopia
FK - Falkland Islands (Malvinas)
FO - Faroe Islands
FJ - Fiji
FI - Finland
FR - France
GF - French Guiana
PF - French Polynesia
TF - French Southern Territories
GA - Gabon
GM - Gambia
GE - Georgia
DE - Germany
GH - Ghana
GI - Gibraltar
GR - Greece
GL - Greenland
GD - Grenada
GP - Guadeloupe
GU - Guam
GT - Guatemala
GG - Guernsey
GN - Guinea
GW - Guinea-Bissau
GY - Guyana
HT - Haiti
HM - Heard Island and McDonald Islands
VA - Holy See
HN - Honduras
HK - Hong Kong
HU - Hungary
IS - Iceland
IN - India
ID - Indonesia
IR - Iran
IQ - Iraq
IE - Ireland
IM - Isle of Man
IL - Israel
IT - Italy
JM - Jamaica
JP - Japan
JE - Jersey
JO - Jordan
KZ - Kazakhstan
KE - Kenya
KI - Kiribati
KW - Kuwait
KG - Kyrgyzstan
LA - Laos
LV - Latvia
LB - Lebanon
LS - Lesotho
LR - Liberia
LY - Libya
LI - Liechtenstein
LT - Lithuania
LU - Luxembourg
MO - Macao
MG - Madagascar
MW - Malawi
MY - Malaysia
MV - Maldives
ML - Mali
MT - Malta
MH - Marshall Islands
MQ - Martinique
MR - Mauritania
MU - Mauritius
YT - Mayotte
MX - Mexico
FM - Micronesia
MD - Moldova
MC - Monaco
MN - Mongolia
ME - Montenegro
MS - Montserrat
MA - Morocco
MZ - Mozambique
MM - Myanmar
NA - Namibia
NR - Nauru
NP - Nepal
NL - Netherlands
NC - New Caledonia
NZ - New Zealand
NI - Nicaragua
NE - Niger
NG - Nigeria
NU - Niue
NF - Norfolk Island
KP - North Korea
MK - North Macedonia
MP - Northern Mariana Islands
NO - Norway
OM - Oman
PK - Pakistan
PW - Palau
PS - Palestine, State of
PA - Panama
PG - Papua New Guinea
PY - Paraguay
PE - Peru
PH - Philippines
PN - Pitcairn
PL - Poland
PT - Portugal
PR - Puerto Rico
QA - Qatar
RE - Réunion
RO - Romania
RU - Russia
RW - Rwanda
BL - Saint Barthélemy
SH - Saint Helena, Ascension and Tristan da Cunha
KN - Saint Kitts and Nevis
LC - Saint Lucia
MF - Saint Martin (French part)
PM - Saint Pierre and Miquelon
VC - Saint Vincent and the Grenadines
WS - Samoa
SM - San Marino
ST - Sao Tome and Principe
SA - Saudi Arabia
SN - Senegal
RS - Serbia
SC - Seychelles
SL - Sierra Leone
SG - Singapore
SX - Sint Maarten (Dutch part)
SK - Slovakia
SI - Slovenia
SB - Solomon Islands
SO - Somalia
ZA - South Africa
GS - South Georgia and the South Sandwich Islands
KR - South Korea
SS - South Sudan
ES - Spain
LK - Sri Lanka
SD - Sudan
SR - Suriname
SJ - Svalbard and Jan Mayen
SE - Sweden
CH - Switzerland
SY - Syria
TW - Taiwan
TJ - Tajikistan
TZ - Tanzania
TH - Thailand
TL - Timor-Leste
TG - Togo
TK - Tokelau
TO - Tonga
TT - Trinidad and Tobago
TN - Tunisia
TR - Türkiye
TM - Turkmenistan
TC - Turks and Caicos Islands
TV - Tuvalu
UG - Uganda
UA - Ukraine
AE - United Arab Emirates
GB - United Kingdom
UM - United States Minor Outlying Islands
UY - Uruguay
UZ - Uzbekistan
VU - Vanuatu
VE - Venezuela
VN - Vietnam
VG - Virgin Islands (British)
VI - Virgin Islands (U.S.)
WF - Wallis and Futuna
EH - Western Sahara
YE - Yemen
ZM - Zambia
ZW - Zimbabwe

Possible values:

investor_typeall ofRequired

The investor type

person - Person
company - Company
trust - Trust
trust_ira - Trust Ira

string · enumOptional

person - Person
company - Company
trust - Trust
trust_ira - Trust Ira

Possible values:

is_us_citizenbooleanOptional

Whether the investor is a US citizen

Responses

200Success

application/json

post

POST /api_third_party/investors/check_tax_id_number_valid/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "tax_id_number": "text",
  "country_code": "US",
  "investor_type": "person",
  "is_us_citizen": true
}

200Success

{
  "data": {
    "is_valid": true
  },
  "success": true,
  "message": "text"
}

post

Return a workflow URL for ID upload.

Example response: { "success": true, "message": "", "data": { "workflow_url": "123" } }

Authorizations

Responses

200Success

application/json

post

POST /api_third_party/investors/create_id_upload_workflow_url/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "workflow_url": "https://example.com"
  },
  "success": true,
  "message": "text"
}

get

Return the KYB-authorized Country codes.

Example return: { "success": true, "message": "", "data": { "country_codes": ["US", "CA"] } }

Authorizations

Responses

200Success

application/json

get

GET /api_third_party/investors/kyb_country_codes/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "country_codes": [
      "US"
    ]
  },
  "success": true,
  "message": "text"
}

get

Return the KYC-authorized Country codes.

Example return: { "success": true, "message": "", "data": { "country_codes": ["US", "CA"] } }

Authorizations

Responses

200Success

application/json

get

GET /api_third_party/investors/kyc_country_codes/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "country_codes": [
      "US"
    ]
  },
  "success": true,
  "message": "text"
}

get

List all the values of the provided fields.

Query Parameters: field: the comma-separated list of fields to query.

Authorizations

Query parameters

Responses

200Success

application/json

get

GET /api_third_party/investors/values/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "values": [
      {
        "upload_document": true,
        "entity__entityperson__first_name": null,
        "type": "person",
        "individual_entity__first_name": "text",
        "user__email": "[email protected]",
        "user": 1,
        "entity": 1,
        "created_at": "2025-07-25T14:28:10.580Z",
        "number_kyc_failed": true,
        "individual_entity__last_name": "text",
        "user__first_name": "text",
        "entity__baseentitycompany__company_name": null,
        "user__last_name": "text",
        "entity__entityperson__last_name": null,
        "individual_entity": 1,
        "entity__frozen_field_update_sponsor": 1,
        "id": 1
      }
    ],
    "count": 1
  },
  "success": true,
  "message": "text"
}

get

Management of invoices.

Authorizations

Query parameters

idintegerOptional

id__ininteger[]Optional

Multiple values may be separated by commas.

investmentintegerOptional

investment__ininteger[]Optional

Multiple values may be separated by commas.

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

Responses

200Success

application/json

get

GET /api_third_party/invoices/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "investment": 1,
      "number": "text",
      "account_number": "text",
      "bank_name": "text",
      "fingerprint": "text",
      "routing_number": "text",
      "swift_code": "text",
      "beneficiary_name": "text",
      "beneficiary_address": "text"
    }
  ]
}

get

Management of invoices.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this invoice.

Responses

200Success

application/json

get

GET /api_third_party/invoices/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "investment": 1,
  "number": "text",
  "account_number": "text",
  "bank_name": "text",
  "fingerprint": "text",
  "routing_number": "text",
  "swift_code": "text",
  "beneficiary_name": "text",
  "beneficiary_address": "text"
}

get

Management of KYB documents.

Authorizations

Query parameters

entityintegerOptional

entity__ininteger[]Optional

Multiple values may be separated by commas.

idintegerOptional

id__ininteger[]Optional

Multiple values may be separated by commas.

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

Responses

200Success

application/json

get

GET /api_third_party/kyb_documents/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "created_at": "2025-07-25T14:28:10.580Z",
      "entity": 1,
      "type": "other",
      "side": "front",
      "verified": true
    }
  ]
}

post

Management of KYB documents.

Authorizations

Body

idintegerRead-onlyRequired

created_atstring · date-timeRead-onlyRequired

entityintegerRequired

typestring · enumRequired

other - Other

Possible values:

sideone ofOptional

string · enumOptional

front - Front
back - Back

Possible values:

or

undefined · enumOptionalPossible values:

verifiedboolean | nullableRead-onlyRequired

Whether the ID was verified

storage_contentstring · uri | nullableWrite-onlyOptional

Management of images and PDF files.

Pattern: (?:pdf)$

Responses

201Success

application/json

post

POST /api_third_party/kyb_documents/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "entity": 1,
  "type": "other",
  "side": "front",
  "storage_content": "https://example.com"
}

201Success

{
  "id": 1,
  "created_at": "2025-07-25T14:28:10.580Z",
  "entity": 1,
  "type": "other",
  "side": "front",
  "verified": true
}

get

Management of KYB documents.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this kyb document.

Responses

200Success

application/json

get

GET /api_third_party/kyb_documents/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "created_at": "2025-07-25T14:28:10.580Z",
  "entity": 1,
  "type": "other",
  "side": "front",
  "verified": true
}

get

API endpoints managing subscription agreements.

Authorizations

Query parameters

idintegerOptional

id__ininteger[]Optional

Multiple values may be separated by commas.

investmentintegerOptional

investment__ininteger[]Optional

Multiple values may be separated by commas.

investment__offeringintegerOptional

investment__offering__ininteger[]Optional

Multiple values may be separated by commas.

investment__offering__slugstringOptional

investment__offering__slug__containsstringOptional

investment__offering__slug__instring[]Optional

Multiple values may be separated by commas.

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

subscription_agreement_templateintegerOptional

subscription_agreement_template__ininteger[]Optional

Multiple values may be separated by commas.

subscription_agreement_template__namestring · enumOptional

subscription_agreement - The Offering Subscription Agreement
subscription_agreement_2 - The Offering Second Subscription Agreement or relevant document
subscription_agreement_3 - The Offering Third Subscription Agreement or relevant document
subscription_agreement_us_only - The Offering Subscription Agreement for US investor only.
subscription_agreement_ca_only - The Offering Subscription Agreement for Canadian investor only.
subscription_agreement_ca_only_individual_only - The Offering Subscription Agreement for Canadian investor only.
subscription_agreement_non_us_non_ca_only - The Offering Subscription Agreement for Non-US, Non-CA investors only
subscription_agreement_non_us_only - The Offering Subscription Agreement for Non-US investors only

Possible values:

subscription_agreement_template__name__containsstringOptional

subscription_agreement_template__name__instring[]Optional

Multiple values may be separated by commas.

subscription_agreement_template__versionintegerOptional

subscription_agreement_template__version__ininteger[]Optional

Multiple values may be separated by commas.

Responses

200Success

application/json

get

GET /api_third_party/subscription_agreement_investor_signatures/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "investment": 1,
      "investor_signature_text": "text",
      "investor_signature_date": "2025-07-25T14:28:10.580Z",
      "signing_url": "text",
      "signed_at": "2025-07-25T14:28:10.580Z"
    }
  ]
}

post

API endpoints managing subscription agreements.

Authorizations

Body

idintegerRead-onlyRequired

investmentintegerRequired

investor_signature_textstring · max: 255Optional

investor_signature_datestring · date-time | nullableOptional

signing_urlstringRead-onlyRequired

Return the E-signing URL

signed_atstring · date-time | nullableRead-onlyRequired

document_nameall ofWrite-onlyRequired

string · enumOptional

subscription_agreement - The Offering Subscription Agreement
subscription_agreement_2 - The Offering Second Subscription Agreement or relevant document
subscription_agreement_3 - The Offering Third Subscription Agreement or relevant document
subscription_agreement_us_only - The Offering Subscription Agreement for US investor only.
subscription_agreement_ca_only - The Offering Subscription Agreement for Canadian investor only.
subscription_agreement_ca_only_individual_only - The Offering Subscription Agreement for Canadian investor only.
subscription_agreement_non_us_non_ca_only - The Offering Subscription Agreement for Non-US, Non-CA investors only
subscription_agreement_non_us_only - The Offering Subscription Agreement for Non-US investors only

Possible values:

document_versionintegerWrite-onlyRequired

investor_titlestringWrite-onlyOptional

facebook_fbcstringWrite-onlyOptional

facebook_fbpstringWrite-onlyOptional

Responses

201Success

application/json

post

POST /api_third_party/subscription_agreement_investor_signatures/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "investment": 1,
  "investor_signature_text": "text",
  "investor_signature_date": "2025-07-25T14:28:10.580Z",
  "document_name": "subscription_agreement",
  "document_version": 1,
  "investor_title": "text",
  "facebook_fbc": "text",
  "facebook_fbp": "text"
}

201Success

{
  "id": 1,
  "investment": 1,
  "investor_signature_text": "text",
  "investor_signature_date": "2025-07-25T14:28:10.580Z",
  "signing_url": "text",
  "signed_at": "2025-07-25T14:28:10.580Z"
}

get

API endpoints managing subscription agreements.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this subscription agreement investor signature.

Responses

200Success

application/json

get

GET /api_third_party/subscription_agreement_investor_signatures/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "investment": 1,
  "investor_signature_text": "text",
  "investor_signature_date": "2025-07-25T14:28:10.580Z",
  "signing_url": "text",
  "signed_at": "2025-07-25T14:28:10.580Z"
}