creditsafe-ruby

Build status:

A ruby library for interacting with the Creditsafe API.

Currently, it only partially implements the API to support finding companies by registration number (and name in Germany), and retrieving company online reports.

Installation

Install the gem from RubyGems.org by adding the following to your Gemfile:

gem 'creditsafe', '~> 0.4.0'

Just run bundle install to install the gem and its dependencies.

Usage

Initialise the client with your username and password.

client = Creditsafe::Client.new(username: "foo", password: "bar")

# optionally with environment (live is default) and or log level
client = Creditsafe::Client.new(username: "foo", password: "bar", environment: :test, log_level: :debug)

Company Search

To perform a search for a company, you need to provide a valid search criteria, including the country code and a company registration number or company name:

client.find_company({ country_code: "GB", registration_number: "07495895" })
=> {
    name: "GOCARDLESS LTD",
    type: "Ltd",
    status: "Active",
    registration_number: "07495895",
    address: {
        simple_value: "338-346, GOSWELL, LONDON",
        postal_code: "EC1V7LQ"
    },
    available_report_types: { available_report_type: "Full" },
    available_languages: { available_language: "EN" },
    @date_of_latest_accounts: "2014-01-31T00:00:00Z",
    @online_reports: "true",
    @monitoring: "false",
    @country: "GB",
    @id: "GB003/0/07495895"
   }

In Germany you can also perform a name search. For this you need to provide a country code and a company name, and can optionally provide a postal code or city to filter the results further:

client.find_company({ country_code: "DE", company_name: "zalando", postal_code: "10243" })
=> [
  {
    "name": "Zalando Logistics Süd SE & Co. KG",
    "type": "NonLtd",
    "status": "Active",
    "address": {
      "street": "Tamara-Danz-Str. 1",
      "city": "Berlin",
      "postal_code": "10243"
    },
    "available_report_types": {
      "available_report_type": [
        "Full",
        "Basic"
      ]
    },
    "available_languages": {
      "available_language": [
        "EN",
        "DE"
      ]
    },
    "@online_reports": "true",
    "@monitoring": "true",
    "@country": "DE",
    "@id": "DE001/1/DE20316785",
    "@safe_number": "DE20316785"
  },
  {
    "name": "Zalando Outlet Store Berlin",
    "type": "NonLtd",
    "status": "Active",
    "address": {
      "street": "Köpenicker Str. 20",
      "city": "Berlin",
      "postal_code": "10997"
    },
    "available_report_types": {
      "available_report_type": [
        "Full",
        "Basic"
      ]
    },
    "available_languages": {
      "available_language": [
        "EN",
        "DE"
      ]
    },
    "@online_reports": "true",
    "@monitoring": "true",
    "@country": "DE",
    "@id": "DE001/1/DE16031795",
    "@safe_number": "DE16031795"
  },
  ...
]

In some countries you can also perform a VAT number search. For this, you need to provide a country code and a VAT number:

client.find_company({ country_code: "US", vat_number: "201665019" })
=> [
  {
    "name": "FACEBOOK, INCORPORATED",
    "officeType": "HeadOffice",
    "status": "Active",
    "registration_number": "0883875",
    "vat_number": "201665019",
    "address": {
      "simple_value": "1601 WILLOW ROAD , MENLO PARK, CA, 94025",
      "street": "1601 WILLOW ROAD ",
      "city": "MENLO PARK",
      "postal_code": "94025",
      "province": "CA"
    },
    "phone_number": "6505434800",
    "available_report_types": {
      "available_report_type": "Full"
    },
    "available_languages": {
      "available_language": "EN"
    },
    "@online_reports": "true",
    "@monitoring": "false",
    "@country": "US",
    "@id": "US023/X/US22964593",
    "@safe_number": "US22964593"
  },
  ...
]

Company Report

To download all the information available in an online company report, you will need the company's Creditsafe identifier (obtainable using find_company above):

client.company_report("GB003/0/07495895")
=> {
    ...
   }

GoCardless ♥ open source. If you do too, come join us.