IDCanopy Developers
Umbrella APIKYB

KYB sandbox test data

The invented companies the KYB sandbox answers with, and what each one shows

The sandbox answers /kyb/search, /kyb/suggest and /kyb/company/details from a fixed set of invented companies in the same 3.0.0 shape as production. Nothing here is a real company, person, address or register entry. Register numbers sit in ranges that cannot collide with real ones:

CountryInvented range
DEHRB 99990 to 99999 (the courts are real, the numbers are not)
ATFN 999990a to 999999z
GB99999901 to 99999999
ITVAT and tax codes in the 00000000001 series, REA in the 9999901 series
US9990001 series

Websites and e-mail addresses are on the reserved .example domain. Dates of birth are made up.

Anything not on this page: a search that matches no case is a 400 Failed to retrieve test cases. An identifier search with an unknown value answers 200 with data: [] and message: "Identifier not in sandbox". A details call for a company that has no details fixture (a search-only row) is a 400 Failed to retrieve test cases.

InputWhat the sandbox does
name and countryThe case whose name contains your text (case and accents ignored) in that country. country is the ISO code in either case. Spelling variants of one case are the same case.
identifier (scheme: REGISTRATION_NUMBER, value)The row whose register number equals value exactly (case ignored), for example HRB 99990, FN 999990a, 99999901. country is optional. The main IT row carries no register number, so search IT by name.
pickNot simulated. Use name or identifier.
localityRequired by the gateway outside DE, GB, FR and AT, so for the IT and US cases here. Any value is accepted; it does not filter.
company_noOnly the GB case "thistle" carries one (99999903).

/kyb/suggest?q=...&country=... returns the rows of every case whose name contains q (at most 10), with source: sandbox and the register number as identifier where the row has one.

How to get details

Send the transaction_id and company_id of a search row; both are in the row. Only the first row of each case has a details fixture (the table at the end lists the ids); the other rows are search-only and show how a result list looks.

visibility is minimal (default, alias basic) or extended (every claim with its source). Include flags gate the sections exactly as live: a section nobody asked for is [], and the parties only it referenced are left out.

includeFills
officersofficerships and their parties
ownershipsshareholdings and their parties; for the DE KGaA also ownership_walk and free_float
transparencyubo (only the IT case has any)
financialsfinancials (the IT and US cases only)
representation_chainrepresentation_chain (only the AT GmbH & Co KG case); also turns officers on, as live
addresses, documentsNothing; they gate nothing live either

Every details body has metadata with sandbox: true, source: "Sandbox (<provider code>)", completeness: 0.8, paid_provider_calls: {} and billable_features: [] (["representation_chain"] when the chain is returned). confidence is null for some cases and 1 for others, as live. warnings is the string "" for the US case and an array [] for the others, mirroring the live providers' shapes.

The cases

Germany

ACME Software GmbH, the standard case

  • Search: name: acme, country: de (4 rows, the first has details), or identifier: HRB 99990.
  • Details: HRB 99990, Amtsgericht München. Three officerships: two Geschäftsführer (one with a date of birth, one without) and an authorised officer who has left (status: inactive, to: 2022-03-31, with a date of birth).
  • Signature: the register text "zwei Geschäftsführer gemeinsam" is read in full (basis: register_text, joint, 2).
  • include.ownerships: two shareholdings (60 percent a person, 40 percent a company).

Quellbach Anlagenberatung GmbH, conditional signature rule

  • Search: name: quellbach, country: de.
  • Details: two Geschäftsführer, both with a date of birth. signature_rules.modeled.conditions: sole director signs alone; several directors sign jointly, two of them, together with a Geschäftsführer or a Prokurist.

Kornfeldt Backwaren GmbH, signature not determined

  • Search: name: kornfeldt, country: de.
  • Details: two Geschäftsführer with dates of birth, but the provider gives no rule text. signature_rules carries no quality and no modeled part (basis: provider_asserted): the rule is not determined. The sandbox does not guess "joint, estimated".

Nordlicht Quantum Labs GmbH

  • Search: name: nordlicht, country: de.
  • Details: HRB 99993, Amtsgericht Hamburg. Two Geschäftsführer (one date of birth present, one missing) and a Prokurist with his own rule ("Gesamtprokura gemeinsam mit einem Geschäftsführer", basis: register_text). One document: the register extract, as a provider-hosted link that expires. The business purpose carries native and modeled.

Morgenstern Beteiligungen KGaA, corporate general partner

  • Search: name: morgenstern, country: de (3 rows).
  • Details: HRB 99994, Amtsgericht Frankfurt am Main. The persönlich haftender Gesellschafter is a company (Morgenstern Verwaltungs AG, a company party), plus two Aufsichtsrat members and a Prokurist.
  • include.ownerships: two shareholdings (a person at 34.5 percent, a company at 21 percent), ownership_walk and free_float: {exact: 44.5} (a company-level fact, never a shareholding). Without the flag none of the three is present.

Austria

Alpenglut Software GmbH, dates of birth present, missing and conflicting

  • Search: name: alpenglut, country: at, or identifier: FN 999990a.
  • Details: FN 999990a, Wien. Berta Lindinger signs alone, Cornelius Hubmayr jointly, Dagmar Egger (Prokuristin) jointly with a Geschäftsführer, all from the Firmenbuch text (register_text, with the register's own wording and code).
  • Dates of birth: Berta has a conflict (the report says 1975-03-04, the register text 1975-03-14; in extended both claims and resolved.conflicts: 1, in minimal the resolved one); Cornelius has one only from the register text; Dagmar has none.
  • No ownership data.

Edelweiss Gastro GmbH & Co KG, general partner chain (representation_chain)

  • Search: name: edelweiss, country: at (2 rows), or identifier: FN 999991b.
  • Details: FN 999991b, Kitzbühel. The unbeschränkt haftender Gesellschafter is a company (Edelweiss Verwaltungs GmbH, FN 999992c); there is also a Prokuristin.
  • include.representation_chain: true: two hops. Level 1 resolved, fetch: fetched: the general partner and the person who signs for it (effective rule: individual, 1 signatory). Level 2 unresolved, reason: daily_limit. billable_features: ["representation_chain"]. Without the flag there is no representation_chain key and nothing is billed.
  • The chain is a fixed fixture; it is the only hand-written part of the sandbox data.

Hinterberger Naturkost e.U., sole trader

  • Search: name: hinterberger, country: at.
  • Details: FN 999993d, Graz, legal form Einzelunternehmer. One officership: the Inhaber, who signs alone (signature_right.basis: legal_form, individual). The register's word "eingetragen" is not carried as a rule.
  • include.ownerships: one derived shareholding, the Inhaber at 100 percent (basis: legal_form, interest_type: sole_proprietor). It is not a UBO: include.transparency gives an empty ubo.

United Kingdom

ALBION WIDGETS LIMITED

  • Search: name: albion, country: gb (2 rows), or identifier: 99999901.
  • Details: 99999901, private limited company. Directors with month-precision dates of birth (1971-04), one resigned (status: inactive, to: 2023-05-31). include.ownerships: persons with significant control as bands (50-75 and 25-50 percent, share.min and share.max), one of them a company. No financials, whatever the flag.

THISTLE HOLDINGS LIMITED, dissolved

  • Search: name: thistle, country: gb, or by number: company_no: 99999903 (with or without a name), or identifier: 99999903.
  • Details: status dissolved, a corporate secretary (a company officer) and a director who left.

Italy

ALFA TECNOLOGIE S.P.A.

  • Search: name: alfa, country: it, locality: milan (3 rows; the register number is null, search by name).
  • Details: S.p.A. (ELF P418), Milano. Three officerships: a legal representative (managing director), a company that is the sole owner, a special representative; the provider's role text is kept, and signature_right.is_legal_representative marks who represents. Dates of birth present for the two persons.
  • include.ownerships: one shareholding (100 percent). include.transparency: one ubo (declared). include.financials: three fiscal years. The tax codes are invented.

United States

ROADRUNNER SUPPLIES INC

  • Search: name: roadrunner, country: us, locality: wilmington (2 rows).
  • Details: register number 9990001, Delaware address. Two officers (position "Officer", no dates of birth). include.ownerships: two shareholdings (70 and 30 percent). include.financials: one fiscal year. metadata.warnings is the string "".

What the sandbox does not simulate

  • Provider outages and the storage fallback (PROVIDER_UNAVAILABLE_SERVED_FROM_STORAGE): never produced.
  • OWNERSHIP_PARTIAL, PENDING_SLICE, SLICE_FAILED and the 25 second bound: never produced. completeness is fixed at 0.8.
  • from_cache and source_fetched_at are absent (nothing is fetched or cached); metadata.note says so.
  • representation_chain exists for the Edelweiss case only, as a fixed fixture.
  • pick searches, company_no as a live filter (live ignores it too), spend caps, and rate limits other than the one on suggest.

Ids of the details fixtures

Casetransaction_id / company_id
ACME Software GmbHd15f70f6-a960-5b42-bb0a-32b6c95e8952 / 66aab658-cccc-548c-a121-f94f21740796
Quellbach Anlagenberatung GmbH4ea1bc71-4179-58ec-9827-3b27772a44cd / e31002d6-21ac-588a-9cba-a2d6ab177ced
Kornfeldt Backwaren GmbH54c65e6b-5146-5f96-858a-773308364470 / f971cc98-5813-5eb4-8822-0084169cde56
Nordlicht Quantum Labs GmbHdf486292-aaae-5b3c-bbda-f29d9b8111a1 / 83257bf8-3d7a-5b8b-b905-126ddf69994d
Morgenstern Beteiligungen KGaA51f1a1d5-d104-50a0-a8c0-0ed9d03c8b03 / 7ad2cee0-885f-5d18-abe7-13ce1fe5f2f3
Alpenglut Software GmbHd7c25506-8eb5-56f9-ac61-662f11a66736 / 312065a9-fbb6-5e76-ad3a-e4fabb6ea199
Edelweiss Gastro GmbH & Co KG42990327-3d98-54c9-8755-c06c78b94c08 / 07ff7b97-6825-56f0-8189-fd45909960e9
Hinterberger Naturkost e.U.93d5e3b2-12ab-54ec-943b-91a476011b71 / 601ac7e9-4c98-5095-aeb2-ceff66a4718d
ALBION WIDGETS LIMITED5ec9432d-287b-54fd-a374-48a9be29feb4 / c1c990b5-e22c-5643-882f-9b0e7e78a6a3
THISTLE HOLDINGS LIMITED533464a9-5179-53cb-a5fe-0175bbf6b2f5 / e5e787cc-fe75-5991-afd5-94fb3fdaffb0
ALFA TECNOLOGIE S.P.A.667a9a0e-8332-538a-9d17-190194aa3113 / cb93b0f0-a4ba-5ec1-81f4-2a5c7aa37de3
ROADRUNNER SUPPLIES INC12a696f8-a688-59d0-b0e0-ed933eccb94e / 513e0510-8827-551c-9aaa-749bf93edb9f

Source: the KYB team's kyb-sandbox-inputs.md, same revision as the published specification.

On this page