Check a carrier's consent

Purpose: Use this API to find out if your company is associated with the carrier to has all the necessary permissions to fetch their data.

This endpoint is primarily used by the brokers or by the third-party agents to determine if they have the consent of the carriers for data sharing. This is to ensure that they are aligned with proper data-sharing agreements and legal compliances.

📘

NOTE

If the response for this endpoint is true, then it means that the you have the consent of the carrier for data-sharing. If the response is false, then it means that you do not have the required permissions. It is recommended to procure the permissions first and then proceed to data fetching or data sharing.

require 'uri'
require 'net/http'

url = URI('https://api.gomotive.com/v1/freight_visibility/company_associated')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request['Authorization'] = "Bearer <OAUTH_TOKEN>"

response = http.request(request)
puts response.read_body

Response Parameters

company_associated

  • Type: Boolean
  • Description: If the response for this endpoint is true, then it means that the you have the consent of the carrier for data-sharing. If the response is false, then it means that you do not have the required permissions. It is recommended to procure the permissions first and then proceed to data fetching or data sharing.

Language
Credentials
Header
Click Try It! to start a request and see the response here!