API Documentation — version 1

Vendors

Sample API URLs

To get all vendors:

https://{your-site}.vendorrisk.com/api/v1/vendors.xml?token={api_key}

XML output:


<vendors>
  <vendor>
    [see fields below]
  </vendor>
  <vendor>
    [see fields below]
  </vendor>
</vendors>

To get a specific vendor:

https://{your-site}.vendorrisk.com/api/v1/vendors/sample-vendor.xml?token={api_key}

XML output:


<vendor>
  <name>Sample Vendor</name>
  <user>John Doe</user>
  <main_phone>(888) 999-9999</main_phone>
  <url>http://www.example.com</url>
  <address_1>PO Box 123</address_1>
  <address_2>456 Main St.</address_2>
  <city>Quahog</city>
  <state>RI</state>
  <region></region>
  <country>US</country>
  <postal>12345</postal>
  <watchlist>Yes</watchlist>
  <watchlist_reason>Spotty 3G coverage in major sales territories</watchlist_reason>
  <watchlist_mitigation>Switch providers</watchlist_mitigation>
  <ofac>Yes</ofac>
  <insider>No</insider>
  <iap>No</iap>
  <risk_level>Low</risk_level>
  <review_frequency>Quarterly</review_frequency>
  <permalink>sample-vendor</permalink>
  <created_at>11/30/2009 8:00 PM</created_at>
  <updated_at>01/04/2010 8:00 PM</updated_at>
</vendor>