# Local Solutions # Introduction The Local Solutions API provides a suite of specialized endpoints designed to address region-specific business needs across multiple countries. It enables users to access a variety of local data services, such as land registry information, bank account verification, consumer and anti-money laundering checks, and company searches tailored to local requirements. The API supports operations in several regions, including Great Britain, France, Germany, the Netherlands, and the United States, offering targeted solutions for each market. With secure authentication and a modular structure, Local Solutions allows businesses to integrate local compliance, verification, and data enrichment processes into their workflows efficiently. The list of supported regions is always expanding and will not be limited to those currently available. Version: 1.0.1 Metadata: - tags: ["Featured"] ## Servers Sandbox server ``` https://connect.sandbox.creditsafe.com/v1 ``` Production server ``` https://connect.creditsafe.com/v1 ``` ## Security ### bearerToken This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the `Authorization` header of each request. Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Local Solutions](https://doc.creditsafe.com/_spec/connect-apis-catalog/product-catalog/LocalSolutions/localSolutions.yaml) ## Authentication This endpoint generates a Bearer JWT (Authentication Token), which is essential for accessing all other endpoints within the API.

To authenticate your requests, you **MUST** include this token in the Authorization header as proof of authenticity.

Please note that each token remains valid for 1 hour from the time of issuance and multiple tokens may exist concurrently. It is imperative to obtain and include a valid token in the Authorization header for every subsequent request made to the API.

Authenticate Help - Access Denied.. ### Authenticate - [POST /authenticate](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/authentication/authenticate.md): Supply username and password to generate Authentication Token. ## FR Bank Match This endpoint provides tools for matching bank information in France. ### Bank Match - [GET /localSolutions/FR/bankmatch](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/fr-bank-match/frbankmatch.md): This endpoint can be used to check the reliability of a company/bank details combination, and ensure that the IBAN is not linked to a risk of fraud. - There are a set of 'required' parameters for this endpoint, however please note the exceptions in the description. ### Bank Match Status - [GET /localSolutions/FR/bankmatch/audition](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/fr-bank-match/frbankmatchstatus.md): This endpoint is used to check the status of a verification whose status is ‘pending’. ## DE NonLtd Companies This endpoint provides the tools for searching non-limited companies in Germany and acquiring company reports. ### DE Company Search Criteria (Non Ltd) - [GET /localSolutions/DE/nonLtdCompanies/searchcriteria](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/de-nonltd-companies/denonltdcompaniessearchcriteria.md): Provides Search Criteria DE non-ltd Companies. ### DE Company Search (Non Ltd) - [GET /localSolutions/DE/nonLtdCompanies](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/de-nonltd-companies/denonltdcompaniessearch.md): Endpoint to search for DE non-ltd Companies according to the provided Search Criteria. ### DE Company Report (Non Ltd) - [GET /localSolutions/DE/nonLtdCompanies/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/de-nonltd-companies/denonltdcompaniesreport.md): Endpoint to retrieve the DE non-ltd Company report according to the provided id. ## NL KVK Extract This endpoint provides tools for extracting information from the Dutch Chamber of Commerce (KVK). ### Return NL Extract - [GET /localSolutions/NL/extract/{kvkNumber}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/nl-kvk-extract/extractnlkvknumber.md): NL extract from KVK Number ## GB Bank Match This endpoint provides tools for matching business bank account information in Great Britain. ### Bank Match - [GET /localSolutions/GB/bankmatch](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-match/bankmatch.md): The Bank Verification tool allows customers to instantly verify that small and medium sized companies you are working with are providing correct bank details, to reduce fraud and avoid delays in your on boarding process. The bank data for these companies is provided to Creditsafe by various financial providers, including major banks. When you provide us with a company number and their bank details, we are able to perform instant checks to verify that those bank details are associated with that company and return - Match – We have bank information on the company, and the data provided by the customer matches the company records No Match – We have bank information on the company, but the data provided does not match any of the company records Data Unavailable - We do not have bank information on the company. ## GB Consumers and AML This endpoint provides tools for consumer and anti-money laundering checks in Great Britain. ### Submit A GB Consumer or AML Search - [POST /localSolutions/GB/identitysearch](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/submitsagbconsumeroramlsearch.md): Submits a GB Consumer or AML depending on the Product provided. Validates criteria for each individual search before submitting, and may return a list of error strings instead. ### Resolve A Picklist Against A Given UniqueId - [PUT /localSolutions/GB/identitysearch](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/resolvesapicklistagainstagivenuniqueid.md): Resolves a picklist belonging to the specified UniqueID, which would have been generated during a prior search. Guids (and thus cached searches) expire after fifteen minutes. ### Return List Of Identity Search History Items - [GET /localSolutions/GB/identitysearch/history](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/getidentitysearchhistory.md): Retrieves a paginated history list for the specified customer/user, filtered based on the include* parameters. ### Return Previous Identity Search Result - [GET /localSolutions/GB/identitysearch/history/{uniqueId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/retrievesaprioridentitysearchresult.md): Retrieves a prior search result. This will include the search input and any ID/AML searches, but as we cannot hold Consumer search results these are not included. Resubmission is necessary if an updated Consumer result is needed. ### Return Previous Identity Search Input - [GET /localSolutions/GB/identitysearch/history/{uniqueId}/input](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/retrievesaprioridentitysearchesinput.md): This will return the input criteria used in a search for a specified id. ### Set Reference For An Existing History Item - [PUT /localSolutions/GB/identitysearch/history/{uniqueId}/reference](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/setsthereferenceforanexistinghistoryitem.md): Allows you to set a reference for an existing history item. This is useful for storing a reference to the record in your own system. ### Revalidate A Given Identity Search With Additional Documents - [PUT /localSolutions/GB/identitysearch/revalidation/{uniqueId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/revalidateagivenidentitysearchwithadditionaldocuments.md): Revalidate's a given identity search with additional documents. ### Return Identity Search Reasons - [GET /localSolutions/GB/identitysearch/searchreasons](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/paths/~1localsolutions~1gb~1identitysearch~1searchreasons/get.md): Returns an object describing which Reasons for Search are available and which are selected by a given customer. All reasons are always listed, with selected reasons specified as true. ## GB Bank Verification This endpoint provides tools for verifying bank account information for individuals in Great Britain. ### Single Request - [POST /localSolutions/GB/bankVerification/search](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationsearch.md): This endpoint will perform a search with the supplied data against a bank or building society. NOTE:- This endpoint will charge when a successful request is made to a bank or building society. This endpoint will charge when a result is returned. This includes charging if the no match is found. All property fields need to be submitted with the request, if information for a specific property is not needed, it is required to pass an empty string. ### Validate Bank Verification Request - [POST /localSolutions/GB/bankVerification/validate/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationvalidate.md): This endpoint will return whether the sort code and bank account number match the sort code and bank account number that was provided for the given single request. Note:- A valid request requires all fields to exist in the request. ### Return Bank Branch Details Of A Given Sort Code - [GET /localSolutions/GB/bankVerification/sortCode/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/sortcodecheck.md): This endpoint will return bank branch details of a given sort code. ### Request Search History - [GET /localSolutions/GB/bankVerification/history](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationgethistorylist.md): Bank Verification History list Request Note:- All property fields need to be submitted with the request, if information for a specific property is not needed, it is required to pass an empty string. ### Return Request History By ID - [GET /localSolutions/GB/bankVerification/history/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationgethistorybyid.md): This endpoint will return details of a past request by id. ### Update CustomerReference by HistoryId - [PATCH /localSolutions/GB/bankVerification/history/{id}/reference](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationupdatehistory.md): This endpoint will update the stored customerReference field of a past request with the provided ID. ## GB Finance Agreements This endpoint provides tools for acquiring and verifying finance agreement information. ### Request Finance Agreements - [GET /localSolutions/GB/CCDS/{companyId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-finance-agreements/financeagreements.md): This tool provides a detailed view of data supplied via the CCDS scheme(Commercial Credit Data Sharing ). It's tailored for users needing immediate access to current and accurate financial agreement information, enhancing decision-making with up-to-date data insights. - Gain in-depth insights with access to up to 48 months of historical data on current accounts, loans, and credit card facilities. This tool is perfect for comprehensive long-term financial analysis, offering a thorough understanding of credit history and trends. - Get a summarized view of non performance related credit activity data. This tool simplifies the complex data into an easily understandable summary, ideal for quick assessments and initial screenings. - A predictive tool that evaluates the likelihood of a company defaulting on payments within the next 90 days. This tool is crucial for risk assessment and mitigation, offering foresight and preparation for potential financial challenges. ## GB Land Registry This endpoint provides tools for accessing land registry information in Great Britain. ### GB Land Registry - [GET /localSolutions/GB/landRegistry/{companyId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-land-registry/gblandregistry.md): Allows users to return Land Registry details of a company. ## Verify Verify is an exclusive add-on to Creditsafe's company credit reports, designed to assist businesses in making smarter, quicker, and more informed credit decisions. For new or small companies that lack a detailed financial footprint, Verify offers unparalleled insights by screening company directors and the individuals behind businesses for their personal financial stability and identity. Using Verify, you can confidently assess a company's leadership, using trusted public datasets that highlight potential financial concerns, such as CCJs or Insolvencies and confirm that they reside at an address on the Electoral roll. ### Company Search - [GET /companies](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/companysearch.md): 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 where available. If a unique identifier is not available, use a combination of the companies registered and for the next best hit rate. ### Return Indicator Based On Company Identififier - [GET /localSolutions/GB/verify/company/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/getcompanyinformation.md): Returns an indicator as to whether verify information is available on a business. ### Company Credit Report - [GET /companies/{connectId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/companycreditreport.md): 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. ### Execute Individual Search - [GET /localSolutions/GB/verify/individual/directReport](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/getindividualdirectreport.md): Executes a search using optional personal and address details. ### Director Search - [GET /people](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/directorssearch.md): Endpoint to find Directors based on search criteria to order a Creditsafe Director Report. ### Retrieve Individual Summary Information - [GET /localSolutions/GB/verify/individual/{id}/summary](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/getsummaryinformationbyid.md): Returns summary information about an individual based on the provided identifier. ### Retrieve Individual Full Information - [GET /localSolutions/GB/verify/individual/{id}/full](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/getfullinformationbyid.md): Returns detailed information about an individual based on the provided identifier. ## US Search Support This endpoint provides support for searching in the United States for companies not immediately available in the Creditsafe database. ### Fresh Investigation Request - [POST /localSolutions/US/searchSupport](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/localsolutions/us-search-support/createfreshinvestigationforuscountry.md): 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 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.