{"items":[{"type":"link","label":"Consumer And Misc","link":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc","routeSlug":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc","content":{"contentType":"overview","meta":{"name":"Consumer And Misc"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"consumerAndMisc.json","url":"/_bundle/connect-apis-catalog/product-catalog/Consumer&Misc/consumerAndMisc.json?download"},{"kind":"download","label":"consumerAndMisc.yaml","url":"/_bundle/connect-apis-catalog/product-catalog/Consumer&Misc/consumerAndMisc.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"attribute","title":"License","titleTranslationKey":"info.license","label":"Proprietary","value":"Proprietary"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Consumer And Misc (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints to order Consumer Reports for multiple regions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"European Consumers (Sweden, Norway, Netherlands, Germany):"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to order a European Consumer Report, sufficient information to uniquely identify the Consumer (search criteria) must be provided to filter potential results down to one record. When one record has been found, the returned object will be the Consumer Report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US Consumers:"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US Consumer credit reports require specific search criteria as defined by US credit bureau requirements."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important Note on Response Structure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response structure shown in this documentation represents the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full set of fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that may be returned by the Consumer Report service."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual responses depend on the data available for the requested consumer. If certain information (e.g., incomes, property details, credit score) is not available, those fields will be omitted from the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always implement your integration to handle missing or partial data gracefully."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc"}],"sectionId":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc"}]}]}},{"type":"group","label":"Authentication","link":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/authentication","routeSlug":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/authentication","items":[{"label":"Authenticate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/authentication/authenticate","routeSlug":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/authentication/authenticate","metadata":{"seo":{"title":"Authenticate","description":"Supply username and password to generate Authentication Token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticate","name":"Authenticate","isWebhook":false,"pointer":"/paths/~1authenticate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Supply username and password to generate Authentication Token.\n  \n"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthRequest"}},"schemaId":"components/schemas/ConnectAuthenticationAuthRequest","pointer":"/paths/~1authenticate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authenticate","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthRequest"}},"responseCodes":["200","401"],"pointer":"/authenticate","href":"authentication/authenticate","openApiOperationId":"authenticate","summary":"Authenticate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectAuthenticationAuthRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthResponse"}},"schemaId":"components/schemas/ConnectAuthenticationAuthResponse"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthFailedResponse"}},"schemaId":"components/schemas/ConnectAuthFailedResponse"}],"pointer":"/paths/~1authenticate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectAuthenticationAuthResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthResponse"}}},{"code":"401","schemaId":"components/schemas/ConnectAuthFailedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthFailedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/authenticate"}],"panels":[]}]},"httpPath":"/authenticate"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true},{"nodeType":"markdoc","content":"Authentication endpoint to obtain access token for API requests."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authenticate","summary":"Authenticate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/authenticate","deprecated":false}]}]}]}]}},{"type":"group","label":"European Consumers","link":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/european-consumers","routeSlug":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/european-consumers","items":[{"label":"Return European Consumer Search Criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/european-consumers/consumersearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/european-consumers/consumersearchcriteria","metadata":{"seo":{"title":"Return European Consumer Search Criteria","description":"Returns country specific fields that can be used to search for a Consumer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerSearchCriteria","name":"Return European Consumer Search Criteria","isWebhook":false,"pointer":"/paths/~1consumers~1searchcriteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return European Consumer Search Criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns country specific fields that can be used to search for a Consumer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_541","description":"Comma-separated list of ISO-2 country codes","required":true,"example":"de"},{"name":"callRef","in":"query","schemaId":"schema_541","description":"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."}],"pointer":"/paths/~1consumers~1searchcriteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/consumers/searchcriteria","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","required":true,"example":"de","schemaId":"schema_541"},{"name":"callRef","in":"query","schemaId":"schema_541"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/consumers/searchcriteria","href":"european-consumers/consumersearchcriteria","openApiOperationId":"consumerSearchCriteria","summary":"Return European Consumer Search Criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_542"}},"schemaId":"schema_542"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1consumers~1searchcriteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_542"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/european-consumers/consumersearchcriteria"}],"panels":[]}]},"httpPath":"/consumers/searchcriteria"},{"label":"Return Custom Report Parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/european-consumers/customreportparameters","routeSlug":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/european-consumers/customreportparameters","metadata":{"seo":{"title":"Return Custom Report Parameters","description":"Returns the allowed values of the customData parameter.Used in the GET Company Report and Director Report endpoints.  I.e. Supplying DE as a country code will return a list of reasons for requesting a DE Credit Report (a legal requirement to supply with each Credit Report request in Germany). This will provide a list of allowedValues to enter into the mandatory Parameter customData = de_reason_code::allowedValue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customReportParameters","name":"Return Custom Report Parameters","isWebhook":false,"pointer":"/paths/~1reportcustomdata~1{country}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Custom Report Parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the allowed values of the customData parameter."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET Company Report and Director Report endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  I.e. Supplying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a country code will return a list of reasons for requesting a DE Credit Report (a legal requirement to supply with each Credit Report request in Germany). This will provide a list of allowedValues to enter into the mandatory Parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de_reason_code::allowedValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"country","in":"path","schemaId":"schema_541","description":"An ISO/Alpha-2 country code to display any special mandatory parameters when ordering a Credit Report in that territory.","required":true}],"pointer":"/paths/~1reportcustomdata~1{country}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reportcustomdata/{country}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"country","in":"path","required":true,"schemaId":"schema_541"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/reportcustomdata/{country}","href":"european-consumers/customreportparameters","openApiOperationId":"customReportParameters","summary":"Return Custom Report Parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_543"}},"schemaId":"schema_543"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1reportcustomdata~1{country}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_543","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_543"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/european-consumers/customreportparameters"}],"panels":[]}]},"httpPath":"/reportcustomdata/{country}"},{"label":"Consumer Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/european-consumers/consumerreport","routeSlug":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/european-consumers/consumerreport","metadata":{"seo":{"title":"Consumer Report","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerReport","name":"Consumer Report","isWebhook":false,"pointer":"/paths/~1consumers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consumer Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_541","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-2 country code. Only available for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Germany) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Netherlands)"},"children":[]}]}]}],"required":true,"example":"DE"},{"name":"language","in":"query","schemaId":"schema_544","description":""},{"name":"firstName","in":"query","schemaId":"schema_541","description":"Consumer's First Name","required":true},{"name":"lastName","in":"query","schemaId":"schema_541","description":"Consumer's Last Name","required":true},{"name":"street","in":"query","schemaId":"schema_541","description":"Address part identifier - Street of the Consumer","required":true},{"name":"houseNo","in":"query","schemaId":"schema_541","description":"Address part identifier - House/Building Number of the Consumer","required":true},{"name":"city","in":"query","schemaId":"schema_541","description":"Address part identifier - City of the Consumer","required":true},{"name":"postCode","in":"query","schemaId":"schema_541","description":"Address part identifier - Postcode/Zip Code of the Consumer","required":true},{"name":"dateOfBirth","in":"query","schemaId":"schema_545"},{"name":"customData","in":"query","schemaId":"schema_546","example":"de_reason_code::ER"},{"name":"callRef","in":"query","schemaId":"schema_547","description":"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."}],"pointer":"/paths/~1consumers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/consumers","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","required":true,"example":"DE","schemaId":"schema_541"},{"name":"language","in":"query","schemaId":"schema_544"},{"name":"firstName","in":"query","required":true,"schemaId":"schema_541"},{"name":"lastName","in":"query","required":true,"schemaId":"schema_541"},{"name":"street","in":"query","required":true,"schemaId":"schema_541"},{"name":"houseNo","in":"query","required":true,"schemaId":"schema_541"},{"name":"city","in":"query","required":true,"schemaId":"schema_541"},{"name":"postCode","in":"query","required":true,"schemaId":"schema_541"},{"name":"dateOfBirth","in":"query","schemaId":"schema_545"},{"name":"customData","in":"query","example":"de_reason_code::ER","schemaId":"schema_546"},{"name":"callRef","in":"query","schemaId":"schema_547"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/consumers","href":"european-consumers/consumerreport","openApiOperationId":"consumerReport","summary":"Consumer Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_548"}},"schemaId":"schema_548"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1consumers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_548","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_548"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/european-consumers/consumerreport"}],"panels":[]}]},"httpPath":"/consumers"}],"content":{"contentType":"group","meta":{"name":"European Consumers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"European Consumers","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for searching and retrieving European consumer credit reports (Sweden, Norway, Netherlands, Germany) based on provided search criteria."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/consumers/searchcriteria","summary":"Return European Consumer Search Criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/european-consumers/consumersearchcriteria","deprecated":false},{"title":"/reportcustomdata/{country}","summary":"Return Custom Report Parameters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/european-consumers/customreportparameters","deprecated":false},{"title":"/consumers","summary":"Consumer Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/european-consumers/consumerreport","deprecated":false}]}]}]}]}},{"type":"group","label":"US Consumers","link":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/us-consumers","routeSlug":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/us-consumers","items":[{"label":"Return US Consumers Search Criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/us-consumers/consumertryreportsearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/us-consumers/consumertryreportsearchcriteria","metadata":{"seo":{"title":"Return US Consumers Search Criteria","description":"Returns country specific fields that can be used to search for a US Consumer TryReport. Use this endpoint to discover all supported search criteria query parameters and validation rules for the /consumers/tryReport endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerTryReportSearchCriteria","name":"Return US Consumers Search Criteria","isWebhook":false,"pointer":"/paths/~1consumers~1tryReport~1searchcriteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return US Consumers Search Criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns country specific fields that can be used to search for a US Consumer TryReport.  Use this endpoint to discover all supported search criteria query parameters and validation rules  for the /consumers/tryReport endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_541","description":"ISO-2 country code","required":true,"example":"US"}],"pointer":"/paths/~1consumers~1tryReport~1searchcriteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/consumers/tryReport/searchcriteria","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","required":true,"example":"US","schemaId":"schema_541"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/consumers/tryReport/searchcriteria","href":"us-consumers/consumertryreportsearchcriteria","openApiOperationId":"consumerTryReportSearchCriteria","summary":"Return US Consumers Search Criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}],"pointer":"/paths/~1consumers~1tryReport~1searchcriteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/us-consumers/consumertryreportsearchcriteria"}],"panels":[]}]},"httpPath":"/consumers/tryReport/searchcriteria"},{"label":"US Consumer Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/us-consumers/consumertryreport","routeSlug":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc/us-consumers/consumertryreport","metadata":{"seo":{"title":"US Consumer Report","description":"Search for US consumer based on provided criteria. Returns a consumer report with credit information,  trade lines, negative information, and employment details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerTryReport","name":"US Consumer Report","isWebhook":false,"pointer":"/paths/~1consumers~1tryReport/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"US Consumer Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search for US consumer based on provided criteria. Returns a consumer report with credit information,  trade lines, negative information, and employment details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template Options:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"basic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Standard consumer report without credit score. No footprint left on consumer's credit file."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hardcheck"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Includes credit score in response and leaves a footprint (inquiry) on the consumer's credit file. Used for actual credit decisions."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_550","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single country code in ISO-2 format. Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for US consumer reports."},"children":[]}]}]}],"required":true,"example":"US"},{"name":"firstName","in":"query","schemaId":"schema_541","description":"First name of US consumer","required":true},{"name":"lastName","in":"query","schemaId":"schema_541","description":"Last name of US consumer","required":true},{"name":"template","in":"query","schemaId":"schema_551","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consumer report template.  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"basic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) returns report without credit score and leaves no footprint.  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hardcheck"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes credit score and leaves an inquiry on the consumer's credit file."},"children":[]}]}]}]},{"name":"personNumber","in":"query","schemaId":"schema_552","description":"Social security number (SSN) of US Consumer"},{"name":"dateOfBirth","in":"query","schemaId":"schema_553","description":"Date of birth of US Consumer (format YYYY-MM-DD)"},{"name":"street","in":"query","schemaId":"schema_541","description":"Street name and house number of US consumer"},{"name":"city","in":"query","schemaId":"schema_541","description":"City of US consumer"},{"name":"postalCode","in":"query","schemaId":"schema_541","description":"Postal / zip code of US consumer"},{"name":"province","in":"query","schemaId":"schema_550","description":"US state of US consumer (2-letter state code, e.g., AL, CA, NY)"},{"name":"telephone","in":"query","schemaId":"schema_541","description":"Telephone number of US consumer"}],"pointer":"/paths/~1consumers~1tryReport/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/consumers/tryReport","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","required":true,"example":"US","schemaId":"schema_550"},{"name":"firstName","in":"query","required":true,"schemaId":"schema_541"},{"name":"lastName","in":"query","required":true,"schemaId":"schema_541"},{"name":"template","in":"query","schemaId":"schema_551"},{"name":"personNumber","in":"query","schemaId":"schema_552"},{"name":"dateOfBirth","in":"query","schemaId":"schema_553"},{"name":"street","in":"query","schemaId":"schema_541"},{"name":"city","in":"query","schemaId":"schema_541"},{"name":"postalCode","in":"query","schemaId":"schema_541"},{"name":"province","in":"query","schemaId":"schema_550"},{"name":"telephone","in":"query","schemaId":"schema_541"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/consumers/tryReport","href":"us-consumers/consumertryreport","openApiOperationId":"consumerTryReport","summary":"US Consumer Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Consumer TryReport response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}],"pointer":"/paths/~1consumers~1tryReport/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/us-consumers/consumertryreport"}],"panels":[]}]},"httpPath":"/consumers/tryReport"}],"content":{"contentType":"group","meta":{"name":"US Consumers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"US Consumers","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for searching and retrieving US consumer credit reports based on provided search criteria."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/consumers/tryReport/searchcriteria","summary":"Return US Consumers Search Criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/us-consumers/consumertryreportsearchcriteria","deprecated":false},{"title":"/consumers/tryReport","summary":"US Consumer Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/us-consumers/consumertryreport","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ConnectAuthenticationAuthRequest":{"id":"components/schemas/ConnectAuthenticationAuthRequest","kind":"json-schema","title":"ConnectAuthenticationAuthRequest","data":{"type":"object","properties":{"username":{"type":"string","description":"Credentials assigned upon sign up","example":"username@domain.com"},"password":{"type":"string","example":"^1gHySRA56aj>tf421o"}}}},"components/schemas/ConnectAuthenticationAuthResponse":{"id":"components/schemas/ConnectAuthenticationAuthResponse","kind":"json-schema","title":"ConnectAuthenticationAuthResponse","data":{"type":"object","properties":{"token":{"type":"string","description":"Authentication Token","example":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyIsInR5cCI6IkpXVCIsIng1dCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyJ9.eyJuYmYiOjE1OTU0MTYyMDksImV4cCI6MTU5NTQxOTgwOSwiaXNzIjoiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20iLCJhdWQiOlsiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20vcmVzb3VyY2VzIiwiY29ubmVjdF9hcGkiLCJ1Ym9fYXBpX2dhdGV3YXkiXSwiY2xpZW50X2lkIjoiY29ubmVjdC5hcGkuY2xpZW50Iiwic3ViIjoiMTAxNTIwMjg1IiwiYXV0aF90aW1lIjoxNTk1NDE2MjA5LCJpZHAiOiJsb2NhbCIsInVzZXJuYW1lIjoiQ29ubmVjdHUxIiwiZW1haWwiOiJDb25uZWN0MUBnbWFpbC5jb20iLCJjdXN0b21lcklkIjoiMTAxNzY0NDA1IiwiY291bnRyeSI6IkMwIiwidXNlclJvbGUiOiJDcm1BZG1pblBsdXMiLCJzYl9jb3VudHJ5IjoiVVMiLCJzY29wZSI6WyJjb25uZWN0X2FwaSIsInVib19hcGlfZ2F0ZXdheSJdLCJhbXIiOlsicHdkIl19.p8kPAlKNB9iWEKiQbfbRXBoLQuBG7NuEDN__A8AQ55CL-gcIwkS1717Af1f9W0uifwIQ6HAZQR_x191LVkvuWD94Zw8zLzzr1ioUIhQny_zYuAS3G6EFNaTHh_mvOQ9XVi1FyuIy6YYcYcNLNZurFuITF2w5LuX4YQBjQy3rhEAdRoKcUKbtCClMFaH2dV35jiX2d7BqyhtJ8GeZyJ6yfMfdzznqxlJ4Osf5aasKUy8RYKEpjU2pkCURojoy5_oviGs8X4U9mJWcuajmPF3i5DHkqbhq1Mp0UZrDyoq_0BDStV5xqRgq6aOY8mc45kX7cwY3O2hPeGE7Ak8YtKFbA"}}}},"components/schemas/ConnectAuthFailedResponse":{"id":"components/schemas/ConnectAuthFailedResponse","kind":"json-schema","title":"ConnectAuthFailedResponse","data":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Access denied -  Please check that your username and password are correct.  Please be aware that usernames and passwords are case sensitive. If the problem persists, please contact your Creditsafe account manager."}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCriteriaSet":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCriteriaSet","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCriteriaSet","data":{"properties":{"countries":{"type":"array","items":{"type":"string","example":"DE"}},"criteriaSets":{"type":"array","items":{"type":"object"}}}}},"components/schemas/ConnectErrorResponsesBadRequest":{"id":"components/schemas/ConnectErrorResponsesBadRequest","kind":"json-schema","title":"ConnectErrorResponsesBadRequest","data":{"type":"object","description":"Bad Request","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"message":{"type":"string"},"details":{"type":"string","description":"Provides further information on why the request was rejected"}}}},"components/schemas/ConnectErrorResponsesInvalidToken":{"id":"components/schemas/ConnectErrorResponsesInvalidToken","kind":"json-schema","title":"ConnectErrorResponsesInvalidToken","data":{"type":"object","properties":{"error":{"type":"string"}},"description":"401 - Authorization Token has either expired or is not a valid Connect Token"}},"components/schemas/CreditsafeGlobalDataReportsGender":{"id":"components/schemas/CreditsafeGlobalDataReportsGender","kind":"json-schema","title":"CreditsafeGlobalDataReportsGender","data":{"enum":["Unknown","Male","Female","NotApplicable"],"type":"string"}},"components/schemas/CreditsafeGlobalDataAddressData":{"id":"components/schemas/CreditsafeGlobalDataAddressData","kind":"json-schema","title":"CreditsafeGlobalDataAddressData","data":{"type":"object","properties":{"type":{"type":"string","description":"Address type description. Examples - \"Registered Office\", \"Trading Address\", \"Postal Address\", \"Service Address\" etc."},"simpleValue":{"type":"string","description":"(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."},"street":{"type":"string","description":"Street portion of the address line. Can also, optionally contain, the house number alongside the street."},"houseNumber":{"type":"string","description":"House number portion of the address line."},"additionToAddress":{"type":"string","description":"Additional details for a specified address, such as a PO Box number, or a unit number at the specified address location."},"city":{"type":"string","description":"City portion of the address line."},"postalCode":{"type":"string","description":"Postal code portion of the address line."},"province":{"type":"string","description":"Province portion of the address line."},"region":{"type":"string","description":"May contain the geographical region, for example \"South-East\" or a territorial division."},"telephone":{"type":"string","description":"Registered telephone number."},"directMarketingOptOut":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},"directMarketingOptIn":{"type":["boolean","null"]},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code representing the geographic location of the entity.","example":"MC"}}}},"components/schemas/CreditsafeGlobalDataReportsAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsAdditionalData","data":{"type":"object","description":"The additionalData field is country-specific and may contain different properties depending on the country and product configuration.\nFor the UK, it may include director verification details (See this link).\nFor other countries, the structure and content may vary or be absent.\n"}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformationAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformationAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerInformationAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerInformation","data":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"age":{"type":["integer","null"],"format":"int32"},"dateOfBirth":{"type":["string","null"],"format":"date-time"},"gender":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsGender"},"consumerID":{"type":"string"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformationAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerIncome":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerIncome","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerIncome","data":{"type":"object","properties":{"incomeYear":{"type":"integer","format":"int32"},"taxClass":{"type":"string"},"netWealth":{"type":["number","null"],"format":"double"},"netIncome":{"type":["number","null"],"format":"double"},"sumTax":{"type":["number","null"],"format":"double"},"grossIncome":{"type":["number","null"],"format":"double"},"municipalityNr":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerDirectorship":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerDirectorship","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerDirectorship","data":{"type":"object","properties":{"companyName":{"type":"string"},"companyStatus":{"type":"string"},"appointmentDate":{"type":["string","null"],"format":"date-time"},"turnover":{"type":["number","null"],"format":"double"},"creditRating":{"type":"string"},"companyNumber":{"type":"string"},"function":{"type":"string"},"companyRegistrationDate":{"type":["string","null"],"format":"date-time"},"netWorth":{"type":["number","null"],"format":"double"},"creditLimit":{"type":["number","null"],"format":"double"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerPaymentSummary":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerPaymentSummary","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerPaymentSummary","data":{"type":"object","properties":{"unsettledROPNumber":{"type":["integer","null"],"format":"int32"},"partlySettledROPNumber":{"type":["integer","null"],"format":"int32"},"voluntaryPledgeNumber":{"type":["integer","null"],"format":"int32"},"unsettledROPAmount":{"type":["number","null"],"format":"double"},"partlySettledROPAmount":{"type":["number","null"],"format":"double"},"voluntaryPledgeAmount":{"type":["number","null"],"format":"double"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment","data":{"type":"object","properties":{"type":{"type":"string"},"date":{"type":["string","null"],"format":"date-time"},"source":{"type":"string"},"refNr":{"type":"string"},"amount":{"type":["number","null"],"format":"double"},"creditor":{"type":"string"},"status":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString":{"id":"components/schemas/CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString","kind":"json-schema","title":"CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString","data":{"type":"object","properties":{"maxValue":{"type":"string","description":"The maximum value of the score that is provided for the Country."},"minValue":{"type":"string","description":"The minimum value of the score that is provided for the Country."},"value":{"type":"string","description":"Local credit score, as used by the supplier in that particular country"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditRating":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditRating","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerCreditRating","data":{"type":"object","properties":{"providerValue":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString"},"providerDescription":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataCurrency":{"id":"components/schemas/CreditsafeGlobalDataCurrency","kind":"json-schema","title":"CreditsafeGlobalDataCurrency","data":{"description":"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"],"type":"string"}},"components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal":{"id":"components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal","kind":"json-schema","title":"CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal","data":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CreditsafeGlobalDataCurrency"},"value":{"type":"number","format":"double","description":"The maximum amount of share capital the company is authorised by its constitutional documents to issue to shareholders."}}}},"components/schemas/CreditsafeGlobalDataReportsCommonRatingValue":{"id":"components/schemas/CreditsafeGlobalDataReportsCommonRatingValue","kind":"json-schema","title":"CreditsafeGlobalDataReportsCommonRatingValue","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standardised credit score – will be A, B, C, D or E."},"children":[]}]}]}],"enum":["A","B","C","D","E"],"type":"string"}},"components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemString":{"id":"components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemString","kind":"json-schema","title":"CreditsafeGlobalDataReportsFinancialValue_1_SystemString","data":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CreditsafeGlobalDataCurrency"},"value":{"type":"string","description":"Amount of credit advisable at any one time."}}}},"components/schemas/CreditsafeGlobalDataReportsCreditRating":{"id":"components/schemas/CreditsafeGlobalDataReportsCreditRating","kind":"json-schema","title":"CreditsafeGlobalDataReportsCreditRating","data":{"type":"object","properties":{"commonValue":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCommonRatingValue"},"commonDescription":{"type":"string","description":"A text description of the common credit score."},"creditLimit":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemString"},"providerValue":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString"},"providerDescription":{"type":"string","description":"Local credit score description."},"pod":{"type":["number","null"],"format":"double","description":"Probability of Default (POD) is the anticipated likelihood of company default within the next 12 months in a percentage format."},"assessment":{"type":"string","description":"An additional score assessment commentary."}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditScore":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditScore","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerCreditScore","data":{"type":"object","properties":{"currentCreditRating":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditRating"},"currentContractLimit":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"previousCreditRating":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCreditRating"},"latestRatingChangeDate":{"type":["string","null"],"format":"date-time"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerAdditionalInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerAdditionalInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerAdditionalInformation","data":{"type":"object"}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerReport":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerReport","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerReport","data":{"type":"object","properties":{"language":{"type":"string","description":"Language code for the consumer data (e.g., EN, DE)."},"consumerInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformation"},"incomes":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerIncome"}},"registeredProperty":{"type":["integer","null"],"format":"int32"},"registeredHousingShare":{"type":["integer","null"],"format":"int32"},"directorships":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerDirectorship"}},"paymentRemarks":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerPaymentSummary"}},"paymentRemarksDetails":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment"}},"voluntaryPledges":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment"}},"consumerRating":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditScore"},"additionalInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerAdditionalInformation"}}}},"components/schemas/ConnectErrorResponsesAccessForbidden":{"id":"components/schemas/ConnectErrorResponsesAccessForbidden","kind":"json-schema","title":"ConnectErrorResponsesAccessForbidden","data":{"type":"object","description":"403 - Access Forbidden","properties":{"message":{"type":"string","example":"Access forbidden"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddress":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddress","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusAddress","data":{"type":"object","properties":{"type":{"type":"string","description":"Type of address (current/former)"},"simpleValue":{"type":"string","description":"Consumer's full address"},"street":{"type":"string","description":"Street Name of the Consumer's address"},"houseNumber":{"type":"string","description":"House Number of the Consumer's address"},"city":{"type":"string","description":"City of the Consumer's address"},"postalCode":{"type":"string","description":"ZIP code of the Consumer's address"},"province":{"type":"string","description":"State of the Consumer's address"},"telephoneNumber":{"type":"string","description":"Telephone Number of the Consumer"},"country":{"type":"string","description":"Country of the Consumer's address"},"dateFrom":{"type":["string","null"],"format":"date-time","description":"Date the Consumer's address was first reported"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusConsumerInformation","data":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the Consumer"},"firstName":{"type":"string","description":"First name of the Consumer"},"middleName":{"type":"string","description":"Middle name(s) of the Consumer"},"surname":{"type":"string","description":"Surname of the Consumer"},"age":{"type":["integer","null"],"format":"int32","description":"Age of Consumer"},"dateOfBirth":{"type":["string","null"],"format":"date-time","description":"Consumer's Date of Birth"},"gender":{"type":"string","description":"Consumer's Gender"},"consumerID":{"type":"string","description":"Consumer's consumer ID"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddress"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusCurrentCreditRating":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusCurrentCreditRating","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusCurrentCreditRating","data":{"type":"object","properties":{"providerValue":{"type":"object","properties":{"modelNumber":{"type":"string","description":"Model Number of the specific scoring model used"},"modelName":{"type":"string","description":"Name of the scoring model"},"value":{"type":"string","description":"Actual Credit Score"}}},"providerDescriptions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Numerical code applied for credit score reasons"},"description":{"type":"string","description":"A commentary that provides reasons behind the credit score produced"}}}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusCreditScoreExtra":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusCreditScoreExtra","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusCreditScoreExtra","data":{"type":"object","properties":{"currentCreditRatings":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusCurrentCreditRating"}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddressAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddressAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusAddressAdditionalData","data":{"type":"object","properties":{"poBox":{"type":["boolean","null"],"description":"Indicator that shows if the address is a PO Box"},"rentOwnBuy":{"type":"string","description":"Rent, Own or Buy flag for the specific address/property"},"addressSource":{"type":"string","description":"The source of the address"},"dateLastReported":{"type":["string","null"],"format":"date-time","description":"The date the address was last reported by the Consumer"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactAddress":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactAddress","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusContactAddress","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddress"},{"type":"object","properties":{"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddressAdditionalData"}}}]}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusContactInformation","data":{"type":"object","properties":{"mainAddress":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactAddress"},"previousAddresses":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactAddress"}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusPotentiallyNegativeInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusPotentiallyNegativeInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusPotentiallyNegativeInformation","data":{"type":"object","properties":{"collections":{"type":["integer","null"],"format":"int32","description":"Number of collections"},"thirtyDayDelinquent":{"type":["integer","null"],"format":"int32","description":"Number of payments over due by 30-59 days"},"sixtyDayDelinquent":{"type":["integer","null"],"format":"int32","description":"Number of payments over due by 60-90 days"},"ninetyDayDelinquent":{"type":["integer","null"],"format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of payments over due by 90+ days"},"children":[]}]}]}]},"chargeOffAccounts":{"type":["integer","null"],"format":"int32","description":"Number of accounts that have been charged-off for the Consumer"},"bankruptcyAccounts":{"type":["integer","null"],"format":"int32","description":"Number of accounts the Consumer has in bankruptcy"},"foreclosureAccounts":{"type":["integer","null"],"format":"int32","description":"Number of accounts the Consumer has in foreclosure"},"vehicleRepossessions":{"type":["integer","null"],"format":"int32","description":"Number of vehicle repossessions for the Consumer"},"potentialFraud":{"type":["boolean","null"],"description":"Potential Fraudulence indicator"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusBankruptcy":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusBankruptcy","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusBankruptcy","data":{"type":"object","properties":{"customerNumber":{"type":"string","description":"The Customer Number assigned to the Consumer"},"caseNumber":{"type":"string","description":"The Case Number assigned to the bankruptcy"},"type":{"type":"string","description":"Type of bankruptcy e.g. individual, other etc."},"dateFiled":{"type":["string","null"],"format":"date-time","description":"The Date the bankruptcy was filed"},"assetAmount":{"type":["number","null"],"format":"double","description":"The value of assets that are part of the bankruptcy estate"},"exemptAmount":{"type":["number","null"],"format":"double","description":"The value of assets that are not part of the bankruptcy estate"},"liabilityAmount":{"type":["number","null"],"format":"double","description":"Total amounts owed to creditors"},"filer":{"type":"string","description":"The filer of the bankruptcy e.g. Individual, Joint, Spouse etc."},"industryCode":{"type":"string","description":"Industry Code"},"industryDescription":{"type":"string","description":"Industry Description"},"comments":{"type":"string","description":"Additional Comments relating to the bankruptcy"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusCollection":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusCollection","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusCollection","data":{"type":"object","properties":{"customerNumber":{"type":"string","description":"Customer Number assigned to the collection"},"clientNameOrNumber":{"type":"string","description":"Client Name or Number"},"balance":{"type":["number","null"],"format":"double","description":"Amount owed at the time of reporting"},"balanceDate":{"type":["string","null"],"format":"date-time","description":"Date the balance was last reported"},"status":{"type":"string","description":"Status of the collection"},"statusDate":{"type":["string","null"],"format":"date-time","description":"The date the status was last updated"},"dateReported":{"type":["string","null"],"format":"date-time","description":"The date the collection was reported"},"dateAssigned":{"type":["string","null"],"format":"date-time","description":"The date the collection was assigned"},"originalAmount":{"type":["number","null"],"format":"double","description":"Original Amount owed to the collection agency"},"lastActivityDate":{"type":["string","null"],"format":"date-time","description":"The date the collection was last updated"},"accountOwner":{"type":"string","description":"The creditor that holds legal rights to the collection"},"industryCode":{"type":"string","description":"Industry Code"},"industryDescription":{"type":"string","description":"Industry Description"},"comments":{"type":"string","description":"Additional comments relating to the collection"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusNegativeInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusNegativeInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusNegativeInformation","data":{"type":"object","properties":{"potentiallyNegativeInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusPotentiallyNegativeInformation"},"bankruptcies":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusBankruptcy"}},"collections":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusCollection"}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusMisc":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusMisc","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusMisc","data":{"type":"object","properties":{"reportDate":{"type":["string","null"],"format":"date-time","description":"The date the report was created"},"lastActivityDate":{"type":["string","null"],"format":"date-time","description":"The date the report was last updated"},"stateOfIssuance":{"type":"string","description":"The state where a specific document or identifier was issued for the Consumer"},"yearOfIssuance":{"type":"string","description":"The year when a specific document or identifier was issued for the Consumer"},"subjectSSN":{"type":"string","description":"The Consumer's person number"},"ssnMatch":{"type":"string","description":"Verifies that the person number is linked to the Consumer"},"referralCode":{"type":"string","description":"Referral Code"},"reportOnFileSince":{"type":["string","null"],"format":"date-time","description":"Date the report was first created at the credit bureau"},"dateOfBirth":{"type":["string","null"],"format":"date-time","description":"Date of Birth"},"deceasedDate":{"type":["string","null"],"format":"date-time","description":"Deceased Date"},"hitCode":{"type":"string","description":"Hit Code"},"hitCodeDescription":{"type":"string","description":"Hit Code Description"},"addressDiscrepancyIndicator":{"type":"string","description":"Identifies discrepancies in the addresses on file compared to addresses reported by lenders/creditors"},"fraudVictimAlert":{"type":"string","description":"Fraud Victim Alert Code"},"fraudVictimAlertDescription":{"type":"string","description":"Fraud Victim Alert Description"},"inquiriesWithin2Years":{"type":["integer","null"],"format":"int32","description":"Number of inquiries within the last 2 years"},"ofac":{"type":["integer","null"],"format":"int32","description":"Office of Foreign Assets Control indicator"},"ssnAffirm":{"type":"string","description":"SSN affirm Yes/No"},"identityScanAlert":{"type":"string","description":"Flags any potential discrepancies in the Consumer's identification"},"ecoaInquiryType":{"type":"string","description":"Equal Credit Opportunity Act inquiry type"},"frozenFile":{"type":["boolean","null"],"description":"Advises if the Consumer's credit file is frozen"},"lockAlert":{"type":["boolean","null"],"description":"Advises if the Consumer's credit file is locked"},"mlaStatus":{"type":"string","description":"Advises if the Consumer is covered under the military lending act"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusSearchCriteria":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusSearchCriteria","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusSearchCriteria","data":{"type":"object","properties":{"identifier":{"type":"string","description":"Identifier"},"nameIdentifier":{"type":"string","description":"Name identifier e.g. current etc."},"firstName":{"type":"string","description":"The First Name used in the search criteria"},"lastName":{"type":"string","description":"The Last Name used in the search criteria"},"dateOfBirth":{"type":["string","null"],"format":"date-time","description":"The Date of Birth used in the search criteria"},"socialSecurityNumber":{"type":"string","description":"The person number used in the search criteria"},"addressSource":{"type":"string","description":"Address Source"},"addressStatus":{"type":"string","description":"Address Status e.g. current, former etc."},"addressLine1":{"type":"string","description":"First line of the address used in the search criteria"},"city":{"type":"string","description":"The City used in the search criteria"},"state":{"type":"string","description":"The State used in the search criteria"},"zip":{"type":"string","description":"The Zip used in the search criteria"},"country":{"type":"string","description":"The Country the address is domiciled"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusActiveAccountDetailsSummary":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusActiveAccountDetailsSummary","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusActiveAccountDetailsSummary","data":{"type":"object","properties":{"accountType":{"type":"string","description":"Account types Revolving, Installment, Others and Totals"},"summary":{"type":"object","properties":{"accounts":{"type":"string","description":"Total number of accounts on file per account type"},"balance":{"type":"string","description":"Balance due on file per account type"},"creditAvailable":{"type":"string","description":"Total Credit Available per account type"},"pastDue":{"type":"string","description":"Total Number of days past due per account type"},"termsOfPayment":{"type":"string","description":"Total Terms of payment in month per account type"}}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTradeLine":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTradeLine","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusTradeLine","data":{"type":"object","properties":{"customerAccountNumber":{"type":"string","description":"The customer account number for the trade line"},"customerNumber":{"type":"string","description":"The customer number for the trade line"},"accountOwner":{"type":"string","description":"The account owner, name of the lender/creditor"},"customerName":{"type":"string","description":"The customer name"},"balance":{"type":"string","description":"Balance remaining on the trade line"},"pastDue":{"type":"string","description":"Number of payments past due on the trade line"},"thirtyDayCounter":{"type":"string","description":"Number of times the Consumer has been late on a payment by 30-59 days on the trade line"},"sixtyDayCounter":{"type":"string","description":"Number of times the Consumer has been late on a payment by 60-90 days on the trade line"},"ninetyDayCounter":{"type":"string","description":"Number of times the Consumer has been late on a payment by more than 90 days on the trade line"},"highCredit":{"type":"string","description":"The high credit for the trade line (often the credit limit)"},"accountType":{"type":"string","description":"The trade line's account type e.g. Revolving, Installment, Other etc."},"monthsReviewed":{"type":"string","description":"Number of months the trade line has been reviewed"},"statusCode":{"type":"string","description":"The status code of the trade line"},"status":{"type":"string","description":"The status of the trade line"},"dateOpened":{"type":["string","null"],"format":"date-time","description":"The date the trade line was first opened"},"dateReported":{"type":["string","null"],"format":"date-time","description":"The date the trade line was first reported"},"dateOfLastActivity":{"type":["string","null"],"format":"date-time","description":"The date the trade line was last updated"},"terms":{"type":"string","description":"Payment terms of the trade line"},"comments":{"type":"array","items":{"type":"string"},"description":"Additional comments relating to the trade line"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusFormerName":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusFormerName","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusFormerName","data":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the former reported name for the Consumer"},"middleName":{"type":"string","description":"Middle name of the former reported name for the Consumer"},"lastName":{"type":"string","description":"Last name of the former reported name for the Consumer"},"suffix":{"type":"string","description":"Suffix of the former reported name for the Consumer"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusEmployment":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusEmployment","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusEmployment","data":{"type":"object","properties":{"employmentStatus":{"type":"string","description":"The status of the reported employment e.g. Current, Former etc."},"employerName":{"type":"string","description":"The employer for the listed employment"},"occupation":{"type":"string","description":"The occupation or job title of the Consumer during the listed employment"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerStatement":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerStatement","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusConsumerStatement","data":{"type":"object","properties":{"dateReported":{"type":["string","null"],"format":"date-time","description":"The date the statement was reported"},"datePurged":{"type":["string","null"],"format":"date-time","description":"Date the statement was purged"},"statement":{"type":"string","description":"Free text containing the statement of the Consumer"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAlertContact":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAlertContact","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusAlertContact","data":{"type":"object","properties":{"alertType":{"type":"string","description":"The type of alert reported on the Consumer e.g. Extended Fraud, Initial Fraud etc."},"dateReported":{"type":["string","null"],"format":"date-time","description":"The date the alert was reported"},"dateEffective":{"type":["string","null"],"format":"date-time","description":"The date the alert was effective from"},"status":{"type":"string","description":"The status of the alert"},"address":{"type":"object","properties":{"street":{"type":"string","description":"Street of the listed address of the contact"},"city":{"type":"string","description":"City of the listed address of the contact"},"province":{"type":"string","description":"Province of the listed address of the contact"},"postalCode":{"type":"string","description":"Postal/Zip of the listed address of the contact"},"additionalInformation":{"type":"string","description":"Any additional data for the listed address of the contact"}}},"telephoneNumbers":{"type":"array","items":{"type":"object","properties":{"telephoneNumberType":{"type":"string","description":"The type of telephone number e.g. Cellular, Pager, Daytime etc."},"countryCode":{"type":"string","description":"The country code for the contact telephone number"},"telephoneNumber":{"type":"string","description":"The reported telephone number for the contact"},"extension":{"type":"string","description":"The extension of the contact"}}}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusInquiry":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusInquiry","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusInquiry","data":{"type":"object","properties":{"customerName":{"type":"string","description":"The name of the customer that initiated the inquiry"},"customerNumber":{"type":"string","description":"The designated ID of the customer that initiated the inquiry"},"dateOfInquiry":{"type":["string","null"],"format":"date-time","description":"The date the inquiry was carried out"},"foreignInquiry":{"type":["boolean","null"],"description":"Foreign inquiry indicator, true/false"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAdditionalInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAdditionalInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusAdditionalInformation","data":{"type":"object","properties":{"misc":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusMisc"},"searchCriteria":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusSearchCriteria"},"activeAccountDetailsSummary":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusActiveAccountDetailsSummary"}},"tradeLines":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusTradeLine"}},"formerNames":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusFormerName"}},"employments":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusEmployment"}},"consumerStatements":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerStatement"}},"alertContacts":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAlertContact"}},"inquiries":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusInquiry"}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerReport":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerReport","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusConsumerReport","data":{"type":"object","description":"Consumer Report response","properties":{"language":{"type":"string","description":"Report language code"},"consumerInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerInformation"},"creditScoreExtra":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusCreditScoreExtra"},"contactInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactInformation"},"negativeInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusNegativeInformation"},"additionalInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAdditionalInformation"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusTryReportResponse","data":{"type":"object","properties":{"correlationId":{"type":"string"},"report":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerReport"},"dateOfOrder":{"type":"string","format":"date-time"},"language":{"type":"string"},"userId":{"type":"string"}}}},"schema_541":{"kind":"json-schema","data":{"type":"string"},"id":"schema_541"},"schema_542":{"kind":"json-schema","data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCriteriaSet"}]}},"id":"schema_542"},"schema_543":{"kind":"json-schema","data":{"type":"object","example":{"customData":[{"key":"de_reason_code","optional":false,"allowedValues":["1","2","3","4","5","6","7","8"],"description":["DE report retrieval reason code:","1 - Credit Decision'","2 - Credit Assessment - Future business connection (with credit risk)","3 - Credit Assessment - Existing business connection (with credit risk)","4 - Realisation check receivables collection","5 - Purchase Contract - Intention of signature of purchase contract (with credit risk)","6 - Goods Credit Insurance (with credit risk)","7 - Contract - Intention of signature of leasing or rent contract (with credit risk)","8 - Insurance Contract - Intention of signature of a insurance contract (with credit risk)"]}],"country":"DE"}},"id":"schema_543"},"schema_544":{"kind":"json-schema","data":{"type":["string","null"],"default":"EN","maxLength":2,"minLength":2},"id":"schema_544"},"schema_545":{"kind":"json-schema","data":{"type":["string","null"],"format":"date-time"},"id":"schema_545"},"schema_546":{"kind":"json-schema","data":{"type":["string","null"]},"id":"schema_546"},"schema_547":{"kind":"json-schema","data":{"type":["string","null"],"default":null},"id":"schema_547"},"schema_548":{"kind":"json-schema","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique identifier for tracing the request."},"totalSize":{"type":"integer","format":"int32"},"consumers":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerReport"}}}},"id":"schema_548"},"schema_549":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCriteriaSet"}},"id":"schema_549"},"schema_550":{"kind":"json-schema","data":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":2,"minLength":2},"id":"schema_550"},"schema_551":{"kind":"json-schema","data":{"type":"string","enum":["basic","hardcheck"],"default":"basic"},"id":"schema_551"},"schema_552":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-zA-Z0-9]+$"},"id":"schema_552"},"schema_553":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_553"}},"exampleStore":{},"securitySchemeStore":{"bearerToken":{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}},"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}]},"options":{"feedback":{"type":"mood","settings":{"optionalEmail":{"hide":true},"label":"Do you like this page?","submitText":"Thanks for your feedback - Your comments will shape documentation changes.","reasons":{"label":"Check all boxes that apply.","items":["The content was useful.","The content was easy to find.","The content could do with improvement."]},"comment":{"satisfiedLabel":"What did you like best?","neutralLabel":"How can we improve?","dissatisfiedLabel":"What needs improvement?"}}},"hideInfoMetadata":true,"hideSidebar":true,"mockServer":{"url":"/_mock/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/connect-apis-catalog/product-catalog/Consumer&Misc/consumerAndMisc.json?download"},{"url":"/_bundle/connect-apis-catalog/product-catalog/Consumer&Misc/consumerAndMisc.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Consumer And Misc","description":"\nEndpoints to order Consumer Reports for multiple regions.\n\n**European Consumers (Sweden, Norway, Netherlands, Germany):**  \nIn order to order a European Consumer Report, sufficient information to uniquely identify the Consumer (search criteria) must be provided to filter potential results down to one record. When one record has been found, the returned object will be the Consumer Report.\n\n**US Consumers:**  \nUS Consumer credit reports require specific search criteria as defined by US credit bureau requirements.\n\n---\n\n**Important Note on Response Structure**\n\nThe response structure shown in this documentation represents the **full set of fields** that may be returned by the Consumer Report service.\n\nActual responses depend on the data available for the requested consumer. If certain information (e.g., incomes, property details, credit score) is not available, those fields will be omitted from the response.\n\n**Always implement your integration to handle missing or partial data gracefully.**\n\n---\n","status":"published","tags":["Featured"]}},"baseSlug":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc","routesMapping":{}}