{"items":[{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Credit&Risk/index.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/connect-apis-catalog/product-catalog/creditrisk","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk"},{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Credit&Risk/gettingStarted.md","metadata":{"type":"markdown"},"label":"Getting Started","link":"/connect-apis-catalog/product-catalog/creditrisk/gettingstarted","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/gettingstarted"},{"type":"group","label":"Product Documentation","items":[{"type":"group","label":"Companies","items":[{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Credit&Risk/documentation/companies/companies.md","metadata":{"type":"markdown"},"label":"Search and Report Process","link":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/companies","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/companies"},{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Credit&Risk/documentation/companies/additionalSearchAndReportOptions.md","metadata":{"type":"markdown"},"label":"Additional Search and Report Options","link":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/additionalsearchandreportoptions","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/additionalsearchandreportoptions"},{"type":"group","label":"Company Report","items":[{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Credit&Risk/documentation/companies/reportResponseOptions.md","metadata":{"type":"markdown"},"label":"Report Response Formats","link":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/reportresponseoptions","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/reportresponseoptions"},{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Credit&Risk/documentation/companies/ubos.md","metadata":{"type":"markdown"},"label":"Report UBOS Per Country","link":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/ubos","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/ubos"},{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Credit&Risk/documentation/companies/idv.md","metadata":{"type":"markdown"},"label":"GB IDV Response","link":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/idv","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/idv"},{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Credit&Risk/documentation/companies/fca.md","metadata":{"type":"markdown"},"label":"GB FCA Response","link":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/fca","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/fca"}]}]},{"type":"group","label":"People and Directors","items":[{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Credit&Risk/documentation/peopleAndDirectors/peopleAndDirectors.md","metadata":{"type":"markdown"},"label":"People and Directors Process","link":"/connect-apis-catalog/product-catalog/creditrisk/documentation/peopleanddirectors/peopleanddirectors","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/documentation/peopleanddirectors/peopleanddirectors"}]},{"type":"group","label":"Images","items":[{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Credit&Risk/documentation/images/images.md","metadata":{"type":"markdown"},"label":"Image Documentation","link":"/connect-apis-catalog/product-catalog/creditrisk/documentation/images/images","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/documentation/images/images"}]},{"type":"group","label":"Fresh Investigations","items":[{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Credit&Risk/documentation/freshInvestigations/freshInvestigations.md","metadata":{"type":"markdown"},"label":"Fresh Investigations Process","link":"/connect-apis-catalog/product-catalog/creditrisk/documentation/freshinvestigations/freshinvestigations","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/documentation/freshinvestigations/freshinvestigations"}]}],"expanded":"true"},{"type":"group","label":"API Documentation","items":[{"type":"link","label":"Credit and Risk","link":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk","routeSlug":"/connect-apis-catalog/product-catalog/creditrisk/creditandrisk","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/authenticate","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"}],"version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/access/countries/{countryCode}/reportLanguages","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/companies/searchcriteria","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/people/searchcriteria","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/companies/schema/{countryCode}","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"}],"version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/companies","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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.<br><br> To acquire a PDF version of the report use the optional request in 'Header'.<br><br> This request will provide a 'Base64-encoded' script to convert to a PDF, this will appear at the end of the JSON response.<br><br>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. <br><br> In OpenAPI, properties not listed as required are optional."}},"httpPath":"/companies/{connectId}","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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.   - <a href=\"https://creditsafe.freshdesk.com/en/support/solutions/articles/7000059769-interpreting-confidence-match-scores\" target=\"_blank\" rel=\"noopener noreferrer\">Interpreting confidence match scores</a>."}},"httpPath":"/companies/match","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"}],"version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/people","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/people/{peopleId}","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"}],"version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/images/companies","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/images/companies/types","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/images/{imageId}","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"}],"version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/freshinvestigations","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/freshinvestigations","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/freshinvestigations/{orderId}","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/freshinvestigations/{orderId}","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/freshinvestigations/{orderId}","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/freshinvestigations/{orderId}/attachments","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/freshinvestigations/{orderId}/attachments","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/freshinvestigations/{orderId}/attachments/{id}","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/freshinvestigations/{orderId}/comments","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/freshinvestigations/{orderId}/comments","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"},{"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."}},"httpPath":"/freshinvestigations/{orderId}/report","version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"}],"version":"OAS3.1","isDefault":true,"versionFolderId":"8b98e654"}],"expanded":"true"}]}