Skip to content
Connect API Catalog/
/
/
Set Reference For An Exis...

Local Solutions (1.0.1)

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.

Download OpenAPI description
localSolutions.json
localSolutions.yaml
Languages
Servers
Sandbox server

https://connect.sandbox.creditsafe.com/v1/

Production server

https://connect.creditsafe.com/v1/

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..

Operations

FR Bank Match

This endpoint provides tools for matching bank information in France.

Operations

DE NonLtd Companies

This endpoint provides the tools for searching non-limited companies in Germany and acquiring company reports.

Operations

NL KVK Extract

This endpoint provides tools for extracting information from the Dutch Chamber of Commerce (KVK).

Operations

GB Bank Match

This endpoint provides tools for matching business bank account information in Great Britain.

Operations

GB Consumers and AML

This endpoint provides tools for consumer and anti-money laundering checks in Great Britain.

Operations

Return Previous Identity Search Input

Request

This will return the input criteria used in a search for a specified id.

Security
bearerToken
Path
uniqueIdstringrequired
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch/history/{uniqueId}/input' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
correlationIdstring

A unique ID assigned to this request.

uniqueIdstring
inputobject(ConnectIdentityAMLSearchRequest)

The input data submitted for the AML search, detailing the information used to initiate the search.

commonobject(ConnectIdentityCommonResult)

General results from the search that are applicable across different types of identity checks.

consumerobject(ConnectIdentitySupplierResult)
idobject(ConnectIdentitySupplierResult)
amlResultobject(ConnectIdentitySupplierResult)
bankMatchobject(ConnectIdentitySupplierResult)
picklistArray of objects or null(ConnectIdentitypicklist)
messagestring or null
errorsobject or null
Response
application/json
{
  "correlationId": "string",
  "uniqueId": "string",
  "input": {
    "uniqueId": "string",
    "common": { … },
    "idAml": { … },
    "products": [ … ]
  },
  "common": {
    "customerId": 0,
    "userId": 0,
    "uniqueId": "string",
    "searchText": "string",
    "reference": "string",
    "searchTime": "2019-08-24T14:15:22Z"
  },
  "consumer": {
    "success": true,
    "supplierId": "string",
    "supplierOriginalId": "string",
    "creditsIncurred": 0
  },
  "id": {
    "success": true,
    "supplierId": "string",
    "supplierOriginalId": "string",
    "creditsIncurred": 0
  },
  "amlResult": {
    "success": true,
    "supplierId": "string",
    "supplierOriginalId": "string",
    "creditsIncurred": 0
  },
  "bankMatch": {
    "success": true,
    "supplierId": "string",
    "supplierOriginalId": "string",
    "creditsIncurred": 0
  },
  "picklist": [
    { … }
  ],
  "message": "string",
  "errors": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Set Reference For An Existing History Item

Request

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.

Security
bearerToken
Path
uniqueIdstringrequired

The ID of the record to update

Bodyapplication/jsonrequired
string
curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch/history/{uniqueId}/reference' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json'

Responses

Success

Bodyapplication/json
string
Response
application/json
"string"

Revalidate A Given Identity Search With Additional Documents

Request

Revalidate's a given identity search with additional documents.

Security
bearerToken
Path
uniqueIdstringrequired

The ID of the record to update

Bodyapplication/jsonrequired
uniqueIdstring or null
passportobject(ConnectIdentityPassport)
driversLicenseobject(ConnectIdentityDriversLicense)
electricitySupplierobject(ConnectIdentityElectricitySupplier)
europeanIDCardobject(ConnectIdentityEuropeanIDCard)
niNumberobject(ConnectIdentityNINumber)
bankAccountDetailsobject(ConnectIdentityBankAccountDetails)
curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch/revalidation/{uniqueId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "uniqueId": "string",
    "passport": {},
    "driversLicense": {},
    "electricitySupplier": {},
    "europeanIDCard": {},
    "niNumber": {},
    "bankAccountDetails": {}
  }'

Responses

Success

Bodyapplication/json
correlationIdstring

A unique ID assigned to this request.

uniqueIdstring
inputobject(ConnectIdentityAMLSearchRequest)

The input data submitted for the AML search, detailing the information used to initiate the search.

commonobject(ConnectIdentityCommonResult)

General results from the search that are applicable across different types of identity checks.

consumerobject(ConnectIdentitySupplierResult)
idobject(ConnectIdentitySupplierResult)
amlResultobject(ConnectIdentitySupplierResult)
bankMatchobject(ConnectIdentitySupplierResult)
picklistArray of objects or null(ConnectIdentitypicklist)
messagestring or null
errorsobject or null
Response
application/json
{
  "correlationId": "string",
  "uniqueId": "string",
  "input": {
    "uniqueId": "string",
    "common": { … },
    "idAml": { … },
    "products": [ … ]
  },
  "common": {
    "customerId": 0,
    "userId": 0,
    "uniqueId": "string",
    "searchText": "string",
    "reference": "string",
    "searchTime": "2019-08-24T14:15:22Z"
  },
  "consumer": {
    "success": true,
    "supplierId": "string",
    "supplierOriginalId": "string",
    "creditsIncurred": 0
  },
  "id": {
    "success": true,
    "supplierId": "string",
    "supplierOriginalId": "string",
    "creditsIncurred": 0
  },
  "amlResult": {
    "success": true,
    "supplierId": "string",
    "supplierOriginalId": "string",
    "creditsIncurred": 0
  },
  "bankMatch": {
    "success": true,
    "supplierId": "string",
    "supplierOriginalId": "string",
    "creditsIncurred": 0
  },
  "picklist": [
    { … }
  ],
  "message": "string",
  "errors": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

GB Bank Verification

This endpoint provides tools for verifying bank account information for individuals in Great Britain.

Operations

GB Finance Agreements

This endpoint provides tools for acquiring and verifying finance agreement information.

Operations

GB Land Registry

This endpoint provides tools for accessing land registry information in Great Britain.

Operations

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.

Operations

US Search Support

This endpoint provides support for searching in the United States for companies not immediately available in the Creditsafe database.

Operations