Skip to content
Connect API Catalog/
/
/
Director Search

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

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

Execute Individual Search

Request

Executes a search using optional personal and address details.

Security
bearerToken
Bodyapplication/jsonrequired
firstNamestringrequired

First name of the individual.

middleNamestring

Middle name of the individual.

lastNamestringrequired

Last name of the individual.

dateOfBirthstring(date)required

Date of birth of the individual.

Example: "YYYY-MM-DD"
reasonForSearchstringrequired

Reason for performing the search.

Enum"AM""AV""BS""CA""DC""DS""EC""GI""QS""TV"
titlestring

Title of the individual.

addressesobjectrequired
addresses.​currentAddressobjectrequired
addresses.​currentAddress.​postCodestringrequired

Postal code of the address.

addresses.​currentAddress.​addressLinestring

Full address line. You can provide either addressLine OR the component fields (buildingNo, buildingName, subBuilding, street, town, county).

addresses.​currentAddress.​buildingNostring

Building number of the address.

addresses.​currentAddress.​buildingNamestring

Building name of the address.

addresses.​currentAddress.​subBuildingstring

Sub building of the address.

addresses.​currentAddress.​streetstring

Street of the address.

addresses.​currentAddress.​townstring

Town of the address.

addresses.​currentAddress.​countystring

County of the address.

addresses.​previousAddressesArray of objects<= 2 items

Previous addresses (optional, max 2 items).

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/verify/individual/directReport \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "dateOfBirth": "YYYY-MM-DD",
    "reasonForSearch": "AM",
    "title": "string",
    "addresses": {
      "currentAddress": {
        "postCode": "string",
        "addressLine": "string",
        "buildingNo": "string",
        "buildingName": "string",
        "subBuilding": "string",
        "street": "string",
        "town": "string",
        "county": "string"
      },
      "previousAddresses": [
        {
          "position": 1,
          "postCode": "string",
          "addressLine": "string",
          "buildingNo": "string",
          "buildingName": "string",
          "subBuilding": "string",
          "street": "string",
          "town": "string",
          "county": "string"
        }
      ]
    }
  }'

Responses

Bodyapplication/json
verifyMatchboolean

Indicates if the verification matches (true if ANY address matched). Aggregated from all address results using OR logic.

flagsobject(Flags)

Top-level aggregated flags. Each flag is true if ANY address has the flag set to true (aggregated using OR logic). Always present in response.

directorshipsArray of objects

Company directorships for the individual. Always present in response (may be empty array). Only populated when PNR is matched and customer has Full (3136) backend flag. Ordered by appointment status: Current, then Resigned, then Dissolved.

addressesobject

Address verification results matching the request structure. Always present in response.

requestDetailsobject(PostSearchRequestDetails)
Response
application/json
{
  "verifyMatch": true,
  "flags": {
    "ccjMatch": true,
    "electoralRegisterMatch": true,
    "deceasedRegisterMatch": true,
    "insolvencyMatch": true
  },
  "directorships": [
    { … }
  ],
  "addresses": {
    "currentAddress": { … },
    "previousAddresses": { … }
  },
  "requestDetails": {
    "title": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "dateOfBirth": "string",
    "reasonForSearch": "string",
    "buildingNo": "string",
    "buildingName": "string",
    "subBuilding": "string",
    "street": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "addressLine": "string",
    "addresses": { … }
  }
}

Director Search

Request

Endpoint to find Directors based on search criteria to order a Creditsafe Director Report.

Security
bearerToken
Query
pageinteger

Starting page number.

Default 1
pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

countriesobjectrequired

comma-separated list of iso-2 country codes

Example: countries=GB,FR
peopleIdstring

Person/Director Identifier - used to order a Director Report.

firstNamestring

Person's First Name.

lastNamestring

Person's Last Name

localDirectorNumberstring or null

Local Identifier of the Director, the PNR in GB.

dateOfBirthstring

Person DOB - provide YYYY-MM-DD or YYYY-MM format.

callRefstring or null

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.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/people?page=1&pageSize=0&countries=GB%2CFR&peopleId=string&firstName=string&lastName=string&localDirectorNumber=string&dateOfBirth=string&callRef=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataDirectorSearchData (object)
Response
application/json
{
  "messages": [
    { … }
  ],
  "correlationId": "string",
  "directors": [
    { … }
  ],
  "totalSize": 0
}

Retrieve Individual Summary Information

Request

Returns summary information about an individual based on the provided identifier.

Security
bearerToken
Path
idstring/^(GB|IE)-.+$/irequired

Unique identifier for the people.

Query
freeTextstring

Additional free text for audit logging.

reasonForSearchstringrequired

Reason for performing the search.

Enum"AM""AV""BS""CA""DC""DS""EC""GI""QS""TV"
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/verify/individual/{id}/summary?freeText=string&reasonForSearch=AM' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
verifyMatchboolean

Indicates if the verification matches the individual.

flagsobject
Response
application/json
{
  "verifyMatch": true,
  "flags": {
    "ccjMatch": true,
    "electoralRegisterMatch": true,
    "deceasedRegisterMatch": true,
    "insolvencyMatch": true
  }
}

US Search Support

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

Operations