{"items":[{"type":"link","label":"Credit and Risk","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk","content":{"contentType":"overview","meta":{"name":"Credit and Risk"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"creditAndRisk.json","url":"/_bundle/connect-apis-catalog/product-catalog/Credit&Risk/@OAS3.1/creditAndRisk.json?download"},{"kind":"download","label":"creditAndRisk.yaml","url":"/_bundle/connect-apis-catalog/product-catalog/Credit&Risk/@OAS3.1/creditAndRisk.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"attribute","title":"License","titleTranslationKey":"info.license","label":"Proprietary","value":"Proprietary"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Credit and Risk (1.0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Credit and Risk API provides access to a comprehensive suite of endpoints designed to deliver critical business insights."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API enables users to authenticate, search for companies and directors, retrieve detailed credit and risk reports,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access official company filing documents, and manage fresh investigation requests for companies not available in the instant database."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"OAS 3.0.4 Trial Availability"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The OAS 3.0.4 version of this API specification is provided for trial purposes only. While every effort is made to ensure its accuracy, the OAS 3.1.0 version is the primary managed and maintained specification and is recommended for all integrations and production use."},"children":[]}]}]}]}]}],"sectionId":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk"}],"sectionId":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk"}]}]}},{"type":"group","label":"Authentication","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/authentication","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/authentication","items":[{"label":"Authenticate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/authentication/authenticate","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/authentication/authenticate","metadata":{"seo":{"title":"Authenticate","description":"Supply username and password to generate Authentication Token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticate","name":"Authenticate","isWebhook":false,"pointer":"/paths/~1authenticate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Supply username and password to generate Authentication Token.\n  \n"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthRequest"}},"schemaId":"components/schemas/ConnectAuthenticationAuthRequest","pointer":"/paths/~1authenticate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authenticate","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthRequest"}},"responseCodes":["200","401"],"pointer":"/authenticate","href":"authentication/authenticate","openApiOperationId":"authenticate","summary":"Authenticate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectAuthenticationAuthRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthResponse"}},"schemaId":"components/schemas/ConnectAuthenticationAuthResponse"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthFailedResponse"}},"schemaId":"components/schemas/ConnectAuthFailedResponse"}],"pointer":"/paths/~1authenticate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectAuthenticationAuthResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthResponse"}}},{"code":"401","schemaId":"components/schemas/ConnectAuthFailedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthFailedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/authenticate"}],"panels":[]}]},"httpPath":"/authenticate"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to authenticate and generate an Authentication Token."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authenticate","summary":"Authenticate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/authenticate","deprecated":false}]}]}]}]}},{"type":"group","label":"Search And Report Schemas/Criteria","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria","items":[{"label":"Return Languages Available For Company Reports For Selected Country","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/useraccessreportlanguages","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/useraccessreportlanguages","metadata":{"seo":{"title":"Return Languages Available For Company Reports For Selected Country","description":"Endpoint which returns available languages for a report.   The JSON structure of the report is language invariant, but field content will return in the selected language where available."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userAccessReportLanguages","name":"Return Languages Available For Company Reports For Selected Country","isWebhook":false,"pointer":"/paths/~1access~1countries~1{countryCode}~1reportLanguages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Languages Available For Company Reports For Selected Country","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint which returns available languages for a report.   The JSON structure of the report is language invariant, but field content will return in the selected language where available."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The availability of field content in a specific language depends on the data source. If certain properties in the report are not available in the chosen language, they will default to English. As a result, only a certain percentage of the report may appear in the selected language."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"countryCode","in":"path","schemaId":"schema_642","description":"Accepts valid iso-2 country code","required":true,"example":"NL"}],"pointer":"/paths/~1access~1countries~1{countryCode}~1reportLanguages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/access/countries/{countryCode}/reportLanguages","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"countryCode","in":"path","required":true,"example":"NL","schemaId":"schema_642"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/access/countries/{countryCode}/reportLanguages","href":"search-and-report-schemascriteria/useraccessreportlanguages","openApiOperationId":"userAccessReportLanguages","summary":"Return Languages Available For Company Reports For Selected Country"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_643"}},"schemaId":"schema_643"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1access~1countries~1{countryCode}~1reportLanguages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_643","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_643"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-and-report-schemascriteria/useraccessreportlanguages"}],"panels":[]}]},"httpPath":"/access/countries/{countryCode}/reportLanguages"},{"label":"Company Search Criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/companysearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/companysearchcriteria","metadata":{"seo":{"title":"Company Search Criteria","description":"Returns the set of available Company Search parameters/fields for a provided list of countries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companySearchCriteria","name":"Company Search Criteria","isWebhook":false,"pointer":"/paths/~1companies~1searchcriteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Search Criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the set of available Company Search parameters/fields for a provided list of countries."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_642","description":"A comma separated list of ISO/Alpha 2 format country codes, or singular country Code. e.g. US,GB will return the common searchable Company fields in the United States and Great Britain.","required":true}],"pointer":"/paths/~1companies~1searchcriteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/searchcriteria","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","required":true,"schemaId":"schema_642"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/companies/searchcriteria","href":"search-and-report-schemascriteria/companysearchcriteria","openApiOperationId":"companySearchCriteria","summary":"Company Search Criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry"}},"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1companies~1searchcriteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-and-report-schemascriteria/companysearchcriteria"}],"panels":[]}]},"httpPath":"/companies/searchcriteria"},{"label":"People/Director Search Criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/peopledirectorsearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/peopledirectorsearchcriteria","metadata":{"seo":{"title":"People/Director Search Criteria","description":"Returns the set of available People Search parameters/fields for a provided list of countries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peopleDirectorSearchCriteria","name":"People/Director Search Criteria","isWebhook":false,"pointer":"/paths/~1people~1searchcriteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"People/Director Search Criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the set of available People Search parameters/fields for a provided list of countries."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_642","description":"A comma separated list of ISO/Alpha 2 format country codes, or singular country Code. e.g. US,GB will return the common searchable People/Director fields in the United States and Great Britain."}],"pointer":"/paths/~1people~1searchcriteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/searchcriteria","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","schemaId":"schema_642"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/people/searchcriteria","href":"search-and-report-schemascriteria/peopledirectorsearchcriteria","openApiOperationId":"peopleDirectorSearchCriteria","summary":"People/Director Search Criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector"}},"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1people~1searchcriteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-and-report-schemascriteria/peopledirectorsearchcriteria"}],"panels":[]}]},"httpPath":"/people/searchcriteria"},{"label":"Report Schema Structure Per Country","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/reportschema","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/reportschema","metadata":{"seo":{"title":"Report Schema Structure Per Country","description":"Returns the Company Report JSON schema of the provided country. Largely redundant as the Company Report 200 response is defined as a superset of all country's JSON schemas and can be used for any country."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reportSchema","name":"Report Schema Structure Per Country","isWebhook":false,"pointer":"/paths/~1companies~1schema~1{countryCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Schema Structure Per Country","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the Company Report JSON schema of the provided country. Largely redundant as the Company Report 200 response is defined as a superset of all country's JSON schemas and can be used for any country."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"countryCode","in":"path","schemaId":"schema_642","description":"ISO2 / Alpha 2 Country Code","required":true}],"pointer":"/paths/~1companies~1schema~1{countryCode}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"section","in":"query","schemaId":"schema_644","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CompanyReportResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the Company Credit Report JSON schema."},"children":[]}]}]}],"required":true},{"name":"template","in":"query","schemaId":"schema_642","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Templated Company Report JSON Schemas."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selection of templates can be found here:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000063360-connect-report-templates-glossary-availability","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect report templates glossary and availability"},"children":[]}]}]}]}]}],"pointer":"/paths/~1companies~1schema~1{countryCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/schema/{countryCode}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"countryCode","in":"path","required":true,"schemaId":"schema_642"}],"query":[{"name":"section","in":"query","required":true,"schemaId":"schema_644"},{"name":"template","in":"query","schemaId":"schema_642"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/companies/schema/{countryCode}","href":"search-and-report-schemascriteria/reportschema","openApiOperationId":"reportSchema","summary":"Report Schema Structure Per Country"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase"}},"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1companies~1schema~1{countryCode}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-and-report-schemascriteria/reportschema"}],"panels":[]}]},"httpPath":"/companies/schema/{countryCode}"}],"content":{"contentType":"group","meta":{"name":"Search And Report Schemas/Criteria"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search And Report Schemas/Criteria","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints to retrieve the structure of the Company and Director Search Criteria,  Report Schemas, and available Report Languages for a specific country. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" These endpoints provide the necessary information to validate responses,  understand search parameters, and determine localization options for reports."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/access/countries/{countryCode}/reportLanguages","summary":"Return Languages Available For Company Reports For Selected Country","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-and-report-schemascriteria/useraccessreportlanguages","deprecated":false},{"title":"/companies/searchcriteria","summary":"Company Search Criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-and-report-schemascriteria/companysearchcriteria","deprecated":false},{"title":"/people/searchcriteria","summary":"People/Director Search Criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-and-report-schemascriteria/peopledirectorsearchcriteria","deprecated":false},{"title":"/companies/schema/{countryCode}","summary":"Report Schema Structure Per Country","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-and-report-schemascriteria/reportschema","deprecated":false}]}]}]}]}},{"type":"group","label":"Companies","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies","items":[{"label":"Company Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/companysearch","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/companysearch","metadata":{"seo":{"title":"Company Search","description":"Endpoint to search for Companies according to the provided Search Criteria. To get the most relevant results, it is recommended to use a unique identifier such as regNo where available. If a unique identifier is not available, use a combination of the companies registered postCode and name for the next best hit rate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companySearch","name":"Company Search","isWebhook":false,"pointer":"/paths/~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint to search for Companies according to the provided Search Criteria. To get the most relevant results, it is recommended to use a unique identifier such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where available. If a unique identifier is not available, use a combination of the companies registered "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next best hit rate."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_645","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_646","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"countries","in":"query","schemaId":"schema_647","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comma-separated list of iso-2 country codes."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used here to search for companies of this type across all countries."},"children":[]}]}]}],"required":true,"example":"GB,FR"},{"name":"language","in":"query","schemaId":"schema_648","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only used for Countries where more than one Company Name exists for different languages e.g.  Japanese Kanji and English."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country -  Languages Available"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Japan [JP] - EN & JA"},"children":[]}]}]}]},{"name":"id","in":"query","schemaId":"schema_649","description":"connectId - The primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network. This is returned on all Company Search Results. Use this field to use in other operations such as Ordering Company Credit Report by Id, and Adding Company to Monitoring Portfolio."},{"name":"safeNo","in":"query","schemaId":"schema_650","description":"Safe Number - Identifier for Companies in Creditsafe's Home Countries."},{"name":"regNo","in":"query","schemaId":"schema_650","description":"Local Company Identifier - The Company identifier associated with it's Domestic Filing Agency. i.e. French SIREN/SIRET, United Kingdom Companies House CRN."},{"name":"vatNo","in":"query","schemaId":"schema_650","description":"Company VAT Number"},{"name":"name","in":"query","schemaId":"schema_650","description":"Company Name"},{"name":"tradeName","in":"query","schemaId":"schema_650","description":"Trade Name of the Company, typically used in Countries where Name is not uniquely registered."},{"name":"acronym","in":"query","schemaId":"schema_650","description":"A (non-unique) identifier to look for Companies by their more commonly known acronym rather than their lesser known full name. Acronym is predominantly available on French Companies."},{"name":"exact","in":"query","schemaId":"schema_651","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find Companies matching a Name exactly."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of countries this is available at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000083702-company-search-exact-parameter-availability","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company search exact parameter availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"address","in":"query","schemaId":"schema_650"},{"name":"street","in":"query","schemaId":"schema_649","description":"Address part identifier - Street of the Company"},{"name":"houseNo","in":"query","schemaId":"schema_650","description":"Address part identifier - House/Building Number of the Company"},{"name":"city","in":"query","schemaId":"schema_650","description":"Address part identifier - City of the Company"},{"name":"postCode","in":"query","schemaId":"schema_650","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address part identifier - Postcode/Zip Code of the Company. Can be provided partially to extend to a region with a * as a wildcard. I.e. CF* can represent all postcodes starting with CF."},"children":[]}]}]}]},{"name":"province","in":"query","schemaId":"schema_650","description":"Address part identifier - Province/State of the Company"},{"name":"callRef","in":"query","schemaId":"schema_649","description":"This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions."},{"name":"officeType","in":"query","schemaId":"schema_652"},{"name":"phoneNo","in":"query","schemaId":"schema_653","description":"Provides Array of phone numbers or Null"},{"name":"status","in":"query","schemaId":"schema_654"},{"name":"type","in":"query","schemaId":"schema_655"},{"name":"website","in":"query","schemaId":"schema_650"},{"name":"customData","in":"query","schemaId":"schema_650","description":"Not currently used."}],"pointer":"/paths/~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_645"},{"name":"pageSize","in":"query","schemaId":"schema_646"},{"name":"countries","in":"query","required":true,"example":"GB,FR","schemaId":"schema_647"},{"name":"language","in":"query","schemaId":"schema_648"},{"name":"id","in":"query","schemaId":"schema_649"},{"name":"safeNo","in":"query","schemaId":"schema_650"},{"name":"regNo","in":"query","schemaId":"schema_650"},{"name":"vatNo","in":"query","schemaId":"schema_650"},{"name":"name","in":"query","schemaId":"schema_650"},{"name":"tradeName","in":"query","schemaId":"schema_650"},{"name":"acronym","in":"query","schemaId":"schema_650"},{"name":"exact","in":"query","schemaId":"schema_651"},{"name":"address","in":"query","schemaId":"schema_650"},{"name":"street","in":"query","schemaId":"schema_649"},{"name":"houseNo","in":"query","schemaId":"schema_650"},{"name":"city","in":"query","schemaId":"schema_650"},{"name":"postCode","in":"query","schemaId":"schema_650"},{"name":"province","in":"query","schemaId":"schema_650"},{"name":"callRef","in":"query","schemaId":"schema_649"},{"name":"officeType","in":"query","schemaId":"schema_652"},{"name":"phoneNo","in":"query","schemaId":"schema_653"},{"name":"status","in":"query","schemaId":"schema_654"},{"name":"type","in":"query","schemaId":"components/schemas/CreditsafeGlobalDataCompanyType"},{"name":"website","in":"query","schemaId":"schema_650"},{"name":"customData","in":"query","schemaId":"schema_650"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/companies","href":"companies/companysearch","openApiOperationId":"companySearch","summary":"Company Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectCompanySearchResponse"}},"schemaId":"components/schemas/ConnectCompanySearchResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectCompanySearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectCompanySearchResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/companysearch"}],"panels":[]}]},"httpPath":"/companies"},{"label":"Company Credit Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/companycreditreport","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/companycreditreport","metadata":{"seo":{"title":"Company Credit Report","description":"Orders a Company Credit Report by connectId. To acquire a PDF version of the report use the optional request in 'Header'. This request will provide a 'Base64-encoded' script to convert to a PDF, this will appear at the end of the JSON response.The response properties listed for this endpoint represent the core global company fields.  For country-specific fields and a complete list of all possible properties for a given country,  use the Report Schema endpoint.  Not all properties will be returned in every response—fields with no value are omitted by design.  In OpenAPI, properties not listed as required are optional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companyCreditReport","name":"Company Credit Report","isWebhook":false,"pointer":"/paths/~1companies~1{connectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Credit Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders a Company Credit Report by connectId."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To acquire a PDF version of the report use the optional request in 'Header'."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This request will provide a 'Base64-encoded' script to convert to a PDF, this will appear at the end of the JSON response."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response properties listed for this endpoint represent the core global company fields.  For country-specific fields and a complete list of all possible properties for a given country,  use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/reportschema"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report Schema endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Not all properties will be returned in every response—fields with no value are omitted by design. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In OpenAPI, properties not listed as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/companies"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Companies help documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"connectId","in":"path","schemaId":"schema_642","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The connectId (optionally Safe Number where available) of the Company required to order their Credit Report. Obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" search results."},"children":[]}]}]}],"required":true,"example":"GB-0-03836192"}],"pointer":"/paths/~1companies~1{connectId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_656","description":"Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available."},{"name":"template","in":"query","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter to request a Templated Company Report. A Template adds/reduces sections of the Credit Report depending on your subscription. Do not include this parameter if you have not been given a template to use."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000063360-connect-report-templates-glossary-availability","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect report templates glossary and availability"},"children":[]}]}]}]}]},{"name":"includeIndicators","in":"query","schemaId":"schema_658","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter to include the indicator scores in to a company report -"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fsi = Financial Strength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pbi = Payment Behaviour Indicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eti = Estimated Turnover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pei = Payment Expectation Indicator"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Addition information on indicator acronyms can be found "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000084411-connect-report-indicator-definitions","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report indicator definitions"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Addition information on understanding indicators can be found "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000078780-what-are-indicators-in-the-scores-and-indicators-tab-","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indicator guidance in the Scores and Indicators tab"},"children":[]}]}]}]}]},{"name":"customData","in":"query","schemaId":"schema_650","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Report Parameters e.g.  German Report Reason Code value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de_reason_code::1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" . Use /reportcustomdata/{country} endpoint to see all values."},"children":[]}]}]}]},{"name":"callRef","in":"query","schemaId":"schema_649","description":"This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions."}],"pointer":"/paths/~1companies~1{connectId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_659","description":"Specifies the desired response format."}],"pointer":"/paths/~1companies~1{connectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{connectId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"connectId","in":"path","required":true,"example":"GB-0-03836192","schemaId":"schema_642"}],"query":[{"name":"language","in":"query","schemaId":"schema_656"},{"name":"template","in":"query","schemaId":"schema_657"},{"name":"includeIndicators","in":"query","schemaId":"schema_658"},{"name":"customData","in":"query","schemaId":"schema_650"},{"name":"callRef","in":"query","required":false,"schemaId":"schema_649"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":false,"example":"application/pdf","schemaId":"schema_659"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/companies/{connectId}","href":"companies/companycreditreport","openApiOperationId":"companyCreditReport","summary":"Company Credit Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json","application/json+pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse"},"application/json+pdf":{"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachmentjson"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1companies~1{connectId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse","mediaTypes":["application/json","application/json+pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse"},"application/json+pdf":{"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachmentjson"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/companycreditreport"}],"panels":[]}]},"httpPath":"/companies/{connectId}"},{"label":"Confidence Match Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/confidencematchsearch","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/confidencematchsearch","metadata":{"seo":{"title":"Confidence Match Search","description":"Supply all company search criteria to find potential company matches ranked by a single score.   - Interpreting confidence match scores."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"confidenceMatchSearch","name":"Confidence Match Search","isWebhook":false,"pointer":"/paths/~1companies~1match/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confidence Match Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supply all company search criteria to find potential company matches ranked by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"single score"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".   - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://creditsafe.freshdesk.com/en/support/solutions/articles/7000059769-interpreting-confidence-match-scores","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interpreting confidence match scores"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This endpoint does not support pagination. Any pagination-related query parameters sent by the client will be ignored and will not affect the response."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"country","in":"query","schemaId":"schema_642","description":"Iso-2 country code","required":true,"example":"GB"},{"name":"matchThreshold","in":"query","schemaId":"schema_646","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum threshold value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"893"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", maximum threshold value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"999"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":905},{"name":"regNo","in":"query","schemaId":"schema_650","description":"Local Company Identifier - The Company identifier associated with it's Domestic Filing Agency. i.e. French SIREN/SIRET, United Kingdom Companies House CRN."},{"name":"vatNo","in":"query","schemaId":"schema_650","description":"Company VAT Number"},{"name":"name","in":"query","schemaId":"schema_650","description":"Company Name","required":true},{"name":"street","in":"query","schemaId":"schema_649","description":"Address part identifier - Street of the Company"},{"name":"houseNo","in":"query","schemaId":"schema_650","description":"Address part identifier - House/Building Number of the Company"},{"name":"city","in":"query","schemaId":"schema_650","description":"Address part identifier - City of the Company"},{"name":"postCode","in":"query","schemaId":"schema_650","description":"Address part identifier - Postcode/Zip Code of the Company."},{"name":"province","in":"query","schemaId":"schema_650","description":"Address part identifier - Province of the Company"},{"name":"phoneNo","in":"query","schemaId":"schema_650"},{"name":"reference1","in":"query","schemaId":"schema_642","description":"Customer supplied free text reference 1 of 3","example":"free text 1"},{"name":"reference2","in":"query","schemaId":"schema_642","description":"Customer supplied free text reference 2 of 3","example":"free text 2"},{"name":"reference3","in":"query","schemaId":"schema_642","description":"Customer supplied free text reference 3 of 3","example":"free text 3"},{"name":"callRef","in":"query","schemaId":"schema_649","description":"This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions."}],"pointer":"/paths/~1companies~1match/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/match","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"country","in":"query","required":true,"example":"GB","schemaId":"schema_642"},{"name":"matchThreshold","in":"query","required":true,"example":905,"schemaId":"schema_646"},{"name":"regNo","in":"query","schemaId":"schema_650"},{"name":"vatNo","in":"query","schemaId":"schema_650"},{"name":"name","in":"query","required":true,"schemaId":"schema_650"},{"name":"street","in":"query","schemaId":"schema_649"},{"name":"houseNo","in":"query","schemaId":"schema_650"},{"name":"city","in":"query","schemaId":"schema_650"},{"name":"postCode","in":"query","schemaId":"schema_650"},{"name":"province","in":"query","schemaId":"schema_650"},{"name":"phoneNo","in":"query","schemaId":"schema_650"},{"name":"reference1","in":"query","example":"free text 1","schemaId":"schema_642"},{"name":"reference2","in":"query","example":"free text 2","schemaId":"schema_642"},{"name":"reference3","in":"query","example":"free text 3","schemaId":"schema_642"},{"name":"callRef","in":"query","schemaId":"schema_649"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/companies/match","href":"companies/confidencematchsearch","openApiOperationId":"confidenceMatchSearch","summary":"Confidence Match Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_660"}},"schemaId":"schema_660"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1companies~1match/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_660","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_660"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/confidencematchsearch"}],"panels":[]}]},"httpPath":"/companies/match"}],"content":{"contentType":"group","meta":{"name":"Companies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Companies","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints to search for Companies in the Creditsafe Global Company Database. Companies are uniquely identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the identifier used to order a Company Credit Report. The Company Credit Report is a JSON object comprising of key business and financial data points such as Credit Score & Limit, Industry Code, Directors, Balance Sheet and Negative Information. A full list of Company data points can be found in the Data Matrix, in the help resources."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies","summary":"Company Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/companysearch","deprecated":false},{"title":"/companies/{connectId}","summary":"Company Credit Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/companycreditreport","deprecated":false},{"title":"/companies/match","summary":"Confidence Match Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/confidencematchsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"People/Directors","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/peopledirectors","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/peopledirectors","items":[{"label":"Director Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/peopledirectors/directorssearch","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/peopledirectors/directorssearch","metadata":{"seo":{"title":"Director Search","description":"Endpoint to find Directors based on search criteria to order a Creditsafe Director Report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"directorSSearch","name":"Director Search","isWebhook":false,"pointer":"/paths/~1people/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Director Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to find Directors based on search criteria to order a Creditsafe Director Report."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_645","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_646","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"countries","in":"query","schemaId":"schema_647","description":"comma-separated list of iso-2 country codes","required":true,"example":"GB,FR"},{"name":"peopleId","in":"query","schemaId":"schema_642","description":"Person/Director Identifier - used to order a Director Report."},{"name":"firstName","in":"query","schemaId":"schema_642","description":"Person's First Name."},{"name":"lastName","in":"query","schemaId":"schema_642","description":"Person's Last Name"},{"name":"localDirectorNumber","in":"query","schemaId":"schema_650","description":"Local Identifier of the Director, the PNR in GB."},{"name":"dateOfBirth","in":"query","schemaId":"schema_642","description":"Person DOB - provide YYYY-MM-DD or YYYY-MM format."},{"name":"callRef","in":"query","schemaId":"schema_650","description":"This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions."}],"pointer":"/paths/~1people/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_645"},{"name":"pageSize","in":"query","schemaId":"schema_646"},{"name":"countries","in":"query","required":true,"example":"GB,FR","schemaId":"schema_647"},{"name":"peopleId","in":"query","schemaId":"schema_642"},{"name":"firstName","in":"query","schemaId":"schema_642"},{"name":"lastName","in":"query","schemaId":"schema_642"},{"name":"localDirectorNumber","in":"query","schemaId":"schema_650"},{"name":"dateOfBirth","in":"query","schemaId":"schema_642"},{"name":"callRef","in":"query","schemaId":"schema_650"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/people","href":"peopledirectors/directorssearch","openApiOperationId":"directorSSearch","summary":"Director Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_661"}},"schemaId":"schema_661"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1people/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_661","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_661"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peopledirectors/directorssearch"}],"panels":[]}]},"httpPath":"/people"},{"label":"Director Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/peopledirectors/directorreport","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/peopledirectors/directorreport","metadata":{"seo":{"title":"Director Report","description":"Returns a report from the ID supplied to the search."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"directorReport","name":"Director Report","isWebhook":false,"pointer":"/paths/~1people~1{peopleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Director Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a report from the ID supplied to the search."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"peopleId","in":"path","schemaId":"schema_662","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the Person/Director required to order their Director Report. Obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/people"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" search results."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1people~1{peopleId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_663","description":"Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available."},{"name":"callRef","in":"query","schemaId":"schema_642","description":"This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions."}],"pointer":"/paths/~1people~1{peopleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{peopleId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"peopleId","in":"path","required":true,"schemaId":"schema_662"}],"query":[{"name":"language","in":"query","schemaId":"schema_663"},{"name":"callRef","in":"query","schemaId":"schema_642"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/people/{peopleId}","href":"peopledirectors/directorreport","openApiOperationId":"directorReport","summary":"Director Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1people~1{peopleId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peopledirectors/directorreport"}],"panels":[]}]},"httpPath":"/people/{peopleId}"}],"content":{"contentType":"group","meta":{"name":"People/Directors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"People/Directors","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints to find People/Directors and order Director Reports. A Director Report will contain a person's registered information and Active & Previous Directorships, where available. This endpoint is not advised to get a list of directors for a specific Company. Instead, order a Company Credit Report using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/companycreditreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Companies Report Endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":",  and use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in the report response."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people","summary":"Director Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peopledirectors/directorssearch","deprecated":false},{"title":"/people/{peopleId}","summary":"Director Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peopledirectors/directorreport","deprecated":false}]}]}]}]}},{"type":"group","label":"Images","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/images","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/images","items":[{"label":"Company Image Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/images/companyimagedocuments","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/images/companyimagedocuments","metadata":{"seo":{"title":"Company Image Documents","description":"Returns the available Images for a given Company connectId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companyImageDocuments","name":"Company Image Documents","isWebhook":false,"pointer":"/paths/~1images~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Image Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the available Images for a given Company connectId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_645","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_646","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"id","in":"query","schemaId":"schema_642","description":"The company's connectId."}],"pointer":"/paths/~1images~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/images/companies","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_645"},{"name":"pageSize","in":"query","schemaId":"schema_646"},{"name":"id","in":"query","schemaId":"schema_642"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/images/companies","href":"images/companyimagedocuments","openApiOperationId":"companyImageDocuments","summary":"Company Image Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectImagesCompanyImages"}},"schemaId":"components/schemas/ConnectImagesCompanyImages"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1images~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectImagesCompanyImages","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectImagesCompanyImages"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/images/companyimagedocuments"}],"panels":[]}]},"httpPath":"/images/companies"},{"label":"Image Document Category Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/images/imagedocumentcategorytypes","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/images/imagedocumentcategorytypes","metadata":{"seo":{"title":"Image Document Category Types","description":"Lists available Image Document formats, types and languages per country."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"imageDocumentCategoryTypes","name":"Image Document Category Types","isWebhook":false,"pointer":"/paths/~1images~1companies~1types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Image Document Category Types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists available Image Document formats, types and languages per country."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_642","description":"Filter Images by country."}],"pointer":"/paths/~1images~1companies~1types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/images/companies/types","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","schemaId":"schema_642"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/images/companies/types","href":"images/imagedocumentcategorytypes","openApiOperationId":"imageDocumentCategoryTypes","summary":"Image Document Category Types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectImagesCompanyImageTypes"}},"schemaId":"components/schemas/ConnectImagesCompanyImageTypes"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1images~1companies~1types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectImagesCompanyImageTypes","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectImagesCompanyImageTypes"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/images/imagedocumentcategorytypes"}],"panels":[]}]},"httpPath":"/images/companies/types"},{"label":"Company Image","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/images/companyimage","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/images/companyimage","metadata":{"seo":{"title":"Company Image","description":"Endpoint to order an Image Document by Image ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companyImage","name":"Company Image","isWebhook":false,"pointer":"/paths/~1images~1{imageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to order an Image Document by Image ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"imageId","in":"path","schemaId":"schema_642","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image ID retrieved from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"images/companies"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1images~1{imageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/images/{imageId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"imageId","in":"path","required":true,"schemaId":"schema_642"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/images/{imageId}","href":"images/companyimage","openApiOperationId":"companyImage","summary":"Company Image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Image object as a binary stream.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment"}},"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1images~1{imageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/images/companyimage"}],"panels":[]}]},"httpPath":"/images/{imageId}"}],"content":{"contentType":"group","meta":{"name":"Images"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Images","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints to order official Company Image/Filing Documents from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source. Company Filings such as Annual Account Statements, Annual Returns,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Liquidations and Changes of Registered Information can be downloaded as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDFs, and are typically used as a resource in extended company"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"auditing/compliance. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/images/companies","summary":"Company Image Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/images/companyimagedocuments","deprecated":false},{"title":"/images/companies/types","summary":"Image Document Category Types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/images/imagedocumentcategorytypes","deprecated":false},{"title":"/images/{imageId}","summary":"Company Image","prefix":{"name":"get","color":"get"},"badges":[],"link":"/images/companyimage","deprecated":false}]}]}]}]}},{"type":"group","label":"Fresh Investigations","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations","items":[{"label":"Create Fresh Investigation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/createfreshinvestigation","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/createfreshinvestigation","metadata":{"seo":{"title":"Create Fresh Investigation","description":"Places an order for a Fresh Investigation (Offline Report). Providing as much detail as possible about the Company, our team will use official sources and registries to quickly answer questions about a company's stability and financial health. Fresh Investigations take 5.5 days on average to complete. By adding consent:true to the request, you are allowing Creditsafe to disclose your company details to the company you have requested the Investigation against, to be used only in the aim of improving our Investigation report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFreshInvestigation","name":"Create Fresh Investigation","isWebhook":false,"pointer":"/paths/~1freshinvestigations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Fresh Investigation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Places an order for a Fresh Investigation (Offline Report). Providing as much detail as possible about the Company, our team will use official sources and registries to quickly answer questions about a company's stability and financial health. Fresh Investigations take 5.5 days on average to complete. By adding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consent:true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the request, you are allowing Creditsafe to disclose your company details to the company you have requested the Investigation against, to be used only in the aim of improving our Investigation report."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvCreateInvestigation"}},"schemaId":"components/schemas/ConnectFreshInvCreateInvestigation","pointer":"/paths/~1freshinvestigations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/freshinvestigations","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvCreateInvestigation"}},"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations","href":"fresh-investigations/createfreshinvestigation","openApiOperationId":"createFreshInvestigation","summary":"Create Fresh Investigation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectFreshInvCreateInvestigation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvCreateInvestigation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvInvestigationConfirmed"}},"schemaId":"components/schemas/ConnectFreshInvInvestigationConfirmed"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1freshinvestigations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectFreshInvInvestigationConfirmed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvInvestigationConfirmed"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fresh-investigations/createfreshinvestigation"}],"panels":[]}]},"httpPath":"/freshinvestigations"},{"label":"Get Fresh Investigations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/getfreshinvestigations","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/getfreshinvestigations","metadata":{"seo":{"title":"Get Fresh Investigations","description":"Returns a list of your submitted Fresh Investigation Orders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFreshInvestigations","name":"Get Fresh Investigations","isWebhook":false,"pointer":"/paths/~1freshinvestigations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Fresh Investigations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of your submitted Fresh Investigation Orders."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_645","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_646","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"transactionId","in":"query","schemaId":"schema_642","description":"Fresh Investigation Identifier used internally and with our data partners."},{"name":"reportCreatedAfter","in":"query","schemaId":"schema_642","description":"Returns Fresh Investigations processed after this date","example":"2020-01-01T11:23:56Z"},{"name":"reportCreatedBefore","in":"query","schemaId":"schema_642","description":"Returns ordered Fresh Investigations that were processed before this date","example":"2020-01-01T11:23:56Z"},{"name":"createdBefore","in":"query","schemaId":"schema_642","description":"Returns Fresh Investigations created before this date"},{"name":"createdSince","in":"query","schemaId":"schema_642","description":"Returns ordered Fresh Investigations created after this date"},{"name":"lookUpOrderBy","in":"query","schemaId":"schema_664","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use to search for your Fresh Investigations by either the returned Company Details in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freshInvestigations/{orderId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint or your supplied Search Criteria in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/freshInvestigations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]},{"name":"companyDetailsCountry","in":"query","schemaId":"schema_642","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks for your returned Fresh Investigations where the returned Company Country is named this. Use with lookUpOrderBy=CompanyDetails"},"children":[]}]}]}]},{"name":"companyDetailsName","in":"query","schemaId":"schema_642","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks for your returned Fresh Investigations where the returned Company Name is named this. Use with lookUpOrderBy=CompanyDetails"},"children":[]}]}]}]},{"name":"searchCriteriaCountry","in":"query","schemaId":"schema_642","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks for your returned Fresh Investigations where your submitted Search Criteria Company Country is this. Use with lookUpOrderBy=searchCriteria"},"children":[]}]}]}]},{"name":"searchCriteriaName","in":"query","schemaId":"schema_642","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks for your Fresh Investigations where your submitted Search Criteria Company Name is this. Use with lookUpOrderBy=searchCriteria"},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_665","description":"Sorts  returned Fresh Investigations by this field"},{"name":"sortDir","in":"query","schemaId":"schema_666","description":"The direction that you wish to sort results by."}],"pointer":"/paths/~1freshinvestigations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/freshinvestigations","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_645"},{"name":"pageSize","in":"query","schemaId":"schema_646"},{"name":"transactionId","in":"query","schemaId":"schema_642"},{"name":"reportCreatedAfter","in":"query","example":"2020-01-01T11:23:56Z","schemaId":"schema_642"},{"name":"reportCreatedBefore","in":"query","example":"2020-01-01T11:23:56Z","schemaId":"schema_642"},{"name":"createdBefore","in":"query","schemaId":"schema_642"},{"name":"createdSince","in":"query","schemaId":"schema_642"},{"name":"lookUpOrderBy","in":"query","schemaId":"schema_664"},{"name":"companyDetailsCountry","in":"query","schemaId":"schema_642"},{"name":"companyDetailsName","in":"query","schemaId":"schema_642"},{"name":"searchCriteriaCountry","in":"query","schemaId":"schema_642"},{"name":"searchCriteriaName","in":"query","schemaId":"schema_642"},{"name":"sortBy","in":"query","schemaId":"schema_665"},{"name":"sortDir","in":"query","schemaId":"schema_666"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations","href":"fresh-investigations/getfreshinvestigations","openApiOperationId":"getFreshInvestigations","summary":"Get Fresh Investigations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvListInvestigations"}},"schemaId":"components/schemas/ConnectFreshInvListInvestigations"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1freshinvestigations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectFreshInvListInvestigations","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvListInvestigations"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fresh-investigations/getfreshinvestigations"}],"panels":[]}]},"httpPath":"/freshinvestigations"},{"label":"Retrieve FreshInvestigation Order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/retrievefreshinvestigationorder","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/retrievefreshinvestigationorder","metadata":{"seo":{"title":"Retrieve FreshInvestigation Order","description":"Returns a specific Fresh Investigation order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveFreshInvestigationOrder","name":"Retrieve FreshInvestigation Order","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve FreshInvestigation Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific Fresh Investigation order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_642","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sections","in":"query","schemaId":"schema_642","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify a value to return a single section, or multiple-comma separated sections of the completed Fresh Investigation. Leave null to return all sections. Available sections; - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyIdentification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditScore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactInformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherInformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groupStructure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extendedGroupStructure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"financialStatements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"negativeInformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalInformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directorships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"localFinancialStatements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companySummary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alternateSummary"},"children":[]}]}]}],"example":"companyIdentification,creditScore"},{"name":"comments","in":"query","schemaId":"schema_667","description":"Selects number of comments which should be returned with the order details."}],"pointer":"/paths/~1freshinvestigations~1{orderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/freshinvestigations/{orderId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_642"}],"query":[{"name":"sections","in":"query","example":"companyIdentification,creditScore","schemaId":"schema_642"},{"name":"comments","in":"query","schemaId":"schema_667"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}","href":"fresh-investigations/retrievefreshinvestigationorder","openApiOperationId":"retrieveFreshInvestigationOrder","summary":"Retrieve FreshInvestigation Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a specific Fresh Investigation Order. For completed orders this will contain the Investigation content as Report Sections.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvCompletedInvestigation"}},"schemaId":"components/schemas/ConnectFreshInvCompletedInvestigation"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1freshinvestigations~1{orderId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectFreshInvCompletedInvestigation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvCompletedInvestigation"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fresh-investigations/retrievefreshinvestigationorder"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}"},{"label":"Delete Fresh Investigations","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/deletefreshinvestigations","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/deletefreshinvestigations","metadata":{"seo":{"title":"Delete Fresh Investigations","description":"Deletes specified investigations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFreshInvestigations","name":"Delete Fresh Investigations","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Fresh Investigations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes specified investigations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_642","description":"Investigation id.","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/freshinvestigations/{orderId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_642"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}","href":"fresh-investigations/deletefreshinvestigations","openApiOperationId":"deleteFreshInvestigations","summary":"Delete Fresh Investigations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteFreshInvetigationsByOrderId"}},"schemaId":"components/schemas/DeleteFreshInvetigationsByOrderId"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1freshinvestigations~1{orderId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteFreshInvetigationsByOrderId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteFreshInvetigationsByOrderId"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fresh-investigations/deletefreshinvestigations"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}"},{"label":"Update FreshInvestigation Report Content","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/updatefreshinvestigationreportcontent","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/updatefreshinvestigationreportcontent","metadata":{"seo":{"title":"Update FreshInvestigation Report Content","description":"Update the Fresh Investigation Report data for a specific order, after the order has a status of delivered."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFreshInvestigationReportContent","name":"Update FreshInvestigation Report Content","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update FreshInvestigation Report Content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the Fresh Investigation Report data for a specific order, after the order has a status of delivered."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_642","description":"Fresh investigation orderId","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectUpdateFreshInvestigation"}},"schemaId":"components/schemas/ConnectUpdateFreshInvestigation","pointer":"/paths/~1freshinvestigations~1{orderId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/freshinvestigations/{orderId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_642"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectUpdateFreshInvestigation"}},"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}","href":"fresh-investigations/updatefreshinvestigationreportcontent","openApiOperationId":"updateFreshInvestigationReportContent","summary":"Update FreshInvestigation Report Content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectUpdateFreshInvestigation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectUpdateFreshInvestigation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Investigation Report.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_668"}},"schemaId":"schema_668"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1freshinvestigations~1{orderId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_668","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_668"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fresh-investigations/updatefreshinvestigationreportcontent"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}"},{"label":"Upload attachments for fresh investigation orderId","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/uploadattachmentsforfreshinvestigationorderid","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/uploadattachmentsforfreshinvestigationorderid","metadata":{"seo":{"title":"Upload attachments for fresh investigation orderId","description":"Returns the status of attachment upload for the particular order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadAttachmentsForFreshInvestigationOrderId","name":"Upload attachments for fresh investigation orderId","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload attachments for fresh investigation orderId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the status of attachment upload for the particular order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_642","description":"Fresh investigation orderId","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest"}},"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest","pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/freshinvestigations/{orderId}/attachments","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_642"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}/attachments","href":"fresh-investigations/uploadattachmentsforfreshinvestigationorderid","openApiOperationId":"uploadAttachmentsForFreshInvestigationOrderId","summary":"Upload attachments for fresh investigation orderId"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderResponse"}},"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fresh-investigations/uploadattachmentsforfreshinvestigationorderid"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}/attachments"},{"label":"Get attachments for the given fresh investigation orderId","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/getattachmentsforthegivenfreshinvestigationorderid","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/getattachmentsforthegivenfreshinvestigationorderid","metadata":{"seo":{"title":"Get attachments for the given fresh investigation orderId","description":"Returns attachments available for that particular order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAttachmentsForTheGivenFreshInvestigationOrderId","name":"Get attachments for the given fresh investigation orderId","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get attachments for the given fresh investigation orderId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns attachments available for that particular order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_642","description":"fresh investigation orderId","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/freshinvestigations/{orderId}/attachments","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_642"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}/attachments","href":"fresh-investigations/getattachmentsforthegivenfreshinvestigationorderid","openApiOperationId":"getAttachmentsForTheGivenFreshInvestigationOrderId","summary":"Get attachments for the given fresh investigation orderId"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FreshInvestigationGetAttachmentsForOrderResponse"}},"schemaId":"components/schemas/FreshInvestigationGetAttachmentsForOrderResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FreshInvestigationGetAttachmentsForOrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FreshInvestigationGetAttachmentsForOrderResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fresh-investigations/getattachmentsforthegivenfreshinvestigationorderid"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}/attachments"},{"label":"Get attachment for the given fresh investigation attachment Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/getattachmentforthegivenfreshinvestigationattachmentid","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/getattachmentforthegivenfreshinvestigationattachmentid","metadata":{"seo":{"title":"Get attachment for the given fresh investigation attachment Id","description":"Retrieve attachment for the given attachmentId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAttachmentForTheGivenFreshInvestigationAttachmentId","name":"Get attachment for the given fresh investigation attachment Id","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get attachment for the given fresh investigation attachment Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve attachment for the given attachmentId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_642","description":"fresh investigation orderId","required":true},{"name":"id","in":"path","schemaId":"schema_642","description":"fresh investigation attachment id for the given order","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/freshinvestigations/{orderId}/attachments/{id}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_642"},{"name":"id","in":"path","required":true,"schemaId":"schema_642"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}/attachments/{id}","href":"fresh-investigations/getattachmentforthegivenfreshinvestigationattachmentid","openApiOperationId":"getAttachmentForTheGivenFreshInvestigationAttachmentId","summary":"Get attachment for the given fresh investigation attachment Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment as a binary stream.","mediaType":"application/*","mediaTypes":["application/*","text/*","image/*"],"mediaTypeContent":{"application/*":{"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment"},"text/*":{"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment"},"image/*":{"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment"}},"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment","mediaTypes":["application/*","text/*","image/*"],"mediaTypeContent":{"application/*":{"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment"},"text/*":{"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment"},"image/*":{"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fresh-investigations/getattachmentforthegivenfreshinvestigationattachmentid"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}/attachments/{id}"},{"label":"Comments for fresh investigation orderId","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/commentsforfreshinvestigationorderid","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/commentsforfreshinvestigationorderid","metadata":{"seo":{"title":"Comments for fresh investigation orderId","description":"Returns the status of comments for the particular order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"commentsForFreshInvestigationOrderId","name":"Comments for fresh investigation orderId","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Comments for fresh investigation orderId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the status of comments for the particular order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_642","description":"fresh investigation orderId","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FreshInvestigationCommentsForOrderRequest","exampleIds":["paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/FreshInvestigationCommentsForOrderRequest","exampleIds":["paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/freshinvestigations/{orderId}/comments","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_642"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FreshInvestigationCommentsForOrderRequest","exampleIds":["paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}/comments","href":"fresh-investigations/commentsforfreshinvestigationorderid","openApiOperationId":"commentsForFreshInvestigationOrderId","summary":"Comments for fresh investigation orderId"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/FreshInvestigationCommentsForOrderRequest","exampleIds":["paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FreshInvestigationCommentsForOrderRequest","exampleIds":["paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FreshInvestigationCommentsForOrderResponse"}},"schemaId":"components/schemas/FreshInvestigationCommentsForOrderResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FreshInvestigationCommentsForOrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FreshInvestigationCommentsForOrderResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fresh-investigations/commentsforfreshinvestigationorderid"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}/comments"},{"label":"Retrieve comments of specified FreshInvestigation Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/retrievecommentsofspecifiedfreshinvestigationreport","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/retrievecommentsofspecifiedfreshinvestigationreport","metadata":{"seo":{"title":"Retrieve comments of specified FreshInvestigation Report","description":"Returns the Fresh Investigation Report comments for a specific order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveCommentsOfSpecifiedFreshInvestigationReport","name":"Retrieve comments of specified FreshInvestigation Report","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}~1comments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve comments of specified FreshInvestigation Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the Fresh Investigation Report comments for a specific order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_642","description":"FreshInvestigation Report Id","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1comments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/freshinvestigations/{orderId}/comments","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_642"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}/comments","href":"fresh-investigations/retrievecommentsofspecifiedfreshinvestigationreport","openApiOperationId":"retrieveCommentsOfSpecifiedFreshInvestigationReport","summary":"Retrieve comments of specified FreshInvestigation Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Investigation Report.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetFreshInvestigationCommentsByOrderIdResponse"}},"schemaId":"components/schemas/GetFreshInvestigationCommentsByOrderIdResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1comments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetFreshInvestigationCommentsByOrderIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetFreshInvestigationCommentsByOrderIdResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fresh-investigations/retrievecommentsofspecifiedfreshinvestigationreport"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}/comments"},{"label":"Retrieve FreshInvestigation Report Content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/retrievefreshinvestigationreportcontent","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/retrievefreshinvestigationreportcontent","metadata":{"seo":{"title":"Retrieve FreshInvestigation Report Content","description":"Returns the Fresh Investigation Report data for a specific order, after the order has a status of delivered."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveFreshInvestigationReportContent","name":"Retrieve FreshInvestigation Report Content","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}~1report/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve FreshInvestigation Report Content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the Fresh Investigation Report data for a specific order, after the order has a status of delivered."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_642","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1report/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/freshinvestigations/{orderId}/report","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_642"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}/report","href":"fresh-investigations/retrievefreshinvestigationreportcontent","openApiOperationId":"retrieveFreshInvestigationReportContent","summary":"Retrieve FreshInvestigation Report Content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Investigation Report.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1report/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fresh-investigations/retrievefreshinvestigationreportcontent"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}/report"}],"content":{"contentType":"group","meta":{"name":"Fresh Investigations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fresh Investigations","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to manage Fresh Investigation requests. With the need for accurate data, you can check on any company that is not available within our instant online database by placing a Fresh Investigation (Offline Order). Depending on the market, the information we obtain will vary. Using official sources and registries we are able to quickly answer questions about a company's stability and financial health. Where official information is not available we will conduct a direct interview with the business."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/freshinvestigations","summary":"Create Fresh Investigation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fresh-investigations/createfreshinvestigation","deprecated":false},{"title":"/freshinvestigations","summary":"Get Fresh Investigations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fresh-investigations/getfreshinvestigations","deprecated":false},{"title":"/freshinvestigations/{orderId}","summary":"Retrieve FreshInvestigation Order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fresh-investigations/retrievefreshinvestigationorder","deprecated":false},{"title":"/freshinvestigations/{orderId}","summary":"Delete Fresh Investigations","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/fresh-investigations/deletefreshinvestigations","deprecated":false},{"title":"/freshinvestigations/{orderId}","summary":"Update FreshInvestigation Report Content","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/fresh-investigations/updatefreshinvestigationreportcontent","deprecated":false},{"title":"/freshinvestigations/{orderId}/attachments","summary":"Upload attachments for fresh investigation orderId","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fresh-investigations/uploadattachmentsforfreshinvestigationorderid","deprecated":false},{"title":"/freshinvestigations/{orderId}/attachments","summary":"Get attachments for the given fresh investigation orderId","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fresh-investigations/getattachmentsforthegivenfreshinvestigationorderid","deprecated":false},{"title":"/freshinvestigations/{orderId}/attachments/{id}","summary":"Get attachment for the given fresh investigation attachment Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fresh-investigations/getattachmentforthegivenfreshinvestigationattachmentid","deprecated":false},{"title":"/freshinvestigations/{orderId}/comments","summary":"Comments for fresh investigation orderId","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fresh-investigations/commentsforfreshinvestigationorderid","deprecated":false},{"title":"/freshinvestigations/{orderId}/comments","summary":"Retrieve comments of specified FreshInvestigation Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fresh-investigations/retrievecommentsofspecifiedfreshinvestigationreport","deprecated":false},{"title":"/freshinvestigations/{orderId}/report","summary":"Retrieve FreshInvestigation Report Content","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fresh-investigations/retrievefreshinvestigationreportcontent","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ConnectAuthenticationAuthRequest":{"id":"components/schemas/ConnectAuthenticationAuthRequest","kind":"json-schema","title":"ConnectAuthenticationAuthRequest","data":{"type":"object","properties":{"username":{"type":"string","description":"Credentials assigned upon sign up","example":"username@domain.com"},"password":{"type":"string","example":"^1gHySRA56aj>tf421o"}}}},"components/schemas/ConnectAuthenticationAuthResponse":{"id":"components/schemas/ConnectAuthenticationAuthResponse","kind":"json-schema","title":"ConnectAuthenticationAuthResponse","data":{"type":"object","properties":{"token":{"type":"string","description":"Authentication Token","example":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyIsInR5cCI6IkpXVCIsIng1dCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyJ9.eyJuYmYiOjE1OTU0MTYyMDksImV4cCI6MTU5NTQxOTgwOSwiaXNzIjoiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20iLCJhdWQiOlsiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20vcmVzb3VyY2VzIiwiY29ubmVjdF9hcGkiLCJ1Ym9fYXBpX2dhdGV3YXkiXSwiY2xpZW50X2lkIjoiY29ubmVjdC5hcGkuY2xpZW50Iiwic3ViIjoiMTAxNTIwMjg1IiwiYXV0aF90aW1lIjoxNTk1NDE2MjA5LCJpZHAiOiJsb2NhbCIsInVzZXJuYW1lIjoiQ29ubmVjdHUxIiwiZW1haWwiOiJDb25uZWN0MUBnbWFpbC5jb20iLCJjdXN0b21lcklkIjoiMTAxNzY0NDA1IiwiY291bnRyeSI6IkMwIiwidXNlclJvbGUiOiJDcm1BZG1pblBsdXMiLCJzYl9jb3VudHJ5IjoiVVMiLCJzY29wZSI6WyJjb25uZWN0X2FwaSIsInVib19hcGlfZ2F0ZXdheSJdLCJhbXIiOlsicHdkIl19.p8kPAlKNB9iWEKiQbfbRXBoLQuBG7NuEDN__A8AQ55CL-gcIwkS1717Af1f9W0uifwIQ6HAZQR_x191LVkvuWD94Zw8zLzzr1ioUIhQny_zYuAS3G6EFNaTHh_mvOQ9XVi1FyuIy6YYcYcNLNZurFuITF2w5LuX4YQBjQy3rhEAdRoKcUKbtCClMFaH2dV35jiX2d7BqyhtJ8GeZyJ6yfMfdzznqxlJ4Osf5aasKUy8RYKEpjU2pkCURojoy5_oviGs8X4U9mJWcuajmPF3i5DHkqbhq1Mp0UZrDyoq_0BDStV5xqRgq6aOY8mc45kX7cwY3O2hPeGE7Ak8YtKFbA"}}}},"components/schemas/ConnectAuthFailedResponse":{"id":"components/schemas/ConnectAuthFailedResponse","kind":"json-schema","title":"ConnectAuthFailedResponse","data":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Access denied -  Please check that your username and password are correct.  Please be aware that usernames and passwords are case sensitive. If the problem persists, please contact your Creditsafe account manager."}}},"components/schemas/ConnectErrorResponsesBadRequest":{"id":"components/schemas/ConnectErrorResponsesBadRequest","kind":"json-schema","title":"ConnectErrorResponsesBadRequest","data":{"type":"object","description":"Bad Request","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"message":{"type":"string"},"details":{"type":"string","description":"Provides further information on why the request was rejected"}}}},"components/schemas/ConnectErrorResponsesInvalidToken":{"id":"components/schemas/ConnectErrorResponsesInvalidToken","kind":"json-schema","title":"ConnectErrorResponsesInvalidToken","data":{"type":"object","properties":{"error":{"type":"string"}},"description":"401 - Authorization Token has either expired or is not a valid Connect Token"}},"components/schemas/ConnectErrorResponsesAccessForbidden":{"id":"components/schemas/ConnectErrorResponsesAccessForbidden","kind":"json-schema","title":"ConnectErrorResponsesAccessForbidden","data":{"type":"object","description":"403 - Access Forbidden","properties":{"message":{"type":"string","example":"Access forbidden"}}}},"components/schemas/ConnectErrorResponsesResourceNotFoundRequest":{"id":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","kind":"json-schema","title":"ConnectErrorResponsesResourceNotFoundRequest","data":{"type":"object","description":"404 - Not Found","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","format":"uuid"},"message":{"type":"string"},"details":{"type":"string","description":"Provides further information on why the request was rejected"}}}},"components/schemas/CreditsafeGlobalDataCountryCode":{"id":"components/schemas/CreditsafeGlobalDataCountryCode","kind":"json-schema","title":"CreditsafeGlobalDataCountryCode","data":{"description":"Country where the company is registered.","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MC","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VA","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","XK","SS","SX","CW","BQ","WW","PLC"],"type":"string"}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchemaBase","data":{"type":"object"}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString","data":{"type":"object","properties":{"required":{"type":"boolean"},"minLength":{"type":["integer","null"],"format":"int32"},"maxLength":{"type":["integer","null"],"format":"int32"},"allowedValues":{"type":"array","items":{"type":"string"}},"validationRegExp":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"}]}},"components/schemas/CreditsafeGlobalDataCompanyType":{"id":"components/schemas/CreditsafeGlobalDataCompanyType","kind":"json-schema","title":"CreditsafeGlobalDataCompanyType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NonLtdNonReg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only available for countries in Norway."},"children":[]}]}]}],"enum":["NotSet","Ltd","NonLtd","NonLtdNonReg"],"type":"string"}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType","data":{"type":"object","properties":{"optional":{"type":"boolean"},"minLength":{"type":["integer","null"],"format":"int32"},"maxLength":{"type":["integer","null"],"format":"int32"},"allowedValues":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyType"}},"validationRegExp":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataOfficeType":{"id":"components/schemas/CreditsafeGlobalDataOfficeType","kind":"json-schema","title":"CreditsafeGlobalDataOfficeType","data":{"enum":["Registered","Trading","HeadOffice","Branch","Subsidiary","Franchise","Franchisor","SingleOffice","Other"],"type":"string"}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataOfficeType":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataOfficeType","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataOfficeType","data":{"type":"object","properties":{"optional":{"type":"boolean"},"minLength":{"type":["integer","null"],"format":"int32"},"maxLength":{"type":["integer","null"],"format":"int32"},"allowedValues":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataOfficeType"}},"validationRegExp":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataCompanyStatus":{"id":"components/schemas/CreditsafeGlobalDataCompanyStatus","kind":"json-schema","title":"CreditsafeGlobalDataCompanyStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High-level status. Values include \"Active\", \"NonActive\", \"Pending\" and \"Other\". Note - “Pending” indicates that the entity has entered into a legal process such as insolvency or liquidation, and “Other” indicates an unknown status."},"children":[]}]}]}],"enum":["Active","NonActive","Pending","Other"],"type":"string"}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyStatus":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyStatus","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyStatus","data":{"type":"object","properties":{"optional":{"type":"boolean"},"minLength":{"type":["integer","null"],"format":"int32"},"maxLength":{"type":["integer","null"],"format":"int32"},"allowedValues":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"}},"validationRegExp":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataAddressCriteriaSchema":{"id":"components/schemas/CreditsafeGlobalDataAddressCriteriaSchema","kind":"json-schema","title":"CreditsafeGlobalDataAddressCriteriaSchema","data":{"type":"object","properties":{"simpleValue":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema"},"street":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"houseNo":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"city":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"postCode":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"province":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"}}}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean","data":{"type":"object","properties":{"optional":{"type":"boolean"},"minLength":{"type":["integer","null"],"format":"int32"},"maxLength":{"type":["integer","null"],"format":"int32"},"allowedValues":{"type":"array","items":{"type":"boolean"}},"validationRegExp":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase"},{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"safeNo":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"regNo":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"vatNo":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"name":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema"},"type":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType"},"officeType":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataOfficeType"},"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyStatus"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressCriteriaSchema"},"phoneNumber":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"website":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"includeTradingNames":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean"},"includeTradingAddresses":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean"}}}]}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchemaCountry","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"countries":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"}},"languages":{"type":"array","description":"Available languages to perform a company search in the country queried","items":{"type":"string"}},"criteriaSets":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema"}}}}},"components/schemas/CreditsafeGlobalDataMessageType":{"id":"components/schemas/CreditsafeGlobalDataMessageType","kind":"json-schema","title":"CreditsafeGlobalDataMessageType","data":{"enum":["Information","Warning","Error"],"type":"string"}},"components/schemas/CreditsafeGlobalDataMessageCode":{"id":"components/schemas/CreditsafeGlobalDataMessageCode","kind":"json-schema","title":"CreditsafeGlobalDataMessageCode","data":{"enum":["NoResults","TooManyResults","ReportUnavailable","ReportUnavailableDueToLegal","ReportUnavailableOnline","LegalNotice","InvalidCredentials","AccessRestricted","AccessLimitsNearing","InsufficientCustomerData","ReportboxAlmostFull","ReportboxFull","InvalidRequestXml","InvalidOperationParameters","OperationNotSupported","InvalidCustomData","ChangeNotification","TemporarySystemProblem","EndpointShutdown","UnexpectedInternalError","Other","DataServiceAccessProblems","DataServiceInvalidResponse"],"type":"string"}},"components/schemas/CreditsafeGlobalDataMessage":{"id":"components/schemas/CreditsafeGlobalDataMessage","kind":"json-schema","title":"CreditsafeGlobalDataMessage","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/CreditsafeGlobalDataMessageType"},"code":{"$ref":"#/components/schemas/CreditsafeGlobalDataMessageCode"},"text":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataServiceResponse":{"id":"components/schemas/CreditsafeGlobalDataServiceResponse","kind":"json-schema","title":"CreditsafeGlobalDataServiceResponse","data":{"type":"object","properties":{"messages":{"description":"Provides information about the request and the response.","type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataMessage"}}}}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaDirector":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaDirector","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchemaDirector","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase"},{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"firstName":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema"},"lastName":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema"},"companyId":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"companyName":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema"},"companyType":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType"},"companyRegistrationNumber":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressCriteriaSchema"},"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"}}}]}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountryDirector":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountryDirector","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchemaCountryDirector","data":{"type":"object","properties":{"country":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaDirector"}}}}},"components/schemas/CreditsafeGlobalDataCustomDataEntrySchema":{"id":"components/schemas/CreditsafeGlobalDataCustomDataEntrySchema","kind":"json-schema","title":"CreditsafeGlobalDataCustomDataEntrySchema","data":{"type":"object","properties":{"key":{"type":"string"},"optional":{"type":"boolean"},"allowedValues":{"type":"array","items":{"type":"string"}},"description":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchemaSetDirector","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataServiceResponse"},{"type":"object","properties":{"countriesCriteria":{"description":"The list of available parameters for the search in the given country.","type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountryDirector"}},"customData":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataCustomDataEntrySchema"}}}}]}},"components/schemas/CreditsafeGlobalDataReportsIdType":{"id":"components/schemas/CreditsafeGlobalDataReportsIdType","kind":"json-schema","title":"CreditsafeGlobalDataReportsIdType","data":{"description":"Description for the ID, to describe the type of ID presented e.g. Person number, Tax ID (if a company), Company Registration Number etc.","enum":["Other","SafeNumber","RegistrationNumber","VATNumber","TaxID","PersonNumber","ExternalID","InternalID"],"type":"string"}},"components/schemas/CreditsafeGlobalDataAdditionalInformation":{"id":"components/schemas/CreditsafeGlobalDataAdditionalInformation","kind":"json-schema","title":"CreditsafeGlobalDataAdditionalInformation","data":{"type":"object","properties":{"isPLC":{"type":"string"},"coefficientLinear":{"type":"number"}}}},"components/schemas/CreditsafeGlobalDataSearchAddressData":{"id":"components/schemas/CreditsafeGlobalDataSearchAddressData","kind":"json-schema","title":"CreditsafeGlobalDataSearchAddressData","data":{"type":"object","properties":{"type":{"type":"string","description":"Address type description. Examples-  \"Registered Office\", \"Trading Address\", \"Postal Address\", \"Service Address\" etc."},"simpleValue":{"type":"string","description":"(Optionally populated) Registered address of the company. Whole string address if Creditsafe is unable to accurately assign values to specific address fields, or when specific local address formats need to be observed."},"street":{"type":"string","description":"Street portion of the address line. Can also, optionally contain, the house number alongside the street."},"houseNo":{"type":"string","description":"House number portion of the address line."},"city":{"type":"string","description":"City portion of the address line."},"postCode":{"type":"string","description":"Postal code portion of the address line."},"province":{"type":"string","description":"Province portion of the address line."},"telephone":{"type":"string","description":"Registered telephone number."},"directMarketingOptOut":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean [true/false]. Where set to true, the subject has \"opted out\" via a central register, and they must not be contacted for commercial marketing purposes."},"children":[]}]}]}]},"directMarketingOptIn":{"type":["boolean","null"]},"country":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"}}}},"components/schemas/CreditsafeGlobalDataCompanyActivityClassification":{"id":"components/schemas/CreditsafeGlobalDataCompanyActivityClassification","kind":"json-schema","title":"CreditsafeGlobalDataCompanyActivityClassification","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main activity classification being used for the company’s main activity, including the code, industry sector, and description."},"children":[]}]}]}],"properties":{"code":{"type":"string","description":"Main activity code used in that country e.g. SIC / NACE."},"industrySector":{"type":"string","description":"(Optionally populated) A high-level description, describing the industry sector/division in which the company operates."},"description":{"type":"string","description":"Description of main activity."},"classification":{"type":"string","description":"The type of activity classification being used for the main activity. E.g SIC07, NACE Rev2 etc. Where possible includes the version/revision date."}}}},"components/schemas/CreditsafeGlobalDataReportsAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsAdditionalData","data":{"type":"object","description":"The additionalData field is country-specific and may contain different properties depending on the country and product configuration.\nFor the UK, it may include director verification details (See this link).\nFor other countries, the structure and content may vary or be absent.\n"}},"components/schemas/CreditsafeGlobalDataCompanyDataAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataCompanyDataAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataCompanyDataAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataCompanyData":{"id":"components/schemas/CreditsafeGlobalDataCompanyData","kind":"json-schema","title":"CreditsafeGlobalDataCompanyData","data":{"type":"object","properties":{"id":{"type":"string","description":"Connect Id."},"country":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"regNo":{"type":"string","description":"Official registration number."},"safeNo":{"type":"string","description":"Creditsafe global identifier, called the Safe Number."},"idType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIdType"},"name":{"type":"string","description":"Full company name of Ultimate Holding Company."},"type":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyType"},"officeType":{"$ref":"#/components/schemas/CreditsafeGlobalDataOfficeType"},"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"},"vatNo":{"description":"Local VAT Number.","oneOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}}]},"additionalInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataAdditionalInformation"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchAddressData"},"activity":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyActivityClassification"},"legalForm":{"type":"string"},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyDataAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataCompany":{"id":"components/schemas/CreditsafeGlobalDataCompany","kind":"json-schema","title":"CreditsafeGlobalDataCompany","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyData"},{"type":"object","properties":{"dateOfLatestAccounts":{"type":["string","null"],"format":"date-time"},"dateOfLatestChange":{"type":["string","null"],"format":"date-time"},"phoneNumbers":{"type":"array","items":{"type":"string"}},"activityCode":{"type":["string","null"]}}}]}},"components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataCompany":{"id":"components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataCompany","kind":"json-schema","title":"CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataCompany","data":{"allOf":[{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"messages":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataMessage"}},"totalSize":{"type":"integer","format":"int32"},"companies":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompany"}}}}]}},"components/schemas/ConnectCompanySearchNoResults":{"id":"components/schemas/ConnectCompanySearchNoResults","kind":"json-schema","title":"ConnectCompanySearchNoResults","data":{"type":"object","properties":{"totalSize":{"type":"number"},"companies":{"type":"object"},"messages":{"type":"object","properties":{"code":{"type":"string","description":"Message code indicating the reason or status for the result. See enum values for possible codes.","enum":["NoResults","TooManyResults","ReportUnavailable","ReportUnavailableDueToLegal","ReportUnavailableOnline","LegalNotice","InvalidCredentials","AccessRestricted","AccessLimitsNearing","InsufficientCustomerData","ReportboxAlmostFull","ReportboxFull","InvalidRequestXml","InvalidOperationParameters","OperationNotSupported","InvalidCustomData","ChangeNotification","TemporarySystemProblem","EndpointShutdown","UnexpectedInternalError","Other","DataServiceAccessProblems","DataServiceInvalidResponse"]},"text":{"type":"string"},"type":{"type":"string","description":"Message type indicating the severity or nature of the message. See enum values for possible types.","enum":["Information","Warning","Error"]}}}}}},"components/schemas/ConnectCompanySearchResponse":{"id":"components/schemas/ConnectCompanySearchResponse","kind":"json-schema","title":"ConnectCompanySearchResponse","data":{"oneOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataCompany"},{"$ref":"#/components/schemas/ConnectCompanySearchNoResults"}]}},"components/schemas/CreditsafeGlobalDataReportsReportSection":{"id":"components/schemas/CreditsafeGlobalDataReportsReportSection","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportSection","data":{"enum":["CompanySummary","CompanySummaryExtra","AlternateSummary","CompanyIdentification","CompanyIdentificationExtra","CreditScore","CreditScoreExtra","ContactInformation","ContactInformationExtra","ShareCapitalStructure","ShareCapitalStructureExtra","Directors","DirectorsExtra","Directorships","DirectorshipsExtra","OtherInformation","OtherInformationExtra","GroupStructure","GroupStructureExtra","ExtendedGroupStructure","ExtendedGroupStructureExtra","GlobalFinancialStatements","GlobalFinancialStatementsExtra","LocalFinancialStatements","LocalFinancialStatementsExtra","PaymentData","PaymentDataExtra","NegativeInformation","NegativeInformationExtra","AdditionalInformation","AdditionalInformationExtra","UPPData","Unused"],"type":"string"}},"components/schemas/CreditsafeGlobalDataLanguage":{"id":"components/schemas/CreditsafeGlobalDataLanguage","kind":"json-schema","title":"CreditsafeGlobalDataLanguage","data":{"enum":["OM","AB","AA","AF","SQ","AM","AR","HY","AS","AY","AZ","BA","EU","BN","DZ","BH","BI","BR","BG","MY","BE","KM","CA","ZH","CO","HR","CS","DA","NL","EN","EO","ET","FO","FJ","FI","FR","FY","GL","KA","DE","EL","KL","GN","GU","HA","HE","HI","HU","IS","ID","IA","IE","IK","IU","GA","IT","JA","JW","KN","KS","KK","RW","KY","RN","KO","KU","LO","LA","LV","LN","LT","MK","MG","MS","ML","MT","MI","MR","MO","MN","NA","NE","NO","OC","OR","PS","FA","PL","PT","PA","QU","RM","RO","RU","SM","SG","SA","GD","SR","SH","ST","TN","SN","SD","SI","SS","SK","SL","SO","ES","SU","SW","SV","TL","TG","TA","TT","TE","TH","BO","TI","TO","TS","TR","TK","TW","UG","UK","UR","UZ","VI","VO","CY","WO","XH","YI","YO","ZA","ZU"],"type":"string"}},"components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyStatusDescription","data":{"type":"object","description":"High-level status of the company, such as 'Active', 'NonActive', 'Pending', or 'Other'.","properties":{"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"},"providerStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Optionally populated) high-level local status. E.g. may contain a registry status, such as \"Active\" for a \"Non-Trading\" company, whereas the common \"status\" will say “NonActive\"."},"children":[]}]}]}]},"providerCode":{"type":"string","description":"(Optionally populated) if available, this code pairs with the companyStatus.description"},"isActive":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean [true/false] when set to true indicates that the company is economically active."},"children":[]}]}]}]},"description":{"type":"string","description":"A more in-depth status value, based on local descriptions."}}}},"components/schemas/CreditsafeGlobalDataCurrency":{"id":"components/schemas/CreditsafeGlobalDataCurrency","kind":"json-schema","title":"CreditsafeGlobalDataCurrency","data":{"description":"The Currency in which the financial value is displayed, as a three-character ISO code.","enum":["AFA","ALL","DZD","ADF","ADP","AOA","ARA","ARS","AMD","AWG","AUD","AZM","BSD","BHD","BDT","BBD","BYR","BZD","BMD","BTN","BOB","BAM","BWP","BRC","BRL","GBP","BND","BGN","BIF","XOF","XAF","KHR","CAD","CVE","KYD","CLP","CNY","COP","KMF","CDF","CRC","HRK","CUP","CZK","DKK","DJF","DOP","NLG","EUR","ECS","EGP","SVC","EEK","ETB","FKP","FJD","FRF","GMD","GEL","GHC","GIP","XAU","GTQ","GNF","GWP","GYD","HTG","HNL","HKD","HUF","ISK","INR","IDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KRW","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MOP","MKD","MGF","MWK","MYR","MVR","MTL","MRO","MUR","MXN","MDL","MNT","MAD","MZM","MMK","ANG","NAD","NPR","NZD","NIO","NGN","KPW","NOK","OMR","PKR","XPD","PAB","PGK","PYG","PEN","PHP","XPT","PLN","QAR","RON","RUB","RWF","WST","STD","SAR","RSD","SCR","SLL","XAG","SGD","SKK","SIT","SBD","SOS","ZAR","LKR","SHP","SDD","SDG","SDP","SRD","SRG","SZL","SEK","CHF","SYP","TWD","TJS","TZS","THB","TOP","TTD","TND","TRY","TMM","USD","UGX","UAG","UAK","AED","UYU","UZS","VUV","VEF","VND","YUN","ZMK","ZWD","AFN","ATS","AZN","BYN","BEF","BOV","GRD","FIM","DEM","GHS","IEP","ITL","LUF","PTE","ESP","XDR","TMT","UAH","ERN","MGA","MRU","MZN","SSP","STN","YER","XPF","XCD","ZMW","ZWL"],"type":"string"}},"components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal":{"id":"components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal","kind":"json-schema","title":"CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal","data":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CreditsafeGlobalDataCurrency"},"value":{"type":"number","format":"double","description":"The maximum amount of share capital the company is authorised by its constitutional documents to issue to shareholders."}}}},"components/schemas/CreditsafeGlobalDataReportsCommonRatingValue":{"id":"components/schemas/CreditsafeGlobalDataReportsCommonRatingValue","kind":"json-schema","title":"CreditsafeGlobalDataReportsCommonRatingValue","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standardised credit score – will be A, B, C, D or E."},"children":[]}]}]}],"enum":["A","B","C","D","E"],"type":"string"}},"components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemString":{"id":"components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemString","kind":"json-schema","title":"CreditsafeGlobalDataReportsFinancialValue_1_SystemString","data":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CreditsafeGlobalDataCurrency"},"value":{"type":"string","description":"Amount of credit advisable at any one time."}}}},"components/schemas/CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString":{"id":"components/schemas/CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString","kind":"json-schema","title":"CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString","data":{"type":"object","properties":{"maxValue":{"type":"string","description":"The maximum value of the score that is provided for the Country."},"minValue":{"type":"string","description":"The minimum value of the score that is provided for the Country."},"value":{"type":"string","description":"Local credit score, as used by the supplier in that particular country"}}}},"components/schemas/CreditsafeGlobalDataReportsCreditRating":{"id":"components/schemas/CreditsafeGlobalDataReportsCreditRating","kind":"json-schema","title":"CreditsafeGlobalDataReportsCreditRating","data":{"type":"object","properties":{"commonValue":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCommonRatingValue"},"commonDescription":{"type":"string","description":"A text description of the common credit score."},"creditLimit":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemString"},"providerValue":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString"},"providerDescription":{"type":"string","description":"Local credit score description."},"pod":{"type":["number","null"],"format":"double","description":"Probability of Default (POD) is the anticipated likelihood of company default within the next 12 months in a percentage format."},"assessment":{"type":"string","description":"An additional score assessment commentary."}}}},"components/schemas/CreditsafeGlobalDataReportsLtdCompanySummary":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdCompanySummary","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdCompanySummary","data":{"type":"object","properties":{"businessName":{"type":"string","description":"Registered company name/trading name of the business."},"country":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"companyNumber":{"type":"string","description":"Creditsafe global identifier, called the Safe Number."},"companyRegistrationNumber":{"type":"string","description":"Official registration number."},"ggsID":{"type":"string","description":"The Connect API ID as used in v1.3 (GGS)."},"leiNumber":{"type":"string","description":"Global Legal Entity Identifier (LEI), often used in financial transactions identifier of an organisation"},"mainActivity":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyActivityClassification"},"companyStatus":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription"},"latestTurnoverFigure":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"latestShareholdersEquityFigure":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"creditRating":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCreditRating"}}}},"components/schemas/CreditsafeGlobalDataReportsLegalForm":{"id":"components/schemas/CreditsafeGlobalDataReportsLegalForm","kind":"json-schema","title":"CreditsafeGlobalDataReportsLegalForm","data":{"type":"object","properties":{"commonCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A common global code that aims to categorise legal forms across Countries. Currently only available for Non Ltd reports as “Sole Trader” or “Other”."},"children":[]}]}]}]},"providerCode":{"type":"string","description":"The local provider legal form codes specific to each Country"},"description":{"type":"string","description":"The legal type of the company e.g. S.A., GmbH, Ltd, N.V. etc."}}}},"components/schemas/CreditsafeGlobalDataAddressData":{"id":"components/schemas/CreditsafeGlobalDataAddressData","kind":"json-schema","title":"CreditsafeGlobalDataAddressData","data":{"type":"object","properties":{"type":{"type":"string","description":"Address type description. Examples - \"Registered Office\", \"Trading Address\", \"Postal Address\", \"Service Address\" etc."},"simpleValue":{"type":"string","description":"(Optionally populated) Registered address of the company. Whole string address if Creditsafe is unable to accurately assign values to specific address fields, or when specific local address formats need to be observed."},"street":{"type":"string","description":"Street portion of the address line. Can also, optionally contain, the house number alongside the street."},"houseNumber":{"type":"string","description":"House number portion of the address line."},"additionToAddress":{"type":"string","description":"Additional details for a specified address, such as a PO Box number, or a unit number at the specified address location."},"city":{"type":"string","description":"City portion of the address line."},"postalCode":{"type":"string","description":"Postal code portion of the address line."},"province":{"type":"string","description":"Province portion of the address line."},"region":{"type":"string","description":"May contain the geographical region, for example \"South-East\" or a territorial division."},"telephone":{"type":"string","description":"Registered telephone number."},"directMarketingOptOut":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean [true/false]. Where set to true, the subject has \"opted out\" via a central register, and they must not be contacted for commercial marketing purposes."},"children":[]}]}]}]},"directMarketingOptIn":{"type":["boolean","null"]},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code representing the geographic location of the entity.","example":"MC"}}}},"components/schemas/CreditsafeGlobalDataReportsLtdCompanyBasicInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdCompanyBasicInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdCompanyBasicInformation","data":{"type":"object","properties":{"businessName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The trading name of business, or “-“ if unknown"},"children":[]}]}]}]},"registeredCompanyName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registered company name, the legal name of the company. For NonLtd companies this would include the Owner name (i.e. the legal name), or “-“ if unknown."},"children":[]}]}]}]},"companyRegistrationNumber":{"type":"string","description":"Official registration number."},"ggsId":{"type":"string","description":"The Connect API ID as used in v1.3 (GGS)."},"leiNumber":{"type":"string","description":"Global Legal Entity Identifier (LEI), often used in financial transactions identifier of an organisation."},"country":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"vatRegistrationNumber":{"type":"string","description":"Local VAT Number."},"vatRegistrationDate":{"description":"Registration date of the local VAT number.","type":["string","null"],"format":"date-time"},"companyRegistrationDate":{"description":"The date the company was registered.","type":["string","null"],"format":"date-time"},"operationsStartDate":{"description":"The date the company began trading.","type":["string","null"],"format":"date-time"},"commercialCourt":{"description":"The local commercial court at which the company was registered.","type":"string"},"legalForm":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLegalForm"},"officeType":{"description":"Describes the office establishment type","enum":["Registered","Trading","HeadOffice","Branch","Subsidiary","Franchise","Franchisor","SingleOffice"]},"ownershipType":{"description":"Whether the company is wholly, part owned etc.","type":"string"},"companyStatus":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription"},"principalActivity":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyActivityClassification"},"contactAddress":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"}}}},"components/schemas/CreditsafeGlobalDataReportsCompanyActivity":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyActivity","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyActivity","data":{"type":"object","properties":{"code":{"type":"string","description":"Industry code used in that country e.g. SIC / NACE"},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of company’s main activity."},"children":[]}]}]}]}}}},"components/schemas/CreditsafeGlobalDataReportsCompanyActivityList":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyActivityList","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyActivityList","data":{"type":"object","properties":{"classification":{"type":"string","description":"The type of activity classification being used in the activities array. E.g. SIC07, NACE etc. Where possible includes the version/revision date."},"activities":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyActivity"}}}}},"components/schemas/CreditsafeGlobalDataReportsPreviousValue":{"id":"components/schemas/CreditsafeGlobalDataReportsPreviousValue","kind":"json-schema","title":"CreditsafeGlobalDataReportsPreviousValue","data":{"type":"object","properties":{"dateChanged":{"description":"Date when this name was officially changed (i.e. end date).","type":["string","null"],"format":"date-time"}}}},"components/schemas/CreditsafeGlobalDataReportsPreviousName":{"id":"components/schemas/CreditsafeGlobalDataReportsPreviousName","kind":"json-schema","title":"CreditsafeGlobalDataReportsPreviousName","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsPreviousValue"},{"type":"object","properties":{"name":{"type":"string","description":"Any previous name under which the company was registered."}}}]}},"components/schemas/CreditsafeGlobalDataReportsPreviousLegalForm":{"id":"components/schemas/CreditsafeGlobalDataReportsPreviousLegalForm","kind":"json-schema","title":"CreditsafeGlobalDataReportsPreviousLegalForm","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsPreviousValue"},{"type":"object","properties":{"legalForm":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLegalForm"}}}]}},"components/schemas/CreditsafeGlobalDataReportsLtdCompanyIdentification":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdCompanyIdentification","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdCompanyIdentification","data":{"type":"object","properties":{"basicInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdCompanyBasicInformation"},"activityClassifications":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyActivityList"}},"previousNames":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsPreviousName"}},"previousLegalForms":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsPreviousLegalForm"}}}}},"components/schemas/CreditsafeGlobalDataReportsLtdCreditScore":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdCreditScore","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdCreditScore","data":{"type":"object","properties":{"currentCreditRating":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCreditRating"},"currentContractLimit":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"previousCreditRating":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCreditRating"},"latestRatingChangeDate":{"description":"Last date that the credit score changed.","type":["string","null"],"format":"date-time"}}}},"components/schemas/CreditsafeGlobalDataAddressDataReport":{"id":"components/schemas/CreditsafeGlobalDataAddressDataReport","kind":"json-schema","title":"CreditsafeGlobalDataAddressDataReport","data":{"type":"object","properties":{"type":{"type":"string","description":"Address type description. Examples - \"Registered Office\", \"Trading Address\", \"Postal Address\", \"Service Address\" etc."},"simpleValue":{"type":"string","description":"(Optionally populated) Registered address of the company. Whole string address if Creditsafe is unable to accurately assign values to specific address fields, or when specific local address formats need to be observed."},"street":{"type":"string","description":"Street portion of the address line. Can also, optionally contain, the house number alongside the street."},"houseNumber":{"type":"string","description":"House number portion of the address line."},"additionToAddress":{"type":"string","description":"Additional details for a specified address, such as a PO Box number, or a unit number at the specified address location."},"city":{"type":"string","description":"City portion of the address line."},"postalCode":{"type":"string","description":"Postal code portion of the address line"},"province":{"type":"string","description":"Province portion of the address line."},"region":{"type":"string","description":"May contain the geographical region, for example \"South-East\" or a territorial division."},"telephone":{"type":"string","description":"Telephone number of the main address."},"directMarketingOptOut":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean [true/false]. Where set to true, the subject has \"opted out\" via a central register, and they must not be contacted for commercial marketing purposes."},"children":[]}]}]}]},"directMarketingOptIn":{"type":["boolean","null"]},"country":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"}}}},"components/schemas/CreditsafeGlobalDataReportsLtdContactInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdContactInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdContactInformation","data":{"type":"object","properties":{"mainAddress":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressDataReport"},"otherAddresses":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressDataReport"}},"previousAddresses":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressDataReport"}},"emailAddresses":{"type":"array","description":"Email address for the company.","items":{"type":"string"}},"websites":{"type":"array","description":"Website address of the company.","items":{"type":"string"}}}}},"components/schemas/CreditsafeGlobalDataReportsIndicatorIndustryComparison":{"id":"components/schemas/CreditsafeGlobalDataReportsIndicatorIndustryComparison","kind":"json-schema","title":"CreditsafeGlobalDataReportsIndicatorIndustryComparison","data":{"type":"object","properties":{"sectorCode":{"type":"string"},"sectorAverage":{"type":"string","description":"The average indicator value for the industry sector in which the subject company operates."},"sectorCount":{"type":["integer","null"],"format":"int32","description":"The count of all companies in this industry sector."},"totalAverage":{"type":"string","description":"The average indicator value for all companies (irrespective of industry sector)."},"totalCount":{"type":["integer","null"],"format":"int32","description":"The count of all companies (irrespective of industry sector)."}}}},"components/schemas/CreditsafeGlobalDataReportsIndicators":{"id":"components/schemas/CreditsafeGlobalDataReportsIndicators","kind":"json-schema","title":"CreditsafeGlobalDataReportsIndicators","data":{"type":"array","description":"Indicators provides additional information when assessing a company's performance. This is a premium service, not available for all customers.","items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lowercase char(3) code indicating the type of indicator. For example - Financial Strength Indicator (“fsi”), Payment Behaviour Indicator (“pbi”), Payment Expectation Indicator (“pei”)."},"children":[]}]}]}],"enum":["eti","pei","fsi","pbi"]},"value":{"type":"string","description":"The value of the indicator.","example":"X"},"changeDate":{"type":"string","format":"date-time","description":"The date associated with the current indicator."},"industryComparison":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIndicatorIndustryComparison"}}}}},"components/schemas/CreditsafeGlobalDataReportsEntityFullName":{"id":"components/schemas/CreditsafeGlobalDataReportsEntityFullName","kind":"json-schema","title":"CreditsafeGlobalDataReportsEntityFullName","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID."},"idType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIdType"},"name":{"type":"string","description":"Name of the Shareholder, or Company Name if a corporate shareholder exists."},"title":{"type":"string","description":"Title, if known."},"firstNames":{"type":"string","description":"First name(s) of the shareholder. May optionally include middle names, or initials if these cannot be distinguished."},"firstName":{"type":"string","description":"First name of the shareholder. This field should be used if a middleName also exists."},"middleName":{"type":"string","description":"Middle name of the shareholder."},"surname":{"type":"string","description":"Last name of the shareholder."},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"}}}},"components/schemas/CreditsafeGlobalDataReportsEntityType":{"id":"components/schemas/CreditsafeGlobalDataReportsEntityType","kind":"json-schema","title":"CreditsafeGlobalDataReportsEntityType","data":{"description":"Indicates if the shareholders record relates to a \"Person\", \"Company\" or \"Other\".","enum":["Other","Person","Company"],"type":"string"}},"components/schemas/CreditsafeGlobalDataReportsShareClassAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsShareClassAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsShareClassAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsShareClass":{"id":"components/schemas/CreditsafeGlobalDataReportsShareClass","kind":"json-schema","title":"CreditsafeGlobalDataReportsShareClass","data":{"type":"object","properties":{"shareType":{"description":"(Optionally populated) The share class description.","type":"string"},"currency":{"$ref":"#/components/schemas/CreditsafeGlobalDataCurrency"},"valuePerShare":{"type":["number","null"],"format":"double","description":"(Optionally populated) The value per share, also known as the par value. Expressed as an integer, or to two decimal places."},"jointlyOwned":{"type":["boolean","null"],"description":"(Optionally populated) Boolean. Set to true where the shares are jointly owned."},"numberOfSharesOwned":{"type":["integer","null"],"format":"int64","description":"(Optionally populated) The number of shares owned. If more than one share class exists, this is the number per share class."},"valueOfSharesOwned":{"type":["number","null"],"format":"double","description":"(Optionally populated) The total nominal value of Shares owned. If more than one share class exists, this is the total nominal value per share class."},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsShareClassAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataReportsShareHolder":{"id":"components/schemas/CreditsafeGlobalDataReportsShareHolder","kind":"json-schema","title":"CreditsafeGlobalDataReportsShareHolder","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsEntityFullName"},{"type":"object","properties":{"shareholderType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsEntityType"},"shareType":{"type":"string","description":"The share class, for example \"Ordinary\"."},"currency":{"$ref":"#/components/schemas/CreditsafeGlobalDataCurrency"},"totalValueOfSharesOwned":{"type":["number","null"],"format":"double","description":"The total nominal value of all shares owned. Expressed as an integer, or to two decimal places."},"totalNumberOfSharesOwned":{"type":["integer","null"],"format":"int64","description":"The total number of all shares owned."},"percentSharesHeld":{"type":["number","null"],"format":"double","description":"The total percentage of all shares held. Expressed as an integer, or to two decimal places."},"startDate":{"type":["string","null"],"format":"date-time","description":"Date when the shareholding started."},"endDate":{"type":["string","null"],"format":"date-time","description":"Date when the shareholding ended. Where populated, this indicates that the party has ceased to be a shareholder."},"hasNegativeInfo":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean [true/false] when set to true, this indicates that the shareholder has negative information such as Protesti, Court Judgements etc. linked to their unique shareholders ID."},"children":[]}]}]}]},"shareClasses":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsShareClass"}}}}]}},"components/schemas/CreditsafeGlobalDataReportsLtdShareCapitalStructure":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdShareCapitalStructure","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdShareCapitalStructure","data":{"type":"object","properties":{"nominalShareCapital":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"issuedShareCapital":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"shareCapitalCurrency":{"type":"string","description":"The Currency in which the share values are displayed, as a three-character ISO code."},"numberOfSharesIssued":{"type":["integer","null"],"format":"int64","description":"The total number of issued shares."},"shareHolders":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsShareHolder"}}}}},"components/schemas/CreditsafeGlobalDataReportsGender":{"id":"components/schemas/CreditsafeGlobalDataReportsGender","kind":"json-schema","title":"CreditsafeGlobalDataReportsGender","data":{"enum":["Unknown","Male","Female","NotApplicable"],"type":"string"}},"components/schemas/CreditsafeGlobalDataReportsCorporatePositionAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsCorporatePositionAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsCorporatePositionAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsCorporatePosition":{"id":"components/schemas/CreditsafeGlobalDataReportsCorporatePosition","kind":"json-schema","title":"CreditsafeGlobalDataReportsCorporatePosition","data":{"type":"object","properties":{"dateAppointed":{"type":["string","null"],"format":"date-time","description":"The date the director was appointed."},"commonCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A common global code that aims to categorise director positions across Countries – currently no data available."},"children":[]}]}]}]},"providerCode":{"type":"string","description":"The local provider director code (if exists) specific to each Country."},"positionName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The director’s role/position in a company."},"children":[]}]}]}]},"authority":{"type":"string","description":"If available, any available details pertaining to the score, power, limitations, signing authority or ability to bind the company."},"apptDurationType":{"type":"string","description":"The appointment duration should be used in conjunction with the appointment term field."},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCorporatePositionAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataReportsDirectorAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsDirector":{"id":"components/schemas/CreditsafeGlobalDataReportsDirector","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirector","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsEntityFullName"},{"type":"object","properties":{"gender":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsGender"},"birthName":{"type":"string","description":"The birth name or previous legal name of the officer."},"dateOfBirth":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The director’s date of birth."},"children":[]}]}]}]},"placeOfBirth":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The director’s place or region of birth."},"children":[]}]}]}]},"nationality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The director’s nationality or country of birth."},"children":[]}]}]}]},"countryOfResidence":{"type":"string","description":"The country of residence, if known."},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code representing the geographic location of the entity.","example":"MC"},"directorType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsEntityType"},"hasNegativeInfo":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Linked with DE searches, may return with other countries if data is available. Boolean [true/false] if the director has negative information, such as Protesti, Court Judgements etc linked to their unique directors ID. Boolean [true/false] set to true where the director is known to be an authorised signatory. Further details, if known, may be present in \"authority\" or \"additionalData\"."},"children":[]}]}]}]},"signingAuthority":{"description":"Linked with DE searches, may return with other countries if data is available.","type":["boolean","null"]},"positions":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCorporatePosition"}},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorAdditionalData"}}}]}},"components/schemas/CreditsafeGlobalDataReportsPreviousDirector":{"id":"components/schemas/CreditsafeGlobalDataReportsPreviousDirector","kind":"json-schema","title":"CreditsafeGlobalDataReportsPreviousDirector","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirector"},{"type":"object","properties":{"resignationDate":{"type":["string","null"],"format":"date-time","description":"The date the director resigned."}}}]}},"components/schemas/CreditsafeGlobalDataReportsLtdDirectors":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdDirectors","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdDirectors","data":{"type":"object","properties":{"currentDirectors":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirector"}},"previousDirectors":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsPreviousDirector"}}}}},"components/schemas/CreditsafeGlobalDataReportsCorporatePositionResigned":{"id":"components/schemas/CreditsafeGlobalDataReportsCorporatePositionResigned","kind":"json-schema","title":"CreditsafeGlobalDataReportsCorporatePositionResigned","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCorporatePosition"},{"type":"object","properties":{"resignationDate":{"type":["string","null"],"format":"date-time"}}}]}},"components/schemas/CreditsafeGlobalDataReportsDirectorship":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorship","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorship","data":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"initials":{"type":"string"},"name":{"type":"string"},"position":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCorporatePositionResigned"},"registrationNumber":{"type":"string"},"companyName":{"type":"string"},"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription"}}}},"components/schemas/CreditsafeGlobalDataReportsDirectorships":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorships","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorships","data":{"type":"object","properties":{"currentDirectorships":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorship"}},"previousDirectorships":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorship"}}}}},"components/schemas/CreditsafeGlobalDataReportsEntity":{"id":"components/schemas/CreditsafeGlobalDataReportsEntity","kind":"json-schema","title":"CreditsafeGlobalDataReportsEntity","data":{"type":"object","properties":{"name":{"description":"Name of bank that the company holds an account with.","type":"string"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"}}}},"components/schemas/CreditsafeGlobalDataReportsBanker":{"id":"components/schemas/CreditsafeGlobalDataReportsBanker","kind":"json-schema","title":"CreditsafeGlobalDataReportsBanker","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsEntity"},{"type":"object","properties":{"bankCode":{"type":"string","description":"Bank code associated with the bank."},"bic":{"type":"string","description":"Bank Identifier Code (BIC) or SWIFT code, used for international transfers."}}}]}},"components/schemas/CreditsafeGlobalDataReportsAdvisor":{"id":"components/schemas/CreditsafeGlobalDataReportsAdvisor","kind":"json-schema","title":"CreditsafeGlobalDataReportsAdvisor","data":{"type":"object","properties":{"auditorName":{"type":"string","description":"Full name of the company who is responsible for auditing."},"solicitorName":{"type":"string","description":"Name of solicitors."},"accountantName":{"type":"string","description":"Full name of the accountancy firm who responsible for preparing the accounts."}}}},"components/schemas/CreditsafeGlobalDataReportsEmployeeInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsEmployeeInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsEmployeeInformation","data":{"type":"object","properties":{"year":{"type":["integer","null"],"format":"int32","description":"Year that the figures were reordered."},"numberOfEmployees":{"type":"string","description":"Number of staff that the company employ directly."}}}},"components/schemas/CreditsafeGlobalDataReportsLtdOtherInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdOtherInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdOtherInformation","data":{"type":"object","properties":{"bankers":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsBanker"}},"advisors":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdvisor"}},"employeesInformation":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsEmployeeInformation"}}}}},"components/schemas/CreditsafeGlobalDataGroupStructureCompanyData":{"id":"components/schemas/CreditsafeGlobalDataGroupStructureCompanyData","kind":"json-schema","title":"CreditsafeGlobalDataGroupStructureCompanyData","data":{"type":"object","properties":{"id":{"type":"string","description":"Connect Id."},"country":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"registrationNumber":{"type":"string","description":"Official registration number."},"safeNo":{"type":"string","description":"Creditsafe global identifier, called the Safe Number."},"idType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIdType"},"name":{"type":"string","description":"Full company name of Ultimate Holding Company."},"type":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyType"},"officeType":{"$ref":"#/components/schemas/CreditsafeGlobalDataOfficeType"},"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"},"vatNo":{"description":"Local VAT Number.","oneOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}}]},"additionalInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataAdditionalInformation"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"},"activity":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyActivityClassification"},"legalForm":{"type":"string"},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyDataAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataReportsLtdGroupStructure":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdGroupStructure","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdGroupStructure","data":{"type":"object","properties":{"ultimateParent":{"$ref":"#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData"},"immediateParent":{"$ref":"#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData"},"subsidiaryCompanies":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData"}},"affiliatedCompanies":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData"}}}}},"components/schemas/CreditsafeGlobalDataReportsCompanyInGroupAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyInGroupAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyInGroupAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsCompanyInGroup":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyInGroup","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyInGroup","data":{"type":"object","properties":{"id":{"type":"string","description":"Connect Id."},"country":{"type":"string","description":"Country where the company is established."},"safeNumber":{"type":"string","description":"Creditsafe global identifier, called the Safe Number."},"idType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIdType"},"companyName":{"type":"string","description":"Full company name."},"registeredNumber":{"type":"string","description":"Official registration number."},"latestAnnualAccounts":{"type":["string","null"],"format":"date-time","description":"The last filed financial statements Year End Date of the company."},"level":{"type":"integer","format":"int32","description":"The hierarchical level of the company within the group structure."},"percentOfOwnership":{"type":["number","null"],"format":"double","description":"The percentage of shares owned."},"status":{"type":"string","description":"High-level status. Values include \"Active\", \"NonActive\", \"Pending\" and \"Other\"."},"commonRatingBand":{"type":"string","description":"Standardised credit score."},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyInGroupAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataReportsLtdFinancialStatement":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdFinancialStatement","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdFinancialStatement","data":{"type":"object","properties":{"type":{"type":"string","description":"A code element set as \"GlobalFinancialsGGS\", which represents that the financial statements are in a common/standardised international format."},"yearEndDate":{"type":"string","format":"date-time","description":"Financial Year End date for the annual accounts."},"numberOfWeeks":{"type":["integer","null"],"format":"int32","description":"Number of weeks in the year."},"currency":{"$ref":"#/components/schemas/CreditsafeGlobalDataCurrency"},"consolidatedAccounts":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean [true/false]. Are the accounts consolidated?"},"children":[]}]}]}]}}}},"components/schemas/CreditsafeGlobalDataReportsProfitAndLossFigures":{"id":"components/schemas/CreditsafeGlobalDataReportsProfitAndLossFigures","kind":"json-schema","title":"CreditsafeGlobalDataReportsProfitAndLossFigures","data":{"type":"object","properties":{"revenue":{"type":["number","null"],"format":"double","description":"Income earned from normal business activities, including the sale of goods and services."},"operatingCosts":{"type":["number","null"],"format":"double","description":"Costs incurred in the general running of the business."},"operatingProfit":{"type":["number","null"],"format":"double","description":"The results of the company after deducting Operating Costs from its Revenue."},"wagesAndSalaries":{"type":["number","null"],"format":"double","description":"Wages and salaries paid to employees of the company. Where possible this excludes Pensions."},"pensionCosts":{"type":["number","null"],"format":"double","description":"The cost of pension benefits for employees of the company."},"depreciation":{"type":["number","null"],"format":"double","description":"The amount written off Tangible Fixed Assets during the year."},"amortisation":{"type":["number","null"],"format":"double","description":"The amount written off Intangible Fixed Assets during the year."},"financialIncome":{"type":["number","null"],"format":"double","description":"Interest income earned during the year."},"financialExpenses":{"type":["number","null"],"format":"double","description":"Interest expenses incurred during the year."},"extraordinaryIncome":{"type":["number","null"],"format":"double","description":"Income arising due to events of a non-recurring nature."},"extraordinaryCosts":{"type":["number","null"],"format":"double","description":"Costs incurred due to events of a non-recurring nature."},"profitBeforeTax":{"type":["number","null"],"format":"double","description":"The results of the company before deducting any charge for taxation."},"tax":{"type":["number","null"],"format":"double","description":"Taxation payable on the profits of the company."},"profitAfterTax":{"type":["number","null"],"format":"double","description":"The results of the company after deducting any charge for taxation."},"dividends":{"type":["number","null"],"format":"double","description":"The total amount of profits distributed to shareholders."},"minorityInterests":{"type":["number","null"],"format":"double","description":"Profits attributable to shareholders holding a minority interest in the company."},"otherAppropriations":{"type":["number","null"],"format":"double","description":"Other miscellaneous items that are deducted / added to affect the Retained Profit / Loss of a company."},"retainedProfit":{"type":["number","null"],"format":"double","description":"The results of the company after all income and expenses have been credited/debited."}}}},"components/schemas/CreditsafeGlobalDataReportsBalanceSheet":{"id":"components/schemas/CreditsafeGlobalDataReportsBalanceSheet","kind":"json-schema","title":"CreditsafeGlobalDataReportsBalanceSheet","data":{"type":"object","properties":{"landAndBuildings":{"type":["number","null"],"format":"double","description":"Land and buildings owned by the company for long-term use."},"plantAndMachinery":{"type":["number","null"],"format":"double","description":"Plant and machinery owned by the company for long-term use."},"otherTangibleAssets":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tangible fixed assets other than Land & Buildings or Plant & Machinery."},"children":[]}]}]}]},"totalTangibleAssets":{"type":["number","null"],"format":"double","description":"Physical assets owned by the company for long-term use."},"goodwill":{"type":["number","null"],"format":"double","description":"The premium paid or accumulated on the purchase of an asset."},"otherIntangibleAssets":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intangible fixed assets other than goodwill such as Trademarks, Patents, Research & Development, etc."},"children":[]}]}]}]},"totalIntangibleAssets":{"type":["number","null"],"format":"double","description":"Assets that have a value but no physical existence."},"investments":{"type":["number","null"],"format":"double","description":"Long-term investments including shares and securities."},"loansToGroup":{"type":["number","null"],"format":"double","description":"Long-term loans made by the company to related businesses."},"otherLoans":{"type":["number","null"],"format":"double","description":"Other long-term loans made by the company."},"miscellaneousFixedAssets":{"type":["number","null"],"format":"double","description":"Long-term assets other than Tangible Assets, Intangible Assets, Investments, or Loans."},"totalOtherFixedAssets":{"type":["number","null"],"format":"double","description":"Total long-term assets other than Tangible Assets or Intangible Assets."},"totalFixedAssets":{"type":["number","null"],"format":"double","description":"The total of Tangible, Intangible, and Other Fixed Assets."},"rawMaterials":{"type":["number","null"],"format":"double","description":"Materials held by the company that have not yet been processed."},"workInProgress":{"type":["number","null"],"format":"double","description":"Goods or contracts that are in the process of manufacture or completion."},"finishedGoods":{"type":["number","null"],"format":"double","description":"Goods held that are ready for sale or use."},"otherInventories":{"type":["number","null"],"format":"double","description":"Other amounts classed as Inventory but not included above."},"totalInventories":{"type":["number","null"],"format":"double","description":"The total of stocks held by the company and work in progress."},"tradeReceivables":{"type":["number","null"],"format":"double","description":"Amounts due within one year from customers for goods and services supplied on credit."},"groupReceivables":{"type":["number","null"],"format":"double","description":"Amounts due within one year from related businesses."},"receivablesDueAfter1Year":{"type":["number","null"],"format":"double","description":"Amounts due after one year owing to the company (including trade and group receivables due after one year)."},"miscellaneousReceivables":{"type":["number","null"],"format":"double","description":"Amounts due within one year owing to the company other than trade and group receivables."},"totalReceivables":{"type":["number","null"],"format":"double","description":"Total amounts receivable by the company."},"cash":{"type":["number","null"],"format":"double","description":"Cash at bank, cash in hand, and cash equivalents."},"otherCurrentAssets":{"type":["number","null"],"format":"double","description":"Any short-term assets that have not already been included as Inventory, Receivables, or Cash."},"totalCurrentAssets":{"type":["number","null"],"format":"double","description":"The total of Stocks, Debtors, Cash, and other assets due within one year."},"totalAssets":{"type":["number","null"],"format":"double","description":"The total of Current and Fixed Assets."},"tradePayables":{"type":["number","null"],"format":"double","description":"Amounts due within one year owing to suppliers for goods and services provided on credit."},"bankLiabilities":{"type":["number","null"],"format":"double","description":"Amounts due within one year owing to banks for overdrafts and loans."},"otherLoansOrFinance":{"type":["number","null"],"format":"double","description":"Loans or finance due within one year owing to parties other than banks or related businesses."},"groupPayables":{"type":["number","null"],"format":"double","description":"Amounts due within one year to related businesses."},"miscellaneousLiabilities":{"type":["number","null"],"format":"double","description":"Other amounts due within one year owing by the company."},"totalCurrentLiabilities":{"type":["number","null"],"format":"double","description":"Total short-term liabilities of the company."},"tradePayablesDueAfter1Year":{"type":["number","null"],"format":"double","description":"Amounts due after one year owing to suppliers for goods and services provided on credit."},"bankLiabilitiesDueAfter1Year":{"type":["number","null"],"format":"double","description":"Amounts due after one year owing to banks for overdrafts and loans."},"otherLoansOrFinanceDueAfter1Year":{"type":["number","null"],"format":"double","description":"Loans or finance due after one year owing to parties other than banks or related businesses."},"groupPayablesDueAfter1Year":{"type":["number","null"],"format":"double","description":"Amounts due after one year to related businesses."},"miscellaneousLiabilitiesDueAfter1Year":{"type":["number","null"],"format":"double","description":"Other amounts due after one year owing by the company."},"totalLongTermLiabilities":{"type":["number","null"],"format":"double","description":"Total long-term liabilities of the company."},"totalLiabilities":{"type":["number","null"],"format":"double","description":"The total of Total Long-term Liabilities and Total Current Liabilities."},"calledUpShareCapital":{"type":["number","null"],"format":"double","description":"The issued and paid share capital from shareholders."},"sharePremium":{"type":["number","null"],"format":"double","description":"The excess of the amount received on the issue of shares over their value."},"revenueReserves":{"type":["number","null"],"format":"double","description":"The accumulation of profits/losses from previous trading periods."},"otherReserves":{"type":["number","null"],"format":"double","description":"Other capital and reserves that form part of shareholders' equity."},"totalShareholdersEquity":{"type":["number","null"],"format":"double","description":"The total capital and reserves of the company."}}}},"components/schemas/CreditsafeGlobalDataReportsOtherFinancials":{"id":"components/schemas/CreditsafeGlobalDataReportsOtherFinancials","kind":"json-schema","title":"CreditsafeGlobalDataReportsOtherFinancials","data":{"type":"object","properties":{"contingentLiabilities":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Potential liabilities that are not recognised in the balance sheet, output as a string. Usually contains integers, but can also be output as a string value (such as “YES” or “NO”)."},"children":[]}]}]}]},"workingCapital":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total Current Assets – Receivables Due after 1 year – Total Current Liabilities. This measures if the company has sufficient short-term assets to cover its current debts."},"children":[]}]}]}]},"netWorth":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Often referred to as the 'book value' of the business this equals Total Shareholders’ Equity less Total Intangible Assets"},"children":[]}]}]}]}}}},"components/schemas/CreditsafeGlobalDataReportsFinancialRatios":{"id":"components/schemas/CreditsafeGlobalDataReportsFinancialRatios","kind":"json-schema","title":"CreditsafeGlobalDataReportsFinancialRatios","data":{"type":"object","properties":{"preTaxProfitMargin":{"type":["number","null"],"format":"double","description":"Pre-tax profits / Turnover x 100. This shows the percentage of Profit in each pound of sales or the equivalent of retailers 'mark-up'."},"returnOnCapitalEmployed":{"type":["number","null"],"format":"double","description":"Pre-Tax Profit / Capital Employed x 100. This ratio measures the profits a business yields in return for the money (Capital) invested."},"returnOnTotalAssetsEmployed":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-Tax Profits / Total Assets x 100. This shows the ‘return’ or 'profit' on each pound of Assets used as a percentage."},"children":[]}]}]}]},"returnOnNetAssetsEmployed":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-Tax Profits / Net Assets x 100. This shows the ‘return’ in percent on the net assets of the company. The higher the percentage the more profitable the company."},"children":[]}]}]}]},"salesOrNetWorkingCapital":{"type":["number","null"],"format":"double","description":"Turnover / (Total Current Assets - Receivables Due after 1 year - Total Current Liabilities). The higher the ratio the higher the volume of Sales made per the companies working capital."},"stockTurnoverRatio":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stocks / Turnover x 100. This shows the number of times the trading stock of a company is ‘turned over’ in a trading period. If the ratio is low this indicates that relatively little money is tied up in Stocks."},"children":[]}]}]}]},"debtorDays":{"type":["number","null"],"format":"double","description":"Trade Debtors / Turnover x 365 days. This is a calculation that predicts the average time taken for the company to collect its invoices for goods and services provided to its customers."},"creditorDays":{"type":["number","null"],"format":"double","description":"Trade Creditors / Turnover x 365 days. This is a calculation that predicts the average time taken for the company to settle its invoices for goods and services provided by its suppliers."},"currentRatio":{"type":["number","null"],"format":"double","description":"Total Current Assets - Receivables Due after 1 year / Total Current Liabilities. This is an indication of a company's ability to meet short-term debt obligations; the higher the ratio, the more liquid the company is."},"liquidityRatioOrAcidTest":{"type":["number","null"],"format":"double","description":"Total Current Assets - Total Inventories - Receivables Due after 1 year / Total Current Liabilities. This, like the current ratio, measures how quickly a company can meet its short-term debts. However, this ratio excludes stock, as there is no guarantee the value of Stocks can be realised quickly."},"currentDebtRatio":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total Current Liabilities / Total Shareholders’ Equity. This measures the amount of short-term debt in relation to the value of shareholders’ funds."},"children":[]}]}]}]},"gearing":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Overdraft & Loans + Total Long-term Liabilities/Total Shareholders’ Equity x 100. This is the relationship between the size of the company’s debt in proportion to Equity (Shareholders Funds)."},"children":[]}]}]}]},"equityInPercentage":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total Shareholders’ Equity / (Total Current Assets + Tangible Fixed Assets – Total Intangible Assets) x 100. This ratio shows the worth of the company (shareholders’ funds) as a percentage of total current and tangible assets."},"children":[]}]}]}]},"totalDebtRatio":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total Current Liabilities + Total Long-term liabilities / Total Shareholders’ Equity x 100. This shows the relative indebtedness of a company in relation to the worth of the company."},"children":[]}]}]}]}}}},"components/schemas/CreditsafeGlobalDataReportsGlobalFinancialsGGS":{"id":"components/schemas/CreditsafeGlobalDataReportsGlobalFinancialsGGS","kind":"json-schema","title":"CreditsafeGlobalDataReportsGlobalFinancialsGGS","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdFinancialStatement"},{"type":"object","properties":{"profitAndLoss":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsProfitAndLossFigures"},"balanceSheet":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsBalanceSheet"},"otherFinancials":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsOtherFinancials"},"ratios":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialRatios"}}}]}},"components/schemas/CreditsafeGlobalDataReportsLocalFinancialStatement":{"id":"components/schemas/CreditsafeGlobalDataReportsLocalFinancialStatement","kind":"json-schema","title":"CreditsafeGlobalDataReportsLocalFinancialStatement","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdFinancialStatement"},{"type":"object","properties":{"profitAndLoss":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]},"balanceSheet":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]},"otherFinancials":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]},"ratios":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]}}}]}},"components/schemas/CreditsafeGlobalDataReportsReportNegativeInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsReportNegativeInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportNegativeInformation","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]}},"components/schemas/CreditsafeGlobalDataReportsReportAdditionalInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsReportAdditionalInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportAdditionalInformation","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]}},"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyReportExtraSection","data":{"type":"object"}},"components/schemas/CreditsafeGlobalDataReportsLtdDirectorsExtra":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdDirectorsExtra","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdDirectorsExtra","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsLtdExtendedGroupStructureExtra":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdExtendedGroupStructureExtra","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdExtendedGroupStructureExtra","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsReportPaymentData":{"id":"components/schemas/CreditsafeGlobalDataReportsReportPaymentData","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportPaymentData","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]}},"components/schemas/CreditsafeGlobalDataReportsReportPaymentDataExtra":{"id":"components/schemas/CreditsafeGlobalDataReportsReportPaymentDataExtra","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportPaymentDataExtra","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsReportAlternateSummary":{"id":"components/schemas/CreditsafeGlobalDataReportsReportAlternateSummary","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportAlternateSummary","data":{"type":"object"}},"components/schemas/CreditsafeGlobalDataReportsReportNegativeInformationExtra":{"id":"components/schemas/CreditsafeGlobalDataReportsReportNegativeInformationExtra","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportNegativeInformationExtra","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsExceptions":{"id":"components/schemas/CreditsafeGlobalDataReportsExceptions","kind":"json-schema","title":"CreditsafeGlobalDataReportsExceptions","data":{"type":"object","properties":{"eventType":{"type":"object","description":"Describes the exception alert","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code associated with the exception event, for example GA_8"},"children":[]}]}]}]},"description":{"type":"string","description":"A description associated with the event, for example \"Multiple companies has this exact address\"."}}},"eventLevel":{"type":"object","description":"Level of risk for the exception alert","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A numeric code which indicates if the event level is General [0] OR \"High\" [1]."},"children":[]}]}]}]},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text description which indicates if the event level is General [0] OR \"High\" [1]."},"children":[]}]}]}]}}},"eventDate":{"type":"string","description":"The date associated with the exception event - this might be the date when the unusual behaviour was detected, not necessarily the date of the original event.","format":"date-time"}}}},"components/schemas/CreditsafeGlobalDataReportsCompanyReport":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyReport","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyReport","data":{"type":"object","properties":{"companyId":{"type":"string"},"language":{"$ref":"#/components/schemas/CreditsafeGlobalDataLanguage"},"companySummary":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdCompanySummary"},"companyIdentification":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdCompanyIdentification"},"creditScore":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdCreditScore"},"contactInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdContactInformation"},"indicators":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIndicators"},"shareCapitalStructure":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdShareCapitalStructure"},"directors":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdDirectors"},"directorships":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorships"},"otherInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdOtherInformation"},"groupStructure":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdGroupStructure"},"extendedGroupStructure":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyInGroup"}},"financialStatements":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsGlobalFinancialsGGS"}},"localFinancialStatements":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLocalFinancialStatement"}},"negativeInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportNegativeInformation"},"additionalInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportAdditionalInformation"},"directorsExtra":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdDirectorsExtra"},"extendedGroupStructureExtra":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdExtendedGroupStructureExtra"},"paymentData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportPaymentData"},"paymentDataExtra":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportPaymentDataExtra"},"alternateSummary":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportAlternateSummary"},"negativeInformationExtra":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportNegativeInformationExtra"},"exceptions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies unusual behaviours, for example multiple changes in address in a short period of time. This is a premium service, not available for all customers and is only availble for specific report templates [gycs, custom, full]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsExceptions"}}}}},"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyReportResponse","data":{"allOf":[{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"failedSections":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportSection"}},"report":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReport"},"companyId":{"type":"string"},"dateOfOrder":{"type":"string","format":"date-time"},"language":{"type":"string"},"userId":{"type":"integer"}}}]}},"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachmentjson":{"id":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachmentjson","kind":"json-schema","title":"CreditsafeGlobalDataCoreAttachmentBinaryAttachmentjson","data":{"type":"object","properties":{"correlationID":{"type":"string","description":"A unique ID assigned to this request."},"failedSections":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportSection"}},"report":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReport"},"pdfReportStream":{"type":"string","format":"byte","description":"Base64-encoded contents of the PDF."},"companyID":{"type":"string"},"dateOfOrder":{"type":"string","format":"date-time"},"language":{"type":"string"},"userID":{"type":"integer"}}}},"components/schemas/ConnectConfidenceMatchMatchResults":{"id":"components/schemas/ConnectConfidenceMatchMatchResults","kind":"json-schema","title":"ConnectConfidenceMatchMatchResults","data":{"properties":{"totalMatches":{"type":"integer","description":"The total number of companies matched in the search results."},"matchedCompanies":{"type":"array","description":"A list of companies that matched the search criteria.","items":{"type":"object","properties":{"matchScoreConfidence":{"type":"integer","description":"The confidence score for the match, indicating the likelihood of a correct match (higher is better)."},"id":{"type":"string","description":"The unique identifier for the matched company."},"country":{"type":"string","description":"The ISO country code of the matched company."},"regNo":{"type":"string","description":"The registration number of the matched company."},"safeNo":{"type":"string","description":"The Creditsafe Safe Number for the matched company."},"name":{"type":"string","description":"The name of the matched company."},"phoneNo":{"type":"string","description":"The main phone number of the matched company."},"address":{"type":"object","description":"The address details of the matched company.","properties":{"simpleValue":{"type":"string","description":"A simplified, single-line version of the address."},"street":{"type":"string","description":"The street name of the address."},"city":{"type":"string","description":"The city of the address."},"postcode":{"type":"string","description":"The postal code of the address."},"country":{"type":"string","description":"The ISO country code of the address."},"state":{"type":"string","description":"The state or region of the address."}}},"status":{"type":"string","description":"The current status of the matched company (e.g., Active, Inactive)."},"statusDescription":{"type":"string","description":"Additional description of the company's status (e.g., Non trading)."},"type":{"type":"string","description":"The type or classification of the matched company (e.g., Ltd)."},"activityCode":{"type":"string","description":"The activity code (industry classification) of the matched company."},"officeType":{"type":"string","description":"The office type of the company. Only available with US companies."},"dateOfLatestAccounts":{"type":"string","description":"The date of the latest accounts filed by the company (ISO 8601 format)."},"dateOfLatestChange":{"type":"string","description":"The date of the latest change to the company's details (ISO 8601 format)."},"matchScoreExplainPlan":{"type":"object","description":"Detailed breakdown of the match score calculation for the company.   Each field uses a grading system to indicate the quality of the match: - \"A\": Exact match - \"B\": Close match - \"C\": Partial match - \"D\": Similar in essence (e.g., ignoring common industry keywords) - \"O\": No match - \"X\": Not applicable or not compared\n","properties":{"matchScore":{"type":"integer","description":"The overall match score for the company."},"matchScoreAlpha":{"type":"string","description":"The alphabetical match score component."},"matchScoreLocal Id":{"type":"string","description":"The match score component for the local identifier."},"matchScoreName":{"type":"string","description":"The match score for the company name."},"matchScoreHouseNo":{"type":"string","description":"The match score for the house number."},"matchScoreStreet":{"type":"string","description":"The match score for the street."},"matchScorePoBox":{"type":"string","description":"The match score for the PO Box."},"matchScoreCity":{"type":"string","description":"The match score for the city."},"matchScoreState":{"type":"string","description":"The match score for the province or state."},"matchScorePostCode":{"type":"string","description":"The match score for the postal code."},"matchScoreCountry":{"type":"string","description":"The match score for the country."},"matchScoreVatNo":{"type":"string","description":"The match score for the VAT number."},"matchScoreRegNo":{"type":"string","description":"The match score for the registration number."},"matchScorePhoneNo":{"type":"string","description":"The match score for the phone number."},"matchScoreSimpleValue":{"type":"string","description":"The match score for the simple value address."},"matchScoreNum":{"type":"string","description":"The match score for the numeric value."}}}}}}}}},"components/schemas/ConnectConfidenceMatchNoResults":{"id":"components/schemas/ConnectConfidenceMatchNoResults","kind":"json-schema","title":"ConnectConfidenceMatchNoResults","data":{"properties":{"totalMatches":{"type":"integer"},"matchedCompanies":{"type":"array","items":{"type":"string"}}}}},"components/schemas/CreditsafeGlobalDataDirectorSearchData":{"id":"components/schemas/CreditsafeGlobalDataDirectorSearchData","kind":"json-schema","title":"CreditsafeGlobalDataDirectorSearchData","data":{"type":"object","properties":{"peopleId":{"description":"The unique identifier of the person.","type":"string"},"firstName":{"description":"The first name of the director.","type":"string"},"lastName":{"description":"The last name of the director.","type":"string"},"country":{"description":"The country of the director.","$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"company":{"type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"}}},"companyName":{"description":"The name of the company.","type":"string"},"companyType":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyType"},"companyRegistrationNumber":{"description":"The registration number of the company.","type":"string"},"status":{"type":"string"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"},"dateOfLatestChange":{"description":"The date of the latest change to the director information.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"The date of birth of the director.","type":"string","format":"date-time"},"localDirectorNumber":{"description":"The local director number of the director.","type":"string"},"score":{"type":"integer"},"taxCode":{"type":"string"},"searchRanking":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataDirectorSearchData":{"id":"components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataDirectorSearchData","kind":"json-schema","title":"CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataDirectorSearchData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataServiceResponse"},{"type":"object","properties":{"correlationId":{"type":"string"},"directors":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataDirectorSearchData"}},"totalSize":{"description":"The total number of results.","type":"integer","format":"int32"}}}]}},"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorSummary":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorSummary","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorsDirectorSummary","data":{"type":"object","properties":{"currentAppointments":{"type":"integer","format":"int32"},"inactiveAppointments":{"type":"integer","format":"int32"},"previousAppointments":{"type":"integer","format":"int32"}}}},"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorshipAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorshipAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorsDirectorshipAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorsDirectorship","data":{"type":"object","properties":{"id":{"type":"string"},"idType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIdType"},"companyName":{"type":"string"},"companyNumber":{"type":"string"},"companyRegistrationNumber":{"type":"string"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"},"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"},"activity":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyActivity"},"position":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCorporatePositionResigned"},"signingAuthority":{"type":["boolean","null"]},"companyRegistrationDate":{"type":["string","null"],"format":"date-time"},"legalForm":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLegalForm"},"state":{"type":"string"},"yearEndDate":{"type":["string","null"],"format":"date-time"},"currency":{"$ref":"#/components/schemas/CreditsafeGlobalDataCurrency"},"latestTurnoverFigure":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"netWorth":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"legalCount":{"type":["integer","null"],"format":"int32"},"legalAmount":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"legalCountInLast12Months":{"type":["integer","null"],"format":"int32"},"creditScore":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdCreditScore"},"dbt":{"type":["number","null"],"format":"double"},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorshipAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorships":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorships","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorsDirectorships","data":{"type":"object","properties":{"current":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship"}},"previous":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship"}},"inactive":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship"}}}}},"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReport":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReport","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorsDirectorReport","data":{"type":"object","properties":{"directorId":{"type":"string"},"directorSummary":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorSummary"},"directorDetails":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirector"},"otherAddresses":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"}},"directorships":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorships"}}}},"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorsDirectorReportResponse","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataServiceResponse"},{"type":"object","properties":{"report":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReport"}}}]}},"components/schemas/ConnectImagesCompanyImages":{"id":"components/schemas/ConnectImagesCompanyImages","kind":"json-schema","title":"ConnectImagesCompanyImages","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique identifier for tracing this request, enabling tracking and debugging."},"totalSize":{"type":"integer","description":"Total number of image records available based on the query criteria."},"data":{"type":"array","items":{"type":"object","properties":{"imageId":{"type":"string","description":"Unique identifier for the image document, allowing direct retrieval and reference."},"company":{"type":"object","description":"Contains information about the company associated with the image. This includes identifiers, \nthe registered country, legal type, and other basic details specific to the company in question.\n","properties":{"id":{"type":"string","description":"Unique identifier for the company."},"localId":{"type":"string","description":"Company identifier specific to the country or jurisdiction."},"country":{"type":"string","description":"ISO code representing the country where the company is registered."},"name":{"type":"string","description":"Official registered name of the company."},"type":{"type":"string","description":"Legal structure or type of the company, such as \"Ltd\" for limited companies."},"additionalInformation":{"type":"object","properties":{"legalGroup":{"type":"string","description":"Classification indicating the company's legal grouping or ownership structure.","example":"OVR"}}}}},"document":{"type":"object","description":"Provides details about the specific document or image associated with the company, \nsuch as its type, code, and a description that may include filing information or updates.\n","properties":{"imageType":{"type":"string","description":"Type of document image, e.g., \"AnnualReturns\" or \"ConfirmationStatement.\""},"imageTypeCode":{"type":"string","description":"Code associated with the document type for internal or regulatory identification."},"imageTypeDescription":{"type":"string","description":"Detailed description of the document, often including information about its contents or updates."}}},"filingDate":{"type":"string","format":"date","description":"Date when the document was officially filed or recorded."},"startDate":{"type":"string","format":"date","description":"Start date of the time period covered by the document."},"endDate":{"type":"string","format":"date","description":"End date of the time period covered by the document."},"language":{"type":"string","description":"ISO language code representing the document's primary language."},"consolidated":{"type":"boolean","description":"Indicates if the document contains consolidated information, typically applicable to financial statements."},"publicationDate":{"type":"string","format":"date-time","description":"Date and time when the document was published or made available."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document or image status, currently only available for Netherlands "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"availableFormats":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of available formats for the image, currently only available for Denmark "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"additionalInformation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional details about the document. Note that properties within "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalInformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may vary depending on the country."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not all properties listed below are available for every country, and some properties may not appear at all in certain responses."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integrations should allow flexibility to handle missing or variable properties."},"children":[]}]}]}],"type":"object","properties":{"annotations":{"type":"string","description":"Annotations related to the image"},"barcode":{"type":"string","description":"Unique barcode for tracking or inventory purposes, associated with the document."},"category":{"type":"string","description":"Main category of the document, such as \"confirmation-statement.\""},"descriptionValues":{"type":"object","description":"Description values (object structure may vary by country)"},"imageStatus":{"type":"string","description":"Current processing status of the image, e.g., \"Pending\" or \"Completed.\""},"pages":{"type":"integer","description":"Number of pages in the document"},"paperFiled":{"type":"boolean","description":"Indicates if the image was filed on paper"},"resolutions":{"type":"array","items":{"type":"string"},"description":"List of resolutions related to the image"},"sourceType":{"type":"string","description":"Specific source or origin type for the document, providing additional context (e.g., \"confirmation-statement-with-no-updates\")."},"subcategory":{"type":"string","description":"Further classification within the main category; may be blank if not applicable."},"transactionId":{"type":"string","description":"Transaction ID related to the image"}}}}}}}}},"components/schemas/ConnectImagesCompanyImageTypes":{"id":"components/schemas/ConnectImagesCompanyImageTypes","kind":"json-schema","title":"ConnectImagesCompanyImageTypes","data":{"type":"array","description":"List of country-specific configurations, including requirements and validations for company ID and image reference fields, as well as supported languages and filing types.","items":{"type":"object","properties":{"country":{"type":"string","description":"ISO code representing the country to which this configuration applies."},"companyId":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration details for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, specifying whether it is required"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and any validation rules, such as minimum and maximum length and allowed patterns."},"children":[]}]}]}],"properties":{"required":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for this country."},"children":[]}]}]}]},"validationRegExp":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regular expression for validating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format for this country."},"children":[]}]}]}]},"minLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum length for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if applicable."},"children":[]}]}]}]},"maxLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum length for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if applicable."},"children":[]}]}]}]}}},"imageReference":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration details for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, specifying its requirement status,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"validation rules, and length constraints for the country in question."},"children":[]}]}]}],"properties":{"required":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for this country."},"children":[]}]}]}]},"validationRegExp":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regular expression for validating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"minLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum length for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if applicable."},"children":[]}]}]}]},"maxLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum length for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if applicable."},"children":[]}]}]}]}}},"availableLanguages":{"type":"array","description":"List of languages available for documents in this country, along with filing types and formats.","items":{"type":"object","properties":{"language":{"type":"string","description":"Language code for documents available in this country (e.g., \"EN\" for English)."},"filingTypes":{"type":"array","description":"List of filing types available in this language, with supported formats.","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of filing, such as \"AnnualReport\" or \"Statement.\""},"availableFormats":{"type":"array","description":"List of file formats available for this filing type (e.g., \"PDF\" or \"HTML\").","items":{"type":"string"}}}}},"default":{"type":"boolean","description":"Indicates if this language is the default language for documents in this country."}}}}}}}},"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment":{"id":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment","kind":"json-schema","title":"CreditsafeGlobalDataCoreAttachmentBinaryAttachment","data":{"type":"string","format":"binary"}},"components/schemas/ConnectFreshInvListInvestigations":{"id":"components/schemas/ConnectFreshInvListInvestigations","kind":"json-schema","title":"ConnectFreshInvListInvestigations","data":{"type":"object","properties":{"totalCount":{"type":"integer"},"orders":{"type":"array","items":{"type":"object","properties":{"orderID":{"type":"integer","description":"Fresh Investigation Unique Identifier"},"userID":{"type":"string","description":"Fresh Investigation user Identifier"},"creationDate":{"type":"string","description":"Fresh Investigation Creation Date"},"lastStatusChangeDate":{"type":"string","description":"Fresh Investigation Last Status Change Date"},"transactionID":{"type":"integer","description":"Fresh Investigation Internal Identifier"},"chargeReference":{"type":"string"},"contactDetails":{"type":"object","description":"Contact details of the person who requested the investigation, and where the information will be sent.","properties":{"name":{"type":"string","description":"Contact name of the person who requested the investigation"},"emailAddress":{"type":"string","description":"The address to which the investigation report will be sent"},"telephoneNumber":{"type":"string","description":"Your telephone number"}}},"sectionNames":{"type":"string"},"status":{"type":"object","description":"The status of the investigation","properties":{"code":{"type":"string"},"description":{"type":"string"}}},"consent":{"type":"boolean","description":"Whether permission was granted by the requesting company to disclose the identity of the investigating party to the target company."},"searchCriteria":{"type":"object","description":"The search criteria used to perform the investigation","properties":{"name":{"type":"string","description":"Target company name"},"vatNo":{"type":"string"},"regNo":{"type":"string"},"additionalInfo":{"type":"string"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"}}},"reportDate":{"type":"string","format":"date-time"}}}}}}},"components/schemas/ConnectFreshInvCreateInvestigation":{"id":"components/schemas/ConnectFreshInvCreateInvestigation","kind":"json-schema","title":"ConnectFreshInvCreateInvestigation","data":{"type":"object","properties":{"consent":{"type":"boolean","description":"Including this allows Creditsafe to disclose your company details to the target company in the aim of improving the quality of our Investigation Report"},"contactInfo":{"description":"Your contact information","type":"object","properties":{"name":{"type":"string","description":"Your name"},"emailAddress":{"type":"string","description":"The address where Investigation creation confirmations are sent"},"telephoneNumber":{"type":["string","null"],"description":"Your contact number"},"company":{"type":"object","description":"your company information","properties":{"name":{"type":"string","description":"Your company name"},"number":{"type":"string","description":"Your company VAT number/Reg Number/Tax Number"}}}}},"chargeReference":{"type":"string","description":"Free text field to add your own personal reference to the order"},"searchCriteria":{"type":"object","description":"Details on the company you are investigating - the target company","properties":{"name":{"type":"string","description":"Target company name"},"additionalInfo":{"type":["string","null"],"description":"Any further details on your target company that will assist our Investigation"},"telephoneNumber":{"type":["string","null"],"description":"Target company telephone number"},"address":{"type":["object","null"],"description":"Target company address","properties":{"simple":{"type":"string"},"postcode":{"type":"string"},"city":{"type":"string"}}},"regNo":{"type":["string","null"],"description":"Target company registration number"},"vatNo":{"type":["string","null"],"description":"Target company VAT number"},"countryCode":{"type":"string","description":"Target company ISO2 country code"}}}}}},"components/schemas/ConnectFreshInvInvestigationConfirmed":{"id":"components/schemas/ConnectFreshInvInvestigationConfirmed","kind":"json-schema","title":"ConnectFreshInvInvestigationConfirmed","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"message":{"type":"string"},"orderID":{"type":"string","description":"Fresh Investigation Unique Identifier"},"transactionID":{"type":"string","description":"Fresh Investigation Internal Identifier"}}}},"components/schemas/ConnectFreshInvCompletedInvestigation":{"id":"components/schemas/ConnectFreshInvCompletedInvestigation","kind":"json-schema","title":"ConnectFreshInvCompletedInvestigation","data":{"type":"object","properties":{"chargeReference":{"type":"string"},"contactDetails":{"properties":{"emailAddress":{"type":"string"},"name":{"type":"string"},"telephoneNumber":{"type":"string"}},"type":"object"},"creationDate":{"type":"string"},"lastStatusChangeDate":{"type":"string"},"orderID":{"type":"integer"},"reportDate":{"type":"string"},"searchCriteria":{"properties":{"additionalInfo":{"type":"string"},"address":{"properties":{"city":{"type":"string"},"postcode":{"type":"string"},"simple":{"type":"string"}},"type":"object"},"countryCode":{"type":"string"},"name":{"type":"string"},"regNo":{"type":"string"},"vatNo":{"type":"string"}},"type":"object"},"sections":{"items":{"anyOf":[{"properties":{"content":{"type":"string"},"contentType":{"type":"string"},"creationDate":{"type":"string"},"name":{"type":"string"}},"type":"object"}]},"type":"array"},"status":{"properties":{"code":{"type":"string"},"description":{"type":"string"}},"type":"object"},"transactionID":{"type":"integer"}}}},"components/schemas/DeleteFreshInvetigationsByOrderId":{"id":"components/schemas/DeleteFreshInvetigationsByOrderId","kind":"json-schema","title":"DeleteFreshInvetigationsByOrderId","data":{"type":"object","properties":{"message":{"type":"string"}}}},"components/schemas/ConnectFreshInvInvestigationContactInfo":{"id":"components/schemas/ConnectFreshInvInvestigationContactInfo","kind":"json-schema","title":"ConnectFreshInvInvestigationContactInfo","data":{"description":"Your contact information","type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Your name"},"emailAddress":{"type":"string","description":"The address where Investigation creation confirmations are sent"},"telephoneNumber":{"type":["string","null"],"description":"Your contact number"},"company":{"type":"object","additionalProperties":false,"description":"your company information","properties":{"name":{"type":"string","description":"Your company name"},"number":{"type":"string","description":"Your company VAT number/Reg Number/Tax Number"}}}}}},"components/schemas/ConnectFreshInvInvestigationCompanyData":{"id":"components/schemas/ConnectFreshInvInvestigationCompanyData","kind":"json-schema","title":"ConnectFreshInvInvestigationCompanyData","data":{"type":"object","additionalProperties":false,"description":"Details on the company.","properties":{"name":{"type":"string","description":"Company name."},"additionalInfo":{"type":"string","description":"Further details on the company."},"telephoneNumber":{"type":"string","description":"Company telephone number"},"address":{"type":"object","additionalProperties":false,"description":"Company address","properties":{"simple":{"type":"string"},"postcode":{"type":"string"},"city":{"type":"string"}}},"regNo":{"type":"string","description":"Company registration number"},"vatNo":{"type":"string","description":"Company VAT number"},"countryCode":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"}}}},"components/schemas/ConnectUpdateFreshInvestigation":{"id":"components/schemas/ConnectUpdateFreshInvestigation","kind":"json-schema","title":"ConnectUpdateFreshInvestigation","data":{"type":"object","additionalProperties":false,"properties":{"consent":{"type":"boolean","description":"Including this allows Creditsafe to disclose your company details to the target company in the aim of improving the quality of our Investigation Report"},"contactInfo":{"$ref":"#/components/schemas/ConnectFreshInvInvestigationContactInfo"},"chargeReference":{"type":"string","description":"Free text field to add your own personal reference to the order"},"searchCriteria":{"$ref":"#/components/schemas/ConnectFreshInvInvestigationCompanyData"},"pendingInfo":{"type":"object","description":"PendingInfo property contains the information of respective sections, that someone has requested respective information to be modified.","properties":{"contactDetails":{"description":"Your Contact details of fresh investigation for updating.","$ref":"#/components/schemas/ConnectFreshInvInvestigationContactInfo"},"searchCriteria":{"description":"Search criteria details of the company.","$ref":"#/components/schemas/ConnectFreshInvInvestigationCompanyData"}}}}}},"components/schemas/FreshInvestigationGetAttachmentsForOrderResponse":{"id":"components/schemas/FreshInvestigationGetAttachmentsForOrderResponse","kind":"json-schema","title":"FreshInvestigationGetAttachmentsForOrderResponse","data":{"description":"Attachments for the fresh investigation order","type":"object","additionalProperties":false,"properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"Attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"fileName":{"type":"string"},"fileType":{"type":"string"},"description":{"type":"string"}}}}}}},"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest":{"id":"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest","kind":"json-schema","title":"FreshInvestigationAttachmentUploadForOrderRequest","data":{"type":"object","additionalProperties":false,"properties":{"importFile":{"type":"string","format":"binary","description":"The file which we want to attach to the fresh investigation order"},"description":{"type":"string","description":"Description of the file which we want to attach to the fresh investigation order"}}}},"components/schemas/FreshInvestigationAttachmentUploadForOrderResponse":{"id":"components/schemas/FreshInvestigationAttachmentUploadForOrderResponse","kind":"json-schema","title":"FreshInvestigationAttachmentUploadForOrderResponse","data":{"description":"Attachment upload status for the order","type":"object","additionalProperties":false,"properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"message":{"type":"string"},"details":{"type":"string"}}}},"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment":{"id":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment","kind":"json-schema","title":"CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment","data":{"type":"string","format":"binary"}},"components/schemas/GetFreshInvestigationCommentsByOrderIdResponse":{"id":"components/schemas/GetFreshInvestigationCommentsByOrderIdResponse","kind":"json-schema","title":"GetFreshInvestigationCommentsByOrderIdResponse","data":{"type":"object","properties":{"totalCount":{"type":"integer","description":"Total number of comments for a FreshInvestigation Report"},"comments":{"type":"array","items":{"type":"object","properties":{"userID":{"type":"string","example":"CSC_123456","description":"user id"},"comment":{"type":"string","example":"testing comments","description":"comments about the FreshInvestigation Report"},"creationDate":{"type":"string","example":"2023-03-10T05:44:06.000Z","description":"The time when comment has been posted."}}}}}}},"components/schemas/FreshInvestigationCommentsForOrderRequest":{"id":"components/schemas/FreshInvestigationCommentsForOrderRequest","kind":"json-schema","title":"FreshInvestigationCommentsForOrderRequest","data":{"type":"object","additionalProperties":false,"properties":{"comments":{"description":"comments for fresh investigation orderId","type":"string"}}}},"components/schemas/FreshInvestigationCommentsForOrderResponse":{"id":"components/schemas/FreshInvestigationCommentsForOrderResponse","kind":"json-schema","title":"FreshInvestigationCommentsForOrderResponse","data":{"description":"comments for the fresh investigation orderId","type":"object","additionalProperties":false,"properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"message":{"type":"string"}}}},"schema_642":{"kind":"json-schema","data":{"type":"string"},"id":"schema_642"},"schema_643":{"kind":"json-schema","data":{"type":"object","properties":{"reportLanguages":{"type":"array","items":{"type":"string","example":"NL"}}}},"id":"schema_643"},"schema_644":{"kind":"json-schema","data":{"type":"string","enum":["CompanyReportResponse"]},"id":"schema_644"},"schema_645":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_645"},"schema_646":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_646"},"schema_647":{"kind":"json-schema","data":{"type":"string","pattern":"^([a-zA-Z\\\\s]+,)*[a-zA-Z\\\\s]+$"},"id":"schema_647"},"schema_648":{"kind":"json-schema","data":{"type":["string","null"],"default":null,"maxLength":2,"minLength":2},"id":"schema_648"},"schema_649":{"kind":"json-schema","data":{"type":["string","null"],"default":null},"id":"schema_649"},"schema_650":{"kind":"json-schema","data":{"type":["string","null"]},"id":"schema_650"},"schema_651":{"kind":"json-schema","data":{"type":["boolean","null"]},"id":"schema_651"},"schema_652":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataOfficeType"},{"type":"null"}]},"id":"schema_652"},"schema_653":{"kind":"json-schema","data":{"type":"array","items":{"type":["string","null"]}},"id":"schema_653"},"schema_654":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"},{"type":"null"}]},"id":"schema_654"},"schema_655":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyType"},"id":"schema_655"},"schema_656":{"kind":"json-schema","data":{"pattern":"^[a-zA-Z]{2}$","type":["string","null"],"default":"en"},"id":"schema_656"},"schema_657":{"kind":"json-schema","data":{"type":["string","null"],"default":"full"},"id":"schema_657"},"schema_658":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_658"},"schema_659":{"kind":"json-schema","data":{"oneOf":[{"type":"string","title":"PDF","enum":["application/pdf"]},{"type":"string","title":"HTML","enum":["application/html"]},{"type":"string","title":"PDF + HTML","enum":["application/pdf+html"]},{"type":"string","title":"JSON + PDF","enum":["application/json+pdf"]},{"type":"string","title":"JSON + HTML","enum":["application/json+html"]}],"example":"application/pdf"},"id":"schema_659"},"schema_660":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ConnectConfidenceMatchMatchResults"},{"$ref":"#/components/schemas/ConnectConfidenceMatchNoResults"}]},"id":"schema_660"},"schema_661":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataDirectorSearchData"}]},"id":"schema_661"},"schema_662":{"kind":"json-schema","data":{"pattern":"^[a-zA-Z]{2}([0-9]{1,3})?[-]{1}[a-zA-Z0-9$]+$","type":"string"},"id":"schema_662"},"schema_663":{"kind":"json-schema","data":{"pattern":"^[a-zA-Z]{2}$","type":"string","default":"en"},"id":"schema_663"},"schema_664":{"kind":"json-schema","data":{"type":"string","enum":["CompanyDetails","SearchCriteria"]},"id":"schema_664"},"schema_665":{"kind":"json-schema","data":{"type":"string","enum":["creationDate","lastStatusChangeDate","orderID","status"]},"id":"schema_665"},"schema_666":{"kind":"json-schema","data":{"type":"string","default":"asc","enum":["asc","desc"]},"id":"schema_666"},"schema_667":{"kind":"json-schema","data":{"type":"string","enum":["last","recent","none"],"default":"last"},"id":"schema_667"},"schema_668":{"kind":"json-schema","data":{"properties":{"message":{"type":"string","description":"Success response of updated fresh investigation.","example":"FreshInvestigation OrderId is being updated"}}},"id":"schema_668"}},"exampleStore":{"paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example":{"value":{"comments":"comments by user"},"id":"paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example"}},"securitySchemeStore":{"bearerToken":{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}},"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}]},"options":{"feedback":{"type":"mood","settings":{"optionalEmail":{"hide":true},"label":"Do you like this page?","submitText":"Thanks for your feedback - Your comments will shape documentation changes.","reasons":{"label":"Check all boxes that apply.","items":["The content was useful.","The content was easy to find.","The content could do with improvement."]},"comment":{"satisfiedLabel":"What did you like best?","neutralLabel":"How can we improve?","dissatisfiedLabel":"What needs improvement?"}}},"hideInfoMetadata":true,"hideSidebar":true,"mockServer":{"url":"/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/connect-apis-catalog/product-catalog/Credit&Risk/@OAS3.1/creditAndRisk.json?download"},{"url":"/_bundle/connect-apis-catalog/product-catalog/Credit&Risk/@OAS3.1/creditAndRisk.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Credit and Risk","description":"\nThe Credit and Risk API provides access to a comprehensive suite of endpoints designed to deliver critical business insights. \nThis API enables users to authenticate, search for companies and directors, retrieve detailed credit and risk reports, \naccess official company filing documents, and manage fresh investigation requests for companies not available in the instant database.\n  \n{% admonition type=\"info\" name=\"OAS 3.0.4 Trial Availability\" %}\n  The OAS 3.0.4 version of this API specification is provided for trial purposes only. While every effort is made to ensure its accuracy, the OAS 3.1.0 version is the primary managed and maintained specification and is recommended for all integrations and production use.\n{% /admonition %}\n","status":"published","tags":["Featured"]}},"baseSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk","routesMapping":{}}