People/Directors

Endpoints to find People/Directors and order Director Reports. A Director Report will contain a person's registered information and Active & Previous Directorships, where available. This endpoint is not advised to get a list of directors for a specific Company. Instead, order a Company Credit Report using the Companies Report Endpoint, and use the directors section in the report response.

Operations

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.

countriesstring^([a-zA-Z\\s]+,)*[a-zA-Z\\s]+$required

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

One of:

messagesArray of objects(CreditsafeGlobalDataMessage)

Provides information about the request and the response.

correlationIdstring

directorsArray of objects(CreditsafeGlobalDataDirectorSearchData)

totalSizeinteger, (int32)

The total number of results.

Response

{
  "messages": [
    { … }
  ],
  "correlationId": "string",
  "directors": [
    { … }
  ],
  "totalSize": 0
}