API Documentation
    Add a header to begin generating the table of contents
    Scroll to Top

    API Documentation

    DataDock provides developers with real-time access to Global Sanctions Lists and SEC Filing Data. Our APIs are designed to be secure, scalable, and high-performance.
    1. Introduction

    Dashboard URL

    				
    					https://api.datadock.ai
    
    				
    			

    API Base URL

    				
    					https://api.datadock.ai
    
    				
    			

    2. Getting Started

    2.1 Registration
    Users can register in two ways:
    Recommended Method — Dashboard Registration
    It is strongly recommended that users register through the dashboard at https://app.datadock.ai
    From the dashboard, users can:

    Create an account easily

    Register with your email address. Upon successful registration, you will receive a confirmation email.

    Verify their email

    Click on the verification link in your email to activate your account.

    Log in

    After verification, log in to your dashboard.

    Retrieve their API token

    Your API token will be displayed on the dashboard and sent to your email.

    View and manage their subscription plan

    See your current plan details and usage limits.

    Upgrade or downgrade plans

    Change your subscription based on your needs.

    Monitor real-time API usage

    Track your API calls and data consumption.

    View billing history

    Access invoices and payment records.

    Alternative Method — Register via API Endpoint

    Developers may also register directly through the API:
    POST
    /auth/register

    Request Body (application/json)

    				
    					{
      "username": "your_username",
      "email": "your_email@example.com",
      "password": "your_secure_password"
    }
    				
    			

    Sample Response

    				
    					{
      "message": "User registered. Please check your email to verify your account and get your API token."
    }
    				
    			
    2.2 Email Verification
    After registration (either via dashboard or API), users receive an email containing:

    Subject: Welcome to Datadock!

    Once the email is verified, the token becomes active and can be used immediately to access the APIs.

    2.3 Authentication
    All protected endpoints (e.g., /api/v1/filingflow, /api/v1/globalcomply require the API token to be included in the request header.
    Header Format

    Authorization Header

    				
    					Authorization: Bearer your_api_token
    				
    			
    Example Request

    cURL

    				
    					GET /api/v1/filingflow?form_type=form_8k
    Authorization: Bearer c49ca84bcc452f873********b280776d
    				
    			

    If the token is missing or invalid, the API will return an authentication error.

    2.4 Rate Limiting
    To ensure reliable performance for all users, rate limits apply:
    Endpoint Type Limit
    Default 100 requests per hour
    High-load endpoints 5 requests per minute

    3. FilingFlow Query API – SEC Filings

    The FilingFlow API enables querying metadata from U.S. Securities and Exchange Commission (SEC) filings across various form types. The data is pulled from the EDGAR index and made available for structured search and export.

    Each filing is returned in JSON format, containing metadata such as company name, form type, filing and event dates, geographic info, reporting persons, and filing sources.

    3.1 Use Cases
    3.2 Global Filterable Fields
    Filter keys available globally:
    form_type
    company_name
    cik
    accession
    filing_date
    city
    state
    zipcode
    former_name
    event_date
    name_address
    names_of_reporting_persons
    owner_cik
    issuer_name
    owner_name
    report_period
    address
    report_type
    filer_cik
    issuer_cik
    issuer_city
    issuer_state
    issuer_zip
    owner_zip
    issuer_symbol
    cusip
    Range Filters
    filing_date_min / filing_date_max
    report_period_min / report_period_max
    Key Features
    3.3 Example Queries
    GET
    /api/v1/filingflow
    Example Request

    cURL

    				
    					https://api.datadock.ai/api/v1/filingflow?form_type=form_13f_hrfiler_cik=0000123456
    Authorization: Beareryour_api_token
    				
    			
    JSON Response

    Response

    				
    					{
      "count": 1,
      "results": [
        {
          "schema_location": "example_value",
          "schema_version": "example_value",
          "document_type": "example_value",
          "livetest_flag": "example_value",
          "confirming_copy_flag": "example_value",
          "return_copy_flag": "example_value",
          "filing_website_notice_flag": "example_value",
          "filer_cik": "0000123456"
        }
      ]
    }
    				
    			
    3.4 Step-by-Step Guide
    Step 1: Install and Set Up Postman (or your preferred API testing tool)
    Parameters:
    3.5 Query Parameters
    Parameter Type Description
    form_typerequired string The type of SEC form (e.g., form_10k, form_8k, form_13f_hr, form_d, form_sc_13d, form_sc_13g, form_13f_nt)
    company_name string Filter results by company name (partial match supported)
    filing_date string Filter by exact filing date (YYYY-MM-DD)
    filing_date_min string Filter results from this date (YYYY-MM-DD)
    filing_date_max string Filter results up to this date (YYYY-MM-DD)
    name_address string Filter by name address. Available for form_sc_13g and form_sc_13d only
    names_of_reporting_persons string Filter by reporting person name. Available for form_sc_13g and form_sc_13d only
    cik string Filter by company's CIK number
    accession string Filter by company's accession number
    accession string Filter by company's accession number
    3.6 Supported Form Types
    This section describes which filters are applicable for each form type.
    Form Description Available Filters
    form_10_12b Registration statement under Section 12(b) of the Securities Exchange Act of 1934 address, company_name, filing_date, filing_date_min, filing_date_max
    form_13f_hr Filed quarterly by institutional investment managers to disclose equity holdings filer_cik, report_period, report_type, report_period_min, report_period_max
    form_13f_nt Quarterly 13F notice filings (no holdings table) for certain conditions filer_cik, report_period, report_type, report_period_min, report_period_max
    form_1a Regulation A offering statement issuer_cik, issuer_city, issuer_name, issuer_state, issuer_zip
    form_1a_pos Form 1A posteffective amendments / offering statements issuer_cik, issuer_city, issuer_name, issuer_state, issuer_zip
    form_1a_w Form 1A Withdrawal letters / notices company_name, filing_date, filing_date_min, filing_date_max
    form_3 Initial statement of beneficial ownership for insiders issuer_cik, issuer_name, issuer_symbol, owner_cik, owner_name, owner_zip, report_period, report_period_min, report_period_max
    form_4 Statement of changes in beneficial ownership (insider trades) issuer_cik, issuer_name, issuer_symbol, owner_cik, owner_name, owner_zip, report_period, report_period_min, report_period_max
    form_5 Annual statement of changes in beneficial ownership (catch-up) issuer_cik, issuer_name, issuer_symbol, owner_cik, owner_name, owner_zip, report_period, report_period_min, report_period_max
    form_8k Current report for major events shareholders should know about former_name, issuer_symbol, owner_cik, owner_name, owner_zip, report_period, report_period_min, report_period_max
    form_d Notice of exempt offering under Regulation D and Section 4(a)(5) issuer_cik, issuer_city, issuer_name, issuer_state, issuer_zip
    form_iran_notice Internal/agency notice (IRAN notice) — administrative communication filing_date, filing_date_min, filing_date_max
    form_sc_13d Schedule 13D for beneficial ownership reporting for activist investors cusip, filing_date, issuer_name, filing_date_min, filing_date_max
    form_sc_13g Schedule for reporting beneficial ownership of 5%+ by passive investors cusip, filing_date, issuer_name, filing_date_min, filing_date_max

    4. GlobalComply Query API – Sanctions and Compliance

    The GlobalComply API allows real-time filtering and export of sanctioned individuals, entities, ships, programs, and places from multiple official sources including OFAC, UK, EU, DFAT (Australia), Canada, and SECO (Switzerland).

    Returned results include sanctioned names, aliases, identifiers, nationalities, addresses, program IDs, and relevant listing metadata — all unified in JSON format.

    4.1 Use Cases
    4.2 Filterable Fields
    Searchable by:
    Key Features
    Supported Sanctions Agencies
    dfat_sanctions
    canada_sanctions
    eu_sanctions
    uk_sanctions
    ofac_sdn_sanctions
    ofac_non_sdn_sanctions
    seco_place_sanctions
    seco_program_sanctions
    seco_target_sanctions
    4.3 Example Queries
    GET
    /api/v1/globalcomply

    Example Request

    				
    					GET /api/v1/globalcomply?sanctions_agency=eu_sanctions&Naal_lastname=Putin&Leba_publication_date_min=2023-01-01
    Authorization: Bearer your_api_token
    
    
    				
    			
    Step-by-Step Guide
    Step 1: Install and Set Up Postman
    Parameters:
    4.4 Query Parameters by Agency
    Canada Sanctions
    Parameter Type Description
    country string Country associated with the individual or entity
    last_name string Last name of sanctioned individual
    given_name string Given name of sanctioned individual
    aliases string Alternate names of individuals/entities
    entity string Entity name
    date_of_listing string Official listing date
    schedule string Associated sanction schedule
    date_of_listing_min string Start date for listing filter
    date_of_listing_max string End date for listing filter
    DFAT Sanctions (Australia)
    Parameter Type Description
    Reference string Unique identifier in DFAT listing
    Name of Individual or Entity string Name of subject
    Type string Subject type: individual, entity, ship
    Place of Birth string Subject's place of birth
    Citizenship string Country of citizenship
    Address string Address string
    Listing Information string Additional listing notes
    Committees string Related committees
    EU Sanctions
    Parameter Type Description
    Reference string Unique identifier in DFAT listing
    Name of Individual or Entity string Name of subject
    Type string Subject type: individual, entity, ship
    Place of Birth string Subject's place of birth
    Citizenship string Country of citizenship
    Address string Address string
    Listing Information string Additional listing notes
    Committees string Related committees
    UK Sanctions
    Parameter Type Description
    last_update string Last update date for UK listings
    regime_name string Regime name in UK lists
    sanctions_imposed string Imposed sanctions types
    names_name1 string First part of name
    OFAC Sanctions (SDN & Non-SDN)
    Parameter Type Description
    addresses_city string City in address entries
    uid string Unique ID in OFAC listings
    sdntype string SDN type field (Entity or Individual)
    programs_program string OFAC sanctions program
    akas_firstname string OFAC alternate first name
    akas_lastname string OFAC alternate last name
    date_of_birth_dateOfBirthItem string Date of birth field
    identity_id_number string Document number
    national_country string Nationality
    citizenship_country string Citizenship
    vesselinfo_vesselFlag string Flag of a sanctioned vessel (SDN only)
    SECO Sanctions (Switzerland)
    Parameter Type Description
    location string seco_place_sanctions
    area_variant_type string seco_place_sanctions
    program-key_0_#text string seco_program_sanctions
    origin string seco_program_sanctions
    ind_address_address_details string seco_target_sanctions
    modification_modification_type string seco_target_sanctions

    5. Bulk Data Download API

    POST
    /api/v1/bulk

    Download large volumes of data from supported data sources (workstreams). Users can apply filters to refine results and choose their preferred download format.

    This feature is ideal for clients who need full data exports for analytics, integration, or compliance purposes.

    5.2 Supported Workstreams
    Workstream Description
    filingflow SEC filings data such as Form D, 13F-HR, and 13F-NT
    globalcomply Global sanctions and compliance lists from government and international agencies
    5.3 Authentication
    This endpoint requires a valid API key with bulk access permissions.

    Header Example

    				
    					Authorization: "Bearer <YOUR_API_KEY>"
    Content-Type: "application/json"
    
    				
    			
    5.4 Request Parameters
    Field Type Required Description
    workstream string Yes Data source: realtystream, filingflow, or globalcomply
    filters object No Filters to narrow down results (structure depends on workstream)
    format string No Download format: "json" (default) or "excel"
    Example Request (JSON Format)

    Request Body

    				
    					{
      "workstream": "globalcomply",
      "filters": {
        "country": "Belarus",
        "sanction_type": "canada_sanctions"
      },
      "format": "json"
    }
    				
    			
    Example Request (Excel Format)

    Request Body

    				
    					{
      "workstream": "globalcomply",
      "filters": {
        "country": "Belarus",
        "sanction_type": "canada_sanctions"
      },
      "format": "excel"
    }
    				
    			
    5.5 Successful Responses
    JSON Download

    Example Response

    				
    					[
      {
        "country": "Belarus",
        "last_name": "Atabekov",
        "given_name": "Khazalbek Bakhtibekovich",
        "aliases": null,
        "schedule": "1, Part 1",
        "item": "1",
        "dob": "1800-01-01",
        "entity": null,
        "date_of_listing": "2020-09-28",
        "sanctions_origin": "Canada"
      }
    ]
    				
    			
    5.6 Excel Download

    The response body contains an Excel file with the requested dataset.

    5.7 Error Responses
    Status Code Description Example
    400 Invalid or missing parameters {"error": "Invalid or missing workstream..."}
    403 Download quota exceeded {"error": "Quota exceeded", "message": "..."}
    404 No data found {"message": "No data found for the given filters"}
    500 Internal server error {"error": "Internal server error..."}
    5.8 Quota Policy
    Each user account has a monthly data download quota based on their subscription plan. The API measures the total file size of each download and tracks it toward your quota.
    If a request exceeds your remaining quota, the system returns a 403 Quota Exceeded error.
    5.9 Usage Notes
    5.10 Example Use Cases

    6. Tips for Success

    7. Error Handling

    The API uses standard HTTP status codes to indicate success or failure:
    200 Success — Request completed successfully
    400 Bad Request — Invalid filter parameters or missing form type
    401 Unauthorized — Invalid or missing API token
    404 Not Found — No records match the given filters
    500 Internal Server Error — Database connection failure or other server errors

    8. Contact & Support

    For further assistance, refer to the official documentation or contact our support team.
    Happy coding!

    Enterprise: Enterprise & Institutions

    For large organizations and institutions with specialized requirements, this plan offers customizable solutions. Contact us for options like multiple API keys, priority support, redistribution rights, or unlimited data access. Example use cases include:

    Scale: Business / Internal Use

    Built for organizations leveraging the platform for internal operations, this tier supports data-driven teams and professionals. Common applications include:

    Growth: Personal & Startups

    Designed for innovators, individual developers, and university researchers, this plan supports small-scale projects and early-stage experimentation. Typical scenarios include:

    Explorer:

    For testing purposes.