TradeAware
  • Welcome to TradeAware User Guide
    • Getting Started
  • Using the TradeAware Web App
    • Upload and Analyzing Plots
    • Connect with your supply chain
    • Provide and Review Documents
    • Assess risk in your supply chain
    • Manage your transactions
    • Plot Upload and Analysis Trouble Shooting
    • How-to videos
  • Using the TradeAware API
    • API Access and Business Account Registration
    • Webhooks Guide
    • Authentication
      • Rotate client secret
      • Endpoints enabled for programmatic access
    • Upload and Analyzing Plots
    • Connect with your supply chain
    • Assess risk in your supply chain
    • Manage your transactions
    • 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
  • What is Risk Assessment in TradeAware?
  • Prerequisites
  • Risk Assessment for Suppliers
  • Create a Supplier Risk Assessment
  • Update a Supplier Risk Assessment
  • Retrieve Supplier Risk Assessments
  • Retrieve the History
  • Risk Assessment for Plots
  • Create a Plot Risk Assessment
  • Update a Plot Risk Assessment
  • Retrieve Plot Risk Assessments
  • Retrieve the history
  1. Using the TradeAware API

Assess risk in your supply chain

PreviousConnect with your supply chainNextManage your transactions

Last updated 14 days ago

What is Risk Assessment in TradeAware?

Risk assessment provides a way for companies to be able to assess their suppliers and their plots for compliance with EUDR and document the actions they have taken against these.

Note: only your business can see risk statuses and the associated notes both for suppliers and plots. Your suppliers cannot see these.

Prerequisites

Risk is a premium feature in TradeAware. To use this functionality, your account must be enabled for this. If you do not have this enabled, contact your Customer Success Manager.

Risk Assessment for Suppliers

Supplier risk assessments can have the following statuses in addition to notes:

  • New - The default status when you connect with a supplier for the first time.

  • Under review - When you have started looking at the data provided by the supplier.

  • Ready for assessment - Where the supplier has provided their data and is ready to assess.

  • CMS assessment requested - Where you have a relevant TradeAware package with CMS support, a request to CMS to assess the provided data.

  • CMS assessment completed - Where you have a relevant TradeAware package with CMS support, CMS have completed their assessment.

  • In risk mitigation - Where a risk assessment has been completed and risk mitigation actions are ongoing.

  • EUDR compliant - Where a supplier has been assessed as being compliant with EUDR.

  • EUDR non-compliant - Where a supplier has been assessed as being non-compliant with EUDR.

Create a Supplier Risk Assessment

You can create a risk assessment for a supplier with following request. To do this you will need to include the supplierId in the request you want to create.

. curl -L \
  --request POST \
  --url 'https://api.tradeaware.live-eo.com/businesses/{supplierId}/supplier-risk-assessments' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "NEW",
    "notes": "text"
  }'

Both the status and notes are optional allowing you to add notes without changing the status and also to update the status without notes. By default the status is "NEW". Other status options are UNDER_REVIEW, READY_FOR_ASSESSMENT, CMS_ASSESSMENT_REQUESTED, CMS_ASSESSMENT_COMPLETED, IN_RISK_MITIGATION, EUDR_COMPLIANT and EUDR_NON_COMPLIANT

When successfully created you will see a response like the following. This includes an id for the supplier risk assessment.

{
  "id": "22cd2eab-ce2a-47e3-9dad-aae40735711c",
  "status": "NEW",
  "notes": "Still providing information",
  "createdAt": "2025-05-13T15:13:48.801Z",
  "updatedAt": "2025-05-13T15:13:48.801Z",
  "supplierId": "1cdaa481-2136-4b4d-b2cc-e996a49c24d0",
  "buyerId": "9d78ac05-038b-49c0-a35c-6295669138d8"
}

Update a Supplier Risk Assessment

Likewise, you can update a supplier risk assessment with the following request using the id of the supplier risk assessment.

curl -L \
  --request PATCH \
  --url 'https://api.tradeaware.live-eo.com/supplier-risk-assessments/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "UNDER_REVIEW",
    "notes": "text"
  }'

If we take the previous example, the response would look similar to the following:

{
  "id": "22cd2eab-ce2a-47e3-9dad-aae40735711c",
  "status": "UNDER_REVIEW",
  "notes": "I have the data now and we can start to investigate.",
  "createdAt": "2025-05-13T15:13:48.801Z",
  "updatedAt": "2025-05-13T15:18:01.173Z",
  "supplierId": "1cdaa481-2136-4b4d-b2cc-e996a49c24d0",
  "buyerId": "9d78ac05-038b-49c0-a35c-6295669138d8"
}

Retrieve Supplier Risk Assessments

You can retrieve one supplier assessment using the following request by adding the supplier risk assessment id.

curl -L \
  --url 'https://api.tradeaware.live-eo.com/supplier-risk-assessments/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: */*'

If we take the previous example, this will give us the following response:

{
  "id": "22cd2eab-ce2a-47e3-9dad-aae40735711c",
  "status": "UNDER_REVIEW",
  "notes": "I have the data now and we can start to investigate.",
  "createdAt": "2025-05-13T15:13:48.801Z",
  "updatedAt": "2025-05-13T15:18:01.173Z",
  "supplierId": "1cdaa481-2136-4b4d-b2cc-e996a49c24d0",
  "buyerId": "9d78ac05-038b-49c0-a35c-6295669138d8"
}

You can also retrieve all supplier assessments by using the following request:

curl -L \
  --url 'https://api.tradeaware.live-eo.com/supplier-risk-assessments' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: */*'

This will return all current supplier risk assessments in one go.

Retrieve the History

The previous examples only show the existing status and note but you can retrieve the full history by using the id for a supplier assessment with the following request:

curl -L \
  --url 'https://api.tradeaware.live-eo.com/supplier-risk-assessments/{id}/history' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: */*'

Using the previous example, this will return the following:

[
  {
    "entityId": "22cd2eab-ce2a-47e3-9dad-aae40735711c",
    "changedByUserType": "M2M",
    "changedByUser": null,
    "action": "CREATE",
    "changedAt": "2025-05-13T15:13:48.815Z",
    "beforeData": null,
    "afterData": {
      "id": "22cd2eab-ce2a-47e3-9dad-aae40735711c",
      "status": "NEW",
      "notes": "Still providing information",
      "createdAt": "2025-05-13T15:13:48.801Z",
      "updatedAt": "2025-05-13T15:13:48.801Z",
      "supplierId": "1cdaa481-2136-4b4d-b2cc-e996a49c24d0",
      "buyerId": "9d78ac05-038b-49c0-a35c-6295669138d8"
    }
  },
  {
    "entityId": "22cd2eab-ce2a-47e3-9dad-aae40735711c",
    "changedByUserType": "M2M",
    "changedByUser": null,
    "action": "UPDATE",
    "changedAt": "2025-05-13T15:18:01.176Z",
    "beforeData": {
      "id": "22cd2eab-ce2a-47e3-9dad-aae40735711c",
      "status": "NEW",
      "notes": "Still providing information",
      "createdAt": "2025-05-13T15:13:48.801Z",
      "updatedAt": "2025-05-13T15:13:48.801Z",
      "supplierId": "1cdaa481-2136-4b4d-b2cc-e996a49c24d0",
      "buyerId": "9d78ac05-038b-49c0-a35c-6295669138d8"
    },
    "afterData": {
      "id": "22cd2eab-ce2a-47e3-9dad-aae40735711c",
      "status": "UNDER_REVIEW",
      "notes": "I have the data now and we can start to investigate.",
      "createdAt": "2025-05-13T15:13:48.801Z",
      "updatedAt": "2025-05-13T15:18:01.173Z",
      "supplierId": "1cdaa481-2136-4b4d-b2cc-e996a49c24d0",
      "buyerId": "9d78ac05-038b-49c0-a35c-6295669138d8"
    }
  }
]

Risk Assessment for Plots

You can perform the same actions for plots as for suppliers using the requests below.

Plot risk assessments can have the following statuses in addition to notes:

  • New - The default status when a plot is first added.

  • Under review - When you have started looking at the data associated with the plot.

  • In risk mitigation - Where a risk assessment has been completed and risk mitigation actions are ongoing for the plot

  • EUDR compliant - Where a plot has been assessed as being compliant with EUDR.

  • EUDR non-compliant - Where a plot has been assessed as being non-compliant with EUDR.

Create a Plot Risk Assessment

You can create a risk assessment for a plot with following request. To do this you will need to include the plotId in the request you want to create.

curl -L \
  --request POST \
  --url 'https://api.tradeaware.live-eo.com/plots/{plotId}/plot-risk-assessments' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "NEW",
    "notes": "text"
  }'

Both the status and notes are optional allowing you to add notes without changing the status and also to update the status without notes. By default the status is "NEW". Other status options are UNDER_REVIEW, IN_RISK_MITIGATION, EUDR_COMPLIANT and EUDR_NON_COMPLIANT

Update a Plot Risk Assessment

Likewise, you can update a plot risk assessment with the following request using the plot risk assessment id:

curl -L \
  --request PATCH \
  --url 'https://api.tradeaware.live-eo.com/plot-risk-assessments/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "NEW",
    "notes": "text"
  }'

Retrieve Plot Risk Assessments

You can retrieve one plot assessment using the following request by adding the plot risk assessment id.

curl -L \
  --url 'https://api.tradeaware.live-eo.com/plot-risk-assessments/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: */*'

You can also retrieve all plot assessments by using the following request:

curl -L \
  --url 'https://api.tradeaware.live-eo.com/plot-risk-assessments' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: */*'

Retrieve the history

You can retrieve the history of changes for a plot assessment with the following request using the plot risk assessment id:

curl -L \
  --url 'https://api.tradeaware.live-eo.com/plot-risk-assessments/{id}/history' \
  --header 'Authorization: Bearer JWT' \
  --header 'Accept: */*'

⚠️