{"id":13878784,"url":"https://github.com/gocardless/creditsafe-ruby","last_synced_at":"2026-04-02T02:47:55.417Z","repository":{"id":33669514,"uuid":"37322143","full_name":"gocardless/creditsafe-ruby","owner":"gocardless","description":"Ruby library for the Creditsafe SOAP API","archived":false,"fork":false,"pushed_at":"2023-08-02T14:54:33.000Z","size":200,"stargazers_count":5,"open_issues_count":2,"forks_count":12,"subscribers_count":84,"default_branch":"master","last_synced_at":"2025-04-06T10:03:22.772Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gocardless.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2015-06-12T13:02:24.000Z","updated_at":"2024-01-12T18:05:20.000Z","dependencies_parsed_at":"2024-01-13T20:39:54.372Z","dependency_job_id":"f1f229bc-9ed8-4249-a154-81e2e7c458ff","html_url":"https://github.com/gocardless/creditsafe-ruby","commit_stats":{"total_commits":151,"total_committers":21,"mean_commits":7.190476190476191,"dds":0.7350993377483444,"last_synced_commit":"477148ddfc0308ed08d793f4c9e00e2da92b0af4"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fcreditsafe-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fcreditsafe-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fcreditsafe-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fcreditsafe-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gocardless","download_url":"https://codeload.github.com/gocardless/creditsafe-ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248381716,"owners_count":21094525,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-06T08:01:59.916Z","updated_at":"2026-04-02T02:47:55.238Z","avatar_url":"https://github.com/gocardless.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# creditsafe-ruby\n\n*Build status: [![Circle CI](https://circleci.com/gh/gocardless/creditsafe-ruby.svg?style=svg\u0026circle-token=3f6e9b24fcc6a57abac110c59395b36032f156a5)](https://circleci.com/gh/gocardless/creditsafe-ruby)*\n\nA ruby library for interacting with the\n[Creditsafe API](https://www.creditsafe.com/gb/en/enterprise/integrations/company-data-api.html).\n\nCurrently, it only partially implements the API to support finding companies by\nregistration number (and name in Germany), and retrieving company online reports.\n\n# Installation\n\nInstall the gem from RubyGems.org by adding the following to your `Gemfile`:\n\n```ruby\ngem 'creditsafe', '~\u003e 0.4.0'\n```\n\nJust run `bundle install` to install the gem and its dependencies.\n\n# Usage\n\nInitialise the client with your `username` and `password`.\n\n```ruby\nclient = Creditsafe::Client.new(username: \"foo\", password: \"bar\")\n\n# optionally with environment (live is default) and or log level\nclient = Creditsafe::Client.new(username: \"foo\", password: \"bar\", environment: :test, log_level: :debug)\n```\n\n### Company Search\n\nTo perform a search for a company, you need to provide a valid search criteria, including\nthe country code and a company registration number or company name:\n\n```ruby\nclient.find_company({ country_code: \"GB\", registration_number: \"07495895\" })\n=\u003e {\n    name: \"GOCARDLESS LTD\",\n    type: \"Ltd\",\n    status: \"Active\",\n    registration_number: \"07495895\",\n    address: {\n        simple_value: \"338-346, GOSWELL, LONDON\",\n        postal_code: \"EC1V7LQ\"\n    },\n    available_report_types: { available_report_type: \"Full\" },\n    available_languages: { available_language: \"EN\" },\n    @date_of_latest_accounts: \"2014-01-31T00:00:00Z\",\n    @online_reports: \"true\",\n    @monitoring: \"false\",\n    @country: \"GB\",\n    @id: \"GB003/0/07495895\"\n   }\n```\n\nIn Germany you can also perform a name search. For this you need to provide a country code\nand a company name, and can optionally provide a postal code or city to filter the results\nfurther:\n\n```ruby\nclient.find_company({ country_code: \"DE\", company_name: \"zalando\", postal_code: \"10243\" })\n=\u003e [\n  {\n    \"name\": \"Zalando Logistics Süd SE \u0026 Co. KG\",\n    \"type\": \"NonLtd\",\n    \"status\": \"Active\",\n    \"address\": {\n      \"street\": \"Tamara-Danz-Str. 1\",\n      \"city\": \"Berlin\",\n      \"postal_code\": \"10243\"\n    },\n    \"available_report_types\": {\n      \"available_report_type\": [\n        \"Full\",\n        \"Basic\"\n      ]\n    },\n    \"available_languages\": {\n      \"available_language\": [\n        \"EN\",\n        \"DE\"\n      ]\n    },\n    \"@online_reports\": \"true\",\n    \"@monitoring\": \"true\",\n    \"@country\": \"DE\",\n    \"@id\": \"DE001/1/DE20316785\",\n    \"@safe_number\": \"DE20316785\"\n  },\n  {\n    \"name\": \"Zalando Outlet Store Berlin\",\n    \"type\": \"NonLtd\",\n    \"status\": \"Active\",\n    \"address\": {\n      \"street\": \"Köpenicker Str. 20\",\n      \"city\": \"Berlin\",\n      \"postal_code\": \"10997\"\n    },\n    \"available_report_types\": {\n      \"available_report_type\": [\n        \"Full\",\n        \"Basic\"\n      ]\n    },\n    \"available_languages\": {\n      \"available_language\": [\n        \"EN\",\n        \"DE\"\n      ]\n    },\n    \"@online_reports\": \"true\",\n    \"@monitoring\": \"true\",\n    \"@country\": \"DE\",\n    \"@id\": \"DE001/1/DE16031795\",\n    \"@safe_number\": \"DE16031795\"\n  },\n  ...\n]\n```\n\nIn some countries you can also perform a VAT number search. For this, you need to provide\na country code and a VAT number:\n\n```ruby\nclient.find_company({ country_code: \"US\", vat_number: \"201665019\" })\n=\u003e [\n  {\n    \"name\": \"FACEBOOK, INCORPORATED\",\n    \"officeType\": \"HeadOffice\",\n    \"status\": \"Active\",\n    \"registration_number\": \"0883875\",\n    \"vat_number\": \"201665019\",\n    \"address\": {\n      \"simple_value\": \"1601 WILLOW ROAD , MENLO PARK, CA, 94025\",\n      \"street\": \"1601 WILLOW ROAD \",\n      \"city\": \"MENLO PARK\",\n      \"postal_code\": \"94025\",\n      \"province\": \"CA\"\n    },\n    \"phone_number\": \"6505434800\",\n    \"available_report_types\": {\n      \"available_report_type\": \"Full\"\n    },\n    \"available_languages\": {\n      \"available_language\": \"EN\"\n    },\n    \"@online_reports\": \"true\",\n    \"@monitoring\": \"false\",\n    \"@country\": \"US\",\n    \"@id\": \"US023/X/US22964593\",\n    \"@safe_number\": \"US22964593\"\n  },\n  ...\n]\n```\n\n### Company Report\n\nTo download all the information available in an online company report, you will\nneed the company's Creditsafe identifier (obtainable using\n[find_company](#find_company) above):\n\n```ruby\nclient.company_report(\"GB003/0/07495895\")\n=\u003e {\n    ...\n   }\n```\n\n\n---\n\nGoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/jobs#software-engineer).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgocardless%2Fcreditsafe-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgocardless%2Fcreditsafe-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgocardless%2Fcreditsafe-ruby/lists"}