{"id":20290620,"url":"https://github.com/gocardless/callcredit-ruby","last_synced_at":"2025-04-11T11:02:15.383Z","repository":{"id":13862798,"uuid":"16560599","full_name":"gocardless/callcredit-ruby","owner":"gocardless","description":"Ruby wrapper for Callcredit's CallValidate API","archived":false,"fork":false,"pushed_at":"2021-08-02T06:00:35.000Z","size":144,"stargazers_count":6,"open_issues_count":4,"forks_count":3,"subscribers_count":102,"default_branch":"master","last_synced_at":"2025-04-06T10:03:23.001Z","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","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-02-05T22:18:50.000Z","updated_at":"2019-10-11T09:59:12.000Z","dependencies_parsed_at":"2022-07-11T00:00:29.221Z","dependency_job_id":null,"html_url":"https://github.com/gocardless/callcredit-ruby","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fcallcredit-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fcallcredit-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fcallcredit-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fcallcredit-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gocardless","download_url":"https://codeload.github.com/gocardless/callcredit-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-11-14T15:08:30.046Z","updated_at":"2025-04-11T11:02:15.346Z","avatar_url":"https://github.com/gocardless.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Callcredit Ruby Client Library\n\nSimple Ruby Gem for interacting with Callcredit's CallValidate API. Wraps the\nXML submissions and responses required so you can deal with Ruby hashes\ninstead.\n\n[![Gem Version](https://badge.fury.io/rb/callcredit.svg)](http://badge.fury.io/rb/callcredit)\n[![Build Status](https://travis-ci.org/gocardless/callcredit-ruby.svg?branch=master)](https://travis-ci.org/gocardless/callcredit-ruby)\n\n## This gem is no longer maintained\n\nAs of March 2018, this library is no longer actively maintained.\n\nThe input XSD schema and sample responses have also been removed, since they are\nconsidered confidential by Callcredit. As a result, the automated RSpec tests\nare incomplete as they depended on these fixtures.\n\n## Usage\n\n### Installation\n\nYou don't need this source code unless you want to modify the gem.\n\nIf you just want to use it, you should just add it to your `Gemfile`:\n\n```ruby\ngem 'callcredit', '~\u003e 1.0.0'\n````\n\n### Initialising the gem\n\nRequires your Callcredit credentials. If you don't have any, you'll need to\ncall the sales team at [Callcredit](http://callcredit.co.uk).\n\n```ruby\nCallcredit.configure do |config|\n  config[:company]          = YOUR_COMPANY_NAME\n  config[:username]         = YOUR_USERNAME\n  config[:password]         = YOUR_PASSWORD\n  config[:application_name] = YOUR_APPLICATION_NAME\n  config[:api_endpoint]     = YOUR_API_ENDPOINT\nend\n```\n\n### Performing checks\n\n#### Standard AML checks\nTo perform an IDEnhanced check (the standard AML check) use:\n\n```ruby\nCallcredit.id_enhanced_check(first_name: \"Grey\", last_name: \"Baker\")\n```\n\nThe library will raise an error if you're missing any of the required\nparameters (first_name, last_name, date_of_birth, building_number and\npostcode).\n\n#### BankStandard check\n\nTo perform a BankStandard check use:\n\n```ruby\nCallcredit.bank_standard_check(account_number: \"44779911\", sort_code: \"200000\")\n```\n\nThe library will raise an error unless you provide both account_number and sort_code.\n\n#### BankEnhanced check\n\nTo perform a BankEnhanced check use:\n\n```ruby\nCallcredit.bank_enhanced_check(first_name: \"Tim\", last_name: \"Rogers\", postcode: \"EC1V 7LQ\", account_number: \"44779911\", sort_code: \"200000\", building_number: \"338-346\")\n```\n\nThe library will raise an error if you're missing any of the required\nparameters (first_name, last_name, building_number, postcode, account_number\nand sort_code).\n\n#### Other checks\n\nFor any other check, simply pass the name of the check you'd like to perform\ninto the `perform_check` method, along with details of the individual you're\nchecking.\n\n```ruby\ndata_hash = { personal_data: { first_name: \"Grey\", last_name: \"Baker\" } }\nCallcredit.perform_check(:id_enhanced, data_hash)\n```\n\nIf you'd like to perform multiple checks at once you can pass an array of\nchecks.\n\n```ruby\ndata_hash = { personal_data: { first_name: \"Grey\", last_name: \"Baker\" } }\nCallcredit.perform_check([:id_enhanced, :credit_score], data_hash)\n```\n\n### Parsing responses\n\nUnless you've set the \"raw\" argument to true in your config, checks called by\nname return a `Response` object and checks called using the generic\n`perform_check` method return a hash.\n\n```ruby\nCallcredit.id_enhanced_check(...)              # =\u003e Callcredit::Response\n\nCallcredit.id_enhanced_check(...).input        # =\u003e Hash of input params, as\n                                               #    returned by Callcredit\n\nCallcredit.id_enhanced_check(...).result       # =\u003e Hash of results, mapping\n                                               #    a check type to its results\n\nCallcredit.id_enhanced_check(...).full_result  # =\u003e Hash of the full XML body\n                                               #    returned by Callcredit\n\nCallcredit.perform_check(...)                  # =\u003e Hash of the full XML body\n                                               #    returned by Callcredit\n```\n\nSet the \"raw\" argument to true if you need the full, unprocessed response\n(including headers, etc.).\n\n```ruby\nCallcredit.config[:raw] = true\n\nCallcredit.id_enhanced_check(...)              # =\u003e Faraday::Response object\n```\n\n---\n\nGoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/about/jobs).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgocardless%2Fcallcredit-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgocardless%2Fcallcredit-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgocardless%2Fcallcredit-ruby/lists"}