NAV
curl

API Reference

The ThirdPartyTrust API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.

API Endpoint

https://app.thirdpartytrust.com/api/

Authentication

Example Request

curl
  https://app.thirdpartytrust.com/api/auth \
  -d user=demo@mycompany.com \
  -d password=mypassword

Example Response

{
  "access_token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

HTTP Request

POST https://app.thirdpartytrust.com/api/auth

POST Parameters

Parameter Description
user A registered username or email address
password The corresponding password for the user

Company

All company info

Fetches all company info for the logged in user.

Example Request

curl
  https://app.thirdpartytrust.com/api/companyinfo \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Example Response

{
  "tech_contact_last_name":"Harris",
  "domain":"mycompany.com",
  "business_phone_number":"7675987887",
  "risk_committee":true,
  "year_founded":"1999",
  "company_logo_url":"https://mycompany.com/logo.png",
  "tech_phone_number":"9982234444",
  "postal_code":"60181",
  "incorp_state":"IL",
  "it_budget":"2M_4.9M",
  "it_sec_staff":"14",
  "tech_email":"elizabethharris@mycompany.com",
  "business_fax_number":"",
  "uuid":"f23f5ecc-e88b-41db-9266-7e8229200573",
  "business_contact_first_name":"fsak",
  "user_info":{
    "first_name":"Johnny",
    "last_name":"Appleseed",
    "uuid":"dbd174cd-df74-491b-96de-1e053cf20780",
    "email":"demo_user@mycompany.com",
    "isActive":true,
    "job_title":"Demo"
  },
  "state":"IL",
  "company_logo":"",
  "tech_contact_first_name":"Elizabeth",
  "public":false,
  "isCompanySetup":true,
  "website":"mycompany.com",
  "company_legal_name":"My Company",
  "description":"Company Description",
  "city":"Oakbrook Terrace",
  "no_employees":"100_499",
  "address1":"2 Mid America Plz",
  "address2":" Ste 201",
  "it_staff":"15",
  "business_email":"test@testfake.com",
  "trust_score":55,
  "packages":[
    {
      "name":"Standard Vendor Plan",
      "price":199.99,
      "uuid":"3d3c9823-73hfjs-asdjrndi2-a27c-bbb49rhjs-1ks",
      "code_name":"STDVNDPL",
      "description":"The Standard Vendor Plan is a special plan offering to securely connect and share your data with your partners."
    }
  ],
  "ticker":"myco",
  "isActive":true,
  "isTest":true,
  "name":"My Company",
  "country":"US",
  "industry":"Health Care/Hospital/Medical Center/Retirement Home",
  "org_type":"c_corp",
  "ciso":true,
  "annual_revenue":"Undisclosed",
  "business_contact_last_name":"lastname",
  "it_sec_budget":"2M_4.9M",
  "tech_fax_number":"5126781768"
}

HTTP Request

GET https://app.thirdpartytrust.com/api/companyinfo

Query Parameters

None

Users

All Users

Fetches all the users as part of the company along with their role.

Example Request

curl
  https://app.thirdpartytrust.com/api/admin/users \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Example Response

{
"first_name": "Thomas",
"last_name": "Jefferson", 
"uuid": "7301af3b-abcf-4561-80c3-eee877e1a22c", 
"role": null, 
"email": "demo_user@anthem.com", 
"isActive": true
}

HTTP Request

GET https://app.thirdpartytrust.com/api/admin/users

Query Parameters

None

Reporting

All reporting data

Fetches all reporting data for the company of the logged in user.

Example Request

curl
  https://app.thirdpartytrust.com/api/reporting/everything \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Example Response

{
  "upcoming_vendor_reviews":[
    {
      "company_legal_name":"Indiana, Anthem Blue Cross Blue Shield",
      "domain":"bcbsms.com",
      "name":"Indiana, Anthem Blue Cross Blue Shield",
      "tier_score":42,
      "trust_score":37.5,
      "created_on":"2016-02-22 23:32:06",
      "risk_score":71.0,
      "next_review_date":"2016-01-31 00:00:00",
      "state":null,
      "country_code":null,
      "industry":null,
      "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b"
    }
  ],
  "newest_vendors":[
    {
      "company_legal_name":"Anthem Blue Cross",
      "domain":"anthem.com",
      "name":"California, Anthem Blue Cross",
      "tier_score":50,
      "trust_score":100.0,
      "created_on":"2016-02-24 21:11:46",
      "risk_score":25.0,
      "next_review_date":"2018-02-26 00:00:00",
      "state":"IL",
      "country_code":"AF",
      "industry":"Health Care/Hospital/Medical Center/Retirement Home",
      "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b"
    }
  ],
  "tier_vs_trust":[
    {
      "industry":"Health Care/Hospital/Medical Center/Retirement Home",
      "data":[
        [100, 87.5],
        [59, 87.5],
        [59, 87.5],
        [75, 100.0],
        [26, 87.5],
        [26, 87.5],
        [50, 100.0],
        [59, 87.5]
      ]
    },
    {
      "industry":"Not Specified",
      "data":[
        [75, 82.5],
        [42, 37.5],
        [59, 95.0]
      ]
    }
  ],
  "vendor_population_by_country":[
    {
      "code":"US",
      "value":5
    },
    {
      "code":"CA",
      "value":1
    },
    {
      "code":"AF",
      "value":1
    }
  ],
  "tier_percentiles":{
    "21-30":2,
    "71-80":2,
    "11-20":0,
    "81-90":0,
    "41-50":2,
    "1-10":0,
    "31-40":0,
    "61-70":0,
    "51-60":4,
    "91-100":1
  },
  "riskiest_vendors":[
    {
      "company_legal_name":"Indiana, Anthem Blue Cross Blue Shield",
      "domain":"bcbsms.com",
      "name":"Indiana, Anthem Blue Cross Blue Shield",
      "tier_score":42,
      "trust_score":37.5,
      "created_on":"2016-02-22 23:32:06",
      "risk_score":71.0,
      "next_review_date":"2016-01-31 00:00:00",
      "state":null,
      "country_code":null,
      "industry":null,
      "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b"
    }
  ],
  "vendor_assessment_status_by_range":{
    "Re-Approval in 30-90 days":3,
    "Re-Approval in 30 days":3,
    "Approved":4,
    "Pending":1
  },
  "trust_score":55.0,
  "trust_percentiles":{
    "21-30":0,
    "71-80":0,
    "11-20":0,
    "81-90":7,
    "41-50":0,
    "1-10":0,
    "31-40":1,
    "61-70":0,
    "51-60":0,
    "91-100":3
  },
  "trust_score_average":85.45454545454545
}

HTTP Request

GET https://app.thirdpartytrust.com/api/reporting/everything

Query Parameters

None

Connections

All company connections

Fetches all connnection data for the company of the logged in user

Example Request

curl
  https://app.thirdpartytrust.com/api/connections \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Example Response

[
  {
    "company":{
      "website":"premera.com",
      "company_legal_name":"Alaska, Premera Blue Cross Blue Shield",
      "domain":"premera.com",
      "name":"Alaska, Premera Blue Cross Blue Shield",
      "generic":{
        "description":"words",
        "relationship_date":"2016-03-02 00:00:00",
        "approval_date":"2016-02-04 00:00:00",
        "departments":[
          "management"
        ],
        "approval_boolean":true,
        "connection_date":"2016-02-22T23:32:03.663268"
      },
      "tier_score":100,
      "trust_score":87.5,
      "next_review_date":"2026-02-01 00:00:00",
      "logo":"base64-string",
      "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b"
    },
    "incoming":{
      "secondary_uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
      "primary_uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
      "created_on":"2016-02-22 23:32:03",
      "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b"
    },
    "outgoing":null
  },
  {
    "company":{
      "website":"arkbluecross.com",
      "company_legal_name":"Arizona, Blue Cross and Blue Shield",
      "domain":"arkbluecross.com",
      "name":"Arizona, Blue Cross and Blue Shield",
      "generic":{
        "approval_boolean":false,
        "connection_date":"2016-02-22T23:32:04.136505",
        "approval_date":"2016-01-23 00:00:00",
        "departments":[
          "quality_assurance"
        ]
      },
      "tier_score":59,
      "trust_score":87.5,
      "next_review_date":" ",
      "logo":"base64-string",
      "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b"
    },
    "incoming":{
      "secondary_uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
      "primary_uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
      "created_on":"2016-02-22 23:32:04",
      "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b"
    },
    "outgoing":null
  }
]

HTTP Request

GET https://app.thirdpartytrust.com/api/connections

Query Parameters

None

Outgoing connection requests

Fetch all outgoing connection request information for the company of the currently logged in user.

Example Request

curl
  https://app.thirdpartytrust.com/api/connections/requests/outgoing \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Example Response

[  
  {  
    "status":"pending",
    "from_company":{  
      "company_legal_name":"BCSF",
      "domain":"bcsf.com",
      "description":"Company Description",
      "name":"BCS Financial",
      "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b"
    },
    "from_user_uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
    "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
    "to_user_uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
    "to_company":{  
      "company_legal_name":"ThirdPartyTrust",
      "domain":"thirdpartytrust.com",
      "description":"Intrust",
      "name":"thirdpartytrust",
      "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b"
    },
    "primary_uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
    "request_type":"view",
    "to_user":{  
      "title":null,
      "first_name":"Adam",
      "last_name":"Moore",
      "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
      "email":"adam@thirdpartytrust.com"
    },
    "created_on":"2016-03-11 21:39:45",
    "from_user":{  
      "title":null,
      "first_name":"Johnny",
      "last_name":"Appleseed",
      "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
      "email":"demo_user@bcsf.com"
    },
    "message":"test123456",
    "secondary_uuid":"3325139b-4fb3-45e6-804b-07ee8643717b"
  }
]

HTTP Request

GET https://app.thirdpartytrust.com/api/connections/requests/outgoing

Query Parameters

None

Incoming connection requests

Fetch all incoming connection request information for the company of the currently logged in user.

Example Request

curl
  https://app.thirdpartytrust.com/api/connections/requests/incoming \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

HTTP Request

GET https://app.thirdpartytrust.com/api/connections/requests/incoming

Query Parameters

None

Outgoing share requests

Fetch all outgoing share request information for the company of the currently logged in user.

Example Request

curl
  https://app.thirdpartytrust.com/api/connections/shares/outgoing \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

HTTP Request

GET https://app.thirdpartytrust.com/api/connections/requests/incoming

Query Parameters

None

Incoming share requests

Fetch all incoming share request information for the company of the currently logged in user.

Example Request

curl
  https://app.thirdpartytrust.com/api/connections/shares/incoming \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

HTTP Request

GET https://app.thirdpartytrust.com/api/connections/requests/incoming

Query Parameters

None

Assurance Programs

Certifications

Fetch all certification information for the company of the currently logged in user.

Example Request

curl
  https://app.thirdpartytrust.com/api/assurance/certifications \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

HTTP Request

GET https://app.thirdpartytrust.com/api/assurance/certifications

Query Parameters

None

Certifications {uuid}

Fetch a single certification’s information by certification uuid.

Example Request

curl
  https://app.thirdpartytrust.com/api/assurance/certifications/3325139b-4fb3-45e6-804b-07ee8643717b \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

HTTP Request

GET https://app.thirdpartytrust.com/api/assurance/certifications/{uuid}

Query Parameters

None

URL Parameters

Parameter Description
uuid The uuid of the certification

Certifications Available

Fetch all information on certifications that are available to the company of the currently logged in user.

Example Request

curl
  https://app.thirdpartytrust.com/api/assurance/certifications/available \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

HTTP Request

GET https://app.thirdpartytrust.com/api/assurance/certifications/available

Query Parameters

None

Insurance

Fetch all insurance information for the company of the currently logged in user.

Example Request

curl
  https://app.thirdpartytrust.com/api/assurance/insurance \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Example Response

[  
  {  
    "@documents":"/assurance/insurance/3325139b-4fb3-45e6-804b-07ee8643717b/documents",
    "name":"Cyber Liability / Data Privacy",
    "modified":{  
      "date":"2016-03-15T21:53:07.219086",
      "name":"Johnny Appleseed"
    },
    "insurance_uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
    "provider":"IBM Security",
    "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b"
  }
]

HTTP Request

GET https://app.thirdpartytrust.com/api/assurance/insurance

Query Parameters

None

Insurance {uuid}

Fetch a single insurance policy’s information by insurance uuid.

Example Request

curl
  https://app.thirdpartytrust.com/api/assurance/insurance/3325139b-4fb3-45e6-804b-07ee8643717b \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Example Response

{  
  "@documents":"/assurance/insurance/3325139b-4fb3-45e6-804b-07ee8643717b/documents",
  "name":"Cyber Liability / Data Privacy",
  "modified":{  
    "date":"2016-03-15T21:53:07.219086",
    "name":"Johnny Appleseed"
  },
  "insurance_uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
  "provider":"IBM Security",
  "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b"
}

HTTP Request

GET https://app.thirdpartytrust.com/api/assurance/insurance/{uuid}

Query Parameters

None

URL Parameters

Parameter Description
uuid The uuid of the insurance

Audits

Fetch all audit information for the company of the currently logged in user.

Example Request

curl
  https://app.thirdpartytrust.com/api/assurance/audits \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Example Response

[  
  {  
    "@documents":"/assurance/audits/3325139b-4fb3-45e6-804b-07ee8643717b/documents",
    "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
    "modified":{  
      "date":"2016-03-02T19:46:18.841455",
      "name":"Johnny Appleseed"
    },
    "audited_on":"2016-02-29",
    "auditor":"Accenture",
    "audit_uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
    "expires_on":null,
    "name":"General Security Audit"
  }
]

HTTP Request

GET https://app.thirdpartytrust.com/api/assurance/audits

Query Parameters

None

Audits {uuid}

Fetch a single audit’s information by audit uuid.

Example Request

curl
  https://app.thirdpartytrust.com/api/assurance/audits/3325139b-4fb3-45e6-804b-07ee8643717b \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Example Response

{  
  "@documents":"/assurance/audits/3325139b-4fb3-45e6-804b-07ee8643717b/documents",
  "uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
  "modified":{  
    "date":"2016-03-02T19:46:18.841455",
    "name":"Johnny Appleseed"
  },
  "audited_on":"2016-02-29",
  "auditor":"Accenture",
  "audit_uuid":"3325139b-4fb3-45e6-804b-07ee8643717b",
  "expires_on":null,
  "name":"General Security Audit"
}

HTTP Request

GET https://app.thirdpartytrust.com/api/assurance/audits/{uuid}

Query Parameters

None

URL Parameters

Parameter Description
uuid The uuid of the audit

Errors

Error Code Meaning
401 Unauthorized – Your Authorization token is incorrect or has expired
403 Forbidden – The entity requested is not accessable
404 Not Found – The specified endpoint could not be found
406 Not Acceptable – The requested data format is not supported
410 Gone – The entity requested has been removed
429 Too Many Requests – The number of requests made has exceeded your assigned limit
500 Internal Server Error – We had a problem with our server. Try again later.
503 Service Unavailable – We’re temporarially offline for maintanance. Please try again later.