# Director Report

Returns a report from the ID supplied to the search.

Endpoint: GET /people/{peopleId}
Version: 1.0.0
Security: bearerToken

## Query parameters:

  - `language` (string)
    Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available.

  - `callRef` (string)
    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.

## Path parameters:

  - `peopleId` (string, required)
    Identifier of the Person/Director required to order their Director Report. Obtained from  search results.

## Response 200 fields (application/json):

  - `messages` (array)
    Provides information about the request and the response.

  - `messages.type` (string)
    Enum: "Information", "Warning", "Error"

  - `messages.code` (string)
    Enum: "NoResults", "TooManyResults", "ReportUnavailable", "ReportUnavailableDueToLegal", "ReportUnavailableOnline", "LegalNotice", "InvalidCredentials", "AccessRestricted", "AccessLimitsNearing", "InsufficientCustomerData", "ReportboxAlmostFull", "ReportboxFull", "InvalidRequestXml", "InvalidOperationParameters", "OperationNotSupported", "InvalidCustomData", "ChangeNotification", "TemporarySystemProblem", "EndpointShutdown", "UnexpectedInternalError", "Other", "DataServiceAccessProblems", "DataServiceInvalidResponse"

  - `messages.text` (string)

  - `report` (object)

  - `report.directorId` (string)

  - `report.directorSummary` (object)

  - `report.directorSummary.currentAppointments` (integer)

  - `report.directorSummary.inactiveAppointments` (integer)

  - `report.directorSummary.previousAppointments` (integer)

  - `report.directorDetails` (object)

  - `report.directorDetails.id` (string)
    Unique ID.

  - `report.directorDetails.idType` (string)
    Description for the ID, to describe the type of ID presented e.g. Person number, Tax ID (if a company), Company Registration Number etc.
    Enum: "Other", "SafeNumber", "RegistrationNumber", "VATNumber", "TaxID", "PersonNumber", "ExternalID", "InternalID"

  - `report.directorDetails.name` (string)
    Name of the Shareholder, or Company Name if a corporate shareholder exists.

  - `report.directorDetails.title` (string)
    Title, if known.

  - `report.directorDetails.firstNames` (string)
    First name(s) of the shareholder. May optionally include middle names, or initials if these cannot be distinguished.

  - `report.directorDetails.firstName` (string)
    First name of the shareholder. This field should be used if a middleName also exists.

  - `report.directorDetails.middleName` (string)
    Middle name of the shareholder.

  - `report.directorDetails.surname` (string)
    Last name of the shareholder.

  - `report.directorDetails.address` (object)

  - `report.directorDetails.address.type` (string)
    Address type description. Examples - "Registered Office", "Trading Address", "Postal Address", "Service Address" etc.

  - `report.directorDetails.address.simpleValue` (string)
    (Optionally populated) Registered address of the company. Whole string address if Creditsafe is unable to accurately assign values to specific address fields, or when specific local address formats need to be observed.

  - `report.directorDetails.address.street` (string)
    Street portion of the address line. Can also, optionally contain, the house number alongside the street.

  - `report.directorDetails.address.houseNumber` (string)
    House number portion of the address line.

  - `report.directorDetails.address.additionToAddress` (string)
    Additional details for a specified address, such as a PO Box number, or a unit number at the specified address location.

  - `report.directorDetails.address.city` (string)
    City portion of the address line.

  - `report.directorDetails.address.postalCode` (string)
    Postal code portion of the address line.

  - `report.directorDetails.address.province` (string)
    Province portion of the address line.

  - `report.directorDetails.address.region` (string)
    May contain the geographical region, for example "South-East" or a territorial division.

  - `report.directorDetails.address.telephone` (string)
    Registered telephone number.

  - `report.directorDetails.address.directMarketingOptOut` (boolean,null)
    Boolean [true/false]. Where set to true, the subject has "opted out" via a central register, and they must not be contacted for commercial marketing purposes.

  - `report.directorDetails.address.directMarketingOptIn` (boolean,null)

  - `report.directorDetails.address.country` (string)
    Country where the company is registered.
    Enum: "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VA", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "XK", "SS", "SX", "CW", "BQ", "WW", "PLC"

  - `report.directorDetails.gender` (string)
    Enum: "Unknown", "Male", "Female", "NotApplicable"

  - `report.directorDetails.birthName` (string)
    The birth name or previous legal name of the officer.

  - `report.directorDetails.dateOfBirth` (string,null)
    The director’s date of birth.

  - `report.directorDetails.placeOfBirth` (string)
    The director’s place or region of birth.

  - `report.directorDetails.nationality` (string)
    The director’s nationality or country of birth.

  - `report.directorDetails.countryOfResidence` (string)
    The country of residence, if known.

  - `report.directorDetails.directorType` (string)
    Indicates if the shareholders record relates to a "Person", "Company" or "Other".
    Enum: "Other", "Person", "Company"

  - `report.directorDetails.hasNegativeInfo` (boolean,null)
    Linked with DE searches, may return with other countries if data is available. Boolean [true/false] if the director has negative information, such as Protesti, Court Judgements etc linked to their unique directors ID. Boolean [true/false] set to true where the director is known to be an authorised signatory. Further details, if known, may be present in "authority" or "additionalData".

  - `report.directorDetails.signingAuthority` (boolean,null)
    Linked with DE searches, may return with other countries if data is available.

  - `report.directorDetails.positions` (array)

  - `report.directorDetails.positions.dateAppointed` (string,null)
    The date the director was appointed.

  - `report.directorDetails.positions.commonCode` (string)
    A common global code that aims to categorise director positions across Countries – currently no data available.

  - `report.directorDetails.positions.providerCode` (string)
    The local provider director code (if exists) specific to each Country.

  - `report.directorDetails.positions.positionName` (string)
    The director’s role/position in a company.

  - `report.directorDetails.positions.authority` (string)
    If available, any available details pertaining to the score, power, limitations, signing authority or ability to bind the company.

  - `report.directorDetails.positions.apptDurationType` (string)
    The appointment duration should be used in conjunction with the appointment term field.

  - `report.directorDetails.positions.additionalData` (object)
    A free-flowing section, containing country specific elements.

  - `report.otherAddresses` (array)

  - `report.directorships` (object)

  - `report.directorships.current` (array)

  - `report.directorships.current.id` (string)

  - `report.directorships.current.companyName` (string)

  - `report.directorships.current.companyNumber` (string)

  - `report.directorships.current.companyRegistrationNumber` (string)

  - `report.directorships.current.status` (string)
    High-level status. Values include "Active", "NonActive", "Pending" and "Other". Note - “Pending” indicates that the entity has entered into a legal process such as insolvency or liquidation, and “Other” indicates an unknown status.
    Enum: "Active", "NonActive", "Pending", "Other"

  - `report.directorships.current.activity` (object)

  - `report.directorships.current.activity.code` (string)
    Industry code used in that country e.g. SIC / NACE

  - `report.directorships.current.activity.description` (string)
    Description of company’s main activity.

  - `report.directorships.current.position` (object)

  - `report.directorships.current.position.resignationDate` (string,null)

  - `report.directorships.current.signingAuthority` (boolean,null)

  - `report.directorships.current.companyRegistrationDate` (string,null)

  - `report.directorships.current.legalForm` (object)

  - `report.directorships.current.legalForm.commonCode` (string)
    A common global code that aims to categorise legal forms across Countries. Currently only available for Non Ltd reports as “Sole Trader” or “Other”.

  - `report.directorships.current.legalForm.providerCode` (string)
    The local provider legal form codes specific to each Country

  - `report.directorships.current.legalForm.description` (string)
    The legal type of the company e.g. S.A., GmbH, Ltd, N.V. etc.

  - `report.directorships.current.state` (string)

  - `report.directorships.current.yearEndDate` (string,null)

  - `report.directorships.current.currency` (string)
    The Currency in which the financial value is displayed, as a three-character ISO code.
    Enum: "AFA", "ALL", "DZD", "ADF", "ADP", "AOA", "ARA", "ARS", "AMD", "AWG", "AUD", "AZM", "BSD", "BHD", "BDT", "BBD", "BYR", "BZD", "BMD", "BTN", "BOB", "BAM", "BWP", "BRC", "BRL", "GBP", "BND", "BGN", "BIF", "XOF", "XAF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "HRK", "CUP", "CZK", "DKK", "DJF", "DOP", "NLG", "EUR", "ECS", "EGP", "SVC", "EEK", "ETB", "FKP", "FJD", "FRF", "GMD", "GEL", "GHC", "GIP", "XAU", "GTQ", "GNF", "GWP", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "JOD", "KZT", "KES", "KRW", "KWD", "KGS", "LAK", "LVL", "LBP", "LSL", "LRD", "LYD", "LTL", "MOP", "MKD", "MGF", "MWK", "MYR", "MVR", "MTL", "MRO", "MUR", "MXN", "MDL", "MNT", "MAD", "MZM", "MMK", "ANG", "NAD", "NPR", "NZD", "NIO", "NGN", "KPW", "NOK", "OMR", "PKR", "XPD", "PAB", "PGK", "PYG", "PEN", "PHP", "XPT", "PLN", "QAR", "RON", "RUB", "RWF", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "XAG", "SGD", "SKK", "SIT", "SBD", "SOS", "ZAR", "LKR", "SHP", "SDD", "SDG", "SDP", "SRD", "SRG", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "TOP", "TTD", "TND", "TRY", "TMM", "USD", "UGX", "UAG", "UAK", "AED", "UYU", "UZS", "VUV", "VEF", "VND", "YUN", "ZMK", "ZWD", "AFN", "ATS", "AZN", "BYN", "BEF", "BOV", "GRD", "FIM", "DEM", "GHS", "IEP", "ITL", "LUF", "PTE", "ESP", "XDR", "TMT", "UAH", "ERN", "MGA", "MRU", "MZN", "SSP", "STN", "YER", "XPF", "XCD", "ZMW", "ZWL"

  - `report.directorships.current.latestTurnoverFigure` (object)

  - `report.directorships.current.latestTurnoverFigure.value` (number)
    The maximum amount of share capital the company is authorised by its constitutional documents to issue to shareholders.

  - `report.directorships.current.netWorth` (object)

  - `report.directorships.current.legalCount` (integer,null)

  - `report.directorships.current.legalAmount` (object)

  - `report.directorships.current.legalCountInLast12Months` (integer,null)

  - `report.directorships.current.creditScore` (object)

  - `report.directorships.current.creditScore.currentCreditRating` (object)

  - `report.directorships.current.creditScore.currentCreditRating.commonValue` (string)
    Standardised credit score – will be A, B, C, D or E.
    Enum: "A", "B", "C", "D", "E"

  - `report.directorships.current.creditScore.currentCreditRating.commonDescription` (string)
    A text description of the common credit score.

  - `report.directorships.current.creditScore.currentCreditRating.creditLimit` (object)

  - `report.directorships.current.creditScore.currentCreditRating.creditLimit.value` (string)
    Amount of credit advisable at any one time.

  - `report.directorships.current.creditScore.currentCreditRating.providerValue` (object)

  - `report.directorships.current.creditScore.currentCreditRating.providerValue.maxValue` (string)
    The maximum value of the score that is provided for the Country.

  - `report.directorships.current.creditScore.currentCreditRating.providerValue.minValue` (string)
    The minimum value of the score that is provided for the Country.

  - `report.directorships.current.creditScore.currentCreditRating.providerValue.value` (string)
    Local credit score, as used by the supplier in that particular country

  - `report.directorships.current.creditScore.currentCreditRating.providerDescription` (string)
    Local credit score description.

  - `report.directorships.current.creditScore.currentCreditRating.pod` (number,null)
    Probability of Default (POD) is the anticipated likelihood of company default within the next 12 months in a percentage format.

  - `report.directorships.current.creditScore.currentCreditRating.assessment` (string)
    An additional score assessment commentary.

  - `report.directorships.current.creditScore.currentContractLimit` (object)

  - `report.directorships.current.creditScore.previousCreditRating` (object)

  - `report.directorships.current.creditScore.latestRatingChangeDate` (string,null)
    Last date that the credit score changed.

  - `report.directorships.current.dbt` (number,null)

  - `report.directorships.previous` (array)

  - `report.directorships.inactive` (array)

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 401 fields (application/json):

  - `error` (string)

## Response 403 fields (application/json):

  - `message` (string)
    Example: "Access forbidden"

## Response 404 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected