new-vision/duedil

Swagger generated client for DueDil API.

Maintainers

Details

bitbucket.org/hugh-new-vision/duedil-swagger-client

Homepage

Source

Installs: 98

Dependents: 0

Suggesters: 0

Security: 0

1.0.0 2019-09-02 15:50 UTC

Requires

Requires (Dev)

proprietary dc5ee69474c6333ed1f91594ad4626d9361ec5aa

phpapisdkswagger

This package is not auto-updated.

Last update: 2024-04-21 05:47:53 UTC

README

Welcome to the DueDil API v4, which provides programmatic access to DueDil's comprehensive company data. It can be used to enhance a wide variety of business functions, from auto-populating website forms to verifying customer credentials. ### Getting started In order to make requests, you'll need to obtain an API key. Please visit https://www.duedil.com/api for more information. Once you have an API key, requests can be made using a UI such as Postman or via a terminal using curl. An example curl request should look as follows: curl -X GET --header 'Accept: application/json' --header 'X-AUTH-TOKEN: api_key' 'https://duedil.io/v4/company/gb/06999618.json' ### Generating clients This API has been authored using the OpenAPI (Swagger) specification. Being machine readable, it can be used to generate V4 API clients in a range of languages. To create a client: Open the Swagger Editor. Select 'File', 'Import URL' then enter https://duedil.io/v4/swagger.json * Select 'Generate Client' then choose from over 30 languages such as PHP, Python and Java. ### International data DueDil provides a wide range of data spanning across multiple geographic regions. Our international package currently includes company information from the following countries: | Country | | Country | | |----------------------|----|---------------|----| | Albania | AL | Jersey | JE | | Bahamas | BS | Latvia | LV | | Belgium | BE | Liechtenstein | LI | | Bermuda | BM | Luxembourg | LU | | Hong Kong, SAR China | HK | Malta | MT | | Cyprus | CY | Montenegro | ME | | Denmark | DK | Netherlands | NL | | Finland | FI | Norway | NO | | France | FR | Poland | PL | | Germany | DE | Romania | RO | | Greenland | GL | Slovakia | SK | | Guernsey | GG | Slovenia | SI | | Iceland | IS | Sweden | SE | | Isle of Man | IM | Switzerland | CH | | Israel | IL | | | Retrieving international data is simple. Construct your request with the corresponding country code. For the German company Daimler AG you should construct your request URI as follows: curl -X GET --header 'Accept: application/json' --header 'X-AUTH-TOKEN: api_key' 'https://duedil.io/v4/company/de/Stuttgart%20HRB%2019360.json' For Companies search, the country code should be included in the post body: { \"criteria\": { \"name\": \"Daimler AG\", \"countryCodes\": { \"values\": [\"DE\", \"FR\"] } } } Note: You will need to have international access added to your plan to search for and retrieve information for companies outside of the United Kingdom (GB) and Ireland (IE). #### Data coverage While 100% coverage is our goal, this is not feasible for every international country at present. If we cannot find the entity you are requesting, the API will return HTTP 404 with message “Resource not found”. Partial responses can include null fields where specific data is unavailable. ### Pagination All endpoints that return collections can be paginated in the same way through two optional parameters (limit and offset). The offset parameter determines the 0-based index of the first element of the collection to be returned, which defaults to 0. The limit parameter sets the maximum number of items from the collection to be returned, which defaults to 10. The maximum allowed limit parameter is 50. Note: API keys issued for evaluation purposes will have limited access to the first 10 search results only. Other non-search endpoints do not apply this constraint. Every response from a paginated endpoint contains a top-level property called pagination, which in turn contains the offset and limit values used in the API call, as well as the total number of items in the collection. For instance: \"pagination\": { \"offset\": 0, \"limit\": 10, \"total\": 12 } In the example above, an API call with offset = 10 and limit = 10 would return the 11th and 12th items in the collection, whereas an API call with offset = 20 and limit = 10 would return a successful response (200 HTTP code) with an empty collection. Calls with invalid offset/limit parameters, such as negative values, return an error (400 HTTP code).

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 4.5.6
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com//.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: UserSecurity
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-TOKEN', 'Bearer');

$apiInstance = new Swagger\Client\Api\ComplianceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$format = "format_example"; // string | Response format. Currently, only supported option is json.
$callcredit_identity_check = new \Swagger\Client\Model\CallcreditIdentityCheckInput(); // \Swagger\Client\Model\CallcreditIdentityCheckInput | Details about an individual and their address to conduct an identity check.

try {
    $result = $apiInstance->callcreditIdentityCheckFormatPost($format, $callcredit_identity_check);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ComplianceApi->callcreditIdentityCheckFormatPost: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://duedil.io/v4

ClassMethodHTTP requestDescription
ComplianceApicallcreditIdentityCheckFormatPostPOST /callcredit/identity-check.{format}Identity check
ComplianceApiduedilCompanyCheckFormatPostPOST /duedil/company-check.{format}Company check
CreditReportApicompanyCountryCodeCompanyIdCreditReportFormatGetGET /company/{countryCode}/{companyId}/credit-report.{format}Credit report
EssentialsApicharityCountryCodeCharityIdAreasOfActivityFormatGetGET /charity/{countryCode}/{charityId}/areas-of-activity.{format}Charity areas of activity
EssentialsApicharityCountryCodeCharityIdClassifiersFormatGetGET /charity/{countryCode}/{charityId}/classifiers.{format}Charity classifiers
EssentialsApicharityCountryCodeCharityIdFormatGetGET /charity/{countryCode}/{charityId}.{format}Charity vitals
EssentialsApicharityCountryCodeCharityIdRegisteredNamesFormatGetGET /charity/{countryCode}/{charityId}/registered-names.{format}Charity registered names
EssentialsApicharityCountryCodeCharityIdStatusHistoryFormatGetGET /charity/{countryCode}/{charityId}/status-history.{format}Charity status history
EssentialsApicharityCountryCodeCharityIdTrusteesFormatGetGET /charity/{countryCode}/{charityId}/trustees.{format}Charity trustees
EssentialsApicompanyCountryCodeCompanyIdAddressesFormatGetGET /company/{countryCode}/{companyId}/addresses.{format}Company addresses
EssentialsApicompanyCountryCodeCompanyIdCharitableIdentitiesFormatGetGET /company/{countryCode}/{companyId}/charitable-identities.{format}Company charitable identities
EssentialsApicompanyCountryCodeCompanyIdDescriptionsFormatGetGET /company/{countryCode}/{companyId}/descriptions.{format}Company descriptions
EssentialsApicompanyCountryCodeCompanyIdFormatGetGET /company/{countryCode}/{companyId}.{format}Company vitals
EssentialsApicompanyCountryCodeCompanyIdHmrcImportsExportsFormatGetGET /company/{countryCode}/{companyId}/hmrc-imports-exports.{format}Company HMRC imports and exports
EssentialsApicompanyCountryCodeCompanyIdIndustriesFormatGetGET /company/{countryCode}/{companyId}/industries.{format}Company industries
EssentialsApicompanyCountryCodeCompanyIdKeywordsFormatGetGET /company/{countryCode}/{companyId}/keywords.{format}Company keywords
EssentialsApicompanyCountryCodeCompanyIdOfficersFormatGetGET /company/{countryCode}/{companyId}/officers.{format}Company officers
EssentialsApicompanyCountryCodeCompanyIdRegisteredNamesFormatGetGET /company/{countryCode}/{companyId}/registered-names.{format}Company registered names
EssentialsApicompanyCountryCodeCompanyIdRelatedNamesFormatGetGET /company/{countryCode}/{companyId}/related-names.{format}Company related names
EssentialsApicompanyCountryCodeCompanyIdSocialMediaProfilesFormatGetGET /company/{countryCode}/{companyId}/social-media-profiles.{format}Company social media profiles
EssentialsApicompanyCountryCodeCompanyIdTelephoneNumbersFormatGetGET /company/{countryCode}/{companyId}/telephone-numbers.{format}Company telephone numbers
EssentialsApicompanyCountryCodeCompanyIdWebsitesFormatGetGET /company/{countryCode}/{companyId}/websites.{format}Company websites
EssentialsApiofficerOfficerIdCompaniesFormatGetGET /officer/{officerId}/companies.{format}Officer appointments
EssentialsApiofficerOfficerIdFormatGetGET /officer/{officerId}.{format}Officer vitals
FinancialsApicharityCountryCodeCharityIdFinancialsFormatGetGET /charity/{countryCode}/{charityId}/financials.{format}Charity financials
FinancialsApicompanyCountryCodeCompanyIdFinancialsFormatGetGET /company/{countryCode}/{companyId}/financials.{format}Company financials
OwnershipApicharityCountryCodeCharityIdSubsidiariesFormatGetGET /charity/{countryCode}/{charityId}/subsidiaries.{format}Charity subsidiaries
OwnershipApicompanyCountryCodeCompanyIdBankAccountsFormatGetGET /company/{countryCode}/{companyId}/bank-accounts.{format}Company bank accounts
OwnershipApicompanyCountryCodeCompanyIdChargesFormatGetGET /company/{countryCode}/{companyId}/charges.{format}Company charges
OwnershipApicompanyCountryCodeCompanyIdFcaAuthorisationsFormatGetGET /company/{countryCode}/{companyId}/fca-authorisations.{format}Company FCA authorisations
OwnershipApicompanyCountryCodeCompanyIdFilingsFormatGetGET /company/{countryCode}/{companyId}/filings.{format}Company filings
OwnershipApicompanyCountryCodeCompanyIdGazetteNoticesFormatGetGET /company/{countryCode}/{companyId}/gazette-notices.{format}Company gazette notices
OwnershipApicompanyCountryCodeCompanyIdGroupParentsFormatGetGET /company/{countryCode}/{companyId}/group-parents.{format}Company group parents
OwnershipApicompanyCountryCodeCompanyIdGroupSubsidiariesFormatGetGET /company/{countryCode}/{companyId}/group-subsidiaries.{format}Company group subsidiaries
OwnershipApicompanyCountryCodeCompanyIdPersonsSignificantControlFormatGetGET /company/{countryCode}/{companyId}/persons-significant-control.{format}Company persons of significant control
OwnershipApicompanyCountryCodeCompanyIdPortfolioCompaniesFormatGetGET /company/{countryCode}/{companyId}/portfolio-companies.{format}Company portfolio companies
OwnershipApicompanyCountryCodeCompanyIdRelatedCompaniesFormatGetGET /company/{countryCode}/{companyId}/related-companies.{format}Company related companies
OwnershipApicompanyCountryCodeCompanyIdShareholdersFormatGetGET /company/{countryCode}/{companyId}/shareholders.{format}Company shareholders
PEPsAndSanctionsApipepsSanctionsBusinessLookupIdFormatGetGET /peps-sanctions/business/{lookupId}.{format}PEPs and Sanctions business lookup
PEPsAndSanctionsApipepsSanctionsIndividualLookupIdFormatGetGET /peps-sanctions/individual/{lookupId}.{format}PEPs and Sanctions individuals lookup
PEPsAndSanctionsApipepsSanctionsSearchBusinessesFormatPostPOST /peps-sanctions/search/businesses.{format}PEPs and Sanctions businesses search
PEPsAndSanctionsApipepsSanctionsSearchIndividualsFormatPostPOST /peps-sanctions/search/individuals.{format}PEPs and Sanctions individuals search
SearchApisearchCharitiesFormatPostPOST /search/charities.{format}Find charities
SearchApisearchCompaniesFormatPostPOST /search/companies.{format}Find companies
SearchApisearchKeywordsFormatPostPOST /search/keywords.{format}Find keywords (to be used on company/officer search filters)
SearchApisearchOfficersFormatPostPOST /search/officers.{format}Find officers
SearchApisearchRegionsFormatPostPOST /search/regions.{format}Find regions (to be used on company/officer search filters)

Documentation For Models

Documentation For Authorization

UserSecurity

  • Type: API key
  • API key parameter name: X-AUTH-TOKEN
  • Location: HTTP header

Author