Compatible Cases
About the service
This is a "Know Your Business" service used to generate KYB reports.
Product Code: W2-DATA-EKYB-GlobalOnline-009
Does this service leave a credit search Footprint? No
The service is broken down into two steps and requires calling our API twice:
- Finding the company (Company search)
- Generating the report (Report generation)
Company Search
The first step is all about finding the company you want.
All that's needed is the company's name and country. Sending these to our api will return a list of matched companies with basic information.
Each company has a CompanyId that is used in the next step to generate the report.
Searching companies is free.
Query Data
Add these to the Data section of the request:
| Property Name | Type | Length | Mandatory/Optional | Notes |
|---|---|---|---|---|
| NameQuery | string | - | Mandatory | Name of the Company e.g. "W2 Global Data" |
| Country | string | 3 | Mandatory | IS0 3 Country Code e.g. "GBR" |
Example for Company Search
You can enter a company name i.e. "W2GlobalData" in the NameQuery field and you will get a list of companies that match that search term, along with a small summary of information.
Example request for W2GlobalData
{
"data": {
"nameQuery":"W2 Global Data",
"country":"GBR"
}
}
Each company in the returned list will contain a company identifier. The company identifier will be included in the results of a name search in the CompanyId element.
Example response
"companySearchResults": [{
"address": {
"address": "UNIT 18 CBTC2, CAPITAL BUSINESS PARK, CARDIFF",
"country": "UK",
"postcode": "CF3 2PX",
"telephoneNumber": "000000000"
},
"companyType": "Ltd",
"country": "GB",
"dateOfLatestAccountsSpecified": false,
"monitoring": false,
"name": "W2 GLOBAL DATA SOLUTIONS LIMITED",
"onlineReports": false,
"registrationNumber": "07669978"
}
]
Report Generation
The second step is where we generate the report.
Calling the api with a CompanyId from the previous step will generate the report for that company.
Query Options
Add these to the Options section of the request:
| Property | Type | Length | Optional/Mandatory | Notes |
|---|---|---|---|---|
| CompanyId | String | - | Mandatory | CompanyId found from the Company Search step e.g. GB-0-07559968 |
| KybReason | String | - | Optional | Kyb Reason is required for generating reports from Germany. Possible options listed below. |
Examples
To obtain the report for a company enter the company identifier in the "CompanyId" query options field.
Example request for company ID: GB003/0/07669978
"Options" : {
"CompanyId":"GB003/0/07669978"
}
This is an extensive report containing a full set of information about a company in the response
Example response providing a report
"w2DataEkyb009Result": {
"companyReports": [{
"additionalAccountsItems": [{
"costOfSales": "0",
"directorsEmoluments": "0",
"export": "0",
"financialYear": "2016-01-01T00:00:00",
"longTermHpFinanceLeaseLiabilities": "0",
"revaluationReserve": "0",
"shortTermHpFinanceLeaseLiabilities": "0"
}
],
"advisorsInformation": [{
"auditorName": "AuditorName",
"solicitorName": "SolicitorName"
}
],
"bankerInformation": [{
"bankerAddress": {
"city": "City",
"houseNumber": "HouseNumber",
"postalCode": "PostalCode",
"province": "Province",
"street": "Street"
},
"bankerCode": "BankerCode",
"bankerName": "BankerName"
}
],
"bankruptcyData": {
"hasBankruptcyExactAddressMatch": "HasBankruptcyExactAddressMatch",
"hasBankruptcyExactNameAndAddressMatch": "HasBankruptcyExactNameAndAddressMatch",
"hasBankruptcyExactNameMatch": "HasBankruptcyExactNameMatch"
},
"commentaries": [{
"commentaryText": "CommentaryText",
"positivity": "Positivity"
}
],
"companyActivties": [{
"activityCode": "ActivityCode",
"activityDescription": "ActivityDescription"
}
],
"companyHistory": [{
"date": "2016-01-01T00:00:00",
"description": "Description"
}
],
"countyCourtJudgments": [{
"caseNumber": "CaseNumber",
"cccjDate": "2016-01-01T00:00:00",
"ccjAmount": 0.0,
"ccjDatePaid": "2016-01-01T00:00:00",
"ccjStatus": "CcjStatus",
"court": "Court",
"incomingRecordDetails": "IncomingRecordDetails"
}
],
"creditScore": {
"currentContractLimit": "CurrentContractLimit",
"currentCreditRating": {
"commonCreditRatingDescription": "CommonCreditRatingDescription",
"creditLimit": 0.0,
"providerCreditRating0to100": 0.0,
"providerRatingDescription": "ProviderRatingDescription",
"value": "Value"
},
"dateOfLatestRatingChange": "2016-01-01T00:00:00",
"previousCreditRating": {
"commonCreditRatingDescription": "CommonCreditRatingDescription",
"creditLimit": 0.0,
"providerCreditRating0to100": 0.0,
"providerRatingDescription": "ProviderRatingDescription",
"value": "Value"
}
},
"currentDirectors": [{
"dateOfBirth": "2016-01-01T00:00:00",
"fullname": "Fullname",
"position": [{
"appointmentDate": "2016-01-01T00:00:00",
"appointmentDateSpecified": true,
"commonCode": "CommonCode",
"providerCode": "ProviderCode",
"value": "ProviderCode"
}
]
}
],
"emailAddress": "[email protected]",
"employeeInformation": [{
"dateReported": 112,
"numberOfEmployees": "NumberOfEmployees"
}
],
"faxNumber": "FaxNumber",
"financeSheets": [{
"profitAndLoss": [{
"amortisation": "100",
"depreciation": "100",
"dividends": "100",
"extraordinaryCosts": "100",
"extraordinaryIncome": "100",
"financialExpenses": "100",
"financialIncome": "100",
"minorityInterests": "10",
"operatingCosts": "50",
"operatingProfit": "50",
"otherAppropriations": "100",
"pensionCosts": "10",
"profitAfterTax": "90",
"profitBeforeTax": "100",
"retainedProfit": "10",
"revenue": "10",
"tax": "50",
"wagesAndSalaries": "100",
"consolidatedAccounts": true,
"currency": "Currency",
"financialYear": "2016-01-01T00:00:00",
"numberOfWeeks": 1
}
]
}
],
"groupStructure": {
"affiliates": [{
"address": {
"city": "City",
"houseNumber": "HouseNumber",
"postalCode": "PostalCode",
"province": "Province",
"street": "Street"
},
"country": "GB",
"id": "Id",
"name": "Name",
"officeType": "OfficeType",
"phoneNumber": "PhoneNumber",
"registrationNumber": "RegistrationNumber",
"safeNumber": "SafeNumber",
"status": "Status",
"type": "Type",
"vatNumber": "VatNumber"
}
],
"immediateHoldingParent": {
"address": {
"city": "City",
"houseNumber": "HouseNumber",
"postalCode": "PostalCode",
"province": "Province",
"street": "Street"
},
"country": "GB",
"id": "Id",
"name": "Name",
"officeType": "OfficeType",
"phoneNumber": "PhoneNumber",
"registrationNumber": "RegistrationNumber",
"safeNumber": "SafeNumber",
"status": "Status",
"type": "Type",
"vatNumber": "VatNumber"
},
"subsidiaries": [{
"address": {
"city": "City",
"houseNumber": "HouseNumber",
"postalCode": "PostalCode",
"province": "Province",
"street": "Street"
},
"country": "GB",
"id": "Id",
"name": "Name",
"officeType": "OfficeType",
"phoneNumber": "PhoneNumber",
"registrationNumber": "RegistrationNumber",
"safeNumber": "SafeNumber",
"status": "Status",
"type": "Type",
"vatNumber": "VatNumber"
}
],
"ultimateHoldingParent": {
"address": {
"city": "City",
"houseNumber": "HouseNumber",
"postalCode": "PostalCode",
"province": "Province",
"street": "Street"
},
"country": "GB",
"id": "Id",
"name": "Name",
"officeType": "OfficeType",
"phoneNumber": "PhoneNumber",
"registrationNumber": "RegistrationNumber",
"safeNumber": "SafeNumber",
"status": "Status",
"type": "Type",
"vatNumber": "VatNumber"
}
},
"id": "0",
"mainAddress": {
"country": "GB",
"phoneNumber": "PhoneNumber",
"city": "City",
"houseNumber": "HouseNumber",
"postalCode": "PostalCode",
"province": "Province",
"street": "Street"
},
"mortgageInformation": {
"mortgageDetails": [{
"amountSecured": "AmountSecured",
"dateChargeCreated": "DateChargeCreated",
"dateChargeRegistered": "DateChargeRegistered",
"dateChargeSatisfied": "DateChargeSatisfied",
"details": "Details",
"mortgageType": "MortgageType",
"personsEntitled": "PersonsEntitled",
"status": "Status"
}
],
"mortgageSummary": {
"outstanding": 0,
"satsified": 0
}
},
"negativeRating": "NegativeRating",
"otherAddresses": [{
"country": "GB",
"phoneNumber": "PhoneNumber",
"city": "City",
"houseNumber": "HouseNumber",
"postalCode": "PostalCode",
"province": "Province",
"street": "Street"
}
],
"paymentData": {
"annualDbtWithTrend": [{
"balance": "Balance",
"dbtTrend": "DBTTrend",
"dbtValue": "DBTValue",
"month": "Month"
}
],
"balance": "Balance",
"balanceP1": "BalanceP1",
"balanceP2": "BalanceP2",
"balanceP3": "BalanceP3",
"balanceP4": "BalanceP4",
"balanceWithinTerms": "BalanceWithinTerms",
"dbt": "Dbt",
"invoicesBetween3And12Months": {
"paidInTerms": "PaidInTerms",
"paidP1": "PaidP1",
"paidP2": "PaidP2",
"paidP3": "PaidP3",
"paidP4": "PaidP4",
"totalPaid": "TotalPaid"
},
"invoicesLast3Months": {
"paidInTerms": "PaidInTerms",
"paidP1": "PaidP1",
"paidP2": "PaidP2",
"paidP3": "PaidP3",
"paidP4": "PaidP4",
"totalPaid": "TotalPaid"
},
"lastSixMonthsBalance": [{
"balance": "Balance",
"dbtTrend": "DBTTrend",
"dbtValue": "DBTValue",
"month": "Month"
}
],
"paymentTrend": "PaymentTrend",
"totalNoofInvoicesAvailable": "TotalNoofInvoicesAvailable",
"totalNoofInvoicesOwingAfter30DaysDue": "TotalNoofInvoicesOwingAfter30DaysDue",
"totalNoofInvoicesOwingBefore30DaysDue": "TotalNoofInvoicesOwingBefore30DaysDue",
"totalNoofInvoicesPaidAfter30DaysDue": "TotalNoofInvoicesPaidAfter30DaysDue",
"totalNoofInvoicesPaidBefore30DaysDue": "TotalNoofInvoicesPaidBefore30DaysDue",
"totalTradeLines": "TotalTradeLines",
"totalTradeLinesOutstanding": "TotalTradeLinesOutstanding"
},
"premiseType": "PremiseType",
"previousAddresses": [{
"country": "GB",
"phoneNumber": "PhoneNumber",
"city": "City",
"houseNumber": "HouseNumber",
"postalCode": "PostalCode",
"province": "Province",
"street": "Street"
}
],
"previousDirectors": [{
"dateOfBirth": "2016-01-01T00:00:00",
"fullname": "Fullname",
"position": [{
"appointmentDate": "2016-01-01T00:00:00",
"appointmentDateSpecified": true,
"commonCode": "CommonCode",
"providerCode": "ProviderCode",
"value": "ProviderCode"
}
]
}
],
"previousNames": [{
"dateChangedFromPreviousName": "2016-01-01T00:00:00",
"previousName": "PreviousName"
}
],
"shareCapitalStructure": {
"issuedShareCapital": "IssuedShareCapital",
"nominalShareCapital": "NominalShareCapital",
"shareholders": [{
"address": {
"city": "City",
"houseNumber": "HouseNumber",
"postalCode": "PostalCode",
"province": "Province",
"street": "Street"
},
"name": "Name",
"percentageShares": "PercentageShares"
}
]
},
"statusHistory": [{
"date": "2016-01-01T00:00:00",
"description": "Description"
}
],
"summary": {
"businessName": "BusinessName",
"companyRegistrationNumber": "FK000/0/0000001",
"companyStatus": "CompanyStatus",
"country": "GB",
"lastTurnoverFigure": 10.0,
"latestShareholderEquityFigure": 10.0,
"number": "01010101010",
"vatRegistrationDate": "2016-01-01T00:00:00",
"vatRegistrationNumber": "FK00000000001"
},
"webPages": [
"http://testwebpage.com"
]
}
],
"companySearchResults": []
}
Sandbox
To use sandbox the following example request can be used. Remember to include the W2 provided API key in the Authorization Header.
{
"Bundle": "KYB_009",
"Data": {
"NameQuery": "W2FakeCompany"
},
"Options": {
"Sandbox": "true"
},
"ClientReference": "your-client-reference"
}
Here are some examples of sandboxes cases that can be used to trial this endpoint:
| NameQuery | CompanyId | Result |
|---|---|---|
| W2FakeCompany | - | Single fictitious single company result |
| W2FakeMultipleCompany | - | Multiple fictitious company results |
| NullCompany | - | No companies found result |
| - | FK000/0/0000001 | Fake company report |
Docs not making sense? Please contact us so we can fix them: [email protected] :)