# Consumer Report

Consumer Search and Report endpoint. When sufficient information has been provided to filter potential Consumer results down to one record then the Consumer Report will be returned.

Endpoint: GET /consumers
Version: 1.10.9
Security: bearerToken

## Query parameters:

  - `countries` (string, required)
    ISO-2 country code. Only available for  (Germany) and  (Netherlands)
    Example: "DE"

  - `language` (string,null)

  - `firstName` (string, required)
    Consumer's First Name

  - `lastName` (string, required)
    Consumer's Last Name

  - `street` (string, required)
    Address part identifier - Street of the Consumer

  - `houseNo` (string, required)
    Address part identifier - House/Building Number of the Consumer

  - `city` (string, required)
    Address part identifier - City of the Consumer

  - `postCode` (string, required)
    Address part identifier - Postcode/Zip Code of the Consumer

  - `dateOfBirth` (string,null)

  - `customData` (string,null)
    Example: "de_reason_code::ER"

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

## Response 200 fields (application/json):

  - `totalSize` (integer)

  - `consumers` (array)

  - `consumers.consumerInformation` (object)

  - `consumers.consumerInformation.name` (string)

  - `consumers.consumerInformation.firstName` (string)

  - `consumers.consumerInformation.surname` (string)

  - `consumers.consumerInformation.age` (integer,null)

  - `consumers.consumerInformation.dateOfBirth` (string,null)

  - `consumers.consumerInformation.gender` (string)
    Enum: "Unknown", "Male", "Female", "NotApplicable"

  - `consumers.consumerInformation.consumerID` (string)

  - `consumers.consumerInformation.address` (object)

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

  - `consumers.consumerInformation.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.

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

  - `consumers.consumerInformation.address.houseNumber` (string)
    House number portion of the address line.

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

  - `consumers.consumerInformation.address.city` (string)
    City portion of the address line.

  - `consumers.consumerInformation.address.postalCode` (string)
    Postal code portion of the address line.

  - `consumers.consumerInformation.address.province` (string)
    Province portion of the address line.

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

  - `consumers.consumerInformation.address.telephone` (string)
    Registered telephone number.

  - `consumers.consumerInformation.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.

  - `consumers.consumerInformation.address.directMarketingOptIn` (boolean,null)

  - `consumers.consumerInformation.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"

  - `consumers.consumerInformation.additionalData` (object)
    A free-flowing section, containing country specific elements.

  - `consumers.incomes` (array)

  - `consumers.incomes.incomeYear` (integer)

  - `consumers.incomes.taxClass` (string)

  - `consumers.incomes.netWealth` (number,null)

  - `consumers.incomes.netIncome` (number,null)

  - `consumers.incomes.sumTax` (number,null)

  - `consumers.incomes.grossIncome` (number,null)

  - `consumers.incomes.municipalityNr` (string)

  - `consumers.registeredProperty` (integer,null)

  - `consumers.registeredHousingShare` (integer,null)

  - `consumers.directorships` (array)

  - `consumers.directorships.companyName` (string)

  - `consumers.directorships.companyStatus` (string)

  - `consumers.directorships.appointmentDate` (string,null)

  - `consumers.directorships.turnover` (number,null)

  - `consumers.directorships.creditRating` (string)

  - `consumers.directorships.companyNumber` (string)

  - `consumers.directorships.function` (string)

  - `consumers.directorships.companyRegistrationDate` (string,null)

  - `consumers.directorships.netWorth` (number,null)

  - `consumers.directorships.creditLimit` (number,null)

  - `consumers.paymentRemarks` (array)

  - `consumers.paymentRemarks.unsettledROPNumber` (integer,null)

  - `consumers.paymentRemarks.partlySettledROPNumber` (integer,null)

  - `consumers.paymentRemarks.voluntaryPledgeNumber` (integer,null)

  - `consumers.paymentRemarks.unsettledROPAmount` (number,null)

  - `consumers.paymentRemarks.partlySettledROPAmount` (number,null)

  - `consumers.paymentRemarks.voluntaryPledgeAmount` (number,null)

  - `consumers.paymentRemarksDetails` (array)

  - `consumers.paymentRemarksDetails.type` (string)

  - `consumers.paymentRemarksDetails.date` (string,null)

  - `consumers.paymentRemarksDetails.source` (string)

  - `consumers.paymentRemarksDetails.refNr` (string)

  - `consumers.paymentRemarksDetails.amount` (number,null)

  - `consumers.paymentRemarksDetails.creditor` (string)

  - `consumers.paymentRemarksDetails.status` (string)

  - `consumers.voluntaryPledges` (array)

  - `consumers.consumerRating` (object)

  - `consumers.consumerRating.currentCreditRating` (object)

  - `consumers.consumerRating.currentCreditRating.providerValue` (object)

  - `consumers.consumerRating.currentCreditRating.providerValue.maxValue` (string)
    The maximum value of the score that is provided for the Country.

  - `consumers.consumerRating.currentCreditRating.providerValue.minValue` (string)
    The minimum value of the score that is provided for the Country.

  - `consumers.consumerRating.currentCreditRating.providerValue.value` (string)
    Local credit score, as used by the supplier in that particular country

  - `consumers.consumerRating.currentCreditRating.providerDescription` (string)

  - `consumers.consumerRating.currentContractLimit` (object)

  - `consumers.consumerRating.currentContractLimit.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"

  - `consumers.consumerRating.currentContractLimit.value` (number)
    The maximum amount of share capital the company is authorised by its constitutional documents to issue to shareholders.

  - `consumers.consumerRating.previousCreditRating` (object)

  - `consumers.consumerRating.previousCreditRating.commonValue` (string)
    Standardised credit score – will be A, B, C, D or E.
    Enum: "A", "B", "C", "D", "E"

  - `consumers.consumerRating.previousCreditRating.commonDescription` (string)
    A text description of the common credit score.

  - `consumers.consumerRating.previousCreditRating.providerDescription` (string)
    Local credit score description.

  - `consumers.consumerRating.previousCreditRating.pod` (number,null)
    Probability of Default (POD) is the anticipated likelihood of company default within the next 12 months in a percentage format.

  - `consumers.consumerRating.previousCreditRating.assessment` (string)
    An additional score assessment commentary.

  - `consumers.consumerRating.latestRatingChangeDate` (string,null)

  - `consumers.additionalInformation` (object)

## 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)