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

Notifications

All Notifications

Fetches all notifications that have been received by the company.

Example Request

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

Example Response

{
  "created_on": "2016-09-24 03:38:46",
  "source":
  [
    {
      "feature": "invitation",
      "name": "User Invitation",
      "service": "users",
      "uuid": "76da3afc-a62d-4651-a14c-e6fad828d468"
    }
  ]
}

HTTP Request

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

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 connection 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

Inactive connections

Fetches all inactive connections for the company of the currently logged in user.

Example Request

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

Example Response

[
  {
    "company":
    {
      "website": "bcsf.com",
      "company_legal_name": "BCS Financial",
      "departments": [],
      "domain": "bcsf.com",
      "generic": {
        "connection_date": "2016-05-03T22:45:26.572283",
        "description": ""
      },
      "logo": "/9j/4AAQSkZJRgABAgAAAQABAAD/7Q...",
      "name": "BCS Financial",
      "next_review_date": " ",
      "tier_score": 59,
      "trust_score": "--",
      "uuid": "d0b4b742-7817-40dc-b910-e3f4baee44b8",
      "website": "bcsf.com"
    },
    "incoming": null,
    "outgoing": {
      "created_on": "2016-09-17 23:02:23",
      "manaul": "True",
      "primary_uuid": "d0b4b742-7817-40dc-b910-e3f4baee44b8",
      "secondary_uuid": "75554495-b796-4602-b60a-30bd8149bbf7",
      "type_relation": "secondary_shares_primary",
      "uuid": "ac6ac339-83e1-4eda-b71e-36f4bdc0f2fc"
    }
  }
]

HTTP Request

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

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

Department connections

Fetch all departments that have established connections for the company of the currently logged in user.

Example Request

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

Example Response

{
  "model_name": "Department",
  "name": "Business Development",
  "uuid": "4c99249d-e4fc-49a1-8233-8da8ab59bfcb"
}

HTTP Request

GET https://app.thirdpartytrust.com/api/tier/departments

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

Audits Inventory

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

Example Request

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

Example Response

[
  {
    "code_name": "PT",
    "isActive": "true",
    "isTest": "true",
    "name": "Penetration Test",
    "score_value": "50",
    "uuid": "714571fd-857c-4a00-8ce6-32d249a8e272"
  }
]

HTTP Request

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

Query Parameters

None

Insurance Inventory

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

Example Request

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

Example Response

[
  {
    "insurance_uuid": "498386c8-d4ce-4ba3-88f6-21c2b261f56d",
    "provider": "IBM Security",
    "uuid": "6a2e8ece-59ee-436f-a7ac-07352ec12aac"
  }
]

HTTP Request

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

Query Parameters

None

Questionnaires

Surveys

Fetches survey information for a specified company and survey. This includes optional query parameters for questions, answers, notes, and documents.

Example Request

curl
  https://dev.thirdpartytrust.com/api/questionnaires/companies/f335fe1c-ea8f-49be-afbf-7540f713fb87/surveys/ad246514-1255-4f0e-97cb-1acafdf333cd?joins=categories&joins=questions&joins=documents&joins=answers&joins=notes
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Example Response

 {  
   "categories":[  
      {  
         "name":"Financials",
         "questions":[  
            {  
               "answer":{  
                  "model_name":"AnswerTypeMultiValue",
                  "uuid":"2363fc35-b38f-4142-8718-4479647b43d5",
                  "values":[  
                     {  
                        "answer":"55",
                        "value":"Last Year"
                     },
                     {  
                        "answer":"44",
                        "value":"Current Year"
                     },
                     {  
                        "answer":"66",
                        "value":"Projected next year"
                     },
                     {  
                        "answer":"This was a test",
                        "value":"notes"
                     }
                  ]
               },
               "documents":[  

               ],
               "documents_required":"0",
               "note":{  
                  "note":"This was a test",
                  "uuid":"f61599a0-7e8e-4357-b09e-eae3c9f76791"
               },
               "notes_required":"0",
               "question":"Percentage of annual transactions paid for by debit / credit card:",
               "type":{  
                  "model_name":"QuestionTypeMultiValue",
                  "options":[  
                     {  
                        "uuid":"6bdf401f-44b6-4357-a6f5-5fc8be040f7e",
                        "value":"Last Year",
                        "weight":0
                     },
                     {  
                        "uuid":"f4d5b316-a66c-4cef-a706-b0bd03d25d3b",
                        "value":"Current Year",
                        "weight":0
                     },
                     {  
                        "uuid":"1b2ebf57-be46-440f-82ed-17c9e56695dc",
                        "value":"Projected next year",
                        "weight":0
                     }
                  ],
                  "type":"int",
                  "uuid":"cdc884ea-2de8-4c9a-807b-88dad5a015d6"
               },
               "uuid":"474d8c0e-d718-49d3-8f7f-a5f51b0838c5"
            },
            {  
               "answer":{  
                  "model_name":"AnswerTypeValue",
                  "uuid":"083eff4d-9555-469a-8e05-3061bb2eb95a",
                  "value":"5999999"
               },
               "documents":[  

               ],
               "documents_required":"0",
               "note":{  
                  "note":"",
                  "uuid":"85010cd3-a500-419a-9df2-7665ea530219"
               },
               "notes_required":"0",
               "question":"Gross Annual Revenue",
               "type":{  
                  "model_name":"QuestionTypeMultiValue",
                  "options":[  
                     {  
                        "uuid":"08054f9e-844f-40c7-ae0b-b73cf7f6c8e3",
                        "value":"Annually",
                        "weight":0
                     },
                     {  
                        "uuid":"d1c237d4-b714-449a-8e7d-5af15422f017",
                        "value":"Quarterly",
                        "weight":0
                     },
                     {  
                        "uuid":"9c1ac1ce-e2a3-44d2-8a39-7920b56ddb4d",
                        "value":"Monthly",
                        "weight":0
                     },
                     {  
                        "uuid":"15beb13b-8d0e-427b-8b29-66ec74df80c7",
                        "value":"Other (Specify in Notes)",
                        "weight":0
                     }
                  ],
                  "type":"dollar",
                  "uuid":"cc52f9f0-d989-460d-8e8d-94d05529376c"
               },
               "uuid":"ed39f88c-9167-4aa9-8cef-c69f4c959e9d"
            },
            {  
               "documents":[  

               ],
               "documents_required":"0",
               "notes_required":"0",
               "question":"Annual Net Income before Taxes",
               "type":{  
                  "model_name":"QuestionTypeMultiValue",
                  "options":[  
                     {  
                        "uuid":"6bdf401f-44b6-4357-a6f5-5fc8be040f7e",
                        "value":"Last Year",
                        "weight":0
                     },
                     {  
                        "uuid":"f4d5b316-a66c-4cef-a706-b0bd03d25d3b",
                        "value":"Current Year",
                        "weight":0
                     },
                     {  
                        "uuid":"1b2ebf57-be46-440f-82ed-17c9e56695dc",
                        "value":"Projected next year",
                        "weight":0
                     }
                  ],
                  "type":"int",
                  "uuid":"cdc884ea-2de8-4c9a-807b-88dad5a015d6"
               },
               "uuid":"2ba93ca0-f64a-43c9-8678-8b5f9c03c1a5"
            },
            {  
               "documents":[  

               ],
               "documents_required":"0",
               "notes_required":"0",
               "question":"Split in Revenue clients subject to USA law",
               "type":{  
                  "model_name":"QuestionTypeMultiValue",
                  "options":[  
                     {  
                        "uuid":"6bdf401f-44b6-4357-a6f5-5fc8be040f7e",
                        "value":"Last Year",
                        "weight":0
                     },
                     {  
                        "uuid":"f4d5b316-a66c-4cef-a706-b0bd03d25d3b",
                        "value":"Current Year",
                        "weight":0
                     },
                     {  
                        "uuid":"1b2ebf57-be46-440f-82ed-17c9e56695dc",
                        "value":"Projected next year",
                        "weight":0
                     }
                  ],
                  "type":"int",
                  "uuid":"cdc884ea-2de8-4c9a-807b-88dad5a015d6"
               },
               "uuid":"656032f5-cda7-41cf-b9a9-25684c0b56a7"
            },
            {  
               "documents":[  

               ],
               "question":" Current number of employees:",
               "type":{  
                  "model_name":"QuestionTypeValue",
                  "name":"Value",
                  "options":[  

                  ],
                  "type":"int",
                  "uuid":"3407cb08-efd8-4a5f-b34e-e99d19b1d213"
               },
               "uuid":"861d6800-fb36-47d3-83a7-73e68282a361"
            },
            {  
               "documents":[  

               ],
               "question":"Have you been involved in any mergers/acquisitions within the last three years? If so, were systems integrated?",
               "type":{  
                  "model_name":"QuestionTypeMultipleChoice",
                  "name":"Multiple Choice",
                  "options":[  
                     {  
                        "uuid":"1ceaab56-b737-4520-954a-4a0957816e37",
                        "value":"Yes",
                        "weight":"100"
                     },
                     {  
                        "uuid":"96fbac78-7234-4e88-ac1c-a182854ef69f",
                        "value":"No",
                        "weight":0
                     }
                  ],
                  "uuid":"174afa03-02e7-4a8e-b0fa-e165edae9a35"
               },
               "uuid":"6272e637-15d7-462a-be84-39f0aca9d3c8"
            }
         ],
         "uuid":"caa5e431-a050-4cf3-8fa9-dae1e9b06cf1"
      }
   ],
   "logo":{  
      "url":{  
         "url":"https://s3.amazonaws.com/fileservice2.thirdpartytrust.com/fbd2992d-ad3b-47c4-b211-1cb1d7e89309"
      }
   },
   "name":"Cloud System Questionnaire",
   "questions":"questionnaires/surveys/168f65e7-2f48-49a1-9193-3f9cf3369003/questions",
   "uuid":"168f65e7-2f48-49a1-9193-3f9cf3369003"
}

HTTP Request

GET https://dev.thirdpartytrust.com/api/questionnaires/companies/{companyuuid}/surveys/{surveyuuid}?joins=categories&joins=questions&joins=documents&joins=answers&joins=notes

Query Parameters

None

URL Parameters

Parameter Description
companyuuid The uuid of the company you wish to pull the survey for.
surveyuuid The uuid of the survey you wish to pull the answers for.

Survey Scores

Fetches the survey score information for a specified company.

Example Request

curl
  https://app.thirdpartytrust.com/api/questionnaires/companies/75554495-b796-4602-b60a-30bd8149bbf7/surveys/scores \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Example Response

[
  {
    "score": "79.48717948717949",
    "uuid": "168f65e7-2f48-49a1-9193-3f9cf3369003"
  }
]

HTTP Request

GET https://app.thirdpartytrust.com/api/questionnaires/companies/{uuid}/surveys/scores

Query Parameters

None

URL Parameters

Parameter Description
uuid The uuid of the company you wish to pull the survey score for.

Settings

TrustScore

Fetches TrustScore configuration information for the company of the currently logged in user.

Example Request

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

Example Response

{
  "audit_weight": "20",
  "certification_weight": "20",
  "ciso_weight": "20",
  "insurance_weight": "20",
  "survey_weight": "20",
  "uuid": "7f7f1c4b-ec6e-4bbb-9f09-5422c8b3cfd5"
}

HTTP Request

GET https://app.thirdpartytrust.com/api/company/settings/trustscore

Query Parameters

None

Tier

Fetches tier information for the company of the currently logged in user.

Example Request

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

Example Response

[
  {
    "description": "The volume of sensitive company information the third party will...",
    "model_name": "ReferenceEntity",
    "name": "Volume of Information",
    "owner_uuid": "75554495-b796-4602-b60a-30bd8149bbf7",
    "target_uuid": "16d18eaf-09f9-4903-a672-5b97ec0598cc",
    "uuid": "4250801b-6aa3-4a0a-a386-e2087ba48226",
    "weight": "0"
  }
]

HTTP Request

GET https://app.thirdpartytrust.com/api/company/settings/tier

Query Parameters

None

User Settings

Settings

Fetches settings for the specified user.

Example Request

curl
  https://app.thirdpartytrust.com/api/users/56853932-2516-4f11-b4d4-e3cb9c386618/settings \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Example Response

{
  "setting":
  {
    "start_page": "dashboard",
    "time_zone": "DST"
  },
  "user_uuid": "56853932-2516-4f11-b4d4-e3cb9c386618"
}

HTTP Request

GET https://app.thirdpartytrust.com/api/users/{uuid}/settings

Query Parameters

None

URL Parameters

Parameter Description
uuid The uuid of the user that you want pull settings for

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.