TradeAware
  • Welcome to TradeAware User Guide
    • Getting Started
  • Using the TradeAware Web App
    • Upload and Analyzing Plots
    • Connect with your supply chain
    • Risk Assessment
    • Transaction Management
    • Document Management
    • Plot Upload and Analysis Trouble Shooting
    • How-to videos
  • Using the TradeAware API
    • API Access and Business Account Registration
    • Authentication
      • Rotate client secret
      • Endpoints enabled for programmatic access
    • Plot Uploading and Analysis Requests
    • Commercial network management
    • Transaction Management
    • API reference
      • Auth
      • Plots
        • Analyses of a specific Plot
        • Batch
      • Analyses
      • Attachments
      • Business invitations
      • Business connections
      • Transactions
        • Create a Transaction
        • Retrieve Transactions
          • Get a transaction by id
          • List all transactions
        • Modify an existing Transaction
          • Update a Transaction
          • Add a Transaction Component
          • Update a Transaction Component
          • Delete a Transaction Component
        • Delete a Transaction
        • Submit a Transaction
        • Retrieve DDS Data
      • Risk Assessments
        • Supplier Risk Assessments
          • Create a Supplier Risk Assessment
          • Update a Supplier Risk Assessment
          • Retrieve Supplier Risk Assessments
            • Get a supplier risk assessment by id
            • Get all supplier risk assessments
          • Retrieve the history
        • Plot Risk Assessments
          • Create a Plot Risk Assessment
          • Update a Plot Risk Assessment
          • Retrieve Plot Risk Assessments
            • Get a plot risk assessment by id
            • Get all plot risk assessments
          • Retrieve the history
      • Survey responses
      • Health
      • Version
      • Specification
  • Additional Resources
    • FAQs
    • Contact Support
    • Terms and Conditions
Powered by GitBook
On this page
  • Register a Business Account
  • TradeAware User Guides
  • TradeAware API Reference and Limitations
  • Support
  1. Using the TradeAware API

API Access and Business Account Registration

PreviousHow-to videosNextAuthentication

Last updated 3 months ago

To start utilizing the TradeAware platform and API, you’ll first need to create a business account. Follow these steps to complete registration and set up programmatic access for your applications

Register a Business Account

  1. Sign Up for TradeAware

    • Visit and select Sign Up.

    • Email and Password: Enter your preferred email address and create a secure password.

  2. Use Separate Emails for Demo and Production Accounts To avoid confusion and potential conflicts during integration, we recommend using different email addresses for demo and production accounts. This will ensure a clear separation between testing and live environments.

    1. Please use email and password for creation of Demo and Production accounts.

  3. Completing the Onboarding Process After registration, you’ll be guided through onboarding steps, including email verification and profile setup. Follow these steps until you reach the main dashboard (the World Map screen), confirming that your account is fully set up.

  4. Confirm the Primary Account Once the onboarding process is complete, please contact our Customer Success Manager (CS) to inform them of the primary account. This will serve as the main access point for your business.

Note: At this time, each business is limited to one primary account for API access. We are working on enabling multi-user support, which will allow more team members to have individual accounts in the future.

We recommend using email and password for account creation instead of social sign-on (SSO), especially if login details need to be shared with multiple users.

TradeAware User Guides

To interact with the TradeAware API programmatically, please refer to our User Guides:

  • : This allows your application to securely access TradeAware services on behalf of your business.

  • : A guide on how to upload and analyze geographical plot data.

  • : Instructions for managing business networks and commercial interactions within TradeAware.

TradeAware API Reference and Limitations

  1. Maximum Payload Size: 10 megabytes per request.

  2. Supported Input Format: Currently, the API accepts GeoJSON files.

  3. Supported Geometry Types: Only Polygon and MultiPolygon geometries are supported in GeoJSON format.

    1. Unsupported types include Point, MultiPoint, LineString, and MultiLineString.

  4. Projection Requirement: Files must be in the CRS84 projection.

  5. Geometry Dimensionality: Only 2D geometries are supported at this time.

Support

Please refer to and limitations:

For reference on polygon geometry definitions, please refer to.

If you have any issues with the TradeAware API, please let us know. We’d love to hear your feedback! For assistance, please refer to our section.

TradeAware
OAuth2.0 Authentication Documentation
Plot Uploading and Analysis Requests
Commercial network management
API Reference specifications
RFC 7946, Section 3.1.6
Contact Support