Skip to content
Connect API Catalog/
/
/
Submit A GB Consumer or A...

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

Submit A GB Consumer or AML Search

Request

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.

Security
bearerToken
Bodyapplication/json

Select the relevant tab for the request body for one of the products AML, AMLMultiBureau or Consumer.

NOTE:' If a previous address is used in addition to current the postCode becomes required.

One of:

Search parameters for AML product

commonobject(ConnectIdentityAmlCommonSearchCriteria)

Person search criteria

Example: {"person":{"currentName":{"title":"","forename":"Doe","otherNames":"","surname":"John","suffix":""},"previousName\"":{"title":null,"forename":null,"otherName\"":null,"surname":null,"suffix":null},"dateOfBirth":"1991-04-05","gender":"Male","addresses":{"current":{"abodeNo":"","buildingNo":"110","buildingName":"","street":"Pierhead Street","subStreet":"","city":"Cardiff","postCode":"CF10 4DQ","organisation":"","subBuilding":"","district":""},"previous1":{"abodeNo":"","buildingNo":"","buildingName":"","street":"","subStreet":"","city":"","postCode":"","organisation":"","subBuilding":"","district":""},"previous2":{"abodeNo":"","buildingNo":"","buildingName":"","street":"","subStreet":"","city":"","postCode":"","organisation":"","subBuilding":"","district":""}}},"reference":"24680"}
idAmlobject

Contains information relevant for anti-money laundering (AML) identity verification, including contact details, banking information, and documentation status.

Example: {"LandlineNumber":"","ExDirectory":false,"Documents":null}
productsArray of strings

Enter AML for this product search

Example: ["AML"]
curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "common": {
      "person": {
        "currentName": {
          "title": "",
          "forename": "Doe",
          "otherNames": "",
          "surname": "John",
          "suffix": ""
        },
        "previousName\"": {
          "title": null,
          "forename": null,
          "otherName\"": null,
          "surname": null,
          "suffix": null
        },
        "dateOfBirth": "1991-04-05",
        "gender": "Male",
        "addresses": {
          "current": {
            "abodeNo": "",
            "buildingNo": "110",
            "buildingName": "",
            "street": "Pierhead Street",
            "subStreet": "",
            "city": "Cardiff",
            "postCode": "CF10 4DQ",
            "organisation": "",
            "subBuilding": "",
            "district": ""
          },
          "previous1": {
            "abodeNo": "",
            "buildingNo": "",
            "buildingName": "",
            "street": "",
            "subStreet": "",
            "city": "",
            "postCode": "",
            "organisation": "",
            "subBuilding": "",
            "district": ""
          },
          "previous2": {
            "abodeNo": "",
            "buildingNo": "",
            "buildingName": "",
            "street": "",
            "subStreet": "",
            "city": "",
            "postCode": "",
            "organisation": "",
            "subBuilding": "",
            "district": ""
          }
        }
      },
      "reference": "24680"
    },
    "idAml": {
      "LandlineNumber": "",
      "ExDirectory": false,
      "Documents": null
    },
    "products": [
      "AML"
    ],
    "uniqueId": null
  }'

Responses

Success

Bodyapplication/json
One of:
correlationIdstring

A unique identifier for tracking the request across systems.

Example: "a2093b41-b7fe-4973-8eba-78f3627168a7"
uniqueIdstring

A unique identifier for the specific search request.

Example: "43d27878fa4b4e74b336a6c1b21d690d"
inputobject

Contains the input parameters used for the search request.

commonobject
pickListArray of objects

A list of potential consumer results when more than one match is found.
This property will not appear if only one result is returned.

consumerResultobject

Contains the result of the consumer search when exactly one match is found. This property will not appear if multiple results are returned; in that case, the pickList property will be present instead.

errorsobject
Response
application/json
{
  "correlationId": "a2093b41-b7fe-4973-8eba-78f3627168a7",
  "uniqueId": "43d27878fa4b4e74b336a6c1b21d690d",
  "input": {
    "uniqueId": "43d27878fa4b4e74b336a6c1b21d690d",
    "common": { … },
    "consumer": { … },
    "products": [ … ]
  },
  "common": {
    "customerId": 106828872,
    "userId": 101686746,
    "uniqueId": "43d27878fa4b4e74b336a6c1b21d690d",
    "searchText": "Miss Anne Delta (4/06/1948) X9 8JD",
    "reference": "Test - Consumer Search",
    "searchTime": "024-04-23T11:19:35.180004+00:00"
  },
  "pickList": [
    { … }
  ],
  "consumerResult": {
    "applicant1Report": { … },
    "dateAndTimeOfReport": "2021-01-01T12:00:48",
    "gaugeVersion": "G1",
    "reason": "Quotation Search",
    "success": false,
    "supplierId": "{AAAAE42F-92E5-4ED9-B322-XXXXXXXXXXXX}",
    "creditsIncurred": 1
  },
  "errors": {}
}

Resolve A Picklist Against A Given UniqueId

Request

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.

Security
bearerToken
Query
uniqueIdstringrequired

UniqueId of the search to resolve. This is acquired from the response of a previous search that returned a picklist.

Bodyapplication/jsonrequired

The picklist to resolve. This is acquired from the response of a previous search that returned a picklist.

Array [
string
]
curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch?uniqueId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    "1:1:1_0"
  ]'

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": [ … ]
  }
}

Return List Of Identity Search History Items

Request

Retrieves a paginated history list for the specified customer/user, filtered based on the include* parameters.

Security
bearerToken
Query
pageinteger or null(int32)

The 1-indexed page number to fetch

pageSizeinteger or null(int32)

The page size number to fetch

IncludeCustomerboolean

If true, returns all results for this customer. Valid for senior users only.

ProductsArray of strings or null(ConnectIdentityProduct)

The array of products to include

Below is a list of Definitions for the ENUM

  • 0 - Consumer
  • 1 - Id
  • 2 - AML
  • 3 - Bank Match
  • 4 - AML with Bank Match
Example: Products=AML
DateFromstring or null(date-time)

The earliest date to include

DateTostring or null(date-time)

The latest date to include

Keywordstring or null

Include this string

Resultstring or null

Return only items with this result

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch/history?page=0&pageSize=0&IncludeCustomer=true&Products=AML&DateFrom=2019-08-24T14%3A15%3A22Z&DateTo=2019-08-24T14%3A15%3A22Z&Keyword=string&Result=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
totalCountinteger(int32)
dataArray of objects or null(ConnectIdentityIdentityHistoryItem)
messagestring or null
errorsobject or null
Response
application/json
{
  "totalCount": 0,
  "data": [
    { … }
  ],
  "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