{"items":[{"type":"link","label":"Local Solutions","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions","content":{"contentType":"overview","meta":{"name":"Local Solutions"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"localSolutions.json","url":"/_bundle/connect-apis-catalog/product-catalog/LocalSolutions/localSolutions.json?download"},{"kind":"download","label":"localSolutions.yaml","url":"/_bundle/connect-apis-catalog/product-catalog/LocalSolutions/localSolutions.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":"Local Solutions (1.0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions"}],"sectionId":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/introduction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Local Solutions API provides a suite of specialized endpoints designed to address region-specific business needs across multiple countries."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It enables users to access a variety of local data services, such as land registry information, bank account verification, consumer and anti-money laundering checks, and company searches tailored to local requirements."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API supports operations in several regions, including Great Britain, France, Germany, the Netherlands, and the United States, offering targeted solutions for each market."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With secure authentication and a modular structure, Local Solutions allows businesses to integrate local compliance, verification, and data enrichment processes into their workflows efficiently."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of supported regions is always expanding and will not be limited to those currently available."},"children":[]}]}]}]}],"sectionId":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/section/introduction"}]}]}},{"type":"link","label":"Introduction","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/section/introduction","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/section/introduction","content":null},{"type":"separator","label":"Access","content":null},{"type":"group","label":"Authentication","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/authentication","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/authentication","items":[{"label":"Authenticate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/authentication/authenticate","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint generates a Bearer JWT (Authentication Token), which is essential for accessing all other endpoints within the API. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To authenticate your requests, you "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MUST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" include this token in the Authorization header as proof of authenticity. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please note that each token remains valid for 1 hour from the time of issuance and multiple tokens may exist concurrently. It is imperative to obtain and include a valid token in the Authorization header for every subsequent request made to the API."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000052598-what-to-do-if-you-see-access-denied-please-check-that-your-username-and-password-are-correct-","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate Help - Access Denied."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"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":"separator","label":"France","content":null},{"type":"group","label":"FR Bank Match","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/fr-bank-match","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/fr-bank-match","items":[{"label":"Bank Match","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/fr-bank-match/frbankmatch","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/fr-bank-match/frbankmatch","metadata":{"seo":{"title":"Bank Match","description":"This endpoint can be used to check the reliability of a company/bank details combination,and ensure that the IBAN is not linked to a risk of fraud."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"frBankmatch","name":"Bank Match","isWebhook":false,"pointer":"/paths/~1localSolutions~1FR~1bankmatch/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bank Match","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":"This endpoint can be used to check the reliability of a company/bank details combination,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and ensure that the IBAN is not linked to a risk of fraud."},"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":"NOTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - There are a set of 'required' parameters for this endpoint, however please note the exceptions in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryCode"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"description."},"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":"registrationId","in":"query","schemaId":"schema_598","description":"registrationId of company","required":true},{"name":"countryCode","in":"query","schemaId":"schema_598","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country codes in iso-2 format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following counties do "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" support the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iban"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZA"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the following link for required parameters on these countries: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FR Bank Match Parameter Information"},"children":[]}]}]}]}],"required":true},{"name":"bban","in":"query","schemaId":"schema_598","description":"Bank Account Number for countries where IBAN format doesn't support"},{"name":"bankCountry","in":"query","schemaId":"schema_598","description":"Bank Country always expected in ISO-2-alpha code"},{"name":"iban","in":"query","schemaId":"schema_598","description":"Bank Account details in IBAN format","required":true},{"name":"bic","in":"query","schemaId":"schema_598","description":"Business/Bank Identifier Code to identify the bank/branch holding the account along with BBAN"},{"name":"routingCode","in":"query","schemaId":"schema_598","description":"Routing Code to identify the bank/branch holding the account along with BBAN"}],"pointer":"/paths/~1localSolutions~1FR~1bankmatch/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/FR/bankmatch","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"registrationId","in":"query","required":true,"schemaId":"schema_598"},{"name":"countryCode","in":"query","required":true,"schemaId":"schema_598"},{"name":"bban","in":"query","schemaId":"schema_598"},{"name":"bankCountry","in":"query","schemaId":"schema_598"},{"name":"iban","in":"query","required":true,"schemaId":"schema_598"},{"name":"bic","in":"query","schemaId":"schema_598"},{"name":"routingCode","in":"query","schemaId":"schema_598"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/FR/bankmatch","href":"fr-bank-match/frbankmatch","openApiOperationId":"frBankmatch","summary":"Bank Match"},"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":"components/schemas/LocalSolutionsFRBankMatch"}},"schemaId":"components/schemas/LocalSolutionsFRBankMatch"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1FR~1bankmatch/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocalSolutionsFRBankMatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocalSolutionsFRBankMatch"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fr-bank-match/frbankmatch"}],"panels":[]}]},"httpPath":"/localSolutions/FR/bankmatch"},{"label":"Bank Match Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/fr-bank-match/frbankmatchstatus","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/fr-bank-match/frbankmatchstatus","metadata":{"seo":{"title":"Bank Match Status","description":"This endpoint is used to check the status of a verification whose status is ‘pending’."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"frBankmatchStatus","name":"Bank Match Status","isWebhook":false,"pointer":"/paths/~1localSolutions~1FR~1bankmatch~1audition/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bank Match Status","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":"This endpoint is used to check the status of a verification whose status is ‘pending’."},"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":"audition_id","in":"query","schemaId":"schema_598","description":"identifier to check status","required":true}],"pointer":"/paths/~1localSolutions~1FR~1bankmatch~1audition/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/FR/bankmatch/audition","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"audition_id","in":"query","required":true,"schemaId":"schema_598"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/FR/bankmatch/audition","href":"fr-bank-match/frbankmatchstatus","openApiOperationId":"frBankmatchStatus","summary":"Bank Match Status"},"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":"components/schemas/LocalSolutionsFRBankMatch"}},"schemaId":"components/schemas/LocalSolutionsFRBankMatch"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1FR~1bankmatch~1audition/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocalSolutionsFRBankMatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocalSolutionsFRBankMatch"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fr-bank-match/frbankmatchstatus"}],"panels":[]}]},"httpPath":"/localSolutions/FR/bankmatch/audition"}],"content":{"contentType":"group","meta":{"name":"FR Bank Match"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FR Bank Match","showPageActions":true},{"nodeType":"markdoc","content":"This endpoint provides tools for matching bank information in France."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/localSolutions/FR/bankmatch","summary":"Bank Match","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fr-bank-match/frbankmatch","deprecated":false},{"title":"/localSolutions/FR/bankmatch/audition","summary":"Bank Match Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fr-bank-match/frbankmatchstatus","deprecated":false}]}]}]}]}},{"type":"separator","label":"Germany","content":null},{"type":"group","label":"DE NonLtd Companies","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/de-nonltd-companies","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/de-nonltd-companies","items":[{"label":"DE Company Search Criteria (Non Ltd)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/de-nonltd-companies/denonltdcompaniessearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/de-nonltd-companies/denonltdcompaniessearchcriteria","metadata":{"seo":{"title":"DE Company Search Criteria (Non Ltd)","description":"Provides Search Criteria DE non-ltd Companies."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"denonltdcompaniessearchcriteria","name":"DE Company Search Criteria (Non Ltd)","isWebhook":false,"pointer":"/paths/~1localSolutions~1DE~1nonLtdCompanies~1searchcriteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DE Company Search Criteria (Non Ltd)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provides Search Criteria DE non-ltd Companies."},{"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":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/DE/nonLtdCompanies/searchcriteria","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":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/localSolutions/DE/nonLtdCompanies/searchcriteria","href":"de-nonltd-companies/denonltdcompaniessearchcriteria","openApiOperationId":"denonltdcompaniessearchcriteria","summary":"DE Company Search Criteria (Non Ltd)"},"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":"components/schemas/DELocalSolutionsNonLtdCompaniesSearchCriteriaResponse"}},"schemaId":"components/schemas/DELocalSolutionsNonLtdCompaniesSearchCriteriaResponse"},{"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/~1localSolutions~1DE~1nonLtdCompanies~1searchcriteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DELocalSolutionsNonLtdCompaniesSearchCriteriaResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DELocalSolutionsNonLtdCompaniesSearchCriteriaResponse"}}},{"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":"/de-nonltd-companies/denonltdcompaniessearchcriteria"}],"panels":[]}]},"httpPath":"/localSolutions/DE/nonLtdCompanies/searchcriteria"},{"label":"DE Company Search (Non Ltd)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/de-nonltd-companies/denonltdcompaniessearch","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/de-nonltd-companies/denonltdcompaniessearch","metadata":{"seo":{"title":"DE Company Search (Non Ltd)","description":"Endpoint to search for DE non-ltd Companies according to the provided Search Criteria."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"denonltdcompaniessearch","name":"DE Company Search (Non Ltd)","isWebhook":false,"pointer":"/paths/~1localSolutions~1DE~1nonLtdCompanies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DE Company Search (Non Ltd)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to search for DE non-ltd Companies according to the provided Search Criteria."},{"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":"name","in":"query","schemaId":"schema_598","description":"The name of the company to search for.","required":true},{"name":"countryAreaCode","in":"query","schemaId":"schema_599","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The international dialing code for the telephone number (e.g., \"\"+49\"\" for Germany)."},"children":[]}]}]}]},{"name":"number","in":"query","schemaId":"schema_599","description":"The primary telephone number"},{"name":"areaCode","in":"query","schemaId":"schema_599","description":"The regional or city-specific area code ( e.g. \"\"030\"\" for Berlin )."},{"name":"zipPostCode","in":"query","schemaId":"schema_599","description":"A combination of ZIP and PO box information, if applicable."},{"name":"country","in":"query","schemaId":"schema_599","description":"The country of the address."},{"name":"zipCode","in":"query","schemaId":"schema_600","description":"The postal code associated with the address. This field is optional."},{"name":"postCode","in":"query","schemaId":"schema_599","description":"The post office box number, if applicable."},{"name":"street","in":"query","schemaId":"schema_601","description":"The street name and house number for the address. This field is optional."},{"name":"city","in":"query","schemaId":"schema_601","description":"The city where the company is located. This field is mandatory.","required":true}],"pointer":"/paths/~1localSolutions~1DE~1nonLtdCompanies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/DE/nonLtdCompanies","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":true,"schemaId":"schema_598"},{"name":"countryAreaCode","in":"query","schemaId":"schema_599"},{"name":"number","in":"query","schemaId":"schema_599"},{"name":"areaCode","in":"query","schemaId":"schema_599"},{"name":"zipPostCode","in":"query","schemaId":"schema_599"},{"name":"country","in":"query","schemaId":"schema_599"},{"name":"zipCode","in":"query","schemaId":"schema_600"},{"name":"postCode","in":"query","schemaId":"schema_599"},{"name":"street","in":"query","schemaId":"schema_601"},{"name":"city","in":"query","required":true,"schemaId":"schema_601"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/localSolutions/DE/nonLtdCompanies","href":"de-nonltd-companies/denonltdcompaniessearch","openApiOperationId":"denonltdcompaniessearch","summary":"DE Company Search (Non Ltd)"},"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":"components/schemas/DELocalSolutionsNonLtdCompaniesSearchResponse"}},"schemaId":"components/schemas/DELocalSolutionsNonLtdCompaniesSearchResponse"},{"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/~1localSolutions~1DE~1nonLtdCompanies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DELocalSolutionsNonLtdCompaniesSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DELocalSolutionsNonLtdCompaniesSearchResponse"}}},{"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":"/de-nonltd-companies/denonltdcompaniessearch"}],"panels":[]}]},"httpPath":"/localSolutions/DE/nonLtdCompanies"},{"label":"DE Company Report (Non Ltd)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/de-nonltd-companies/denonltdcompaniesreport","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/de-nonltd-companies/denonltdcompaniesreport","metadata":{"seo":{"title":"DE Company Report (Non Ltd)","description":"Endpoint to retrieve the DE non-ltd Company report according to the provided id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"denonltdcompaniesreport","name":"DE Company Report (Non Ltd)","isWebhook":false,"pointer":"/paths/~1localSolutions~1DE~1nonLtdCompanies~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DE Company Report (Non Ltd)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to retrieve the DE non-ltd Company report according to the provided id."},{"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":"id","in":"path","schemaId":"schema_602","description":"id of the report","required":true}],"pointer":"/paths/~1localSolutions~1DE~1nonLtdCompanies~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"reason","in":"query","schemaId":"schema_598","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A reason for the request. This is a mandatory field. The reason must be one of the following: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Credit enquiry "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Credit Decision "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Credit Assessment - Future business connection(with credit risk) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Credit Assessment - Existing business connection(with credit risk) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Realisation check receivables collection "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Purchase Contract - Intention of signature of purchase contract(with credit risk) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Contract - Intention of signature of leasing or rent contract(with credit risk) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Insurance Contract -Intention of signature of a insurance contract(with credit risk)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1localSolutions~1DE~1nonLtdCompanies~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/DE/nonLtdCompanies/{id}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_602"}],"query":[{"name":"reason","in":"query","required":true,"schemaId":"schema_598"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/localSolutions/DE/nonLtdCompanies/{id}","href":"de-nonltd-companies/denonltdcompaniesreport","openApiOperationId":"denonltdcompaniesreport","summary":"DE Company Report (Non Ltd)"},"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":"components/schemas/DELocalSolutionsNonLtdCompaniesReportResponse"}},"schemaId":"components/schemas/DELocalSolutionsNonLtdCompaniesReportResponse"},{"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/~1localSolutions~1DE~1nonLtdCompanies~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DELocalSolutionsNonLtdCompaniesReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DELocalSolutionsNonLtdCompaniesReportResponse"}}},{"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":"/de-nonltd-companies/denonltdcompaniesreport"}],"panels":[]}]},"httpPath":"/localSolutions/DE/nonLtdCompanies/{id}"}],"content":{"contentType":"group","meta":{"name":"DE NonLtd Companies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DE NonLtd Companies","showPageActions":true},{"nodeType":"markdoc","content":"This endpoint provides the tools for searching non-limited companies in Germany and acquiring company reports."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/localSolutions/DE/nonLtdCompanies/searchcriteria","summary":"DE Company Search Criteria (Non Ltd)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/de-nonltd-companies/denonltdcompaniessearchcriteria","deprecated":false},{"title":"/localSolutions/DE/nonLtdCompanies","summary":"DE Company Search (Non Ltd)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/de-nonltd-companies/denonltdcompaniessearch","deprecated":false},{"title":"/localSolutions/DE/nonLtdCompanies/{id}","summary":"DE Company Report (Non Ltd)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/de-nonltd-companies/denonltdcompaniesreport","deprecated":false}]}]}]}]}},{"type":"separator","label":"Netherlands","content":null},{"type":"group","label":"NL KVK Extract","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/nl-kvk-extract","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/nl-kvk-extract","items":[{"label":"Return NL Extract","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/nl-kvk-extract/extractnlkvknumber","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/nl-kvk-extract/extractnlkvknumber","metadata":{"seo":{"title":"Return NL Extract","description":"NL extract from KVK Number"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"extractNLKvkNumber","name":"Return NL Extract","isWebhook":false,"pointer":"/paths/~1localSolutions~1NL~1extract~1{kvkNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return NL Extract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"NL extract from KVK Number"},{"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":"kvkNumber","in":"path","schemaId":"schema_598","description":"kvkNumber to fetch details","required":true}],"pointer":"/paths/~1localSolutions~1NL~1extract~1{kvkNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/NL/extract/{kvkNumber}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"kvkNumber","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/NL/extract/{kvkNumber}","href":"nl-kvk-extract/extractnlkvknumber","openApiOperationId":"extractNLKvkNumber","summary":"Return NL Extract"},"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":"success and returns html text","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_598"}},"schemaId":"schema_598"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1NL~1extract~1{kvkNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_598","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_598"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/nl-kvk-extract/extractnlkvknumber"}],"panels":[]}]},"httpPath":"/localSolutions/NL/extract/{kvkNumber}"}],"content":{"contentType":"group","meta":{"name":"NL KVK Extract"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"NL KVK Extract","showPageActions":true},{"nodeType":"markdoc","content":"This endpoint provides tools for extracting information from the Dutch Chamber of Commerce (KVK)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/localSolutions/NL/extract/{kvkNumber}","summary":"Return NL Extract","prefix":{"name":"get","color":"get"},"badges":[],"link":"/nl-kvk-extract/extractnlkvknumber","deprecated":false}]}]}]}]}},{"type":"separator","label":"United Kingdom","content":null},{"type":"group","label":"GB Bank Match","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-match","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-match","items":[{"label":"Bank Match","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-match/bankmatch","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-match/bankmatch","metadata":{"seo":{"title":"Bank Match","description":"The Bank Verification tool allows customers to instantly verify that small and medium sized companies you are working with are providing correct bank details, to reduce fraud and avoid delays in your on boarding process. The bank data for these companies is provided to Creditsafe by various financial providers, including major banks. When you provide us with a company number and their bank details, we are able to perform instant checks to verify that those bank details are associated with that company and return -  Match – We have bank information on the company, and the data provided by the customer matches the company records  No Match – We have bank information on the company, but the data provided does not match any of the company records  Data Unavailable - We do not have bank information on the company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bankMatch","name":"Bank Match","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1bankmatch/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bank Match","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":"The Bank Verification tool allows customers to instantly verify that small and medium sized companies you are working with are providing correct bank details, to reduce fraud and avoid delays in your on boarding process. The bank data for these companies is provided to Creditsafe by various financial providers, including major banks. When you provide us with a company number and their bank details, we are able to perform instant checks to verify that those bank details are associated with that company and return - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Match – We have bank information on the company, and the data provided by the customer matches the company records "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" No Match – We have bank information on the company, but the data provided does not match any of the company records "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Data Unavailable - We do not have bank information on the company."},"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":"checkType","in":"query","schemaId":"schema_603","description":"Validation uses an algorithm to determine if a SCAN or IBAN exists, but does not let you know if that SCAN or IBAN actually belongs to the company who has provided it. Verification takes this a step further and checks the Creditsafe database for a match on the SCAN/IBAN, and tells you if the bank details actually belong to the company, so you can be assured that you are sending your money to the correct entity.","required":true},{"name":"companyId","in":"query","schemaId":"schema_598","description":"The connectId or safeNumber of the company to check against.","required":true,"example":"GB-0-X9999999"},{"name":"sortCode","in":"query","schemaId":"schema_598","description":"Sort Code to check - Must be passed in with Account Number to form a SCAN Result","example":"089997"},{"name":"accountNumber","in":"query","schemaId":"schema_598","description":"Account Number to check - Must be passed in with Sort Code to form a SCAN Result","example":66374958},{"name":"iban","in":"query","schemaId":"schema_598","description":"IBAN to check","example":"GB55TEST08999966374957"},{"name":"vatNumber","in":"query","schemaId":"schema_598","description":"VAT Number to check"}],"pointer":"/paths/~1localSolutions~1GB~1bankmatch/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/bankmatch","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"checkType","in":"query","required":true,"schemaId":"schema_603"},{"name":"companyId","in":"query","required":true,"example":"GB-0-X9999999","schemaId":"schema_598"},{"name":"sortCode","in":"query","example":"089997","schemaId":"schema_598"},{"name":"accountNumber","in":"query","example":66374958,"schemaId":"schema_598"},{"name":"iban","in":"query","example":"GB55TEST08999966374957","schemaId":"schema_598"},{"name":"vatNumber","in":"query","schemaId":"schema_598"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/GB/bankmatch","href":"gb-bank-match/bankmatch","openApiOperationId":"bankMatch","summary":"Bank Match"},"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":"Indicates the check has been made successfully and contains the result of the Verification/Validation. A 200 response alone does not immediately indicate the bank account is valid, only that the check was made in the correct format. Check the SCAN text and IBAN text fields for the result of the Check.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectBankMatchResult"}},"schemaId":"components/schemas/ConnectBankMatchResult"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1GB~1bankmatch/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectBankMatchResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectBankMatchResult"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-bank-match/bankmatch"}],"panels":[]}]},"httpPath":"/localSolutions/GB/bankmatch"}],"content":{"contentType":"group","meta":{"name":"GB Bank Match"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GB Bank Match","showPageActions":true},{"nodeType":"markdoc","content":"This endpoint provides tools for matching business bank account information in Great Britain."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/localSolutions/GB/bankmatch","summary":"Bank Match","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gb-bank-match/bankmatch","deprecated":false}]}]}]}]}},{"type":"group","label":"GB Consumers and AML","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml","items":[{"label":"Submit A GB Consumer or AML Search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/submitsagbconsumeroramlsearch","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/submitsagbconsumeroramlsearch","metadata":{"seo":{"title":"Submit A GB Consumer or AML Search","description":"Submits a GB Consumer or AML depending on the Product provided. Validates criteria for each individual search before submitting, and may return a list of error strings instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submitsAGBConsumerOrAmlSearch","name":"Submit A GB Consumer or AML Search","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1identitysearch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit A GB Consumer or AML Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submits a GB Consumer or AML depending on the Product provided. Validates criteria for each individual search before submitting, and may return a list of error strings instead."},{"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":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_604"}},"schemaId":"schema_604","pointer":"/paths/~1localSolutions~1GB~1identitysearch/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Select the relevant tab for the request body for one of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"products "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AML"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AMLMultiBureau"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Consumer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" NOTE:' If a previous address is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used in addition to current the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes required."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/localSolutions/GB/identitysearch","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":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_604"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/localSolutions/GB/identitysearch","href":"gb-consumers-and-aml/submitsagbconsumeroramlsearch","openApiOperationId":"submitsAGBConsumerOrAmlSearch","summary":"Submit A GB Consumer or AML Search"},"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":"schema_604","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_604"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_605"}},"schemaId":"schema_605"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}},"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_605","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_605"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}},{"code":"500","schemaId":"components/schemas/ConnectIdentityBasicErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-consumers-and-aml/submitsagbconsumeroramlsearch"}],"panels":[]}]},"httpPath":"/localSolutions/GB/identitysearch"},{"label":"Resolve A Picklist Against A Given UniqueId","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/resolvesapicklistagainstagivenuniqueid","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/resolvesapicklistagainstagivenuniqueid","metadata":{"seo":{"title":"Resolve A Picklist Against A Given UniqueId","description":"Resolves a picklist belonging to the specified UniqueID, which would have been generated during a prior search. Guids (and thus cached searches) expire after fifteen minutes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resolvesAPicklistAgainstAGivenUniqueId","name":"Resolve A Picklist Against A Given UniqueId","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1identitysearch/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resolve A Picklist Against A Given UniqueId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resolves a picklist belonging to the specified UniqueID, which would have been generated during a prior search. Guids (and thus cached searches) expire after fifteen minutes."},{"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":"uniqueId","in":"query","schemaId":"schema_598","description":"UniqueId of the search to resolve. This is acquired from the response of a previous search that returned a picklist.","required":true}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_606"}},"schemaId":"schema_606","pointer":"/paths/~1localSolutions~1GB~1identitysearch/put/requestBody","description":"The picklist to resolve. This is acquired from the response of a previous\nsearch that returned a picklist.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/localSolutions/GB/identitysearch","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"uniqueId","in":"query","required":true,"schemaId":"schema_598"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_606"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/localSolutions/GB/identitysearch","href":"gb-consumers-and-aml/resolvesapicklistagainstagivenuniqueid","openApiOperationId":"resolvesAPicklistAgainstAGivenUniqueId","summary":"Resolve A Picklist Against A Given UniqueId"},"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":"schema_606","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_606"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentitySearchResult"}},"schemaId":"components/schemas/ConnectIdentitySearchResult"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}},"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectIdentitySearchResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentitySearchResult"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}},{"code":"500","schemaId":"components/schemas/ConnectIdentityBasicErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-consumers-and-aml/resolvesapicklistagainstagivenuniqueid"}],"panels":[]}]},"httpPath":"/localSolutions/GB/identitysearch"},{"label":"Return List Of Identity Search History Items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/getidentitysearchhistory","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/getidentitysearchhistory","metadata":{"seo":{"title":"Return List Of Identity Search History Items","description":"Retrieves a paginated history list for the specified customer/user, filtered based on the include* parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIdentitySearchHistory","name":"Return List Of Identity Search History Items","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return List Of Identity Search History Items","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":"Retrieves a paginated history list for the specified customer/user, filtered based on the include* parameters."},"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":"page","in":"query","schemaId":"schema_607","description":"The 1-indexed page number to fetch"},{"name":"pageSize","in":"query","schemaId":"schema_607","description":"The page size number to fetch"},{"name":"IncludeCustomer","in":"query","schemaId":"schema_608","description":"If true, returns all results for this customer. Valid for senior users only."},{"name":"Products","in":"query","schemaId":"schema_609","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The array of products to include"},"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":"Below is a list of Definitions for the ENUM"},"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":"text","inline":true,"attributes":{"content":"0 - Consumer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 - Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 - AML"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 - Bank Match"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 - AML with Bank Match"},"children":[]}]}]}]}]},{"name":"DateFrom","in":"query","schemaId":"schema_610","description":"The earliest date to include"},{"name":"DateTo","in":"query","schemaId":"schema_610","description":"The latest date to include"},{"name":"Keyword","in":"query","schemaId":"schema_599","description":"Include this string"},{"name":"Result","in":"query","schemaId":"schema_599","description":"Return only items with this result"}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/identitysearch/history","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_607"},{"name":"pageSize","in":"query","schemaId":"schema_607"},{"name":"IncludeCustomer","in":"query","schemaId":"schema_608"},{"name":"Products","in":"query","schemaId":"schema_609"},{"name":"DateFrom","in":"query","schemaId":"schema_610"},{"name":"DateTo","in":"query","schemaId":"schema_610"},{"name":"Keyword","in":"query","schemaId":"schema_599"},{"name":"Result","in":"query","schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/localSolutions/GB/identitysearch/history","href":"gb-consumers-and-aml/getidentitysearchhistory","openApiOperationId":"getIdentitySearchHistory","summary":"Return List Of Identity Search History Items"},"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":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityHistoryListResponse"}},"schemaId":"components/schemas/ConnectIdentityHistoryListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}},"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectIdentityHistoryListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityHistoryListResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectIdentityBasicErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-consumers-and-aml/getidentitysearchhistory"}],"panels":[]}]},"httpPath":"/localSolutions/GB/identitysearch/history"},{"label":"Return Previous Identity Search Result","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/retrievesaprioridentitysearchresult","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/retrievesaprioridentitysearchresult","metadata":{"seo":{"title":"Return Previous Identity Search Result","description":"Retrieves a prior search result. This will include the search input and any ID/AML searches, but as we cannot hold Consumer search results these are not included. Resubmission is necessary if an updated Consumer result is needed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrievesAPriorIdentitySearchResult","name":"Return Previous Identity Search Result","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history~1{uniqueId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Previous Identity Search Result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a prior search result. This will include the search input and any ID/AML searches, but as we cannot hold Consumer search results these are not included. Resubmission is necessary if an updated Consumer result is needed."},{"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":"uniqueId","in":"path","schemaId":"schema_598","required":true}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history~1{uniqueId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/identitysearch/history/{uniqueId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"uniqueId","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/localSolutions/GB/identitysearch/history/{uniqueId}","href":"gb-consumers-and-aml/retrievesaprioridentitysearchresult","openApiOperationId":"retrievesAPriorIdentitySearchResult","summary":"Return Previous Identity Search Result"},"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":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentitySearchResult"}},"schemaId":"components/schemas/ConnectIdentitySearchResult"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}},"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history~1{uniqueId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectIdentitySearchResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentitySearchResult"}}},{"code":"400","schemaId":"components/schemas/ConnectIdentityBasicErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-consumers-and-aml/retrievesaprioridentitysearchresult"}],"panels":[]}]},"httpPath":"/localSolutions/GB/identitysearch/history/{uniqueId}"},{"label":"Return Previous Identity Search Input","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/retrievesaprioridentitysearchesinput","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/retrievesaprioridentitysearchesinput","metadata":{"seo":{"title":"Return Previous Identity Search Input","description":"This will return the input criteria used in a search for a specified id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrievesAPriorIdentitySearchesInput","name":"Return Previous Identity Search Input","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history~1{uniqueId}~1input/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Previous Identity Search Input","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This will return the input criteria used in a search for a specified id."},{"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":"uniqueId","in":"path","schemaId":"schema_598","required":true}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history~1{uniqueId}~1input/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/identitysearch/history/{uniqueId}/input","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"uniqueId","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/GB/identitysearch/history/{uniqueId}/input","href":"gb-consumers-and-aml/retrievesaprioridentitysearchesinput","openApiOperationId":"retrievesAPriorIdentitySearchesInput","summary":"Return Previous Identity Search Input"},"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":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentitySearchResult"}},"schemaId":"components/schemas/ConnectIdentitySearchResult"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history~1{uniqueId}~1input/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectIdentitySearchResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentitySearchResult"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-consumers-and-aml/retrievesaprioridentitysearchesinput"}],"panels":[]}]},"httpPath":"/localSolutions/GB/identitysearch/history/{uniqueId}/input"},{"label":"Set Reference For An Existing History Item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/setsthereferenceforanexistinghistoryitem","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/setsthereferenceforanexistinghistoryitem","metadata":{"seo":{"title":"Set Reference For An Existing History Item","description":"Allows you to set a reference for an existing history item. This is useful for storing a reference to the record in your own system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setsTheReferenceForAnExistingHistoryItem","name":"Set Reference For An Existing History Item","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history~1{uniqueId}~1reference/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set Reference For An Existing History Item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows you to set a reference for an existing history item. This is useful for storing a reference to the record in your own system."},{"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":"uniqueId","in":"path","schemaId":"schema_598","description":"The ID of the record to update","required":true}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history~1{uniqueId}~1reference/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_598"}},"schemaId":"schema_598","pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history~1{uniqueId}~1reference/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/localSolutions/GB/identitysearch/history/{uniqueId}/reference","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"uniqueId","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_598"}},"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/GB/identitysearch/history/{uniqueId}/reference","href":"gb-consumers-and-aml/setsthereferenceforanexistinghistoryitem","openApiOperationId":"setsTheReferenceForAnExistingHistoryItem","summary":"Set Reference For An Existing History Item"},"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":"schema_598","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_598"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_598"}},"schemaId":"schema_598"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1history~1{uniqueId}~1reference/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_598","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_598"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-consumers-and-aml/setsthereferenceforanexistinghistoryitem"}],"panels":[]}]},"httpPath":"/localSolutions/GB/identitysearch/history/{uniqueId}/reference"},{"label":"Revalidate A Given Identity Search With Additional Documents","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/revalidateagivenidentitysearchwithadditionaldocuments","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/revalidateagivenidentitysearchwithadditionaldocuments","metadata":{"seo":{"title":"Revalidate A Given Identity Search With Additional Documents","description":"Revalidate's a given identity search with additional documents."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"revalidateAGivenIdentitySearchWithAdditionalDocuments","name":"Revalidate A Given Identity Search With Additional Documents","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1revalidation~1{uniqueId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revalidate A Given Identity Search With Additional Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revalidate's a given identity search with additional documents."},{"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":"uniqueId","in":"path","schemaId":"schema_598","description":"The ID of the record to update","required":true}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1revalidation~1{uniqueId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectIdentityRevalidateRequest"}},"schemaId":"components/schemas/ConnectIdentityRevalidateRequest","pointer":"/paths/~1localSolutions~1GB~1identitysearch~1revalidation~1{uniqueId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/localSolutions/GB/identitysearch/revalidation/{uniqueId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"uniqueId","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectIdentityRevalidateRequest"}},"responseCodes":["200","400","500"],"pointer":"/localSolutions/GB/identitysearch/revalidation/{uniqueId}","href":"gb-consumers-and-aml/revalidateagivenidentitysearchwithadditionaldocuments","openApiOperationId":"revalidateAGivenIdentitySearchWithAdditionalDocuments","summary":"Revalidate A Given Identity Search With Additional Documents"},"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/ConnectIdentityRevalidateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectIdentityRevalidateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentitySearchResult"}},"schemaId":"components/schemas/ConnectIdentitySearchResult"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}},"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1revalidation~1{uniqueId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectIdentitySearchResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentitySearchResult"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"500","schemaId":"components/schemas/ConnectIdentityBasicErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-consumers-and-aml/revalidateagivenidentitysearchwithadditionaldocuments"}],"panels":[]}]},"httpPath":"/localSolutions/GB/identitysearch/revalidation/{uniqueId}"},{"label":"Return Identity Search Reasons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/getidentitysearchreasons","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-consumers-and-aml/getidentitysearchreasons","metadata":{"seo":{"title":"Return Identity Search Reasons","description":"Returns an object describing which Reasons for Search are available and which are selected by a given customer. All reasons are always listed, with selected reasons specified as true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIdentitySearchReasons","name":"Return Identity Search Reasons","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1searchreasons/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Identity Search Reasons","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an object describing which Reasons for Search are available and which are selected by a given customer. All reasons are always listed, with selected reasons specified as true."},{"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":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/identitysearch/searchreasons","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":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/localSolutions/GB/identitysearch/searchreasons","href":"gb-consumers-and-aml/getidentitysearchreasons","openApiOperationId":"getIdentitySearchReasons","summary":"Return Identity Search Reasons"},"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":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityReasonResponse"}},"schemaId":"components/schemas/ConnectIdentityReasonResponse"},{"code":"400","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}},"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}],"pointer":"/paths/~1localSolutions~1GB~1identitysearch~1searchreasons/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectIdentityReasonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityReasonResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectIdentityBasicErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectIdentityBasicErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-consumers-and-aml/getidentitysearchreasons"}],"panels":[]}]},"httpPath":"/localSolutions/GB/identitysearch/searchreasons"}],"content":{"contentType":"group","meta":{"name":"GB Consumers and AML"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GB Consumers and AML","showPageActions":true},{"nodeType":"markdoc","content":"This endpoint provides tools for consumer and anti-money laundering checks in Great Britain."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/localSolutions/GB/identitysearch","summary":"Submit A GB Consumer or AML Search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gb-consumers-and-aml/submitsagbconsumeroramlsearch","deprecated":false},{"title":"/localSolutions/GB/identitysearch","summary":"Resolve A Picklist Against A Given UniqueId","prefix":{"name":"put","color":"put"},"badges":[],"link":"/gb-consumers-and-aml/resolvesapicklistagainstagivenuniqueid","deprecated":false},{"title":"/localSolutions/GB/identitysearch/history","summary":"Return List Of Identity Search History Items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gb-consumers-and-aml/getidentitysearchhistory","deprecated":false},{"title":"/localSolutions/GB/identitysearch/history/{uniqueId}","summary":"Return Previous Identity Search Result","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gb-consumers-and-aml/retrievesaprioridentitysearchresult","deprecated":false},{"title":"/localSolutions/GB/identitysearch/history/{uniqueId}/input","summary":"Return Previous Identity Search Input","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gb-consumers-and-aml/retrievesaprioridentitysearchesinput","deprecated":false},{"title":"/localSolutions/GB/identitysearch/history/{uniqueId}/reference","summary":"Set Reference For An Existing History Item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/gb-consumers-and-aml/setsthereferenceforanexistinghistoryitem","deprecated":false},{"title":"/localSolutions/GB/identitysearch/revalidation/{uniqueId}","summary":"Revalidate A Given Identity Search With Additional Documents","prefix":{"name":"put","color":"put"},"badges":[],"link":"/gb-consumers-and-aml/revalidateagivenidentitysearchwithadditionaldocuments","deprecated":false},{"title":"/localSolutions/GB/identitysearch/searchreasons","summary":"Return Identity Search Reasons","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gb-consumers-and-aml/getidentitysearchreasons","deprecated":false}]}]}]}]}},{"type":"group","label":"GB Bank Verification","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification","items":[{"label":"Single Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationsearch","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationsearch","metadata":{"seo":{"title":"Single Request","description":"This endpoint will perform a search with the supplied data against a bank or building society. NOTE:- This endpoint will charge when a successful request is made to a bank or building society. This endpoint will charge when a result is returned. This includes charging if the no match is found. All property fields need to be submitted with the request, if information for a specific property is not needed, it is required to pass an empty string."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bankVerificationSearch","name":"Single Request","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Single Request","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":"This endpoint will perform a search with the supplied data against a bank or building society."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" NOTE:- This endpoint will charge when a successful request is made to a bank or building society. This endpoint will charge when a result is returned. This includes charging if the no match is found."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" All property fields need to be submitted with the request, if information for a specific property is not needed, it is required to pass an empty string."},"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":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GBLocalSolutionBankVerificationSearchRequest"}},"schemaId":"components/schemas/GBLocalSolutionBankVerificationSearchRequest","pointer":"/paths/~1localSolutions~1GB~1bankVerification~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/localSolutions/GB/bankVerification/search","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":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GBLocalSolutionBankVerificationSearchRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/GB/bankVerification/search","href":"gb-bank-verification/bankverificationsearch","openApiOperationId":"bankVerificationSearch","summary":"Single Request"},"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/GBLocalSolutionBankVerificationSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GBLocalSolutionBankVerificationSearchRequest"}},"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/GBLocalSolutionBankVerificationSearchResponse"}},"schemaId":"components/schemas/GBLocalSolutionBankVerificationSearchResponse"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GBLocalSolutionBankVerificationSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GBLocalSolutionBankVerificationSearchResponse"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-bank-verification/bankverificationsearch"}],"panels":[]}]},"httpPath":"/localSolutions/GB/bankVerification/search"},{"label":"Validate Bank Verification Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationvalidate","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationvalidate","metadata":{"seo":{"title":"Validate Bank Verification Request","description":"This endpoint will return whether the sort code and bank account number match the sort code and bank account number that was provided for the given single request. Note:- A valid request requires all fields to exist in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bankVerificationValidate","name":"Validate Bank Verification Request","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1validate~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate Bank Verification Request","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":"This endpoint will return whether the sort code and bank account number match the sort code and bank account number that was provided for the given single request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note:- A valid request requires all fields to exist in the request."},"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":"id","in":"path","schemaId":"schema_598","description":"request id to fetch details","required":true}],"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1validate~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","pointer":"/paths/~1localSolutions~1GB~1bankVerification~1validate~1{id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/localSolutions/GB/bankVerification/validate/{id}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_611"}},"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/GB/bankVerification/validate/{id}","href":"gb-bank-verification/bankverificationvalidate","openApiOperationId":"bankVerificationValidate","summary":"Validate Bank Verification Request"},"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":"schema_611","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_611"}},"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_612"}},"schemaId":"schema_612"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1validate~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-bank-verification/bankverificationvalidate"}],"panels":[]}]},"httpPath":"/localSolutions/GB/bankVerification/validate/{id}"},{"label":"Return Bank Branch Details Of A Given Sort Code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/sortcodecheck","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/sortcodecheck","metadata":{"seo":{"title":"Return Bank Branch Details Of A Given Sort Code","description":"This endpoint will return bank branch details of a given sort code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sortCodeCheck","name":"Return Bank Branch Details Of A Given Sort Code","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1sortCode~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Bank Branch Details Of A Given Sort Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint will return bank branch details of a given sort code."},{"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":"id","in":"path","schemaId":"schema_598","description":"The sort code id of the bank branch.","required":true}],"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1sortCode~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/bankVerification/sortCode/{id}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/GB/bankVerification/sortCode/{id}","href":"gb-bank-verification/sortcodecheck","openApiOperationId":"sortCodeCheck","summary":"Return Bank Branch Details Of A Given Sort Code"},"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_613"}},"schemaId":"schema_613"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1sortCode~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_613","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_613"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-bank-verification/sortcodecheck"}],"panels":[]}]},"httpPath":"/localSolutions/GB/bankVerification/sortCode/{id}"},{"label":"Request Search History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationgethistorylist","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationgethistorylist","metadata":{"seo":{"title":"Request Search History","description":"Bank Verification History list Request Note:- All property fields need to be submitted with the request, if information for a specific property is not needed, it is required to pass an empty string."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bankVerificationGetHistoryList","name":"Request Search History","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request Search History","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":"Bank Verification History list Request"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note:- All property fields need to be submitted with the request, if information for a specific property is not needed, it is required to pass an empty string."},"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":"searchByCustomer","in":"query","schemaId":"schema_608","description":"A value of false will only search records for your account. If your account manager has configured your account to be able to view other users records within your company, a value of true will search all records made by all accounts within your company.","required":true},{"name":"customerName","in":"query","schemaId":"schema_598","description":"Name of the customer returned by the supplier."},{"name":"matchResult","in":"query","schemaId":"schema_598","description":"Whether a match or not a match returned by the supplier. Values are 'Full', 'Close' and 'No Match'."},{"name":"dateFrom","in":"query","schemaId":"schema_598","description":"Start date for filtering the results list by."},{"name":"dateTo","in":"query","schemaId":"schema_598","description":"End date for filtering the results list by."},{"name":"accountType","in":"query","schemaId":"schema_598","description":"Type of account queried with the the supplier. Values are 'Business' and 'Personal'."},{"name":"customerReference","in":"query","schemaId":"schema_598","description":"Your Customer reference."}],"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/bankVerification/history","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"searchByCustomer","in":"query","required":true,"schemaId":"schema_608"},{"name":"customerName","in":"query","schemaId":"schema_598"},{"name":"matchResult","in":"query","schemaId":"schema_598"},{"name":"dateFrom","in":"query","schemaId":"schema_598"},{"name":"dateTo","in":"query","schemaId":"schema_598"},{"name":"accountType","in":"query","schemaId":"schema_598"},{"name":"customerReference","in":"query","schemaId":"schema_598"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/GB/bankVerification/history","href":"gb-bank-verification/bankverificationgethistorylist","openApiOperationId":"bankVerificationGetHistoryList","summary":"Request Search History"},"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_614"}},"schemaId":"schema_614"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_614","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_614"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-bank-verification/bankverificationgethistorylist"}],"panels":[]}]},"httpPath":"/localSolutions/GB/bankVerification/history"},{"label":"Return Request History By ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationgethistorybyid","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationgethistorybyid","metadata":{"seo":{"title":"Return Request History By ID","description":"This endpoint will return details of a past request by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bankVerificationGetHistoryById","name":"Return Request History By ID","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1history~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Request History By ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint will return details of a past request by id."},{"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":"id","in":"path","schemaId":"schema_598","description":"request id to fetch details","required":true}],"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1history~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/bankVerification/history/{id}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/GB/bankVerification/history/{id}","href":"gb-bank-verification/bankverificationgethistorybyid","openApiOperationId":"bankVerificationGetHistoryById","summary":"Return Request History By ID"},"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":"components/schemas/GBLocalSolutionGetHistoryRequestResponse"}},"schemaId":"components/schemas/GBLocalSolutionGetHistoryRequestResponse"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1history~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GBLocalSolutionGetHistoryRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GBLocalSolutionGetHistoryRequestResponse"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-bank-verification/bankverificationgethistorybyid"}],"panels":[]}]},"httpPath":"/localSolutions/GB/bankVerification/history/{id}"},{"label":"Update CustomerReference by HistoryId","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationupdatehistory","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-bank-verification/bankverificationupdatehistory","metadata":{"seo":{"title":"Update CustomerReference by HistoryId","description":"This endpoint will update the stored customerReference field of a past request with the provided ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bankVerificationUpdateHistory","name":"Update CustomerReference by HistoryId","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1history~1{id}~1reference/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update CustomerReference by HistoryId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint will update the stored customerReference field of a past request with the provided ID."},{"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":"id","in":"path","schemaId":"schema_598","description":"The id of the history record","required":true}],"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1history~1{id}~1reference/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GBLocalSolutionCPHistoryRequestByIdRequest"}},"schemaId":"components/schemas/GBLocalSolutionCPHistoryRequestByIdRequest","pointer":"/paths/~1localSolutions~1GB~1bankVerification~1history~1{id}~1reference/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/localSolutions/GB/bankVerification/history/{id}/reference","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GBLocalSolutionCPHistoryRequestByIdRequest"}},"responseCodes":["204","400","401","403","404"],"pointer":"/localSolutions/GB/bankVerification/history/{id}/reference","href":"gb-bank-verification/bankverificationupdatehistory","openApiOperationId":"bankVerificationUpdateHistory","summary":"Update CustomerReference by HistoryId"},"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/GBLocalSolutionCPHistoryRequestByIdRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GBLocalSolutionCPHistoryRequestByIdRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1GB~1bankVerification~1history~1{id}~1reference/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-bank-verification/bankverificationupdatehistory"}],"panels":[]}]},"httpPath":"/localSolutions/GB/bankVerification/history/{id}/reference"}],"content":{"contentType":"group","meta":{"name":"GB Bank Verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GB Bank Verification","showPageActions":true},{"nodeType":"markdoc","content":"This endpoint provides tools for verifying bank account information for individuals in Great Britain."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/localSolutions/GB/bankVerification/search","summary":"Single Request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gb-bank-verification/bankverificationsearch","deprecated":false},{"title":"/localSolutions/GB/bankVerification/validate/{id}","summary":"Validate Bank Verification Request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gb-bank-verification/bankverificationvalidate","deprecated":false},{"title":"/localSolutions/GB/bankVerification/sortCode/{id}","summary":"Return Bank Branch Details Of A Given Sort Code","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gb-bank-verification/sortcodecheck","deprecated":false},{"title":"/localSolutions/GB/bankVerification/history","summary":"Request Search History","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gb-bank-verification/bankverificationgethistorylist","deprecated":false},{"title":"/localSolutions/GB/bankVerification/history/{id}","summary":"Return Request History By ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gb-bank-verification/bankverificationgethistorybyid","deprecated":false},{"title":"/localSolutions/GB/bankVerification/history/{id}/reference","summary":"Update CustomerReference by HistoryId","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/gb-bank-verification/bankverificationupdatehistory","deprecated":false}]}]}]}]}},{"type":"group","label":"GB Finance Agreements","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-finance-agreements","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-finance-agreements","items":[{"label":"Request Finance Agreements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-finance-agreements/financeagreements","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-finance-agreements/financeagreements","metadata":{"seo":{"title":"Request Finance Agreements","description":"This tool provides a detailed view of data supplied via the CCDS scheme(Commercial Credit Data Sharing ). It's tailored for users needing immediate access to current and accurate financial agreement information, enhancing decision-making with up-to-date data insights. 1. Full CCDS Access - Gain in-depth insights with access to up to 48 months of historical data on current accounts, loans, and credit card facilities. This tool is perfect for comprehensive long-term financial analysis, offering a thorough understanding of credit history and trends. 2. Financial Footprint - Get a summarized view of non performance related credit activity data. This tool simplifies the complex data into an easily understandable summary, ideal for quick assessments and initial screenings. 3. Finance Performance Indicator - A predictive tool that evaluates the likelihood of a company defaulting on payments within the next 90 days. This tool is crucial for risk assessment and mitigation, offering foresight and preparation for potential financial challenges."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"financeAgreements","name":"Request Finance Agreements","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1CCDS~1{companyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request Finance Agreements","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":"This tool provides a detailed view of data supplied via the CCDS scheme(Commercial Credit Data Sharing ). It's tailored for users needing immediate access to current and accurate financial agreement information, enhancing decision-making with up-to-date data insights."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1. Full CCDS Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Gain in-depth insights with access to up to 48 months of historical data on current accounts, loans, and credit card facilities. This tool is perfect for comprehensive long-term financial analysis, offering a thorough understanding of credit history and trends."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2. Financial Footprint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Get a summarized view of non performance related credit activity data. This tool simplifies the complex data into an easily understandable summary, ideal for quick assessments and initial screenings."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3. Finance Performance Indicator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A predictive tool that evaluates the likelihood of a company defaulting on payments within the next 90 days. This tool is crucial for risk assessment and mitigation, offering foresight and preparation for potential financial challenges."},"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":"companyId","in":"path","schemaId":"schema_598","description":"The connectId or safeNumber of the company","required":true,"example":"GB-0-X9999999"}],"pointer":"/paths/~1localSolutions~1GB~1CCDS~1{companyId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"excludeCutOffDate","in":"query","schemaId":"schema_615"}],"pointer":"/paths/~1localSolutions~1GB~1CCDS~1{companyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/CCDS/{companyId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"GB-0-X9999999","schemaId":"schema_598"}],"query":[{"name":"excludeCutOffDate","in":"query","required":false,"schemaId":"schema_615"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/GB/CCDS/{companyId}","href":"gb-finance-agreements/financeagreements","openApiOperationId":"financeAgreements","summary":"Request Finance Agreements"},"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":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_616"}},"schemaId":"schema_616"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1GB~1CCDS~1{companyId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_616","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_616"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-finance-agreements/financeagreements"}],"panels":[]}]},"httpPath":"/localSolutions/GB/CCDS/{companyId}"}],"content":{"contentType":"group","meta":{"name":"GB Finance Agreements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GB Finance Agreements","showPageActions":true},{"nodeType":"markdoc","content":"This endpoint provides tools for acquiring and verifying finance agreement information."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/localSolutions/GB/CCDS/{companyId}","summary":"Request Finance Agreements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gb-finance-agreements/financeagreements","deprecated":false}]}]}]}]}},{"type":"group","label":"GB Land Registry","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-land-registry","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-land-registry","items":[{"label":"GB Land Registry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-land-registry/gblandregistry","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/gb-land-registry/gblandregistry","metadata":{"seo":{"title":"GB Land Registry","description":"Allows users to return Land Registry details of a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"gbLandRegistry","name":"GB Land Registry","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1landRegistry~1{companyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GB Land Registry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows users to return Land Registry details of a company."},{"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":"companyId","in":"path","schemaId":"schema_598","description":"A company Safe Number or Connect ID.","required":true}],"pointer":"/paths/~1localSolutions~1GB~1landRegistry~1{companyId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_617","description":"language the report is requested in."},{"name":"page","in":"query","schemaId":"schema_618","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_619","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1localSolutions~1GB~1landRegistry~1{companyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/landRegistry/{companyId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"schema_598"}],"query":[{"name":"language","in":"query","schemaId":"schema_617"},{"name":"page","in":"query","schemaId":"schema_618"},{"name":"pageSize","in":"query","schemaId":"schema_619"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/GB/landRegistry/{companyId}","href":"gb-land-registry/gblandregistry","openApiOperationId":"gbLandRegistry","summary":"GB Land Registry"},"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":"components/schemas/CreditsafeLocalSolutionsGBLandRegistry"}},"schemaId":"components/schemas/CreditsafeLocalSolutionsGBLandRegistry"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1GB~1landRegistry~1{companyId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeLocalSolutionsGBLandRegistry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeLocalSolutionsGBLandRegistry"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gb-land-registry/gblandregistry"}],"panels":[]}]},"httpPath":"/localSolutions/GB/landRegistry/{companyId}"}],"content":{"contentType":"group","meta":{"name":"GB Land Registry"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GB Land Registry","showPageActions":true},{"nodeType":"markdoc","content":"This endpoint provides tools for accessing land registry information in Great Britain."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/localSolutions/GB/landRegistry/{companyId}","summary":"GB Land Registry","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gb-land-registry/gblandregistry","deprecated":false}]}]}]}]}},{"type":"group","label":"Verify","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify","items":[{"label":"Company Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/companysearch","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/companysearch","metadata":{"seo":{"title":"Company Search","description":"Endpoint to search for Companies according to the provided Search Criteria. To get the most relevant results, it is recommended to use a unique identifier such as regNo where available. If a unique identifier is not available, use a combination of the companies registered postCode and name for the next best hit rate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companySearch","name":"Company Search","isWebhook":false,"pointer":"/paths/~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Search","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":"Endpoint to search for Companies according to the provided Search Criteria. To get the most relevant results, it is recommended to use a unique identifier such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where available. If a unique identifier is not available, use a combination of the companies registered "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next best hit rate."},"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":"page","in":"query","schemaId":"schema_618","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_619","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"countries","in":"query","schemaId":"schema_620","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comma-separated list of iso-2 country codes."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used here to search for companies of this type across all countries."},"children":[]}]}]}],"required":true,"example":"GB,FR"},{"name":"language","in":"query","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only used for Countries where more than one Company Name exists for different languages e.g.  Japanese Kanji and English."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country -  Languages Available"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Japan [JP] - EN & JA"},"children":[]}]}]}]},{"name":"id","in":"query","schemaId":"schema_601","description":"connectId - The primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network. This is returned on all Company Search Results. Use this field to use in other operations such as Ordering Company Credit Report by Id, and Adding Company to Monitoring Portfolio."},{"name":"safeNo","in":"query","schemaId":"schema_599","description":"Safe Number - Identifier for Companies in Creditsafe's Home Countries."},{"name":"regNo","in":"query","schemaId":"schema_599","description":"Local Company Identifier - The Company identifier associated with it's Domestic Filing Agency. i.e. French SIREN/SIRET, United Kingdom Companies House CRN."},{"name":"vatNo","in":"query","schemaId":"schema_599","description":"Company VAT Number"},{"name":"name","in":"query","schemaId":"schema_599","description":"Company Name"},{"name":"tradeName","in":"query","schemaId":"schema_599","description":"Trade Name of the Company, typically used in Countries where Name is not uniquely registered."},{"name":"acronym","in":"query","schemaId":"schema_599","description":"A (non-unique) identifier to look for Companies by their more commonly known acronym rather than their lesser known full name. Acronym is predominantly available on French Companies."},{"name":"exact","in":"query","schemaId":"schema_600","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find Companies matching a Name exactly."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of countries this is available at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000083702-company-search-exact-parameter-availability","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company search exact parameter availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"address","in":"query","schemaId":"schema_599"},{"name":"street","in":"query","schemaId":"schema_601","description":"Address part identifier - Street of the Company"},{"name":"houseNo","in":"query","schemaId":"schema_599","description":"Address part identifier - House/Building Number of the Company"},{"name":"city","in":"query","schemaId":"schema_599","description":"Address part identifier - City of the Company"},{"name":"postCode","in":"query","schemaId":"schema_599","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address part identifier - Postcode/Zip Code of the Company. Can be provided partially to extend to a region with a * as a wildcard. I.e. CF* can represent all postcodes starting with CF."},"children":[]}]}]}]},{"name":"province","in":"query","schemaId":"schema_599","description":"Address part identifier - Province/State of the Company"},{"name":"callRef","in":"query","schemaId":"schema_601","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."},{"name":"officeType","in":"query","schemaId":"schema_622"},{"name":"phoneNo","in":"query","schemaId":"schema_623","description":"Provides Array of phone numbers or Null"},{"name":"status","in":"query","schemaId":"schema_624"},{"name":"type","in":"query","schemaId":"schema_625"},{"name":"website","in":"query","schemaId":"schema_599"},{"name":"customData","in":"query","schemaId":"schema_599","description":"Not currently used."}],"pointer":"/paths/~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_618"},{"name":"pageSize","in":"query","schemaId":"schema_619"},{"name":"countries","in":"query","required":true,"example":"GB,FR","schemaId":"components/schemas/CreditsafeGlobalDataCountryCode"},{"name":"language","in":"query","schemaId":"schema_621"},{"name":"id","in":"query","schemaId":"schema_601"},{"name":"safeNo","in":"query","schemaId":"schema_599"},{"name":"regNo","in":"query","schemaId":"schema_599"},{"name":"vatNo","in":"query","schemaId":"schema_599"},{"name":"name","in":"query","schemaId":"schema_599"},{"name":"tradeName","in":"query","schemaId":"schema_599"},{"name":"acronym","in":"query","schemaId":"schema_599"},{"name":"exact","in":"query","schemaId":"schema_600"},{"name":"address","in":"query","schemaId":"schema_599"},{"name":"street","in":"query","schemaId":"schema_601"},{"name":"houseNo","in":"query","schemaId":"schema_599"},{"name":"city","in":"query","schemaId":"schema_599"},{"name":"postCode","in":"query","schemaId":"schema_599"},{"name":"province","in":"query","schemaId":"schema_599"},{"name":"callRef","in":"query","schemaId":"schema_601"},{"name":"officeType","in":"query","schemaId":"schema_622"},{"name":"phoneNo","in":"query","schemaId":"schema_623"},{"name":"status","in":"query","schemaId":"schema_624"},{"name":"type","in":"query","schemaId":"components/schemas/CreditsafeGlobalDataCompanyType"},{"name":"website","in":"query","schemaId":"schema_599"},{"name":"customData","in":"query","schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/companies","href":"verify/companysearch","openApiOperationId":"companySearch","summary":"Company Search"},"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":"components/schemas/ConnectCompanySearchResponse"}},"schemaId":"components/schemas/ConnectCompanySearchResponse"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectCompanySearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectCompanySearchResponse"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verify/companysearch"}],"panels":[]}]},"httpPath":"/companies"},{"label":"Return Indicator Based On Company Identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/getcompanyinformation","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/getcompanyinformation","metadata":{"seo":{"title":"Return Indicator Based On Company Identifier","description":"Returns an indicator as to whether verify information is available on a business."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCompanyInformation","name":"Return Indicator Based On Company Identifier","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1verify~1company~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Indicator Based On Company Identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an indicator as to whether verify information is available on a business."},{"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":"id","in":"path","schemaId":"schema_626","description":"Unique identifier for the company.","required":true}],"pointer":"/paths/~1localSolutions~1GB~1verify~1company~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"reasonForSearch","in":"query","schemaId":"schema_627","description":"Reason for performing the search.","required":true}],"pointer":"/paths/~1localSolutions~1GB~1verify~1company~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/verify/company/{id}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_626"}],"query":[{"name":"reasonForSearch","in":"query","required":true,"schemaId":"schema_627"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/localSolutions/GB/verify/company/{id}","href":"verify/getcompanyinformation","openApiOperationId":"getCompanyInformation","summary":"Return Indicator Based On Company Identifier"},"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":"components/schemas/LocalSolutionsVerifyCompanyResponse"}},"schemaId":"components/schemas/LocalSolutionsVerifyCompanyResponse"},{"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/~1localSolutions~1GB~1verify~1company~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocalSolutionsVerifyCompanyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocalSolutionsVerifyCompanyResponse"}}},{"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":"/verify/getcompanyinformation"}],"panels":[]}]},"httpPath":"/localSolutions/GB/verify/company/{id}"},{"label":"Company Credit Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/companycreditreport","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/companycreditreport","metadata":{"seo":{"title":"Company Credit Report","description":"Orders a Company Credit Report by connectId. To acquire a PDF version of the report use the optional request in 'Header'. This request will provide a 'Base64-encoded' script to convert to a PDF, this will appear at the end of the JSON response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companyCreditReport","name":"Company Credit Report","isWebhook":false,"pointer":"/paths/~1companies~1{connectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Credit 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":"Orders a Company Credit Report by connectId."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To acquire a PDF version of the report use the optional request in 'Header'."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This request will provide a 'Base64-encoded' script to convert to a PDF, this will appear at the end of the JSON response."},"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":"connectId","in":"path","schemaId":"schema_598","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The connectId (optionally Safe Number where available) of the Company required to order their Credit Report. Obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" search results."},"children":[]}]}]}],"required":true,"example":"GB-0-03836192"}],"pointer":"/paths/~1companies~1{connectId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_628","description":"Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available."},{"name":"template","in":"query","schemaId":"schema_629","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter to request a Templated Company Report. A Template adds/reduces sections of the Credit Report depending on your subscription. Do not include this parameter if you have not been given a template to use."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000063360-connect-report-templates-glossary-availability","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect report templates glossary and availability"},"children":[]}]}]}]}]},{"name":"includeIndicators","in":"query","schemaId":"schema_615","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter to include the indicator scores in to a company report -"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fsi = Financial Strength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pbi = Payment Behaviour Indicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eti = Estimated Turnover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pei = Payment Expectation Indicator"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Addition information on indicator acronyms can be found "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000084411-connect-report-indicator-definitions","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report indicator definitions"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Addition information on understanding indicators can be found "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000078780-what-are-indicators-in-the-scores-and-indicators-tab-","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indicator guidance in the Scores and Indicators tab"},"children":[]}]}]}]}]},{"name":"customData","in":"query","schemaId":"schema_599","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Report Parameters e.g.  German Report Reason Code value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de_reason_code::1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" . Use /reportcustomdata/{country} endpoint to see all values."},"children":[]}]}]}]},{"name":"callRef","in":"query","schemaId":"schema_601","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/~1companies~1{connectId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_598","description":"Applies request for PDF link to Company Report.","example":"application/json+pdf"}],"pointer":"/paths/~1companies~1{connectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{connectId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"connectId","in":"path","required":true,"example":"GB-0-03836192","schemaId":"schema_598"}],"query":[{"name":"language","in":"query","schemaId":"schema_628"},{"name":"template","in":"query","schemaId":"schema_629"},{"name":"includeIndicators","in":"query","schemaId":"schema_615"},{"name":"customData","in":"query","schemaId":"schema_599"},{"name":"callRef","in":"query","required":false,"schemaId":"schema_601"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":false,"example":"application/json+pdf","schemaId":"schema_598"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/companies/{connectId}","href":"verify/companycreditreport","openApiOperationId":"companyCreditReport","summary":"Company Credit 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","application/json+pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse"},"application/json+pdf":{"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachmentjson"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1companies~1{connectId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse","mediaTypes":["application/json","application/json+pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse"},"application/json+pdf":{"schemaId":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachmentjson"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verify/companycreditreport"}],"panels":[]}]},"httpPath":"/companies/{connectId}"},{"label":"Execute Individual Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/getindividualdirectreport","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/getindividualdirectreport","metadata":{"seo":{"title":"Execute Individual Search","description":"Executes a search using optional personal and address details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIndividualDirectReport","name":"Execute Individual Search","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1verify~1individual~1directReport/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Individual Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Executes a search using optional personal and address details."},{"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":"title","in":"query","schemaId":"schema_598","description":"Title of the individual."},{"name":"firstName","in":"query","schemaId":"schema_598","description":"First name of the individual.","required":true},{"name":"middleName","in":"query","schemaId":"schema_598","description":"Middle name of the individual."},{"name":"lastName","in":"query","schemaId":"schema_598","description":"Last name of the individual.","required":true},{"name":"dateOfBirth","in":"query","schemaId":"schema_598","description":"Date of birth of the individual.","required":true},{"name":"houseNo","in":"query","schemaId":"schema_598","description":"House number of the address."},{"name":"buildingName","in":"query","schemaId":"schema_598","description":"Building name of the address."},{"name":"subBuilding","in":"query","schemaId":"schema_598","description":"Sub building of the address.."},{"name":"street","in":"query","schemaId":"schema_598","description":"Street of the address."},{"name":"city","in":"query","schemaId":"schema_598","description":"City of the address."},{"name":"province","in":"query","schemaId":"schema_598","description":"Province of the address."},{"name":"postCode","in":"query","schemaId":"schema_598","description":"Postal code of the address.","required":true},{"name":"address","in":"query","schemaId":"schema_598","description":"Full address.","required":true},{"name":"reasonForSearch","in":"query","schemaId":"schema_627","description":"Reason for performing the search.","required":true}],"pointer":"/paths/~1localSolutions~1GB~1verify~1individual~1directReport/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/verify/individual/directReport","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"title","in":"query","schemaId":"schema_598"},{"name":"firstName","in":"query","required":true,"schemaId":"schema_598"},{"name":"middleName","in":"query","schemaId":"schema_598"},{"name":"lastName","in":"query","required":true,"schemaId":"schema_598"},{"name":"dateOfBirth","in":"query","required":true,"schemaId":"schema_598"},{"name":"houseNo","in":"query","schemaId":"schema_598"},{"name":"buildingName","in":"query","schemaId":"schema_598"},{"name":"subBuilding","in":"query","schemaId":"schema_598"},{"name":"street","in":"query","schemaId":"schema_598"},{"name":"city","in":"query","schemaId":"schema_598"},{"name":"province","in":"query","schemaId":"schema_598"},{"name":"postCode","in":"query","required":true,"schemaId":"schema_598"},{"name":"address","in":"query","required":true,"schemaId":"schema_598"},{"name":"reasonForSearch","in":"query","required":true,"schemaId":"schema_627"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/localSolutions/GB/verify/individual/directReport","href":"verify/getindividualdirectreport","openApiOperationId":"getIndividualDirectReport","summary":"Execute Individual Search"},"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":"components/schemas/LocalSolutionsVerifyIndividualDirectReportResponse"}},"schemaId":"components/schemas/LocalSolutionsVerifyIndividualDirectReportResponse"},{"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/~1localSolutions~1GB~1verify~1individual~1directReport/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocalSolutionsVerifyIndividualDirectReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocalSolutionsVerifyIndividualDirectReportResponse"}}},{"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":"/verify/getindividualdirectreport"}],"panels":[]}]},"httpPath":"/localSolutions/GB/verify/individual/directReport"},{"label":"Execute Individual Search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/localsolutionsgbverifyindividualdirectreportpost","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/localsolutionsgbverifyindividualdirectreportpost","metadata":{"seo":{"title":"Execute Individual Search","description":"Executes a search using optional personal and address details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"localsolutionsGbVerifyIndividualDirectReportPost","name":"Execute Individual Search","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1verify~1individual~1directReport/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Individual Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Executes a search using optional personal and address details."},{"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MultiVerifyAddressSearchRequest"}},"schemaId":"components/schemas/MultiVerifyAddressSearchRequest","pointer":"/paths/~1localSolutions~1GB~1verify~1individual~1directReport/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/localSolutions/GB/verify/individual/directReport","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":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MultiVerifyAddressSearchRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/localSolutions/GB/verify/individual/directReport","href":"verify/localsolutionsgbverifyindividualdirectreportpost","openApiOperationId":"localsolutionsGbVerifyIndividualDirectReportPost","summary":"Execute Individual Search"},"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/MultiVerifyAddressSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MultiVerifyAddressSearchRequest"}},"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/LocalSolutionsVerifyIndividualDirectReportPostResponse"}},"schemaId":"components/schemas/LocalSolutionsVerifyIndividualDirectReportPostResponse"},{"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/~1localSolutions~1GB~1verify~1individual~1directReport/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocalSolutionsVerifyIndividualDirectReportPostResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocalSolutionsVerifyIndividualDirectReportPostResponse"}}},{"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":"/verify/localsolutionsgbverifyindividualdirectreportpost"}],"panels":[]}]},"httpPath":"/localSolutions/GB/verify/individual/directReport"},{"label":"Director Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/directorssearch","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/directorssearch","metadata":{"seo":{"title":"Director Search","description":"Endpoint to find Directors based on search criteria to order a Creditsafe Director Report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"directorSSearch","name":"Director Search","isWebhook":false,"pointer":"/paths/~1people/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Director Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to find Directors based on search criteria to order a Creditsafe Director Report."},{"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":"page","in":"query","schemaId":"schema_618","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_619","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"countries","in":"query","schemaId":"schema_630","description":"comma-separated list of iso-2 country codes","required":true,"example":"GB,FR"},{"name":"peopleId","in":"query","schemaId":"schema_598","description":"Person/Director Identifier - used to order a Director Report."},{"name":"firstName","in":"query","schemaId":"schema_598","description":"Person's First Name."},{"name":"lastName","in":"query","schemaId":"schema_598","description":"Person's Last Name"},{"name":"localDirectorNumber","in":"query","schemaId":"schema_599","description":"Local Identifier of the Director, the PNR in GB."},{"name":"dateOfBirth","in":"query","schemaId":"schema_598","description":"Person DOB - provide YYYY-MM-DD or YYYY-MM format."},{"name":"callRef","in":"query","schemaId":"schema_599","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/~1people/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_618"},{"name":"pageSize","in":"query","schemaId":"schema_619"},{"name":"countries","in":"query","required":true,"example":"GB,FR","schemaId":"schema_630"},{"name":"peopleId","in":"query","schemaId":"schema_598"},{"name":"firstName","in":"query","schemaId":"schema_598"},{"name":"lastName","in":"query","schemaId":"schema_598"},{"name":"localDirectorNumber","in":"query","schemaId":"schema_599"},{"name":"dateOfBirth","in":"query","schemaId":"schema_598"},{"name":"callRef","in":"query","schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/people","href":"verify/directorssearch","openApiOperationId":"directorSSearch","summary":"Director Search"},"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_631"}},"schemaId":"schema_631"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1people/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_631","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_631"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verify/directorssearch"}],"panels":[]}]},"httpPath":"/people"},{"label":"Retrieve Individual Summary Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/getsummaryinformationbyid","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/getsummaryinformationbyid","metadata":{"seo":{"title":"Retrieve Individual Summary Information","description":"Returns summary information about an individual based on the provided identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSummaryInformationById","name":"Retrieve Individual Summary Information","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1verify~1individual~1{id}~1summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Individual Summary Information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns summary information about an individual based on the provided identifier."},{"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":"id","in":"path","schemaId":"schema_632","description":"Unique identifier for the people.","required":true}],"pointer":"/paths/~1localSolutions~1GB~1verify~1individual~1{id}~1summary/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"freeText","in":"query","schemaId":"schema_598","description":"Additional free text for audit logging."},{"name":"reasonForSearch","in":"query","schemaId":"schema_627","description":"Reason for performing the search.","required":true}],"pointer":"/paths/~1localSolutions~1GB~1verify~1individual~1{id}~1summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/verify/individual/{id}/summary","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_632"}],"query":[{"name":"freeText","in":"query","schemaId":"schema_598"},{"name":"reasonForSearch","in":"query","required":true,"schemaId":"schema_627"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/localSolutions/GB/verify/individual/{id}/summary","href":"verify/getsummaryinformationbyid","openApiOperationId":"getSummaryInformationById","summary":"Retrieve Individual Summary Information"},"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":"components/schemas/LocalSolutionsVerifyIndividualSummaryReportResponse"}},"schemaId":"components/schemas/LocalSolutionsVerifyIndividualSummaryReportResponse"},{"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/~1localSolutions~1GB~1verify~1individual~1{id}~1summary/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocalSolutionsVerifyIndividualSummaryReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocalSolutionsVerifyIndividualSummaryReportResponse"}}},{"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":"/verify/getsummaryinformationbyid"}],"panels":[]}]},"httpPath":"/localSolutions/GB/verify/individual/{id}/summary"},{"label":"Retrieve Individual Full Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/getfullinformationbyid","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/verify/getfullinformationbyid","metadata":{"seo":{"title":"Retrieve Individual Full Information","description":"Returns detailed information about an individual based on the provided identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFullInformationById","name":"Retrieve Individual Full Information","isWebhook":false,"pointer":"/paths/~1localSolutions~1GB~1verify~1individual~1{id}~1full/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Individual Full Information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns detailed information about an individual based on the provided identifier."},{"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":"id","in":"path","schemaId":"schema_632","description":"Unique identifier for the people.","required":true}],"pointer":"/paths/~1localSolutions~1GB~1verify~1individual~1{id}~1full/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"freeText","in":"query","schemaId":"schema_598","description":"Additional free text for audit logging."},{"name":"reasonForSearch","in":"query","schemaId":"schema_627","description":"Reason for performing the search.","required":true}],"pointer":"/paths/~1localSolutions~1GB~1verify~1individual~1{id}~1full/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/localSolutions/GB/verify/individual/{id}/full","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_632"}],"query":[{"name":"freeText","in":"query","schemaId":"schema_598"},{"name":"reasonForSearch","in":"query","required":true,"schemaId":"schema_627"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/localSolutions/GB/verify/individual/{id}/full","href":"verify/getfullinformationbyid","openApiOperationId":"getFullInformationById","summary":"Retrieve Individual Full Information"},"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":"components/schemas/LocalSolutionsVerifyIndividualFullReportResponse"}},"schemaId":"components/schemas/LocalSolutionsVerifyIndividualFullReportResponse"},{"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/~1localSolutions~1GB~1verify~1individual~1{id}~1full/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocalSolutionsVerifyIndividualFullReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocalSolutionsVerifyIndividualFullReportResponse"}}},{"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":"/verify/getfullinformationbyid"}],"panels":[]}]},"httpPath":"/localSolutions/GB/verify/individual/{id}/full"}],"content":{"contentType":"group","meta":{"name":"Verify"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify","showPageActions":true},{"nodeType":"markdoc","content":"Verify is an exclusive add-on to Creditsafe's company credit reports, designed to assist businesses in making smarter, quicker, \nand more informed credit decisions. For new or small companies that lack a detailed financial footprint, Verify offers unparalleled \ninsights by screening company directors and the individuals behind businesses for their personal financial stability and identity.\n\nUsing Verify, you can confidently assess a company's leadership, using trusted public datasets that highlight potential financial concerns, \nsuch as CCJs or Insolvencies and confirm that they reside at an address on the Electoral roll."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies","summary":"Company Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verify/companysearch","deprecated":false},{"title":"/localSolutions/GB/verify/company/{id}","summary":"Return Indicator Based On Company Identifier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verify/getcompanyinformation","deprecated":false},{"title":"/companies/{connectId}","summary":"Company Credit Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verify/companycreditreport","deprecated":false},{"title":"/localSolutions/GB/verify/individual/directReport","summary":"Execute Individual Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verify/getindividualdirectreport","deprecated":false},{"title":"/localSolutions/GB/verify/individual/directReport","summary":"Execute Individual Search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verify/localsolutionsgbverifyindividualdirectreportpost","deprecated":false},{"title":"/people","summary":"Director Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verify/directorssearch","deprecated":false},{"title":"/localSolutions/GB/verify/individual/{id}/summary","summary":"Retrieve Individual Summary Information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verify/getsummaryinformationbyid","deprecated":false},{"title":"/localSolutions/GB/verify/individual/{id}/full","summary":"Retrieve Individual Full Information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verify/getfullinformationbyid","deprecated":false}]}]}]}]}},{"type":"separator","label":"United States","content":null},{"type":"group","label":"US Search Support","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/us-search-support","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/us-search-support","items":[{"label":"Fresh Investigation Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/us-search-support/createfreshinvestigationforuscountry","routeSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions/us-search-support/createfreshinvestigationforuscountry","metadata":{"seo":{"title":"Fresh Investigation Request","description":"Places an order for a Fresh Investigation (Offline Report). Providing as much detail as possible about the Company, our team will use official sources and registries to quickly answer questions about a company's stability and financial health. Fresh Investigations take 5.5 days on average to complete. By adding consent:true to the request, you are allowing Creditsafe to disclose your company details to the company you have requested the Investigation against, to be used only in the aim of improving our Investigation report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFreshinvestigationForUsCountry","name":"Fresh Investigation Request","isWebhook":false,"pointer":"/paths/~1localSolutions~1US~1searchSupport/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fresh Investigation Request","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":"Places an order for a Fresh Investigation (Offline Report). Providing as much detail as possible about the Company, our team will use official sources and registries to quickly answer questions about a company's stability and financial health. Fresh Investigations take 5.5 days on average to complete. By adding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consent:true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the request, you are allowing Creditsafe to disclose your company details to the company you have requested the Investigation against, to be used only in the aim of improving our Investigation report."},"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":"operationType","in":"query","schemaId":"schema_633","description":"type of check","example":"searchSupport"}],"pointer":"/paths/~1localSolutions~1US~1searchSupport/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data","application/json"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ConnectUSLocalSolutionsFreshInvCreateInvestigationFormData"},"application/json":{"schemaId":"components/schemas/ConnectUSLocalSolutionsFreshInvCreateInvestigation"}},"schemaId":"components/schemas/ConnectUSLocalSolutionsFreshInvCreateInvestigationFormData","pointer":"/paths/~1localSolutions~1US~1searchSupport/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/localSolutions/US/searchSupport","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"operationType","in":"query","example":"searchSupport","schemaId":"schema_633"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/ConnectUSLocalSolutionsFreshInvCreateInvestigationFormData"},"application/json":{"schemaId":"components/schemas/ConnectUSLocalSolutionsFreshInvCreateInvestigation"}},"responseCodes":["200","400","401","403","404"],"pointer":"/localSolutions/US/searchSupport","href":"us-search-support/createfreshinvestigationforuscountry","openApiOperationId":"createFreshinvestigationForUsCountry","summary":"Fresh Investigation Request"},"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/ConnectUSLocalSolutionsFreshInvCreateInvestigationFormData","mediaTypes":["multipart/form-data","application/json"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ConnectUSLocalSolutionsFreshInvCreateInvestigationFormData"},"application/json":{"schemaId":"components/schemas/ConnectUSLocalSolutionsFreshInvCreateInvestigation"}},"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/CreditsafeUSLocalFIResponse"}},"schemaId":"components/schemas/CreditsafeUSLocalFIResponse"},{"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"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1localSolutions~1US~1searchSupport/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeUSLocalFIResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeUSLocalFIResponse"}}},{"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"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/us-search-support/createfreshinvestigationforuscountry"}],"panels":[]}]},"httpPath":"/localSolutions/US/searchSupport"}],"content":{"contentType":"group","meta":{"name":"US Search Support"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"US Search Support","showPageActions":true},{"nodeType":"markdoc","content":"This endpoint provides support for searching in the United States for companies not immediately available in the Creditsafe database."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/localSolutions/US/searchSupport","summary":"Fresh Investigation Request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/us-search-support/createfreshinvestigationforuscountry","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/ConnectBankMatchResult":{"id":"components/schemas/ConnectBankMatchResult","kind":"json-schema","title":"ConnectBankMatchResult","data":{"type":"object","properties":{"totalSize":{"type":"integer","example":1},"bankMatchResults":{"type":"array","items":{"type":"object","properties":{"companyNumber":{"type":["string","null"],"example":"X9999999"},"accountNumber":{"type":["string","null"],"example":"66374957"},"iban":{"type":["string","null"],"example":"GB55TEST08999966374957"},"ibanResult":{"type":["string","null"],"description":"Match or No Match"},"ibanText":{"type":["string","null"],"example":"The IBAN provided does not match the company UK07499628."},"logDate":{"type":["string","null"],"example":"2020-06-04T11:04:32.7301608+00:00"},"safeNumber":{"type":["string","null"],"example":"UK07499628"},"scanResult":{"type":["string","null"],"description":"Match or No Match"},"scanText":{"type":["string","null"],"example":"The Sort Code and Account Number provided does not match the company UK07499628."},"sortCode":{"type":["string","null"],"example":"089999"},"statusResult":{"type":["string","null"],"description":"Request status, e.g. Success, Error, Warning"},"statusText":{"type":["string","null"],"description":"Explanation for error or warning, if applicable, otherwise empty quotation marks"},"vatResult":{"type":["string","null"],"description":"Match or No Match"},"vatText":{"type":["string","null"],"example":"The VAT provided matches the company UK07499628."}}}}}}},"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/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/ConnectErrorResponsesResourceNotFoundRequest":{"id":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","kind":"json-schema","title":"ConnectErrorResponsesResourceNotFoundRequest","data":{"type":"object","description":"404 - Not Found","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","format":"uuid"},"message":{"type":"string"},"details":{"type":"string","description":"Provides further information on why the request was rejected"}}}},"components/schemas/ConnectCcdsOverallAggregations":{"id":"components/schemas/ConnectCcdsOverallAggregations","kind":"json-schema","title":"ConnectCcdsOverallAggregations","data":{"description":"A summarisation of the companies account details.","type":"object","properties":{"totalAccounts":{"type":"integer","example":33},"totalBalance":{"type":"integer","example":-813844},"totalOverdraftOrCreditLimit":{"type":"integer","example":250000},"totalAverageBalance":{"type":"integer","example":273009},"remainingBalance":{"type":"integer","example":485247}}}},"components/schemas/ConnectBankMatchBusinessAddress":{"id":"components/schemas/ConnectBankMatchBusinessAddress","kind":"json-schema","title":"ConnectBankMatchBusinessAddress","data":{"type":"object","properties":{"line1":{"type":["string","null"]},"line2":{"type":["string","null"]},"line3":{"type":["string","null"]},"line4":{"type":["string","null"]},"line5":{"type":["string","null"]},"line6":{"type":["string","null"]},"postcode":{"type":["string","null"]}}}},"components/schemas/ConnectCcdsHistory":{"id":"components/schemas/ConnectCcdsHistory","kind":"json-schema","title":"ConnectCcdsHistory","data":{"type":"object","properties":{"businessTypeIndicator":{"type":["string","null"]},"businessName":{"type":["string","null"]},"businessAddress":{"$ref":"#/components/schemas/ConnectBankMatchBusinessAddress"},"additionalTradingStyle":{"type":["string","null"]},"businessTelephoneNumber":{"type":["string","null"]},"companyRegistrationNumber":{"type":["string","null"]},"vatNumber":{"type":["string","null"]},"specialInstructionIndicator":{"type":["string","null"]},"startDateOfAgreement":{"type":"string","format":"date-time"},"currentBalance":{"type":"integer","format":"int64"},"currentBalanceCreditIndicator":{"type":["string","null"]},"actualCurrentBalance":{"type":"integer","format":"int64"},"facilityStatus":{"type":["string","null"]},"originalDefaultBalance":{"type":"integer","format":"int64"},"creditOrOverdraftLimit":{"type":"integer","format":"int64"},"flagSettings":{"type":["string","null"]},"transferredToConsolidatedDebtAccount":{"type":["string","null"]},"repaymentPeriod":{"type":"integer","format":"int64"},"paymentAmount":{"type":"integer","format":"int64"},"paymentFrequencyIndicator":{"type":["string","null"]},"numberOfCashAdvances":{"type":"integer","format":"int64"},"valueOfCashAdvances":{"type":"integer","format":"int64"},"minimumBalance":{"type":"integer","format":"int64"},"minimumBalanceCreditIndicator":{"type":["string","null"]},"actualMinimumBalance":{"type":"integer","format":"int64"},"maximumBalance":{"type":"integer","format":"int64"},"maximumBalanceCreditIndicator":{"type":["string","null"]},"actualMaximumBalance":{"type":"integer","format":"int64"},"averageBalance":{"type":"integer","format":"int64"},"averageBalanceCreditIndicator":{"type":["string","null"]},"actualAverageBalance":{"type":"integer","format":"int64"},"creditTurnover":{"type":"integer","format":"int64"},"creditTurnoverNetOrGrossIndicator":{"type":["string","null"]},"debitTurnover":{"type":"integer","format":"int64"},"debitTurnoverNetOrGrossIndicator":{"type":["string","null"]},"rejectedPayments":{"type":"integer","format":"int64"},"maximumDurationOfExcess":{"type":"integer","format":"int64"},"currentAccountReportingLevelIndicator":{"type":["string","null"]},"facilityType":{"type":"string"},"facilityTypeCategory":{"type":["string","null"]},"batchDate":{"type":["string","null"]},"facilityId":{"type":["string","null"]}}}},"components/schemas/ConnectCcdsFootprintDataFinance":{"id":"components/schemas/ConnectCcdsFootprintDataFinance","kind":"json-schema","title":"ConnectCcdsFootprintDataFinance","data":{"type":"object","properties":{"activeAccounts":{"type":"integer","format":"int64"},"settledAccounts":{"type":"integer","format":"int64"},"earliestStartDate":{"type":"string","format":"date-time"},"latestStartDate":{"type":"string","format":"date-time"}}}},"components/schemas/ConnectCcdsIndicatorDataFinance":{"id":"components/schemas/ConnectCcdsIndicatorDataFinance","kind":"json-schema","title":"ConnectCcdsIndicatorDataFinance","data":{"type":"object","properties":{"activeAccounts":{"type":"integer","format":"int64"},"settledAccounts":{"type":"integer","format":"int64"},"earliestStartDate":{"type":"string","format":"date-time"},"latestStartDate":{"type":"string","format":"date-time"}}}},"components/schemas/ConnectFootprintDataFinance":{"id":"components/schemas/ConnectFootprintDataFinance","kind":"json-schema","title":"ConnectFootprintDataFinance","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"safeNumber":{"type":"string","description":"Safe Number - Identifier for Companies in Creditsafe's Home Countries.","example":"UK08368892"},"creditSafe":{"type":"object","properties":{"creditSafeCompanyId":{"type":"string","example":"NI008172"}}},"overallAggregations":{"type":"object","allOf":[{"$ref":"#/components/schemas/ConnectCcdsOverallAggregations"}],"example":{"totalAccounts":-1,"totalBalance":0,"totalOverdraftOrCreditLimit":0,"remainingBalance":0,"totalAverageBalance":0}},"history":{"description":"List of accounts connected to the company, snapshot of account at point in time each month.","type":"array","items":{"$ref":"#/components/schemas/ConnectCcdsHistory"},"example":[{"businessTypeIndicator":"L","businessName":"POTS & CO LTD","businessAddress":{"line1":"UNIT 3&7 DAN HOUSE","line2":"ELVEDEN ROAD","line3":"LONDON","line4":"","line5":"","line6":"","postcode":"NW10 7ST"},"additionalTradingStyle":null,"businessTelephoneNumber":null,"companyRegistrationNumber":null,"vatNumber":null,"specialInstructionIndicator":null,"startDateOfAgreement":"2017-05-15T00:00:00","currentBalance":0,"currentBalanceCreditIndicator":null,"actualCurrentBalance":0,"facilityStatus":"0","originalDefaultBalance":0,"creditOrOverdraftLimit":0,"flagSettings":"","transferredToConsolidatedDebtAccount":null,"repaymentPeriod":0,"paymentAmount":0,"paymentFrequencyIndicator":null,"numberOfCashAdvances":0,"valueOfCashAdvances":0,"minimumBalance":0,"minimumBalanceCreditIndicator":null,"actualMinimumBalance":0,"maximumBalance":0,"maximumBalanceCreditIndicator":null,"actualMaximumBalance":0,"averageBalance":0,"averageBalanceCreditIndicator":null,"actualAverageBalance":0,"creditTurnover":0,"creditTurnoverNetOrGrossIndicator":null,"debitTurnover":0,"debitTurnoverNetOrGrossIndicator":null,"rejectedPayments":0,"maximumDurationOfExcess":0,"currentAccountReportingLevelIndicator":null,"facilityType":"01","facilityTypeCategory":"LOAN","batchDate":"20220131","date":"20220131","facilityId":"baffec1bd22b1f30ec6ebce04c9c1ad158d7fce6c9f693c53f880b5db631dd9a"}]},"footprintData":{"description":"A version of a summarisation of companies account details which omits any sensitive data and can be shown to non-CCDS members.","type":"object","properties":{"year":{"type":"object","properties":{"month":{"type":"object","properties":{"loans":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"},"currentAccounts":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"},"all":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"},"creditCards":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"}}}}}},"example":{"2023":{"10":{"loans":{"ActiveAccounts":10,"SettledAccounts":1,"EarliestStartDate":"2016-08-17T00:00:00","LatestStartDate":"2019-09-18T00:00:00"},"currentAccounts":{"ActiveAccounts":1,"SettledAccounts":0,"EarliestStartDate":"2012-07-03T00:00:00","LatestStartDate":"2012-07-03T00:00:00"},"all":{"activeAccounts":11,"settledAccounts":1,"earliestStartDate":"2012-07-03T00:00:00","latestStartDate":"2019-09-18T00:00:00"},"creditCards":{"activeAccounts":0,"settledAccounts":0}},"11":{"loans":{"ActiveAccounts":1,"SettledAccounts":0,"EarliestStartDate":"2012-07-03T00:00:00","LatestStartDate":"2012-07-03T00:00:00"},"currentAccounts":{"ActiveAccounts":1,"SettledAccounts":0,"EarliestStartDate":"2012-07-03T00:00:00","LatestStartDate":"2012-07-03T00:00:00"},"all":{"activeAccounts":1,"settledAccounts":1,"earliestStartDate":"2012-07-03T00:00:00","latestStartDate":"2019-09-18T00:00:00"},"creditCards":{"activeAccounts":0,"settledAccounts":0}}}}},"indicatorData":{"description":"","type":"object","properties":{"year":{"type":"object","properties":{"month":{"$ref":"#/components/schemas/ConnectCcdsIndicatorDataFinance"}}}},"example":{"2023":{"10":{"30_day_pod":0,"30_day_indicator":0,"60_day_pod":0,"60_day_indicator":0,"90_day_pod":0,"90_day_indicator":0},"11":{"30_day_pod":0,"30_day_indicator":0,"60_day_pod":0,"60_day_indicator":0,"90_day_pod":0,"90_day_indicator":0}}}}}}},"components/schemas/ConnectCcdsFinancialIndicatorData":{"id":"components/schemas/ConnectCcdsFinancialIndicatorData","kind":"json-schema","title":"ConnectCcdsFinancialIndicatorData","data":{"type":"object","properties":{"id":{"type":"string"},"updated_date":{"type":"string"},"30_day_pod":{"type":"integer"},"30_day_indicator":{"type":"integer"},"60_day_pod":{"type":"integer"},"60_day_indicator":{"type":"integer"},"90_day_pod":{"type":"integer"},"90_day_indicator":{"type":"integer"}}}},"components/schemas/ConnectFootprintIndicatorData":{"id":"components/schemas/ConnectFootprintIndicatorData","kind":"json-schema","title":"ConnectFootprintIndicatorData","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"safeNumber":{"description":"Safe Number - Identifier for Companies in Creditsafe's Home Countries.","type":"string","example":"UK07005751"},"creditSafe":{"type":"object","properties":{"creditSafeCompanyId":{"type":"string","example":"NI008172"}}},"overallAggregations":{"type":"object","allOf":[{"$ref":"#/components/schemas/ConnectCcdsOverallAggregations"}],"example":{"totalAccounts":-1,"totalBalance":0,"totalOverdraftOrCreditLimit":0,"remainingBalance":0,"totalAverageBalance":0}},"history":{"description":"List of accounts connected to the company, snapshot of account at point in time each month.","type":"array","items":{"$ref":"#/components/schemas/ConnectCcdsHistory"},"example":[{"businessTypeIndicator":"L","businessName":"TEST COMPANY LIMITED - THE","businessAddress":{"line1":"BRYN HOUSE","line2":"CAERPHILLY BUSINESS PARK","line3":"VAN ROAD","line4":"CARDIFF","line5":"","line6":"CF83 3GG","postcode":"CF83 3GG"},"additionalTradingStyle":null,"businessTelephoneNumber":null,"companyRegistrationNumber":"X9999999","vatNumber":null,"specialInstructionIndicator":null,"startDateOfAgreement":"2017-05-15T00:00:00","currentBalance":0,"currentBalanceCreditIndicator":null,"actualCurrentBalance":0,"facilityStatus":"0","originalDefaultBalance":0,"creditOrOverdraftLimit":0,"flagSettings":"","transferredToConsolidatedDebtAccount":null,"repaymentPeriod":0,"paymentAmount":0,"paymentFrequencyIndicator":null,"numberOfCashAdvances":0,"valueOfCashAdvances":0,"minimumBalance":0,"minimumBalanceCreditIndicator":null,"actualMinimumBalance":0,"maximumBalance":0,"maximumBalanceCreditIndicator":null,"actualMaximumBalance":0,"averageBalance":0,"averageBalanceCreditIndicator":null,"actualAverageBalance":0,"creditTurnover":0,"creditTurnoverNetOrGrossIndicator":null,"debitTurnover":0,"debitTurnoverNetOrGrossIndicator":null,"rejectedPayments":0,"maximumDurationOfExcess":0,"currentAccountReportingLevelIndicator":null,"facilityType":"01","facilityTypeCategory":"LOAN","batchDate":"20220131","date":"20220131","facilityId":"baffec1bd22b1f30ec6ebce04c9c1ad158d7fce6c9f693c53f880b5db631dd9a"}]},"financialIndicator":{"description":"A version of a summarisation of companies account details which omits any sensitive data and can be shown to non-CCDS members.","type":"object","properties":{"year":{"type":"object","properties":{"month":{"items":{"$ref":"#/components/schemas/ConnectCcdsFinancialIndicatorData"}}}}},"example":{"2023":{"10":[{"id":"UK123456790","updated_date":"2020-10-21","30_day_pod":0.07,"30_day_indicator":7,"60_day_pod":0.08,"60_day_indicator":8,"90_day_pod":0.08,"90_day_indicator":8}]}}},"footprintData":{"description":"A version of a summarisation of companies account details which omits any sensitive data and can be shown to non-CCDS members.","type":"object","properties":{"year":{"type":"object","properties":{"month":{"type":"object","properties":{"loans":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"},"currentAccounts":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"},"all":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"},"creditCards":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"}}}}}},"example":{"2023":{"10":{"loans":{"ActiveAccounts":10,"SettledAccounts":1,"EarliestStartDate":"2016-08-17T00:00:00","LatestStartDate":"2019-09-18T00:00:00"},"currentAccounts":{"ActiveAccounts":1,"SettledAccounts":0,"EarliestStartDate":"2012-07-03T00:00:00","LatestStartDate":"2012-07-03T00:00:00"},"all":{"activeAccounts":11,"settledAccounts":1,"earliestStartDate":"2012-07-03T00:00:00","latestStartDate":"2019-09-18T00:00:00"},"creditCards":{"activeAccounts":0,"settledAccounts":0}}}}}}}},"components/schemas/ConnectIndicatorData":{"id":"components/schemas/ConnectIndicatorData","kind":"json-schema","title":"ConnectIndicatorData","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"safeNumber":{"description":"Safe Number - Identifier for Companies in Creditsafe's Home Countries.","type":"string","example":"UK07005751"},"creditSafe":{"type":"object","properties":{"creditSafeCompanyId":{"type":"string","example":"NI008172"}}},"overallAggregations":{"type":"object","allOf":[{"$ref":"#/components/schemas/ConnectCcdsOverallAggregations"}],"example":{"totalAccounts":-1,"totalBalance":0,"totalOverdraftOrCreditLimit":0,"remainingBalance":0,"totalAverageBalance":0}},"history":{"description":"List of accounts connected to the company, snapshot of account at point in time each month.","type":"array","items":{"$ref":"#/components/schemas/ConnectCcdsHistory"},"example":[{"businessTypeIndicator":"L","businessName":"TEST COMPANY LIMITED - THE","businessAddress":{"line1":"BRYN HOUSE","line2":"CAERPHILLY BUSINESS PARK","line3":"VAN ROAD","line4":"CARDIFF","line5":"","line6":"CF83 3GG","postcode":"CF83 3GG"},"additionalTradingStyle":null,"businessTelephoneNumber":null,"companyRegistrationNumber":"X9999999","vatNumber":null,"specialInstructionIndicator":null,"startDateOfAgreement":"2017-05-15T00:00:00","currentBalance":0,"currentBalanceCreditIndicator":null,"actualCurrentBalance":0,"facilityStatus":"0","originalDefaultBalance":0,"creditOrOverdraftLimit":0,"flagSettings":"","transferredToConsolidatedDebtAccount":null,"repaymentPeriod":0,"paymentAmount":0,"paymentFrequencyIndicator":null,"numberOfCashAdvances":0,"valueOfCashAdvances":0,"minimumBalance":0,"minimumBalanceCreditIndicator":null,"actualMinimumBalance":0,"maximumBalance":0,"maximumBalanceCreditIndicator":null,"actualMaximumBalance":0,"averageBalance":0,"averageBalanceCreditIndicator":null,"actualAverageBalance":0,"creditTurnover":0,"creditTurnoverNetOrGrossIndicator":null,"debitTurnover":0,"debitTurnoverNetOrGrossIndicator":null,"rejectedPayments":0,"maximumDurationOfExcess":0,"currentAccountReportingLevelIndicator":null,"facilityType":"01","facilityTypeCategory":"LOAN","batchDate":"20220131","date":"20220131","facilityId":"baffec1bd22b1f30ec6ebce04c9c1ad158d7fce6c9f693c53f880b5db631dd9a"}]},"financialIndicator":{"description":"A version of a summarisation of companies account details which omits any sensitive data and can be shown to non-CCDS members.","type":"object","properties":{"year":{"type":"object","properties":{"month":{"$ref":"#/components/schemas/ConnectCcdsFinancialIndicatorData"}}}},"example":{"2023":{"10":[{"id":"UK1234567890","updated_date":"2020-10-21","30_day_pod":0.07,"30_day_indicator":7,"60_day_pod":0.08,"60_day_indicator":8,"90_day_pod":0.08,"90_day_indicator":8}]}}},"footprintData":{"description":"A version of a summarisation of companies account details which omits any sensitive data and can be shown to non-CCDS members.","type":"object","properties":{"year":{"type":"object","properties":{"month":{"type":"object","properties":{"loans":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"},"currentAccounts":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"},"all":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"},"creditCards":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"}}}}}},"example":{"2023":{"10":{"loans":{"ActiveAccounts":0,"SettledAccounts":0,"EarliestStartDate":"","LatestStartDate":""},"currentAccounts":{"ActiveAccounts":1,"SettledAccounts":0,"EarliestStartDate":"2012-07-03T00:00:00","LatestStartDate":"2012-07-03T00:00:00"},"all":{"activeAccounts":11,"settledAccounts":1,"earliestStartDate":"2012-07-03T00:00:00","latestStartDate":"2019-09-18T00:00:00"},"creditCards":{"activeAccounts":0,"settledAccounts":0}}}}}}}},"components/schemas/ConnectCcdsFullHistory":{"id":"components/schemas/ConnectCcdsFullHistory","kind":"json-schema","title":"ConnectCcdsFullHistory","data":{"type":"object","properties":{"businessTypeIndicator":{"type":["string","null"]},"businessName":{"type":["string","null"]},"businessAddress":{"$ref":"#/components/schemas/ConnectBankMatchBusinessAddress"},"additionalTradingStyle":{"type":["string","null"]},"businessTelephoneNumber":{"type":["string","null"]},"companyRegistrationNumber":{"type":["string","null"]},"vatNumber":{"type":["string","null"]},"specialInstructionIndicator":{"type":["string","null"]},"startDateOfAgreement":{"type":"string","format":"date-time"},"currentBalance":{"type":"integer","format":"int64"},"currentBalanceCreditIndicator":{"type":["string","null"]},"actualCurrentBalance":{"type":"integer","format":"int64"},"facilityStatus":{"type":["string","null"]},"originalDefaultBalance":{"type":"integer","format":"int64"},"creditOrOverdraftLimit":{"type":"integer","format":"int64"},"flagSettings":{"type":["string","null"]},"transferredToConsolidatedDebtAccount":{"type":["string","null"]},"repaymentPeriod":{"type":"integer","format":"int64"},"paymentAmount":{"type":"integer","format":"int64"},"paymentFrequencyIndicator":{"type":["string","null"]},"numberOfCashAdvances":{"type":"integer","format":"int64"},"valueOfCashAdvances":{"type":"integer","format":"int64"},"minimumBalance":{"type":"integer","format":"int64"},"minimumBalanceCreditIndicator":{"type":["string","null"]},"actualMinimumBalance":{"type":"integer","format":"int64"},"maximumBalance":{"type":"integer","format":"int64"},"maximumBalanceCreditIndicator":{"type":["string","null"]},"actualMaximumBalance":{"type":"integer","format":"int64"},"averageBalance":{"type":"integer","format":"int64"},"averageBalanceCreditIndicator":{"type":["string","null"]},"actualAverageBalance":{"type":"integer","format":"int64"},"creditTurnover":{"type":"integer","format":"int64"},"creditTurnoverNetOrGrossIndicator":{"type":["string","null"]},"debitTurnover":{"type":"integer","format":"int64"},"debitTurnoverNetOrGrossIndicator":{"type":["string","null"]},"rejectedPayments":{"type":"integer","format":"int64"},"maximumDurationOfExcess":{"type":"integer","format":"int64"},"changedfacilitynumber":{"type":"string"},"bankaccountiban":{"type":"string"},"currentAccountReportingLevelIndicator":{"type":["string","null"]},"sourceCode":{"type":"integer","format":"int64"},"facilitynumber":{"type":"string"},"facilityid":{"type":"string"},"identifier":{"type":"string"},"providertype":{"type":"string"},"bankcode":{"type":"string"},"facilityType":{"type":"string"},"facilityTypeCategory":{"type":["string","null"]},"isvalid":{"type":"boolean"},"bank":{"type":"string"},"portfolio":{"type":"string"},"date":{"type":"string"}}}},"components/schemas/ConnectFullFinanceData":{"id":"components/schemas/ConnectFullFinanceData","kind":"json-schema","title":"ConnectFullFinanceData","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"safeNumber":{"description":"Safe Number - Identifier for Companies in Creditsafe's Home Countries.","type":"string","example":"UK07499628"},"creditSafe":{"type":"object","properties":{"creditSafeCompanyId":{"type":"string","example":"NI008172"}}},"overallAggregations":{"type":"object","$ref":"#/components/schemas/ConnectCcdsOverallAggregations"},"history":{"description":"List of accounts connected to the company, snapshot of account at point in time each month.","type":"array","items":{"$ref":"#/components/schemas/ConnectCcdsFullHistory"},"example":[{"businessTypeIndicator":"L","businessName":"TEST COMPANY LIMITED - THE","businessAddress":{"line1":"BRYN HOUSE","line2":"CAERPHILLY BUSINESS PARK","line3":"VAN ROAD","line4":"CARDIFF","line5":"","line6":"","postcode":"CF83 3GG"},"additionalTradingStyle":null,"businessTelephoneNumber":null,"companyRegistrationNumber":"X9999999","vatNumber":null,"specialInstructionIndicator":null,"startDateOfAgreement":"2017-05-15T00:00:00","currentBalance":0,"currentBalanceCreditIndicator":null,"actualCurrentBalance":0,"facilityStatus":"0","originalDefaultBalance":0,"creditOrOverdraftLimit":0,"flagSettings":"","transferredToConsolidatedDebtAccount":null,"repaymentPeriod":0,"paymentAmount":0,"paymentFrequencyIndicator":null,"numberOfCashAdvances":0,"valueOfCashAdvances":0,"minimumBalance":0,"minimumBalanceCreditIndicator":null,"actualMinimumBalance":0,"maximumBalance":0,"maximumBalanceCreditIndicator":null,"actualMaximumBalance":0,"averageBalance":0,"averageBalanceCreditIndicator":null,"actualAverageBalance":0,"creditTurnover":0,"creditTurnoverNetOrGrossIndicator":null,"debitTurnover":0,"debitTurnoverNetOrGrossIndicator":null,"rejectedPayments":0,"maximumDurationOfExcess":0,"changedfacilitynumber":"","bankaccountiban":"0000000000000000000000000000000000","currentAccountReportingLevelIndicator":"","sourceCode":999,"facilitynumber":"00007684-3000701331","facilityid":"999_00007684-3000701331","identifier":"999_00007684-3000701331","providertype":"Bank","bankcode":"TST","facilityType":"32","facilityTypeCategory":"LOAN","isvalid":true,"bank":"TEST","portfolio":"999","date":"20211231"}]},"financialIndicator":{"description":"A version of a summarisation of companies account details which omits any sensitive data and can be shown to non-CCDS members.","type":"object","properties":{"year":{"type":"object","properties":{"month":{"$ref":"#/components/schemas/ConnectCcdsFinancialIndicatorData"}}}},"example":{"2023":{"10":[{"id":"UK1234567890","updated_date":"2020-10-21","30_day_pod":0.07,"30_day_indicator":7,"60_day_pod":0.08,"60_day_indicator":8,"90_day_pod":0.08,"90_day_indicator":8}]}}},"footprintData":{"description":"A version of a summarisation of companies account details which omits any sensitive data and can be shown to non-CCDS members.","type":"object","properties":{"year":{"type":"object","properties":{"month":{"type":"object","properties":{"loans":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"},"currentAccounts":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"},"all":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"},"creditCards":{"$ref":"#/components/schemas/ConnectCcdsFootprintDataFinance"}}}}}},"example":{"2023":{"10":{"loans":{"ActiveAccounts":10,"SettledAccounts":1,"EarliestStartDate":"2016-08-17T00:00:00","LatestStartDate":"2019-09-18T00:00:00"},"currentAccounts":{"ActiveAccounts":1,"SettledAccounts":0,"EarliestStartDate":"2012-07-03T00:00:00","LatestStartDate":"2012-07-03T00:00:00"},"all":{"activeAccounts":11,"settledAccounts":1,"earliestStartDate":"2012-07-03T00:00:00","latestStartDate":"2019-09-18T00:00:00"},"creditCards":{"activeAccounts":0,"settledAccounts":0}}}}}}}},"components/schemas/ConnectIdentityCurrentName":{"id":"components/schemas/ConnectIdentityCurrentName","kind":"json-schema","title":"ConnectIdentityCurrentName","data":{"type":"object","description":"Contains the current name details of the person.","required":["forename","surname"],"properties":{"title":{"type":["string","null"],"description":"The title or honorific of the person (e.g., Mr., Mrs., Dr.)."},"forename":{"type":["string","null"],"description":"The person's first name."},"otherNames":{"type":["string","null"],"description":"Any middle names or additional names the person may have."},"surname":{"type":["string","null"],"description":"The person's family name or last name."},"suffix":{"type":["string","null"],"description":"Suffixes following the surname (e.g., Jr., Sr., III)."}}}},"components/schemas/ConnectIdentityName":{"id":"components/schemas/ConnectIdentityName","kind":"json-schema","title":"ConnectIdentityName","data":{"type":"object","description":"Contains previous name details if the person has changed their name.","properties":{"title":{"type":["string","null"],"description":"The previous title or honorific of the person, if applicable."},"forename":{"type":["string","null"],"description":"The person's previous first name."},"otherNames":{"type":["string","null"],"description":"Any previous middle names or additional names the person may have had."},"surname":{"type":["string","null"],"description":"The person's previous family name or last name."},"suffix":{"type":["string","null"],"description":"Suffixes following the surname (e.g., Jr., Sr., III)."}}}},"components/schemas/ConnectIdentityGender":{"id":"components/schemas/ConnectIdentityGender","kind":"json-schema","title":"ConnectIdentityGender","data":{"description":"Gender of the individual being searched","enum":["Unknown","Male","Female"],"type":"string"}},"components/schemas/ConnectIdentityAddress":{"id":"components/schemas/ConnectIdentityAddress","kind":"json-schema","title":"ConnectIdentityAddress","data":{"type":"object","description":"Address details, including location identifiers and geographical information.","required":["postCode"],"properties":{"abodeNo":{"type":"string","description":"The specific abode number within a building complex or estate."},"buildingNo":{"type":["string","null"],"description":"The number identifying the building within a street or area."},"buildingName":{"type":["string","null"],"description":"The official name of the building, if applicable."},"street":{"type":["string","null"],"description":"The street name where the building is located."},"subStreet":{"type":"string","description":"Any additional street-level details, like a quadrant or alley."},"city":{"type":["string","null"],"description":"The city or locality of the address."},"postCode":{"type":["string","null"],"description":"The postal code for the address, aiding mail delivery and geographic identification."},"organisation":{"type":"string","description":"The name of any organisation associated with the address."},"subBuilding":{"type":"string","description":"Specific information about a part of a building, like a suite or apartment number."},"district":{"type":"string","description":"A broader area or district encompassing the address, often used in urban address schemas."}}}},"components/schemas/ConnectIdentityAddress1":{"id":"components/schemas/ConnectIdentityAddress1","kind":"json-schema","title":"ConnectIdentityAddress1","data":{"type":"object","description":"Contains previous address details, including location identifiers and geographical information.","properties":{"abodeNo":{"type":"string","description":"The specific abode number within a building complex or estate."},"buildingNo":{"type":["string","null"],"description":"The number identifying the building within a street or area."},"buildingName":{"type":["string","null"],"description":"The official name of the building, if applicable."},"street":{"type":["string","null"],"description":"The street name where the building is located."},"subStreet":{"type":"string","description":"Any additional street-level details, like a quadrant or alley."},"city":{"type":["string","null"],"description":"The city or locality of the address."},"postCode":{"type":["string","null"],"description":"The postal code for the address, aiding mail delivery and geographic identification."},"organisation":{"type":"string","description":"The name of any organisation associated with the address."},"subBuilding":{"type":"string","description":"Specific information about a part of a building, like a suite or apartment number."},"district":{"type":"string","description":"A broader area or district encompassing the address, often used in urban address schemas."}}}},"components/schemas/ConnectIdentityAddressList":{"id":"components/schemas/ConnectIdentityAddressList","kind":"json-schema","title":"ConnectIdentityAddressList","data":{"type":"object","description":"Lists current and historical addresses of the person.","properties":{"current":{"$ref":"#/components/schemas/ConnectIdentityAddress"},"previous1":{"$ref":"#/components/schemas/ConnectIdentityAddress1"},"previous2":{"$ref":"#/components/schemas/ConnectIdentityAddress1"}}}},"components/schemas/ConnectIdentityPerson":{"id":"components/schemas/ConnectIdentityPerson","kind":"json-schema","title":"ConnectIdentityPerson","data":{"type":"object","description":"Represents a person's identity, including current and historical names and addresses.","properties":{"currentName":{"$ref":"#/components/schemas/ConnectIdentityCurrentName"},"previousName":{"$ref":"#/components/schemas/ConnectIdentityName"},"dateOfBirth":{"type":["string","null"],"description":"The birth date of the person, in YYYY-MM-DD format.","format":"date-time"},"gender":{"$ref":"#/components/schemas/ConnectIdentityGender"},"addresses":{"$ref":"#/components/schemas/ConnectIdentityAddressList"}}}},"components/schemas/ConnectIdentityCommonSearchCriteria":{"id":"components/schemas/ConnectIdentityCommonSearchCriteria","kind":"json-schema","title":"ConnectIdentityCommonSearchCriteria","data":{"type":"object","description":"General results from the search that are applicable across different types of identity checks.","properties":{"person":{"$ref":"#/components/schemas/ConnectIdentityPerson"},"customerId":{"type":"integer","format":"int64","description":"ID value of a customer account, typically passed in to allow users to retrieve past searches on a customer."},"userId":{"type":"integer","format":"int64","description":"ID value of the user account, a customer account may have multiple user accounts, this is typically passed in to retrieve past searches by a user."},"reference":{"type":["string","null"],"description":"A string value that a user can submit during their search. This reference value is stored alongside the search details/customer/user ID values. Is typically passed in to allow users to retrieve past searches based on the reference value supplied."}}}},"components/schemas/ConnectIdentityAmlSearchCriteria":{"id":"components/schemas/ConnectIdentityAmlSearchCriteria","kind":"json-schema","title":"ConnectIdentityAmlSearchCriteria","data":{"type":"object","description":"Contains information relevant for anti-money laundering (AML) identity verification, including contact details, banking information, and documentation status.","properties":{"landlineNumber":{"type":"integer","description":"The person's landline telephone number. Useful for verification calls or as a contact method."},"ExDirectory":{"type":"boolean","description":"Indicates whether the person's landline number is excluded from public directories, typically for privacy reasons."},"isAMLMultiBureau":{"type":"boolean","description":"Indicates whether multiple bureaus were used for AML verification. True if data from multiple sources was consulted to enhance accuracy.","example":false}}}},"components/schemas/ConnectIdentityProduct":{"id":"components/schemas/ConnectIdentityProduct","kind":"json-schema","title":"ConnectIdentityProduct","data":{"type":"string","example":"AML"}},"components/schemas/ConnectIdentityAMLSearchRequest":{"id":"components/schemas/ConnectIdentityAMLSearchRequest","kind":"json-schema","title":"ConnectIdentityAMLSearchRequest","data":{"type":"object","description":"The input data submitted for the AML search, detailing the information used to initiate the search.","properties":{"uniqueId":{"type":["string","null"],"description":"A unique identifier for the result, distinct from the correlation ID, which may be used internally for further processing or reference."},"common":{"$ref":"#/components/schemas/ConnectIdentityCommonSearchCriteria"},"idAml":{"$ref":"#/components/schemas/ConnectIdentityAmlSearchCriteria"},"products":{"type":["array","null"],"description":"Below is a list of Definitions for the ENUM","items":{"$ref":"#/components/schemas/ConnectIdentityProduct"}}}}},"components/schemas/ConnectIdentityCommonResult":{"id":"components/schemas/ConnectIdentityCommonResult","kind":"json-schema","title":"ConnectIdentityCommonResult","data":{"type":"object","description":"General results from the search that are applicable across different types of identity checks.","properties":{"customerId":{"type":"integer","format":"int64","description":"A unique identifier for the customer who initiated the search. This ID helps in associating the search with a specific customer in the database."},"userId":{"type":"integer","format":"int64","description":"The unique identifier of the user who performed the search. This can be used for audit trails and to track user activity."},"uniqueId":{"type":["string","null"],"description":"An optional unique identifier for the search result, which can be used for referencing and retrieval in subsequent operations."},"searchText":{"type":["string","null"],"description":"The text input provided by the user for the search. This field captures the query terms used in the search process."},"reference":{"type":["string","null"],"description":"A reference code or string that may be used to link this search to other transactions or processes within the system."},"searchTime":{"type":"string","format":"date-time","description":"The exact date and time when the search was executed, recorded in ISO 8601 format. This timestamp is crucial for logging and chronological analysis."}}}},"components/schemas/ConnectIdentitySupplierResult":{"id":"components/schemas/ConnectIdentitySupplierResult","kind":"json-schema","title":"ConnectIdentitySupplierResult","data":{"type":"object","properties":{"success":{"type":"boolean"},"supplierId":{"type":["string","null"]},"supplierOriginalId":{"type":["string","null"]},"creditsIncurred":{"type":"integer","format":"int32"}}}},"components/schemas/ConnectIdentityPicklistInputs":{"id":"components/schemas/ConnectIdentityPicklistInputs","kind":"json-schema","title":"ConnectIdentityPicklistInputs","data":{"type":"object","properties":{"name":{"type":["string","null"]},"address":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityPicklistOption":{"id":"components/schemas/ConnectIdentityPicklistOption","kind":"json-schema","title":"ConnectIdentityPicklistOption","data":{"type":"object","properties":{"option":{"type":["string","null"]},"value":{"type":["string","null"]}}}},"components/schemas/ConnectIdentitypicklist":{"id":"components/schemas/ConnectIdentitypicklist","kind":"json-schema","title":"ConnectIdentitypicklist","data":{"type":"object","properties":{"type":{"type":["string","null"]},"applicantId":{"type":["integer","null"],"format":"int32"},"address":{"type":["string","null"]},"name":{"type":["string","null"]},"inputs":{"$ref":"#/components/schemas/ConnectIdentityPicklistInputs"},"options":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityPicklistOption"}}}}},"components/schemas/ConnectIdentitySearchResult":{"id":"components/schemas/ConnectIdentitySearchResult","kind":"json-schema","title":"ConnectIdentitySearchResult","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"uniqueId":{"type":"string"},"input":{"$ref":"#/components/schemas/ConnectIdentityAMLSearchRequest"},"common":{"$ref":"#/components/schemas/ConnectIdentityCommonResult"},"consumer":{"$ref":"#/components/schemas/ConnectIdentitySupplierResult"},"id":{"$ref":"#/components/schemas/ConnectIdentitySupplierResult"},"amlResult":{"$ref":"#/components/schemas/ConnectIdentitySupplierResult"},"bankMatch":{"$ref":"#/components/schemas/ConnectIdentitySupplierResult"},"picklist":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentitypicklist"}},"message":{"type":["string","null"]},"errors":{"type":["object","null"],"additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"components/schemas/ConnectIdentityBasicErrorResponse":{"id":"components/schemas/ConnectIdentityBasicErrorResponse","kind":"json-schema","title":"ConnectIdentityBasicErrorResponse","data":{"type":"object","properties":{"message":{"type":["string","null"]},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":["string","null"]}}}}}},"components/schemas/ConnectIdentityAmlCommonSearchCriteria":{"id":"components/schemas/ConnectIdentityAmlCommonSearchCriteria","kind":"json-schema","title":"ConnectIdentityAmlCommonSearchCriteria","data":{"type":"object","description":"Person search criteria","properties":{"person":{"$ref":"#/components/schemas/ConnectIdentityPerson"},"reference":{"type":["string","null"],"description":"A string value that a user can submit during their search. This reference value is stored alongside the search details/customer/user ID values. Is typically passed in to allow users to retrieve past searches based on the reference value supplied."}}}},"components/schemas/AMLSearch":{"id":"components/schemas/AMLSearch","kind":"json-schema","title":"AMLSearch","data":{"description":"Search parameters for AML product","type":"object","properties":{"common":{"$ref":"#/components/schemas/ConnectIdentityAmlCommonSearchCriteria"},"idAml":{"type":"object","description":"Contains information relevant for anti-money laundering (AML) identity verification, including contact details, banking information, and documentation status.","properties":{"landlineNumber":{"type":"integer","description":"The person's landline telephone number. Useful for verification calls or as a contact method."},"ExDirectory":{"type":"boolean","description":"Indicates whether the person's landline number is excluded from public directories, typically for privacy reasons."},"Documents":{"type":["string","null"],"description":"Specifies any documents associated with AML procedures. This can include IDs, utility bills, or other proof of address and identity."}}},"products":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AML"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this product search"},"children":[]}]}]}],"example":["AML"],"items":{"type":"string"}}},"example":{"common":{"person":{"currentName":{"title":"","forename":"Doe","otherNames":"","surname":"John","suffix":""},"previousName\"":{"title":null,"forename":null,"otherName\"":null,"surname":null,"suffix":null},"dateOfBirth":"1991-04-05","gender":"Male","addresses":{"current":{"abodeNo":"","buildingNo":"110","buildingName":"","street":"Pierhead Street","subStreet":"","city":"Cardiff","postCode":"CF10 4DQ","organisation":"","subBuilding":"","district":""},"previous1":{"abodeNo":"","buildingNo":"","buildingName":"","street":"","subStreet":"","city":"","postCode":"","organisation":"","subBuilding":"","district":""},"previous2":{"abodeNo":"","buildingNo":"","buildingName":"","street":"","subStreet":"","city":"","postCode":"","organisation":"","subBuilding":"","district":""}}},"reference":"24680"},"idAml":{"LandlineNumber":"","ExDirectory":false,"Documents":null},"products":["AML"],"uniqueId":null}}},"components/schemas/AMLMultiBureauSearch":{"id":"components/schemas/AMLMultiBureauSearch","kind":"json-schema","title":"AMLMultiBureauSearch","data":{"description":"Search parameters for AML product","type":"object","properties":{"common":{"$ref":"#/components/schemas/ConnectIdentityAmlCommonSearchCriteria"},"idAml":{"type":"object","description":"Contains information relevant for anti-money laundering (AML) identity verification, including contact details, banking information, and documentation status.","properties":{"landlineNumber":{"type":"integer","description":"The person's landline telephone number. Useful for verification calls or as a contact method."},"exDirectory":{"type":"boolean","description":"Indicates whether the person's landline number is excluded from public directories, typically for privacy reasons."},"sortCode":{"type":"integer","description":"The person's bank account sort code. Useful for verifying bank account ownership and identity."},"bankAccountNumber":{"type":"integer","description":"The person's bank account number. Useful for verifying bank account ownership and identity."},"isAmlMultiBureau":{"type":"boolean","description":"Indicates whether multiple bureaus were used for AML verification. True if data from multiple sources was consulted to enhance accuracy."},"documents":{"type":["string","null"],"description":"Specifies any documents associated with AML procedures. This can include IDs, utility bills, or other proof of address and identity."}}},"products":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AML"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this product search"},"children":[]}]}]}],"example":["AML"],"items":{"type":"string"}}},"example":{"common":{"person":{"currentName":{"title":"","forename":"Doe","otherNames":"","surname":"John","suffix":""},"previousName\"":{"title":null,"forename":null,"otherName\"":null,"surname":null,"suffix":null},"dateOfBirth":"1991-04-05","gender":"Unknown","addresses":{"current":{"abodeNo":"","buildingNo":"110","buildingName":"","street":"Pierhead Street","subStreet":"","city":"Cardiff","postCode":"CF10 4DQ","organisation":"","subBuilding":"","district":""},"previous1":{"abodeNo":"","buildingNo":"","buildingName":"","street":"","subStreet":"","city":"","postCode":"","organisation":"","subBuilding":"","district":""},"previous2":{"abodeNo":"","buildingNo":"","buildingName":"","street":"","subStreet":"","city":"","postCode":"","organisation":"","subBuilding":"","district":""}}},"reference":"24680"},"idAml":{"landlineNumber":1234123456,"exDirectory":false,"isAmlMultiBureau":true,"Documents":null},"products":["AML"],"uniqueId":null}}},"components/schemas/ConnectIdentityReasonCode":{"id":"components/schemas/ConnectIdentityReasonCode","kind":"json-schema","title":"ConnectIdentityReasonCode","data":{"description":"List of definitions for potential reason codes","enum":["AddressVerification","BusinessSearch","CreditApplication","DebtCollection","DirectorsSearch","QuotationSearch","EmployeeCheck","TenantVet","GeneralInsurance"],"type":"string"}},"components/schemas/ConnectIdentityConsumerSearchCriteria":{"id":"components/schemas/ConnectIdentityConsumerSearchCriteria","kind":"json-schema","title":"ConnectIdentityConsumerSearchCriteria","data":{"type":"object","required":["reason"],"properties":{"reason":{"$ref":"#/components/schemas/ConnectIdentityReasonCode"},"thirdPartyOptIn":{"description":"Is always set to false on ID/AML/Bankmatch searches. Can be set to true on Consumer searches if need be. If true, does an additional charge against the user account to allow for more data coverage.","type":"boolean"},"addressLink":{"type":"boolean"},"associateLink":{"type":"boolean"}}}},"components/schemas/ConsumerSearch":{"id":"components/schemas/ConsumerSearch","kind":"json-schema","title":"ConsumerSearch","data":{"description":"Search parameters for a consumer product","type":"object","properties":{"common":{"description":"Person search criteria","type":"object","properties":{"person":{"$ref":"#/components/schemas/ConnectIdentityPerson"},"reference":{"type":["string","null"],"description":"A string value that a user can submit during their search. This reference value is stored alongside the search details/customer/user ID values. Is typically passed in to allow users to retrieve past searches based on the reference value supplied."}}},"consumer":{"description":"Consumer Specific Search Criteria","allOf":[{"$ref":"#/components/schemas/ConnectIdentityConsumerSearchCriteria"}]},"products":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Consumer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this product search"},"children":[]}]}]}],"type":"array","items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Consumer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this product search"},"children":[]}]}]}],"example":"consumer"}}},"example":{"common":{"person":{"currentName":{"title":"Miss","forename":"Anne","otherNames":"","surname":"Delta","suffix":""},"previousName":{"title":"Miss","forename":"Anne","otherNames":"","surname":"Alpha","suffix":""},"dateOfBirth":"1948-06-04","gender":"Female","addresses":{"current":{"buildingNo":"7","buildingName":"","street":"Twelve Acre Cresent","city":"Barton-Le-Willows","postCode":"X9 8JD","startDate":"2010-05-13","endDate":""},"previous1":{"buildingNo":"6","buildingName":"","street":"Twelve Acre Cresent","city":"Barton-Le-Willows","postCode":"X9 8JD","startDate":"2012-05-08","endDate":"2013-05-08"},"previous2":{"buildingNo":"1","buildingName":"","street":"Twelve Acre Cresent","city":"Barton-Le-Willows","postCode":"X9 8JD","startDate":"2010-05-13","endDate":"2012-05-08"}}},"reference":"Test - Consumer Search"},"consumer":{"reason":"QuotationSearch","thirdPartyOptIn":false},"products":["Consumer"]}}},"components/schemas/consumerCommonName":{"id":"components/schemas/consumerCommonName","kind":"json-schema","title":"consumerCommonName","data":{"type":"object","properties":{"title":{"type":"string","example":"Miss"},"forename":{"type":"string","example":"Anne"},"otherNames":{"type":"string","example":""},"surname":{"type":"string","example":"Delta"},"suffix":{"type":"string","example":""}}}},"components/schemas/consumerCommonCurrentAddress":{"id":"components/schemas/consumerCommonCurrentAddress","kind":"json-schema","title":"consumerCommonCurrentAddress","data":{"type":"object","properties":{"buildingNo":{"type":"string","example":"7"},"buildingName":{"type":"string","example":""},"street":{"type":"string","example":"Twelve Acre Crescent"},"city":{"type":"string","example":"Barton-Le-Willows"},"postCode":{"type":"string","example":"X9 8JD"},"startDate":{"type":"string","format":"date-time","example":"2010-05-13T00:00:00"}}}},"components/schemas/consumerCommonAddress":{"id":"components/schemas/consumerCommonAddress","kind":"json-schema","title":"consumerCommonAddress","data":{"type":"object","properties":{"buildingNo":{"type":"string","example":"7"},"buildingName":{"type":"string","example":""},"street":{"type":"string","example":"Twelve Acre Crescent"},"city":{"type":"string","example":"Barton-Le-Willows"},"postCode":{"type":"string","example":"X9 8JD"},"startDate":{"type":"string","format":"date-time","example":"2010-05-13T00:00:00"},"endDate":{"type":"string","format":"date-time","example":"2010-05-13T00:00:00"}}}},"components/schemas/consumerResultReportSummary":{"id":"components/schemas/consumerResultReportSummary","kind":"json-schema","title":"consumerResultReportSummary","data":{"type":"object","properties":{"matchedData":{"type":"array","items":{"type":"object","properties":{"dateOfBirth":{"type":"string","format":"date-time","example":"1974-07-07T00:00:00"},"name":{"type":"string","example":"MS SARAH HAWKINS"},"addressLine1":{"type":"string","example":"6 HAZELTREE COURT"},"addressLine2":{"type":"string","example":""},"addressLine3":{"type":"string","example":"TROWBRIDGE"},"addressLine4":{"type":"string","example":"BA99 7SZ"},"isSelected":{"type":"boolean","example":true}}}},"matchLevel":{"type":"string","example":"Individual report"},"noticesOfCorrections":{"type":"boolean","example":true},"totalDisputes":{"type":"integer","example":0},"confirmedAddress":{"type":"string","example":"6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ"},"residency":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"currentAddress":{"type":"boolean"},"id":{"type":"integer"},"message":{"type":"string"},"undeclaredAddressType":{"type":"integer"}}},"example":[{"address":"6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ","currentAddress":true,"id":1,"message":"Individual confirmed using the Electoral Roll."},{"address":"28 SUGAR TERRACE, BRIGHTON, BN99 2TR","currentAddress":false,"id":2,"message":"Individual confirmed using a previous Electoral Roll."},{"address":"13 FISKERTON LANE, BRIGHTON, BN99 5BX","currentAddress":false,"id":2,"message":"Individual confirmed using credit data.","undeclaredAddressType":3}]},"creditSearchesAtCurrentAddress":{"type":"object","properties":{"numberInLast3Months":{"type":"integer","example":3},"numberInLast12Months":{"type":"integer","example":12},"totalinLast3Months":{"type":"integer","example":3000}}},"insolvencyAtAddress":{"type":"object","properties":{"restricted":{"type":"boolean","example":false},"currentlyInsolvent":{"type":"boolean","example":true},"totalDischarged":{"type":"integer","example":4}}},"links":{"type":"object","properties":{"undeclaredAddressCount":{"type":"integer","example":1},"undeclaredAliasCount":{"type":"integer","example":1},"undeclaredAssociatesCount":{"type":"integer","example":1},"undeclaredAddressSearchedCount":{"type":"integer","example":1},"undeclaredAddressUnsearchedCount":{"type":"integer","example":0}}},"judgements":{"type":"object","properties":{"totalActive":{"type":"integer","example":2},"totalSatisfied":{"type":"integer","example":10},"totalActiveAmount":{"type":"integer","example":28675}}},"totalCifas":{"type":"integer","example":0},"rtr":{"type":"boolean","example":true},"impairedCreditHistory":{"type":"object","properties":{"impairedCredit":{"type":"boolean","example":true},"secured":{"type":"boolean","example":false},"unsecured":{"type":"boolean","example":false},"judgement":{"type":"boolean","example":true},"individualVoluntaryAgreement":{"type":"boolean","example":true},"bankruptcy":{"type":"boolean","example":true}}},"thirdParty":{"type":"object","properties":{"alertDecision":{"type":"integer","example":3},"alertReview":{"type":"integer","example":2},"householdOverride":{"type":"integer","example":1}}},"address":{"type":"object","properties":{"paf":{"type":"boolean","example":true},"rollingRoll":{"type":"boolean","example":true},"message":{"type":"string","example":"11"}}},"cardData":{"type":"object","properties":{"totalMinPayments12Months":{"type":"integer","example":2},"totalMinPayments36Months":{"type":"integer","example":2},"totalCashAdvance12Months":{"type":"integer","example":400},"totalCashAdvance36Months":{"type":"integer","example":1200}}}}}},"components/schemas/consumerResultElectoralRollHistory":{"id":"components/schemas/consumerResultElectoralRollHistory","kind":"json-schema","title":"consumerResultElectoralRollHistory","data":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","example":"016-09-01T00:00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-09-01T00:00:00"},"optOut":{"type":"boolean","example":false},"rollingRoll":{"type":"boolean","example":false}}}},"components/schemas/consumerResultLinksUndeclaredAddresses":{"id":"components/schemas/consumerResultLinksUndeclaredAddresses","kind":"json-schema","title":"consumerResultLinksUndeclaredAddresses","data":{"type":"object","properties":{"undeclaredAddress":{"type":"string","example":"21 JAMES COURT, BATH, BA99 3UP"},"undeclaredAddressTo":{"type":"string","example":"6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ"},"lastConfirmation":{"type":"string","format":"date-time","example":"2004-01-01T00:00:00"},"earliestConfirmation":{"type":"string","format":"date-time","example":"2004-01-01T00:00:00"},"supplierDetails":{"type":"object","properties":{"supplierName":{"type":"string","example":"Building Society Name"},"supplierType":{"type":"string","example":"Building Society"}}}}}},"components/schemas/consumerResultLinkAliases":{"id":"components/schemas/consumerResultLinkAliases","kind":"json-schema","title":"consumerResultLinkAliases","data":{"type":"object","properties":{"declared":{"type":"boolean","example":false},"name":{"type":"string","example":"MS SARAH HAWKINS"},"alias":{"type":"string","example":"MS SARAH WATTS"},"creationDate":{"type":"string","format":"date-time","example":"2021-01-01T00:00:00"},"lastConfirmation":{"type":"string","format":"date-time","example":"2021-01-01T00:00:00"},"supplierDetails":{"type":"object","properties":{"supplierName":{"type":"string","example":"Building Society Name"},"supplierType":{"type":"string","example":"Building Society"}}}}}},"components/schemas/consumerResultLinkAssociates":{"id":"components/schemas/consumerResultLinkAssociates","kind":"json-schema","title":"consumerResultLinkAssociates","data":{"type":"object","properties":{"navigationLinkId":{"type":"string","example":"testid"},"name":{"type":"string","example":"MR MICHAEL WATTS"},"creationDate":{"type":"string","format":"date-time","example":"2021-01-01T00:00:00"},"lastConfirmation":{"type":"string","format":"date-time","example":"2021-01-01T00:00:00"},"supplierDetails":{"type":"object","properties":{"supplierName":{"type":"string","example":"Building Society Name"},"supplierType":{"type":"string","example":"Building Society"}}},"declared":{"type":"boolean","example":false}}}},"components/schemas/consumerResultInsolvencies":{"id":"components/schemas/consumerResultInsolvencies","kind":"json-schema","title":"consumerResultInsolvencies","data":{"type":"object","properties":{"address":{"type":"object","properties":{"address":{"type":"string","example":"6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ"},"isCurrent":{"type":"boolean","example":true},"undeclaredAddressType":{"type":"string","example":""}}},"court":{"type":"string","example":"Bath County Court"},"name":{"type":"string","example":"MS SARAH HAWKINS"},"orderDate":{"type":"string","format":"date-time","example":"2016-06-17T00:00:00"},"orderTypeCode":{"type":"string","example":"BO"},"orderType":{"type":"string","example":"Bankruptcy Order"},"status":{"type":"string","example":"Active"},"statusCode":{"type":"string","example":"A"},"tradingName":{"type":"string","example":""},"lineOfBusiness":{"type":"string","example":"Unknown"},"amount":{"type":"integer","example":10000},"caseYear":{"type":"integer","example":2016},"caseRef":{"type":"string","example":"TEST2"},"dateOfBirth":{"type":"string","format":"date-time","example":"1974-07-07T00:00:00"},"restriction":{"type":"object","properties":{"type":{"type":"string","example":"Bankruptcy Restriction Order"},"startDate":{"type":"string","format":"date-time","example":"2016-06-17T00:00:00"},"endDate":{"type":"string","format":"date-time","example":"2025-08-15T00:00:00"}}}}}},"components/schemas/consumerResultJudgements":{"id":"components/schemas/consumerResultJudgements","kind":"json-schema","title":"consumerResultJudgements","data":{"type":"object","properties":{"name":{"type":"string","example":"MS SARAH HAWKINS"},"address":{"type":"object","properties":{"address":{"type":"string","example":"6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ"},"isCurrent":{"type":"boolean","example":true}}},"addressCurrent":{"type":"boolean","example":false},"dateOfBirth":{"type":"string","format":"date-time","example":"1974-07-07T00:00:00"},"judgementDate":{"type":"string","format":"date-time","example":"2019-03-05T00:00:00"},"amount":{"type":"integer","example":21196},"status":{"type":"string","example":"Active"},"court":{"type":"string","example":"Bath County Court"},"courtType":{"type":"string","example":"County Court Judgment"},"caseNumber":{"type":"string","example":"BCT11081"},"satisfiedDate":{"type":["string","null"],"format":"date-time","example":"2016-11-29T00:00:00"}}}},"components/schemas/consumerResultHistory":{"id":"components/schemas/consumerResultHistory","kind":"json-schema","title":"consumerResultHistory","data":{"type":"object","properties":{"address":{"type":"object","properties":{"address":{"type":"string","example":"6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ"},"isCurrent":{"type":"boolean","example":false}}},"balance":{"type":"integer","example":10000},"dateOfBirth":{"type":"string","format":"date-time","example":"1974-07-07T00:00:00"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00"},"endDate":{"type":"string","format":"date-time","example":"2021-01-01T00:00:00"},"jointApplication":{"type":"boolean","example":true},"name":{"type":"string","example":"MS SARAH HAWKINS"},"tpOptIn":{"type":"boolean","example":true},"ownSearch":{"type":"boolean","example":false},"reason":{"type":"string","example":"Address Verification"},"reference":{"type":"string","example":"Some reference"},"supplierReference":{"type":"string","example":"{XXXX-XXXX-XXX}"},"subsequentEnquiry":{"type":"boolean","example":false},"term":{"type":"integer","example":12},"transient":{"type":"boolean","example":true},"creditType":{"type":"string","example":"Hire Purchase"},"userName":{"type":"string","example":"placeholder"},"searchDate":{"type":"string","format":"date-time","example":"2021-01-05T00:00:00"},"searchUnitName":{"type":"string","example":"Creditsafe Business Solutions"},"searchOrganisationName":{"type":"string","example":"Creditsafe Business Solutions"},"searchOrganisationType":{"type":"string","example":"Finance House"}}}},"components/schemas/consumerResultNotices":{"id":"components/schemas/consumerResultNotices","kind":"json-schema","title":"consumerResultNotices","data":{"type":"object","properties":{"name":{"type":"string","example":"MS SARAH HAWKINS"},"address":{"type":"object","properties":{"address":{"type":"string","example":"6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ"},"isCurrent":{"type":"boolean","example":true}}},"reference":{"type":"string","example":"12356"},"comment":{"type":"string","example":"I, Sarah Hawkins, am a test record and have no identity. Please do not lend me money as I do not exist."},"dateRaised":{"type":"string","format":"date-time","example":"2019-12-14T00:00:00"}}}},"components/schemas/ConnectIdentityConsumerSearchResult":{"id":"components/schemas/ConnectIdentityConsumerSearchResult","kind":"json-schema","title":"ConnectIdentityConsumerSearchResult","data":{"type":"object","properties":{"correlationId":{"type":"string","example":"a2093b41-b7fe-4973-8eba-78f3627168a7","description":"A unique identifier for tracking the request across systems."},"uniqueId":{"type":"string","example":"43d27878fa4b4e74b336a6c1b21d690d","description":"A unique identifier for the specific search request."},"input":{"type":"object","description":"Contains the input parameters used for the search request.","properties":{"uniqueId":{"type":"string","example":"43d27878fa4b4e74b336a6c1b21d690d","description":"A unique identifier for the input data."},"common":{"type":"object","description":"Common input details for the search request.","properties":{"person":{"type":"object","description":"Details about the person being searched.","properties":{"currentName":{"$ref":"#/components/schemas/consumerCommonName"},"previousName":{"$ref":"#/components/schemas/consumerCommonName"},"dateOfBirth":{"type":"string","format":"date-time","example":"1948-06-04T00:00:00","description":"The date of birth of the person being searched."},"gender":{"type":"string","example":"Female","description":"The gender of the person being searched."},"addresses":{"type":"object","description":"Address details for the person being searched.","properties":{"current":{"$ref":"#/components/schemas/consumerCommonCurrentAddress"},"previous1":{"$ref":"#/components/schemas/consumerCommonAddress"},"previous2":{"$ref":"#/components/schemas/consumerCommonAddress"}}}}},"customerId":{"type":"integer","example":106828872},"userId":{"type":"integer","example":101686746},"reference":{"type":"string","example":"Test - Consumer Search"}}},"consumer":{"type":"object","properties":{"noOfAddresses":{"type":"integer","example":2},"reason":{"type":"string","example":"QuotationSearch"},"thirdPartyOptIn":{"type":"boolean","example":false},"addressLink":{"type":"boolean","example":false},"associateLink":{"type":"boolean","example":false}}},"products":{"type":"array","items":{"type":"string","example":"Consumer"}}}},"common":{"type":"object","properties":{"customerId":{"type":"integer","example":106828872},"userId":{"type":"integer","example":101686746},"uniqueId":{"type":"string","example":"43d27878fa4b4e74b336a6c1b21d690d"},"searchText":{"type":"string","example":"Miss Anne Delta (4/06/1948) X9 8JD"},"reference":{"type":"string","example":"Test - Consumer Search"},"searchTime":{"type":"string","format":"date-time","example":"024-04-23T11:19:35.180004+00:00"}}},"pickList":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of potential consumer results when more than one match is found."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This property will not appear if only one result is returned."},"children":[]}]}]}]}],"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of result returned."},"applicantId":{"type":"integer","description":"A unique identifier for the applicant."},"address":{"type":"string","description":"The address of the applicant."},"name":{"type":"string","description":"The name of the applicant."},"inputs":{"type":"object","description":"Input details used for the search.","properties":{"name":{"type":"string","description":"The name input used for the search."}}},"options":{"type":"array","description":"Additional options related to the applicant. This information will need to be passed into the 'Resolve PickList' endpoint.","items":{"type":"object","properties":{"option":{"type":"string","example":"1:1:1_0","description":"A code representing the option type."},"value":{"type":"string","example":"MR HENRY BULLDOG","description":"The value associated with the option."},"dateOfBirth":{"type":"string","format":"date","example":"1948-06-04","description":"The date of birth of the applicant."}}}}}}},"consumerResult":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the result of the consumer search when exactly one match is found."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This property will not appear if multiple results are returned; in that case, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pickList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property will be present instead."},"children":[]}]}]}],"type":"object","properties":{"applicant1Report":{"type":"object","description":"The report details for the matched applicant.","properties":{"reportTitle":{"type":"string","example":"MS SARAH HAWKINS","description":"The title of the report."},"reportType":{"type":"string","example":"Individual report","description":"The type of report generated."},"summary":{"$ref":"#/components/schemas/consumerResultReportSummary"},"score":{"type":"object","description":"The scoring details for the applicant.","properties":{"band":{"type":"integer","example":2,"description":"The score band for the applicant."},"version":{"type":"string","example":"G1","description":"The version of the scoring model used."},"score":{"type":"integer","example":542,"description":"The score assigned to the applicant."}}},"address":{"type":"object","description":"The current address of the applicant.","properties":{"address":{"type":"string","example":"6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ","description":"The address of the applicant."},"isCurrent":{"type":"boolean","example":true,"description":"Indicates whether this is the applicant's current address."},"residents":{"type":"array","description":"Details of residents at the address.","items":{"type":"object","properties":{"matchType":{"type":"string","example":"House Match","description":"The type of match found for the resident."},"name":{"type":"string","example":"MR MICHAEL WATTS","description":"The name of the resident."},"duration":{"type":"string","example":"P52M","description":"The duration of residence at the address."},"startDate":{"type":"string","format":"date-time","example":"2016-09-01T00:00:00","description":"The start date of residence."},"endDate":{"type":"string","format":"date-time","example":"2020-09-01T00:00:00","description":"The end date of residence."},"electoralRollValid":{"type":"boolean","example":true,"description":"Indicates whether the resident is listed on the electoral roll."}}}}}},"previousAddress1":{"type":"object","properties":{"address":{"type":"string","example":"6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ"},"isCurrent":{"type":"boolean","example":true},"residents":{"type":"array","items":{"type":"object","properties":{"matchType":{"type":"string","example":"House Match"},"name":{"type":"string","example":"MR MICHAEL WATTS"},"duration":{"type":"string","example":"P52M"},"startDate":{"type":"string","format":"date-time","example":"2016-09-01T00:00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-09-01T00:00:00"},"electoralRollValid":{"type":"boolean","example":true},"electoralRollHistory":{"type":"array","items":{"$ref":"#/components/schemas/consumerResultElectoralRollHistory"}}}}},"undeclaredAddressType":{"type":"string","example":"Undeclared previous Address Link"}}},"previousAddress2":{"type":"object","properties":{"address":{"type":"string","example":"6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ"},"isCurrent":{"type":"boolean","example":true},"residents":{"type":"array","items":{"type":"object","properties":{"matchType":{"type":"string","example":"House Match"},"name":{"type":"string","example":"MR MICHAEL WATTS"},"duration":{"type":"string","example":"P52M"},"startDate":{"type":"string","format":"date-time","example":"2016-09-01T00:00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-09-01T00:00:00"},"electoralRollValid":{"type":"boolean","example":true},"electoralRollHistory":{"type":"array","items":{"$ref":"#/components/schemas/consumerResultElectoralRollHistory"}}}}},"undeclaredAddressType":{"type":"string","example":"Undeclared previous Address Link"}}},"links":{"type":"object","properties":{"undeclaredAddresses":{"type":"array","items":{"$ref":"#/components/schemas/consumerResultLinksUndeclaredAddresses"}},"aliases":{"type":"array","items":{"$ref":"#/components/schemas/consumerResultLinkAliases"}},"associates":{"type":"array","items":{"$ref":"#/components/schemas/consumerResultLinkAssociates"}}}},"insolvencies":{"type":"array","items":{"$ref":"#/components/schemas/consumerResultInsolvencies"}},"judgements":{"type":"array","items":{"$ref":"#/components/schemas/consumerResultJudgements"}},"history":{"type":"array","items":{"$ref":"#/components/schemas/consumerResultHistory"}},"notices":{"type":"array","items":{"$ref":"#/components/schemas/consumerResultNotices"}},"demographics":{"type":"object","properties":{"cameoCode":{"type":"string","example":"01C"},"cameoInvestorCode":{"type":"string","example":"56"},"cameoIncomeCode":{"type":"string","example":"36"},"cameoUnemploymentCode":{"type":"string","example":"09"},"cameoPropertyCode":{"type":"string","example":"06"},"cameoFinanceCode":{"type":"string","example":"66"},"cameoFinanceGroup":{"type":"string","example":"6"},"cameoIncomeGroup":{"type":"string","example":"3"},"cameoInvestmentGroup":{"type":"string","example":"5"},"cameoGroup":{"type":"string","example":"01"},"ageComposition":{"type":"object","properties":{"description":{"type":"string","description":"This score describes the age structure of the postcode. A high score describes postcodes with a young age profile, whereas a low score describes an old profile."},"label":{"type":"string","example":"Score:"},"score":{"type":"string","example":"96.42 / 100"}}},"economicActivityComposition":{"type":"object","properties":{"description":{"type":"string","description":"This score describes the the level of economically active individuals within the area. A high score describes postcodes with a high proportion of the population being economically inactive, whereas a low score indicates an area with above average economical activity."},"label":{"type":"string","example":"Score:"},"score":{"type":"string","example":"83.98 / 100"}}},"hasValues":{"type":"boolean","example":true},"householdComposition":{"type":"object","properties":{"description":{"type":"string","description":"This score describes the household composition of the postcode. A high score describes postcodes with a high proportion of families present, whereas a low score describes an area with high proportions of single person homes."},"label":{"type":"string","example":"Score:"},"score":{"type":"string","example":"8.03 / 100"}}},"lifestageComposition":{"type":"object","properties":{"description":{"type":"string","description":"This score describes the lifestage within the area. A high score describes postcodes with a high proportion of the population being married, whereas a low score indicated an area with above average proportion of singles."},"label":{"type":"string","example":"Score:"},"score":{"type":"string","example":"12.25 / 100"}}},"mortgageComposition":{"type":"object","properties":{"description":{"type":"string","description":"This score describes the proportion and size of the houses within the area. A high score indicates a postcode with a large proportion of the houses being larger than average and mostly owned outright, whereas a low score indicates smaller houses that are not owned by their occupiers."},"label":{"type":"string","example":"Score:"},"score":{"type":"string","example":"4.17 / 100"}}},"neighbourhoodDefinition":{"type":"object","properties":{"financeGroup":{"type":"string","example":"Above Average Risk"},"financeGroupHouseholdPerc":{"type":"string","example":"18.41"},"income":{"type":"string","example":"Young Managers & Professionals"},"incomeGroup":{"type":"string","example":"Many households with an income of between £50 - £75K"},"investorHouseholdPerc":{"type":"string","example":"19.73"},"investorIndex":{"type":"string","example":"38 - 76"},"riskFactor":{"type":"string","example":"20% - 36%"},"uk":{"type":"string","example":"Urban Living Professional Singles & Couples"},"ukGroup":{"type":"string","example":"Affluent Singles & Couples In Exclusive Urban Neighbourhoods"},"ukHouseholdPerc":{"type":"string","example":"3.47"},"description":{"type":"string"}}},"occupationComposition":{"type":"object","properties":{"description":{"type":"string","description":"This score describes the occupational composition within the area. A high score indicates a postcode with a large proportion of the population working in professional and managerial positions, whereas a low score indicates a population working in elementary occupations."},"label":{"type":"string","example":"Score:"},"score":{"type":"string","example":"88.57 / 100"}}},"propertyComposition":{"type":"object","properties":{"activity":{"type":"integer","example":168},"averageDetachedPropertyValue":{"type":"string","example":"£213630"},"averageDetachedPropertyValueDescription":{"type":"string"},"averageDetachedPropertyIndex":{"type":"integer","example":120},"averageFlatPropertyValue":{"type":"string","example":"£74000"},"averageFlatPropertyIndex":{"type":"integer","example":100},"averageHouseAge":{"type":"string","example":"16+"},"averageSemiDetachedPropertyValue":{"type":"string","example":"£130636"},"averageSemiDetachedPropertyValueDescription":{"type":"string"},"averageSemiDetachedPropertyIndex":{"type":"integer","example":80},"averageTerracePropertyValue":{"type":"string","example":"£106269"},"averageTerracePropertyValueDescription":{"type":"string"},"averageTerracePropertyIndex":{"type":"integer","example":1158},"councilTaxBand":{"type":"string","example":"E"},"councilTaxBandDescription":{"type":"string"},"householdDensity":{"type":"string","example":"2000.12 per square kilometre"},"locationType":{"type":"string","example":"a small town"},"nationalAverageHousePrice":{"type":"string","example":"£161361"},"nationalAverageHousePriceAboveOrBelow":{"type":"string","example":"below"},"nationalAverageHousePriceDifference":{"type":"string","example":"increased"},"nationalAverageHousePriceIndex":{"type":"integer","example":349996},"averageFlatPropertyValueDescription":{"type":"string"}}},"shareholderComposition":{"type":"object","properties":{"averageInvestments":{"type":"string","example":"0.31"},"averageInvestmentsDescription":{"type":"string","description":"This is a standardized score between -1 and 1, where a score greater than 0 represents an above average of companies invested in within in the postcode, and vice-versa."},"averageInvestmentsLabel":{"type":"string","example":"Investments:"},"averageShareholders":{"type":"string","example":"0.71"},"averageShareholdersDescription":{"type":"string","description":"This is a standardized score between -1 and 1, where a score greater than 0 represents an above average of individuals with shares relative to the number of households in the postcode, and vice-versa."},"averageShareholdersLabel":{"type":"string","example":"Shareholders:"},"averageShares":{"type":"string","example":"-0.02"},"averageSharesDescription":{"type":"string","description":"This is a standardized score between -1 and 1, where a score greater than 0 represents an above average levels of shares held, and vice-versa."},"averageSharesLabel":{"type":"string","example":"Shares:"},"averageValue":{"type":"string","example":"-0.01"},"averageValueDescription":{"type":"string","description":"This is a standardized score between -1 and 1, where a score greater than 0 represents an above average value, and vice-versa."},"averageValueLabel":{"type":"string","example":"Value:"},"proportionOfHouseholdsWithShares":{"type":"string","example":"-0.08"},"proportionOfHouseholdsWithSharesDescription":{"type":"string","description":"This is a standardized score between -1 and 1, where a score greater than 0 represents an above average levels of share-ownership, and vice-versa."},"proportionOfHouseholdsWithSharesLabel":{"type":"string","example":"Households:"},"socialClassComposition":{"type":"object","properties":{"description":{"type":"string","description":"This score describes the social class composition within the area. A high score indicates a postcode with a large proportion of the population being classed as AB, whereas a low score indicates a population classified in the lower social groups."},"label":{"type":"string","example":"Score:"},"score":{"type":"string","example":"58.27 / 100"}}},"tenureComposition":{"type":"object","properties":{"description":{"type":"string","description":"This score describes the housing tenure of the postcode. A high score describes postcodes with a high proportion of houses owned outright, whereas a low score decribes an area with high proportions of Local Authority rented properties."},"label":{"type":"string","example":"Score:"},"score":{"type":"string","example":"97.12 / 100"}}},"unemploymentComposition":{"type":"object","properties":{"maleLongTermUnemploymentDescription":{"type":"string","description":"This rate is a measure of unemployment for males within the post sector, the rate is based on a per thousand basis. Long-term unemployment is most strongly associated with extreme poverty."},"maleLongTermUnemploymentLabel":{"type":"string","example":"Male Long-Term:"},"unemploymentAmong18to24YearOlds":{"type":"string","example":"0.00"},"unemploymentAmong18to24YearOldsDescription":{"type":"string","description":"This rate is a measure of unemployment for 18 to 24 year olds within the post sector, the rate is based on a per thousand basis."},"unemploymentAmong18to24YearOldsLabel":{"type":"string","example":"18 to 24 Year Olds:"},"unemploymentAmong25to39YearOlds":{"type":"string","example":"15.99"},"unemploymentAmong25to39YearOldsDescription":{"type":"string","description":"This rate is a measure of unemployment for 25 to 39 year olds within the post sector, the rate is based on a per thousand basis."},"unemploymentAmong25to39YearOldsLabel":{"type":"string","example":"25 to 39 Year Olds:"},"unemploymentAmongThoseAged40andOlder":{"type":"string","example":"15.99"},"unemploymentAmongThoseAged40andOlderDescription":{"type":"string","description":"This rate is a measure of unemployment for 40 year olds and older within the post sector, the rate is based on a per thousand basis."},"unemploymentAmongThoseAged40andOlderLabel":{"type":"string","example":"40 and Older:"},"unemploymentScoreLabel":{"type":"string","example":"Score:"},"unemploymentScoreDescription":{"type":"string","description":"This score describes the level of unemployment and economic inactivity within the area. A high score indicates a postcode with a large proportion of the population being unemployed and inactive, whereas a low score indicates a below average rate."},"unemploymentScore":{"type":"string","example":"77.36"},"maleLongTermUnemploymentScore":{"type":"string","example":"5.33"}}}}}}},"share":{"type":"object","properties":{"summary":{"type":"object","properties":{"accountCount":{"type":"integer","example":7},"activeAccountCount":{"type":"integer","example":6},"settledAccountCount":{"type":"integer","example":1},"accountsOpenedLast6Months":{"type":"integer","example":2},"delinquentAccountsLast12Months":{"type":"integer","example":0},"defaultsLast12MonthsCount":{"type":"integer","example":0},"defaultsLast36MonthsCount":{"type":"integer","example":0}}},"accounts":{"type":"array","items":{"type":"object","properties":{"supplierDetails":{"type":"object","properties":{"supplierType":{"type":"string","example":"Current Account"},"supplierTypeCode":{"type":"string","example":"CA"}}},"history":{"type":"array","items":{"type":"object","properties":{"yearAndMonth":{"type":"string","example":"2013-07"},"balance":{"type":"integer","example":0},"limit":{"type":"integer","example":500},"status":{"type":"string","example":"Okay - (repayment requirements fulfilled)"},"statusCode":{"type":"string","example":"OK"},"paymentStatus":{"type":"string","example":"Account up-to-date or less than the equivalent of one PAE(payment arrears equivalent) in arrears"},"paymentStatusCode":{"type":"string","example":"0"}}}},"holderDetails":{"type":"object","properties":{"name":{"type":"string","example":"Sarah Hawkins"},"address":{"type":"object","properties":{"address":{"type":"string","example":"6 Hazeltree Court, Trowbridge, BA99 7SZ"},"isCurrent":{"type":"boolean","example":true},"undeclaredAddressType":{"type":"string","example":"Unknown"}}},"dateOfBirth":{"type":"string","format":"date-time","example":"1974-07-07T00:00:00"},"status":{"type":"string","example":"Normal"},"startDate":{"type":"string","format":"date-time","example":"2013-04-12T00:00:00"},"endDate":{"type":"string","format":"date-time","example":"2018-01-01T00:00:00"}}},"details":{"type":"object","properties":{"accountNumber":{"type":"string","example":"123456"},"accountSuffix":{"type":"string","example":"Unknown"},"joint":{"type":"boolean","example":false},"status":{"type":"string","example":"Normal"},"dateUpdated":{"type":"string","format":"date-time","example":"2013-07-31T00:00:00"},"currencyCode":{"type":"string","example":"GBP"},"balance":{"type":"integer","example":0},"limit":{"type":"integer","example":500},"openingBalance":{"type":"integer","example":22},"paymentStartDate":{"type":"string","format":"date-time","example":"2013-04-12T00:00:00"},"accountStartDate":{"type":"string","format":"date-time","example":"2013-04-12T00:00:00"},"regularPayment":{"type":"integer","example":50},"repaymentPeriod":{"type":"integer","example":12},"lumpPayment":{"type":"integer","example":0},"repaymentFrequencyCode":{"type":"string","example":"M"},"repaymentFrequency":{"type":"string","example":"Monthly"}}}}}},"indebtedness":{"type":"object","properties":{"totalActiveBalance":{"type":"integer","example":81751},"totalBalancedRevolvingCreditAndBudget":{"type":"integer","example":6893},"balanceToLimitRatio":{"type":"integer","example":28},"totalLimit":{"type":"integer","example":24550},"totalBalancedLoansOrInstallmentCredit":{"type":"integer","example":10552},"totalBalancedMortgageAccounts":{"type":"integer","example":64306}}}}},"shareAvailable":{"type":"boolean","example":true}}},"dateAndTimeOfReport":{"type":"string","format":"date-time","example":"2021-01-01T12:00:48"},"gaugeVersion":{"type":"string","example":"G1"},"reason":{"type":"string","example":"Quotation Search"},"success":{"type":"boolean","example":false},"supplierId":{"type":"string","example":"{AAAAE42F-92E5-4ED9-B322-XXXXXXXXXXXX}"},"creditsIncurred":{"type":"integer","example":1}}},"errors":{"type":"object"}}}},"components/schemas/ConnectIdentityAmlMultiBureauSearchCriteria":{"id":"components/schemas/ConnectIdentityAmlMultiBureauSearchCriteria","kind":"json-schema","title":"ConnectIdentityAmlMultiBureauSearchCriteria","data":{"type":"object","description":"Contains information relevant for anti-money laundering (AML) identity verification, including contact details, banking information, and documentation status.","properties":{"landlineNumber":{"type":"integer","description":"The person's landline telephone number. Useful for verification calls or as a contact method."},"ExDirectory":{"type":"boolean","description":"Indicates whether the person's landline number is excluded from public directories, typically for privacy reasons."},"isAMLMultiBureau":{"type":"boolean","description":"Indicates whether multiple bureaus were used for AML verification. True if data from multiple sources was consulted to enhance accuracy.","example":true}}}},"components/schemas/ConnectIdentityAMLMultiBureauSearchRequest":{"id":"components/schemas/ConnectIdentityAMLMultiBureauSearchRequest","kind":"json-schema","title":"ConnectIdentityAMLMultiBureauSearchRequest","data":{"type":"object","description":"The input data submitted for the AML search, detailing the information used to initiate the search.","properties":{"uniqueId":{"type":["string","null"],"description":"A unique identifier for the result, distinct from the correlation ID, which may be used internally for further processing or reference."},"common":{"$ref":"#/components/schemas/ConnectIdentityCommonSearchCriteria"},"idAml":{"$ref":"#/components/schemas/ConnectIdentityAmlMultiBureauSearchCriteria"},"products":{"type":["array","null"],"description":"Below is a list of Definitions for the ENUM","items":{"$ref":"#/components/schemas/ConnectIdentityProduct"}}}}},"components/schemas/UKEditedVotersDatabase":{"id":"components/schemas/UKEditedVotersDatabase","kind":"json-schema","title":"UKEditedVotersDatabase","data":{"type":"object","description":"UK Edited Voters database that provides authentication of name and address; also includes 5 year history and some date of birth coverage.","properties":{"id":{"type":"integer","description":"A unique identifier for the result entry, used internally for tracking individual results within the system."},"name":{"type":"string","description":"The name associated with the identity check result, typically representing a label or category for quick reference."},"description":{"type":"string","description":"A detailed description of the result or status indicated by this entry, providing deeper insight into the verification outcome."},"address":{"type":"string","description":"The address information as returned or matched in the identity verification process."},"alert":{"type":"string","description":"Indicates any alerts triggered by the verification process. This might include fraud warnings or other critical flags."},"dateOfBirth":{"type":"string","description":"The date of birth matched or verified against the input data, often used in age or identity confirmation."},"forename":{"type":"string","description":"The first name as it was matched or verified during the identity check."},"surname":{"type":"string","description":"The surname as it was matched or verified during the identity check."},"pass":{"type":"string","description":"Indicates whether the identity verification passed the set criteria or thresholds, typically as a simple 'pass' or 'fail' outcome."},"comments":{"type":"array","description":"An array of comments related to the verification process, where each item contains a code and its associated description. These comments are used to provide detailed feedback, notes, or annotations that clarify aspects of the verification findings.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A specific code representing a comment or note made during the verification process, used for detailed feedback or annotations."},"description":{"type":"string","description":"The description associated with each comment code, providing context or additional details about the feedback."}}}},"match":{"type":"array","description":"An array that captures all successful matches identified during the verification process. Each item in the array includes a code and a detailed description, explaining the matched data and its relevance, which helps in affirming the identity or data accuracy.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code representing a successful match in the verification process, such as matching personal details with database records."},"description":{"type":"string","description":"Describes the nature of the match, explaining what was matched and the relevance of the match."}}}},"misMatch":{"type":"array","description":"An array detailing mismatches or discrepancies encountered during the verification process. Each mismatch is noted with a code and a comprehensive description, which helps in understanding what information was incorrect or did not meet the verification criteria.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code indicating a mismatch or discrepancy found during the verification process."},"description":{"type":"string","description":"Provides details about the mismatch, including what information did not align with the expected or provided data."}}}},"warning":{"type":"array","description":"Contains warnings that were identified during the verification process. These are not severe enough to be considered alerts but are significant enough to be noted. Each warning is represented by a code and a description that outlines potential concerns or minor issues.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code that flags potential issues or warnings that were not severe enough to trigger an alert but still noteworthy."},"description":{"type":"string","description":"Describes the warning, providing details about minor issues or potential concerns noted during verification."}}}}}}},"components/schemas/UKCreditHeaderAml":{"id":"components/schemas/UKCreditHeaderAml","kind":"json-schema","title":"UKCreditHeaderAml","data":{"type":"object","description":"UK Credit Header Database.  Provides authentication of name, address and date of birth against Credit Header information for an Anti Money Laundering Check.","properties":{"id":{"type":"integer","description":"A unique identifier for the result entry, used internally for tracking individual results within the system."},"name":{"type":"string","description":"The name associated with the identity check result, typically representing a label or category for quick reference."},"description":{"type":"string","description":"A detailed description of the result or status indicated by this entry, providing deeper insight into the verification outcome."},"address":{"type":"string","description":"The address information as returned or matched in the identity verification process."},"alert":{"type":"string","description":"Indicates any alerts triggered by the verification process. This might include fraud warnings or other critical flags."},"dateOfBirth":{"type":"string","description":"The date of birth matched or verified against the input data, often used in age or identity confirmation."},"forename":{"type":"string","description":"The first name as it was matched or verified during the identity check."},"surname":{"type":"string","description":"The surname as it was matched or verified during the identity check."},"pass":{"type":"string","description":"Indicates whether the identity verification passed the set criteria or thresholds, typically as a simple 'pass' or 'fail' outcome."},"comments":{"type":"array","description":"An array of comments related to the verification process, where each item contains a code and its associated description. These comments are used to provide detailed feedback, notes, or annotations that clarify aspects of the verification findings.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A specific code representing a comment or note made during the verification process, used for detailed feedback or annotations."},"description":{"type":"string","description":"The description associated with each comment code, providing context or additional details about the feedback."}}}},"match":{"type":"array","description":"An array that captures all successful matches identified during the verification process. Each item in the array includes a code and a detailed description, explaining the matched data and its relevance, which helps in affirming the identity or data accuracy.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code representing a successful match in the verification process, such as matching personal details with database records."},"description":{"type":"string","description":"Describes the nature of the match, explaining what was matched and the relevance of the match."}}}},"misMatch":{"type":"array","description":"An array detailing mismatches or discrepancies encountered during the verification process. Each mismatch is noted with a code and a comprehensive description, which helps in understanding what information was incorrect or did not meet the verification criteria.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code indicating a mismatch or discrepancy found during the verification process."},"description":{"type":"string","description":"Provides details about the mismatch, including what information did not align with the expected or provided data."}}}},"warning":{"type":"array","description":"Contains warnings that were identified during the verification process. These are not severe enough to be considered alerts but are significant enough to be noted. Each warning is represented by a code and a description that outlines potential concerns or minor issues.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code that flags potential issues or warnings that were not severe enough to trigger an alert but still noteworthy."},"description":{"type":"string","description":"Describes the warning, providing details about minor issues or potential concerns noted during verification."}}}},"accountsInfo":{"type":"array","description":"A collection of financial account details, capturing various aspects of a person's credit history with different lenders. This array provides insight into the types and statuses of accounts held by an individual.","items":{"type":"object","properties":{"lenderType":{"type":"string","description":"Specifies the type of lender (e.g., bank, credit union, mortgage company) associated with the accounts listed."},"accounts":{"type":"integer","description":"The total number of accounts opened with the specified lender. This count includes both active and inactive accounts."},"activeAccounts":{"type":"integer","description":"The number of currently active accounts, indicating those that are in use and have not been closed or written off."},"oldestAccountStartDate":{"type":"string","description":"The start date of the oldest account held by the individual with this lender, formatted as YYYY-MM-DD. Provides a timeline of the person's credit history."},"youngestAccountStartDate":{"type":"string","description":"The start date of the most recently opened account with this lender, also formatted as YYYY-MM-DD. Indicates how recently the individual has engaged in new credit activities."}}}}}}},"components/schemas/UKCreditBureau":{"id":"components/schemas/UKCreditBureau","kind":"json-schema","title":"UKCreditBureau","data":{"type":"object","description":"Performs authentication of voter details and credit account details against Electoral Register, Credit Database and Credit type information. Search is carried out using forename, surname, address and DOB.","properties":{"id":{"type":"integer","description":"A unique identifier for the result entry, used internally for tracking individual results within the system."},"name":{"type":"string","description":"The name associated with the identity check result, typically representing a label or category for quick reference."},"description":{"type":"string","description":"A detailed description of the result or status indicated by this entry, providing deeper insight into the verification outcome."},"address":{"type":"string","description":"The address information as returned or matched in the identity verification process."},"alert":{"type":"string","description":"Indicates any alerts triggered by the verification process. This might include fraud warnings or other critical flags."},"dateOfBirth":{"type":"string","description":"The date of birth matched or verified against the input data, often used in age or identity confirmation."},"forename":{"type":"string","description":"The first name as it was matched or verified during the identity check."},"surname":{"type":"string","description":"The surname as it was matched or verified during the identity check."},"pass":{"type":"string","description":"Indicates whether the identity verification passed the set criteria or thresholds, typically as a simple 'pass' or 'fail' outcome."},"comments":{"type":"array","description":"An array of comments related to the verification process, where each item contains a code and its associated description. These comments are used to provide detailed feedback, notes, or annotations that clarify aspects of the verification findings.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A specific code representing a comment or note made during the verification process, used for detailed feedback or annotations."},"description":{"type":"string","description":"The description associated with each comment code, providing context or additional details about the feedback."}}}},"match":{"type":"array","description":"An array that captures all successful matches identified during the verification process. Each item in the array includes a code and a detailed description, explaining the matched data and its relevance, which helps in affirming the identity or data accuracy.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code representing a successful match in the verification process, such as matching personal details with database records."},"description":{"type":"string","description":"Describes the nature of the match, explaining what was matched and the relevance of the match."}}}},"misMatch":{"type":"array","description":"An array detailing mismatches or discrepancies encountered during the verification process. Each mismatch is noted with a code and a comprehensive description, which helps in understanding what information was incorrect or did not meet the verification criteria.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code indicating a mismatch or discrepancy found during the verification process."},"description":{"type":"string","description":"Provides details about the mismatch, including what information did not align with the expected or provided data."}}}},"warning":{"type":"array","description":"Contains warnings that were identified during the verification process. These are not severe enough to be considered alerts but are significant enough to be noted. Each warning is represented by a code and a description that outlines potential concerns or minor issues.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code that flags potential issues or warnings that were not severe enough to trigger an alert but still noteworthy."},"description":{"type":"string","description":"Describes the warning, providing details about minor issues or potential concerns noted during verification."}}}},"accountsInfo":{"type":"array","description":"A collection of financial account details, capturing various aspects of a person's credit history with different lenders. This array provides insight into the types and statuses of accounts held by an individual.","items":{"type":"object","properties":{"lenderType":{"type":"string","description":"Specifies the type of lender (e.g., bank, credit union, mortgage company) associated with the accounts listed."},"accounts":{"type":"integer","description":"The total number of accounts opened with the specified lender. This count includes both active and inactive accounts."},"activeAccounts":{"type":"integer","description":"The number of currently active accounts, indicating those that are in use and have not been closed or written off."},"oldestAccountStartDate":{"type":"string","description":"The start date of the oldest account held by the individual with this lender, formatted as YYYY-MM-DD. Provides a timeline of the person's credit history."},"youngestAccountStartDate":{"type":"string","description":"The start date of the most recently opened account with this lender, also formatted as YYYY-MM-DD. Indicates how recently the individual has engaged in new credit activities."}}}}}}},"components/schemas/CombinedDecision":{"id":"components/schemas/CombinedDecision","kind":"json-schema","title":"CombinedDecision","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This item check is to be used alongside the UK Credit Header & Bureau checks to allow a combined decision to be made within profile scoring. Combined Decision must be placed after the credit item checks to make use of the outcomes of both results."},"children":[]}]}]}],"properties":{"id":{"type":"integer","description":"A unique identifier for the result entry, used internally for tracking individual results within the system."},"name":{"type":"string","description":"The name associated with the identity check result, typically representing a label or category for quick reference."},"description":{"type":"string","description":"A detailed description of the result or status indicated by this entry, providing deeper insight into the verification outcome."},"address":{"type":"string","description":"The address information as returned or matched in the identity verification process."},"alert":{"type":"string","description":"Indicates any alerts triggered by the verification process. This might include fraud warnings or other critical flags."},"dateOfBirth":{"type":"string","description":"The date of birth matched or verified against the input data, often used in age or identity confirmation."},"forename":{"type":"string","description":"The first name as it was matched or verified during the identity check."},"surname":{"type":"string","description":"The surname as it was matched or verified during the identity check."},"pass":{"type":"string","description":"Indicates whether the identity verification passed the set criteria or thresholds, typically as a simple 'pass' or 'fail' outcome."},"comments":{"type":"array","description":"An array of comments related to the verification process, where each item contains a code and its associated description. These comments are used to provide detailed feedback, notes, or annotations that clarify aspects of the verification findings.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A specific code representing a comment or note made during the verification process, used for detailed feedback or annotations."},"description":{"type":"string","description":"The description associated with each comment code, providing context or additional details about the feedback."}}}},"match":{"type":"array","description":"An array that captures all successful matches identified during the verification process. Each item in the array includes a code and a detailed description, explaining the matched data and its relevance, which helps in affirming the identity or data accuracy.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code representing a successful match in the verification process, such as matching personal details with database records."},"description":{"type":"string","description":"Describes the nature of the match, explaining what was matched and the relevance of the match."}}}},"misMatch":{"type":"array","description":"An array detailing mismatches or discrepancies encountered during the verification process. Each mismatch is noted with a code and a comprehensive description, which helps in understanding what information was incorrect or did not meet the verification criteria.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code indicating a mismatch or discrepancy found during the verification process."},"description":{"type":"string","description":"Provides details about the mismatch, including what information did not align with the expected or provided data."}}}},"warning":{"type":"array","description":"Contains warnings that were identified during the verification process. These are not severe enough to be considered alerts but are significant enough to be noted. Each warning is represented by a code and a description that outlines potential concerns or minor issues.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code that flags potential issues or warnings that were not severe enough to trigger an alert but still noteworthy."},"description":{"type":"string","description":"Describes the warning, providing details about minor issues or potential concerns noted during verification."}}}},"accountsInfo":{"type":"array","description":"A collection of financial account details, capturing various aspects of a person's credit history with different lenders. This array provides insight into the types and statuses of accounts held by an individual.","items":{"type":"object","properties":{"lenderType":{"type":"string","description":"Specifies the type of lender (e.g., bank, credit union, mortgage company) associated with the accounts listed."},"accounts":{"type":"integer","description":"The total number of accounts opened with the specified lender. This count includes both active and inactive accounts."},"activeAccounts":{"type":"integer","description":"The number of currently active accounts, indicating those that are in use and have not been closed or written off."},"oldestAccountStartDate":{"type":"string","description":"The start date of the oldest account held by the individual with this lender, formatted as YYYY-MM-DD. Provides a timeline of the person's credit history."},"youngestAccountStartDate":{"type":"string","description":"The start date of the most recently opened account with this lender, also formatted as YYYY-MM-DD. Indicates how recently the individual has engaged in new credit activities."}}}}}}},"components/schemas/UKNationalIdentityRegister":{"id":"components/schemas/UKNationalIdentityRegister","kind":"json-schema","title":"UKNationalIdentityRegister","data":{"type":"object","description":"UK National Identity Register check. Performs authentication of first, last name, date of birth, address and phone numbers against UK National Identity Register.","properties":{"id":{"type":"integer","description":"A unique identifier for the result entry, used internally for tracking individual results within the system."},"name":{"type":"string","description":"The name associated with the identity check result, typically representing a label or category for quick reference."},"description":{"type":"string","description":"A detailed description of the result or status indicated by this entry, providing deeper insight into the verification outcome."},"address":{"type":"string","description":"The address information as returned or matched in the identity verification process."},"alert":{"type":"string","description":"Indicates any alerts triggered by the verification process. This might include fraud warnings or other critical flags."},"dateOfBirth":{"type":"string","description":"The date of birth matched or verified against the input data, often used in age or identity confirmation."},"forename":{"type":"string","description":"The first name as it was matched or verified during the identity check."},"surname":{"type":"string","description":"The surname as it was matched or verified during the identity check."},"pass":{"type":"string","description":"Indicates whether the identity verification passed the set criteria or thresholds, typically as a simple 'pass' or 'fail' outcome."},"comments":{"type":"array","description":"An array of comments related to the verification process, where each item contains a code and its associated description. These comments are used to provide detailed feedback, notes, or annotations that clarify aspects of the verification findings.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A specific code representing a comment or note made during the verification process, used for detailed feedback or annotations."},"description":{"type":"string","description":"The description associated with each comment code, providing context or additional details about the feedback."}}}},"match":{"type":"array","description":"An array that captures all successful matches identified during the verification process. Each item in the array includes a code and a detailed description, explaining the matched data and its relevance, which helps in affirming the identity or data accuracy.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code representing a successful match in the verification process, such as matching personal details with database records."},"description":{"type":"string","description":"Describes the nature of the match, explaining what was matched and the relevance of the match."}}}},"misMatch":{"type":"array","description":"An array detailing mismatches or discrepancies encountered during the verification process. Each mismatch is noted with a code and a comprehensive description, which helps in understanding what information was incorrect or did not meet the verification criteria.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code indicating a mismatch or discrepancy found during the verification process."},"description":{"type":"string","description":"Provides details about the mismatch, including what information did not align with the expected or provided data."}}}},"warning":{"type":"array","description":"Contains warnings that were identified during the verification process. These are not severe enough to be considered alerts but are significant enough to be noted. Each warning is represented by a code and a description that outlines potential concerns or minor issues.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code that flags potential issues or warnings that were not severe enough to trigger an alert but still noteworthy."},"description":{"type":"string","description":"Describes the warning, providing details about minor issues or potential concerns noted during verification."}}}}}}},"components/schemas/UKDeceasedPersonDatabase":{"id":"components/schemas/UKDeceasedPersonDatabase","kind":"json-schema","title":"UKDeceasedPersonDatabase","data":{"type":"object","description":"UK Deceased Persons Database.  Provides checking of a first and last name at an address against the registered deceased persons database.","properties":{"id":{"type":"integer","description":"A unique identifier for the result entry, used internally for tracking individual results within the system."},"name":{"type":"string","description":"The name associated with the identity check result, typically representing a label or category for quick reference."},"description":{"type":"string","description":"A detailed description of the result or status indicated by this entry, providing deeper insight into the verification outcome."},"address":{"type":"string","description":"The address information as returned or matched in the identity verification process."},"alert":{"type":"string","description":"Indicates any alerts triggered by the verification process. This might include fraud warnings or other critical flags."},"dateOfBirth":{"type":"string","description":"The date of birth matched or verified against the input data, often used in age or identity confirmation."},"forename":{"type":"string","description":"The first name as it was matched or verified during the identity check."},"surname":{"type":"string","description":"The surname as it was matched or verified during the identity check."},"pass":{"type":"string","description":"Indicates whether the identity verification passed the set criteria or thresholds, typically as a simple 'pass' or 'fail' outcome."},"comments":{"type":"array","description":"An array of comments related to the verification process, where each item contains a code and its associated description. These comments are used to provide detailed feedback, notes, or annotations that clarify aspects of the verification findings.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A specific code representing a comment or note made during the verification process, used for detailed feedback or annotations."},"description":{"type":"string","description":"The description associated with each comment code, providing context or additional details about the feedback."}}}},"match":{"type":"array","description":"An array that captures all successful matches identified during the verification process. Each item in the array includes a code and a detailed description, explaining the matched data and its relevance, which helps in affirming the identity or data accuracy.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code representing a successful match in the verification process, such as matching personal details with database records."},"description":{"type":"string","description":"Describes the nature of the match, explaining what was matched and the relevance of the match."}}}},"misMatch":{"type":"array","description":"An array detailing mismatches or discrepancies encountered during the verification process. Each mismatch is noted with a code and a comprehensive description, which helps in understanding what information was incorrect or did not meet the verification criteria.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code indicating a mismatch or discrepancy found during the verification process."},"description":{"type":"string","description":"Provides details about the mismatch, including what information did not align with the expected or provided data."}}}},"warning":{"type":"array","description":"Contains warnings that were identified during the verification process. These are not severe enough to be considered alerts but are significant enough to be noted. Each warning is represented by a code and a description that outlines potential concerns or minor issues.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code that flags potential issues or warnings that were not severe enough to trigger an alert but still noteworthy."},"description":{"type":"string","description":"Describes the warning, providing details about minor issues or potential concerns noted during verification."}}}}}}},"components/schemas/UKNCOA":{"id":"components/schemas/UKNCOA","kind":"json-schema","title":"UKNCOA","data":{"type":"object","description":"UK NCOA (Alert Flag) Database check.  Provides a set of fraud flag warnings against name and address of individuals who have moved house and registered on the national change of address database.","properties":{"id":{"type":"integer","description":"A unique identifier for the result entry, used internally for tracking individual results within the system."},"name":{"type":"string","description":"The name associated with the identity check result, typically representing a label or category for quick reference."},"description":{"type":"string","description":"A detailed description of the result or status indicated by this entry, providing deeper insight into the verification outcome."},"address":{"type":"string","description":"The address information as returned or matched in the identity verification process."},"alert":{"type":"string","description":"Indicates any alerts triggered by the verification process. This might include fraud warnings or other critical flags."},"dateOfBirth":{"type":"string","description":"The date of birth matched or verified against the input data, often used in age or identity confirmation."},"forename":{"type":"string","description":"The first name as it was matched or verified during the identity check."},"surname":{"type":"string","description":"The surname as it was matched or verified during the identity check."},"pass":{"type":"string","description":"Indicates whether the identity verification passed the set criteria or thresholds, typically as a simple 'pass' or 'fail' outcome."},"comments":{"type":"array","description":"An array of comments related to the verification process, where each item contains a code and its associated description. These comments are used to provide detailed feedback, notes, or annotations that clarify aspects of the verification findings.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A specific code representing a comment or note made during the verification process, used for detailed feedback or annotations."},"description":{"type":"string","description":"The description associated with each comment code, providing context or additional details about the feedback."}}}},"match":{"type":"array","description":"An array that captures all successful matches identified during the verification process. Each item in the array includes a code and a detailed description, explaining the matched data and its relevance, which helps in affirming the identity or data accuracy.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code representing a successful match in the verification process, such as matching personal details with database records."},"description":{"type":"string","description":"Describes the nature of the match, explaining what was matched and the relevance of the match."}}}},"misMatch":{"type":"array","description":"An array detailing mismatches or discrepancies encountered during the verification process. Each mismatch is noted with a code and a comprehensive description, which helps in understanding what information was incorrect or did not meet the verification criteria.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code indicating a mismatch or discrepancy found during the verification process."},"description":{"type":"string","description":"Provides details about the mismatch, including what information did not align with the expected or provided data."}}}},"warning":{"type":"array","description":"Contains warnings that were identified during the verification process. These are not severe enough to be considered alerts but are significant enough to be noted. Each warning is represented by a code and a description that outlines potential concerns or minor issues.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code that flags potential issues or warnings that were not severe enough to trigger an alert but still noteworthy."},"description":{"type":"string","description":"Describes the warning, providing details about minor issues or potential concerns noted during verification."}}}}}}},"components/schemas/InternationalSanctions":{"id":"components/schemas/InternationalSanctions","kind":"json-schema","title":"InternationalSanctions","data":{"type":"object","description":"International Sanctions (Enhanced) check.  Provides authentication against multiple Sanctions and Enforcement lists across the globe (lists are selectable at profile level).","properties":{"id":{"type":"integer","description":"A unique identifier for the result entry, used internally for tracking individual results within the system."},"name":{"type":"string","description":"The name associated with the identity check result, typically representing a label or category for quick reference."},"description":{"type":"string","description":"A detailed description of the result or status indicated by this entry, providing deeper insight into the verification outcome."},"address":{"type":"string","description":"The address information as returned or matched in the identity verification process."},"alert":{"type":"string","description":"Indicates any alerts triggered by the verification process. This might include fraud warnings or other critical flags."},"dateOfBirth":{"type":"string","description":"The date of birth matched or verified against the input data, often used in age or identity confirmation."},"forename":{"type":"string","description":"The first name as it was matched or verified during the identity check."},"surname":{"type":"string","description":"The surname as it was matched or verified during the identity check."},"pass":{"type":"string","description":"Indicates whether the identity verification passed the set criteria or thresholds, typically as a simple 'pass' or 'fail' outcome."},"comments":{"type":"array","description":"An array of comments related to the verification process, where each item contains a code and its associated description. These comments are used to provide detailed feedback, notes, or annotations that clarify aspects of the verification findings.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A specific code representing a comment or note made during the verification process, used for detailed feedback or annotations."},"description":{"type":"string","description":"The description associated with each comment code, providing context or additional details about the feedback."}}}},"match":{"type":"array","description":"An array that captures all successful matches identified during the verification process. Each item in the array includes a code and a detailed description, explaining the matched data and its relevance, which helps in affirming the identity or data accuracy.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code representing a successful match in the verification process, such as matching personal details with database records."},"description":{"type":"string","description":"Describes the nature of the match, explaining what was matched and the relevance of the match."}}}},"misMatch":{"type":"array","description":"An array detailing mismatches or discrepancies encountered during the verification process. Each mismatch is noted with a code and a comprehensive description, which helps in understanding what information was incorrect or did not meet the verification criteria.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code indicating a mismatch or discrepancy found during the verification process."},"description":{"type":"string","description":"Provides details about the mismatch, including what information did not align with the expected or provided data."}}}},"warning":{"type":"array","description":"Contains warnings that were identified during the verification process. These are not severe enough to be considered alerts but are significant enough to be noted. Each warning is represented by a code and a description that outlines potential concerns or minor issues.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code that flags potential issues or warnings that were not severe enough to trigger an alert but still noteworthy."},"description":{"type":"string","description":"Describes the warning, providing details about minor issues or potential concerns noted during verification."}}}},"sanctions":{"type":"array","description":"An array of sanction details related to individuals or entities. Each entry provides comprehensive information about the sanctions imposed, including identities, addresses, affiliating sanction bodies, and relevant dates.","items":{"type":"object","properties":{"detail":{"type":"object","description":"Detailed information about the sanctioned individual or entity, including aliases, full name, identity specifics, addresses, sanctioning bodies, and important dates.","properties":{"aliases":{"type":"array","items":{"type":"string"},"description":"A list of alternative names or aliases used by the sanctioned individual or entity."},"fullName":{"type":"string","description":"The full legal name of the sanctioned individual or entity."},"identityInformation":{"type":"array","items":{"type":"object"},"description":"Additional identity information which may include details like nationality, date of birth, and other identifying particulars."},"addresses":{"type":"array","description":"Lists the addresses associated with the individual or entity, providing detailed locational information. Each address entry includes city, country, the first line of the address, and the region, all of which contribute to a comprehensive understanding of the sanctioned party's location.","items":{"type":"object","properties":{"city":{"type":"string","description":"The city part of the address associated with the sanctioned individual or entity."},"country":{"type":"string","description":"The country where the sanctioned individual or entity is located or registered."},"firstLine":{"type":"string","description":"The first line of the address, typically including the street name and number."},"region":{"type":"string","description":"The region or state part of the address, providing additional locational context within the country."}}}},"sanctionBodies":{"type":"array","items":{"type":"string"},"description":"A list of sanctioning bodies that have imposed sanctions on the individual or entity, indicating the authority or government entity responsible."},"dates":{"type":"array","description":"Contains a list of significant dates related to the sanctions, such as the date of imposition, expiration, or review. Each date is associated with a specific type to clarify its relevance to the sanction details.","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"The specific date relevant to the sanction, such as the date it was imposed or when it will be reviewed."},"dateType":{"type":"string","description":"A description of what the date represents in the context of the sanction (e.g., imposition date, review date)."}}}}}},"id":{"type":"string","description":"A unique identifier for the sanction record, facilitating tracking and reference across systems."},"score":{"type":"integer","description":"A score indicating the severity or level of the sanction imposed, which can help in assessing the impact or seriousness of the sanction."},"url":{"type":"string","format":"uri","description":"A URL providing additional information or the source of the data concerning the sanctions, allowing users to access more detailed documentation or reports."}}}}}}},"components/schemas/InternationalEnhancedPepDatabase":{"id":"components/schemas/InternationalEnhancedPepDatabase","kind":"json-schema","title":"InternationalEnhancedPepDatabase","data":{"type":"object","description":"International PEP (Enhanced) Database check.  Provides authentication against Politically Exposed Persons lists from across the globe (contains known associates and known alias details).","properties":{"id":{"type":"integer","description":"A unique identifier for the result entry, used internally for tracking individual results within the system."},"name":{"type":"string","description":"The name associated with the identity check result, typically representing a label or category for quick reference."},"description":{"type":"string","description":"A detailed description of the result or status indicated by this entry, providing deeper insight into the verification outcome."},"address":{"type":"string","description":"The address information as returned or matched in the identity verification process."},"alert":{"type":"string","description":"Indicates any alerts triggered by the verification process. This might include fraud warnings or other critical flags."},"dateOfBirth":{"type":"string","description":"The date of birth matched or verified against the input data, often used in age or identity confirmation."},"forename":{"type":"string","description":"The first name as it was matched or verified during the identity check."},"surname":{"type":"string","description":"The surname as it was matched or verified during the identity check."},"pass":{"type":"string","description":"Indicates whether the identity verification passed the set criteria or thresholds, typically as a simple 'pass' or 'fail' outcome."},"comments":{"type":"array","description":"An array of comments related to the verification process, where each item contains a code and its associated description. These comments are used to provide detailed feedback, notes, or annotations that clarify aspects of the verification findings.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A specific code representing a comment or note made during the verification process, used for detailed feedback or annotations."},"description":{"type":"string","description":"The description associated with each comment code, providing context or additional details about the feedback."}}}},"match":{"type":"array","description":"An array that captures all successful matches identified during the verification process. Each item in the array includes a code and a detailed description, explaining the matched data and its relevance, which helps in affirming the identity or data accuracy.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code representing a successful match in the verification process, such as matching personal details with database records."},"description":{"type":"string","description":"Describes the nature of the match, explaining what was matched and the relevance of the match."}}}},"misMatch":{"type":"array","description":"An array detailing mismatches or discrepancies encountered during the verification process. Each mismatch is noted with a code and a comprehensive description, which helps in understanding what information was incorrect or did not meet the verification criteria.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code indicating a mismatch or discrepancy found during the verification process."},"description":{"type":"string","description":"Provides details about the mismatch, including what information did not align with the expected or provided data."}}}},"warning":{"type":"array","description":"Contains warnings that were identified during the verification process. These are not severe enough to be considered alerts but are significant enough to be noted. Each warning is represented by a code and a description that outlines potential concerns or minor issues.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code that flags potential issues or warnings that were not severe enough to trigger an alert but still noteworthy."},"description":{"type":"string","description":"Describes the warning, providing details about minor issues or potential concerns noted during verification."}}}},"peps":{"type":"array","description":"An array detailing Politically Exposed Persons (PEPs), crucial for compliance with anti-money laundering (AML) and counter-financing of terrorism (CFT) regulations. Each entry provides a complete profile including personal, positional, and historical data necessary for conducting enhanced due diligence. Profiles include aliases, full names, comprehensive identity information, addresses, key dates, and official positions held, accompanied by a risk score and a reference URL for further information.","items":{"type":"object","properties":{"detail":{"type":"object","description":"Contains in-depth details about the individual PEP, including personal identifiers and historical data essential for identity verification and risk assessment.","properties":{"aliases":{"type":"array","items":{"type":"string"},"description":"List of known aliases or other names used by the PEP, which may appear in legal or financial documents."},"fullName":{"type":"string","description":"The complete legal name of the PEP as recognized by governmental or international authorities."},"identityInformation":{"type":"array","items":{"type":"object"},"description":"Additional identity details such as nationality, other citizenships, and important personal identifiers."},"addresses":{"type":"array","description":"A list of current and past addresses associated with the PEP, providing geographic data crucial for background checks.","items":{"type":"object","properties":{"city":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The city component of the PEP’s address."},"children":[]}]}]}]},"country":{"type":"string","description":"The country where the PEP resides or has significant connections."},"firstLine":{"type":"string","description":"The primary line of the address, typically including street name and number."},"region":{"type":"string","description":"The region or state of the address, adding another layer of locational detail."}}}},"dates":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Significant dates related to the PEP’s life and career, such as birth date, dates of appointment, and other key milestones."},"children":[]}]}]}],"items":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Specific dates relevant to the PEP's personal or professional timeline."},"dateType":{"type":"string","description":"Describes the context of the date, clarifying whether it pertains to personal events or professional appointments."}}}},"tier":{"type":"integer","description":"Indicates the level or tier of exposure or risk associated with the PEP, typically determined by their political influence and the positions they hold."},"positions":{"type":"array","description":"Records of official positions held by the PEP, both current and historical, which are essential for understanding their potential influence and risk level.","items":{"type":"object","properties":{"position":{"type":"string","description":"A description of the official position held by the PEP, detailing the role and its relevance in political or social terms."}}}}}},"id":{"type":"string","description":"A unique identifier assigned to each PEP entry for tracking and referencing within the database."},"score":{"type":"integer","description":"A numerical score that quantifies the risk associated with the PEP based on their positions, history, and current status."},"url":{"type":"string","format":"uri","description":"A URL linking to additional information or official documentation about the PEP, facilitating deeper research or verification."}}}}}}},"components/schemas/ConnectIdentityMultiBureauAmlSupplierResult":{"id":"components/schemas/ConnectIdentityMultiBureauAmlSupplierResult","kind":"json-schema","title":"ConnectIdentityMultiBureauAmlSupplierResult","data":{"type":"object","description":"Detailed results specifically from AML verification sources, including data from multiple bureaus if applicable.","properties":{"bandText":{"type":"string","description":"A descriptive label or category assigned based on the results of the AML checks. Typically, this text will indicate the level of risk or compliance category identified through the verification process."},"birthIndexMatch":{"type":"boolean","description":"Indicates whether there was a match found in the birth index database, a critical aspect of verifying an individual's identity against official records."},"noRetry":{"type":"boolean","description":"A flag to indicate whether the AML process should not be retried for this individual. This can be set to true in scenarios where repeated verification attempts are unlikely to yield different results."},"resultCodes":{"type":"object","description":"A collection of codes that provide detailed information about the outcome of the AML search. Each code corresponds to a specific finding or decision point in the AML verification process.","properties":{"UKEditedVotersDatabase":{"$ref":"#/components/schemas/UKEditedVotersDatabase"},"UKCreditHeaderAml":{"$ref":"#/components/schemas/UKCreditHeaderAml"},"UKCreditBureau":{"$ref":"#/components/schemas/UKCreditBureau"},"CombinedDecision":{"$ref":"#/components/schemas/CombinedDecision"},"UKNationalIdentityRegister":{"$ref":"#/components/schemas/UKNationalIdentityRegister"},"UKDeceasedPersonDatabase":{"$ref":"#/components/schemas/UKDeceasedPersonDatabase"},"UKNCOA":{"$ref":"#/components/schemas/UKNCOA"},"InternationalSanctions":{"$ref":"#/components/schemas/InternationalSanctions"},"InternationalEnhancedPepDatabase":{"$ref":"#/components/schemas/InternationalEnhancedPepDatabase"}}},"score":{"type":"integer","description":"A numerical value representing the calculated risk score or validation level derived from the AML checks. This score can guide decision-making processes regarding the subject's verification status."},"searchText":{"type":"string","description":"The exact query text used in the search, allowing for audit and review of the search parameters and terms used."},"legacyUniqueID":{"type":"string","description":"A unique identifier from a legacy system that may still be used to track or reference the subject within older datasets or parallel systems."},"validationID":{"type":"string","description":"A unique identifier assigned to the validation process, facilitating tracking and cross-referencing of the validation attempts across multiple systems."},"hasAlerts":{"type":"boolean","description":"Indicates whether any alerts were triggered during the verification process. This is typically used to flag profiles that require further investigation or immediate attention."},"success":{"type":"boolean","description":"Reflects whether the AML search and verification process was successful, based on the predefined criteria and thresholds set within the system."},"creditsIncurred":{"type":"integer","description":"The number of credits or cost units consumed during the AML search process. This is relevant for systems where operations incur a variable cost based on usage or complexity."}}}},"components/schemas/ConnectIdentityMultiBureauAmlSearchResult":{"id":"components/schemas/ConnectIdentityMultiBureauAmlSearchResult","kind":"json-schema","title":"ConnectIdentityMultiBureauAmlSearchResult","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique identifier for the AML search request, used to track and correlate responses with their respective requests."},"uniqueId":{"type":"string","description":"A unique identifier for the result, distinct from the correlation ID, which may be used internally for further processing or reference."},"input":{"$ref":"#/components/schemas/ConnectIdentityAMLMultiBureauSearchRequest"},"common":{"$ref":"#/components/schemas/ConnectIdentityCommonResult"},"amlResult":{"$ref":"#/components/schemas/ConnectIdentityMultiBureauAmlSupplierResult"},"errors":{"type":["object","null"],"description":"Contains any errors that occurred during the search process, listed as an array of string messages. Each string provides details on specific issues encountered.","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"components/schemas/UKLandlineTelephoneDatabase":{"id":"components/schemas/UKLandlineTelephoneDatabase","kind":"json-schema","title":"UKLandlineTelephoneDatabase","data":{"type":"object","description":"Encapsulates various result codes and related information obtained from an identity verification process. This schema includes identifiers, personal information matches, alerts, and assessment outcomes.","properties":{"id":{"type":"integer","description":"A unique identifier for the result entry, used internally for tracking individual results within the system."},"name":{"type":"string","description":"The name associated with the identity check result, typically representing a label or category for quick reference."},"description":{"type":"string","description":"A detailed description of the result or status indicated by this entry, providing deeper insight into the verification outcome."},"address":{"type":"string","description":"The address information as returned or matched in the identity verification process."},"alert":{"type":"string","description":"Indicates any alerts triggered by the verification process. This might include fraud warnings or other critical flags."},"dateOfBirth":{"type":"string","description":"The date of birth matched or verified against the input data, often used in age or identity confirmation."},"forename":{"type":"string","description":"The first name as it was matched or verified during the identity check."},"surname":{"type":"string","description":"The surname as it was matched or verified during the identity check."},"pass":{"type":"string","description":"Indicates whether the identity verification passed the set criteria or thresholds, typically as a simple 'pass' or 'fail' outcome."},"comments":{"type":"array","description":"An array of comments related to the verification process, where each item contains a code and its associated description. These comments are used to provide detailed feedback, notes, or annotations that clarify aspects of the verification findings.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A specific code representing a comment or note made during the verification process, used for detailed feedback or annotations."},"description":{"type":"string","description":"The description associated with each comment code, providing context or additional details about the feedback."}}}},"match":{"type":"array","description":"An array that captures all successful matches identified during the verification process. Each item in the array includes a code and a detailed description, explaining the matched data and its relevance, which helps in affirming the identity or data accuracy.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code representing a successful match in the verification process, such as matching personal details with database records."},"description":{"type":"string","description":"Describes the nature of the match, explaining what was matched and the relevance of the match."}}}},"misMatch":{"type":"array","description":"An array detailing mismatches or discrepancies encountered during the verification process. Each mismatch is noted with a code and a comprehensive description, which helps in understanding what information was incorrect or did not meet the verification criteria.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code indicating a mismatch or discrepancy found during the verification process."},"description":{"type":"string","description":"Provides details about the mismatch, including what information did not align with the expected or provided data."}}}},"warning":{"type":"array","description":"Contains warnings that were identified during the verification process. These are not severe enough to be considered alerts but are significant enough to be noted. Each warning is represented by a code and a description that outlines potential concerns or minor issues.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code that flags potential issues or warnings that were not severe enough to trigger an alert but still noteworthy."},"description":{"type":"string","description":"Describes the warning, providing details about minor issues or potential concerns noted during verification."}}}}}}},"components/schemas/UKBirthsRegistryDatabase":{"id":"components/schemas/UKBirthsRegistryDatabase","kind":"json-schema","title":"UKBirthsRegistryDatabase","data":{"type":"object","description":"Encapsulates various result codes and related information obtained from an identity verification process. This schema includes identifiers, personal information matches, alerts, and assessment outcomes.","properties":{"id":{"type":"integer","description":"A unique identifier for the result entry, used internally for tracking individual results within the system."},"name":{"type":"string","description":"The name associated with the identity check result, typically representing a label or category for quick reference."},"description":{"type":"string","description":"A detailed description of the result or status indicated by this entry, providing deeper insight into the verification outcome."},"address":{"type":"string","description":"The address information as returned or matched in the identity verification process."},"alert":{"type":"string","description":"Indicates any alerts triggered by the verification process. This might include fraud warnings or other critical flags."},"dateOfBirth":{"type":"string","description":"The date of birth matched or verified against the input data, often used in age or identity confirmation."},"forename":{"type":"string","description":"The first name as it was matched or verified during the identity check."},"surname":{"type":"string","description":"The surname as it was matched or verified during the identity check."},"pass":{"type":"string","description":"Indicates whether the identity verification passed the set criteria or thresholds, typically as a simple 'pass' or 'fail' outcome."},"comments":{"type":"array","description":"An array of comments related to the verification process, where each item contains a code and its associated description. These comments are used to provide detailed feedback, notes, or annotations that clarify aspects of the verification findings.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A specific code representing a comment or note made during the verification process, used for detailed feedback or annotations."},"description":{"type":"string","description":"The description associated with each comment code, providing context or additional details about the feedback."}}}},"match":{"type":"array","description":"An array that captures all successful matches identified during the verification process. Each item in the array includes a code and a detailed description, explaining the matched data and its relevance, which helps in affirming the identity or data accuracy.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code representing a successful match in the verification process, such as matching personal details with database records."},"description":{"type":"string","description":"Describes the nature of the match, explaining what was matched and the relevance of the match."}}}},"misMatch":{"type":"array","description":"An array detailing mismatches or discrepancies encountered during the verification process. Each mismatch is noted with a code and a comprehensive description, which helps in understanding what information was incorrect or did not meet the verification criteria.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code indicating a mismatch or discrepancy found during the verification process."},"description":{"type":"string","description":"Provides details about the mismatch, including what information did not align with the expected or provided data."}}}},"warning":{"type":"array","description":"Contains warnings that were identified during the verification process. These are not severe enough to be considered alerts but are significant enough to be noted. Each warning is represented by a code and a description that outlines potential concerns or minor issues.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code that flags potential issues or warnings that were not severe enough to trigger an alert but still noteworthy."},"description":{"type":"string","description":"Describes the warning, providing details about minor issues or potential concerns noted during verification."}}}}}}},"components/schemas/InternationalAgeAlgorithm":{"id":"components/schemas/InternationalAgeAlgorithm","kind":"json-schema","title":"InternationalAgeAlgorithm","data":{"type":"object","description":"Encapsulates various result codes and related information obtained from an identity verification process. This schema includes identifiers, personal information matches, alerts, and assessment outcomes.","properties":{"id":{"type":"integer","description":"A unique identifier for the result entry, used internally for tracking individual results within the system."},"name":{"type":"string","description":"The name associated with the identity check result, typically representing a label or category for quick reference."},"description":{"type":"string","description":"A detailed description of the result or status indicated by this entry, providing deeper insight into the verification outcome."},"address":{"type":"string","description":"The address information as returned or matched in the identity verification process."},"alert":{"type":"string","description":"Indicates any alerts triggered by the verification process. This might include fraud warnings or other critical flags."},"dateOfBirth":{"type":"string","description":"The date of birth matched or verified against the input data, often used in age or identity confirmation."},"forename":{"type":"string","description":"The first name as it was matched or verified during the identity check."},"surname":{"type":"string","description":"The surname as it was matched or verified during the identity check."},"pass":{"type":"string","description":"Indicates whether the identity verification passed the set criteria or thresholds, typically as a simple 'pass' or 'fail' outcome."},"comments":{"type":"array","description":"An array of comments related to the verification process, where each item contains a code and its associated description. These comments are used to provide detailed feedback, notes, or annotations that clarify aspects of the verification findings.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A specific code representing a comment or note made during the verification process, used for detailed feedback or annotations."},"description":{"type":"string","description":"The description associated with each comment code, providing context or additional details about the feedback."}}}},"match":{"type":"array","description":"An array that captures all successful matches identified during the verification process. Each item in the array includes a code and a detailed description, explaining the matched data and its relevance, which helps in affirming the identity or data accuracy.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code representing a successful match in the verification process, such as matching personal details with database records."},"description":{"type":"string","description":"Describes the nature of the match, explaining what was matched and the relevance of the match."}}}},"misMatch":{"type":"array","description":"An array detailing mismatches or discrepancies encountered during the verification process. Each mismatch is noted with a code and a comprehensive description, which helps in understanding what information was incorrect or did not meet the verification criteria.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code indicating a mismatch or discrepancy found during the verification process."},"description":{"type":"string","description":"Provides details about the mismatch, including what information did not align with the expected or provided data."}}}},"warning":{"type":"array","description":"Contains warnings that were identified during the verification process. These are not severe enough to be considered alerts but are significant enough to be noted. Each warning is represented by a code and a description that outlines potential concerns or minor issues.","items":{"type":"object","properties":{"code":{"type":"integer","description":"A code that flags potential issues or warnings that were not severe enough to trigger an alert but still noteworthy."},"description":{"type":"string","description":"Describes the warning, providing details about minor issues or potential concerns noted during verification.\""}}}}}}},"components/schemas/ConnectIdentityAmlSupplierResult":{"id":"components/schemas/ConnectIdentityAmlSupplierResult","kind":"json-schema","title":"ConnectIdentityAmlSupplierResult","data":{"type":"object","description":"Detailed results specifically from AML verification sources, including data from multiple bureaus if applicable.","properties":{"bandText":{"type":"string","description":"A descriptive label or category assigned based on the results of the AML checks. Typically, this text will indicate the level of risk or compliance category identified through the verification process."},"birthIndexMatch":{"type":"boolean","description":"Indicates whether there was a match found in the birth index database, a critical aspect of verifying an individual's identity against official records."},"noRetry":{"type":"boolean","description":"A flag to indicate whether the AML process should not be retried for this individual. This can be set to true in scenarios where repeated verification attempts are unlikely to yield different results."},"resultCodes":{"type":"object","description":"A collection of codes that provide detailed information about the outcome of the AML search. Each code corresponds to a specific finding or decision point in the AML verification process.","properties":{"UKEditedVotersDatabase":{"$ref":"#/components/schemas/UKEditedVotersDatabase"},"UKNationalIdentityRegister":{"$ref":"#/components/schemas/UKNationalIdentityRegister"},"UKLandlineTelephoneDatabase":{"$ref":"#/components/schemas/UKLandlineTelephoneDatabase"},"UKCreditHeaderAml":{"$ref":"#/components/schemas/UKCreditHeaderAml"},"UKDeceasedPersonDatabase":{"$ref":"#/components/schemas/UKDeceasedPersonDatabase"},"InternationalSanctions":{"$ref":"#/components/schemas/InternationalSanctions"},"InternationalEnhancedPepDatabase":{"$ref":"#/components/schemas/InternationalEnhancedPepDatabase"},"UKBirthsRegistryDatabase":{"$ref":"#/components/schemas/UKBirthsRegistryDatabase"},"InternationalAgeAlgorithm":{"$ref":"#/components/schemas/InternationalAgeAlgorithm"}}},"score":{"type":"integer","description":"A numerical value representing the calculated risk score or validation level derived from the AML checks. This score can guide decision-making processes regarding the subject's verification status."},"searchText":{"type":"string","description":"The exact query text used in the search, allowing for audit and review of the search parameters and terms used."},"legacyUniqueID":{"type":"string","description":"A unique identifier from a legacy system that may still be used to track or reference the subject within older datasets or parallel systems."},"validationID":{"type":"string","description":"A unique identifier assigned to the validation process, facilitating tracking and cross-referencing of the validation attempts across multiple systems."},"hasAlerts":{"type":"boolean","description":"Indicates whether any alerts were triggered during the verification process. This is typically used to flag profiles that require further investigation or immediate attention."},"success":{"type":"boolean","description":"Reflects whether the AML search and verification process was successful, based on the predefined criteria and thresholds set within the system."},"creditsIncurred":{"type":"integer","description":"The number of credits or cost units consumed during the AML search process. This is relevant for systems where operations incur a variable cost based on usage or complexity."}}}},"components/schemas/ConnectIdentityAmlSearchResult":{"id":"components/schemas/ConnectIdentityAmlSearchResult","kind":"json-schema","title":"ConnectIdentityAmlSearchResult","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique identifier for the AML search request, used to track and correlate responses with their respective requests."},"uniqueId":{"type":"string","description":"A unique identifier for the result, distinct from the correlation ID, which may be used internally for further processing or reference."},"input":{"$ref":"#/components/schemas/ConnectIdentityAMLSearchRequest"},"common":{"$ref":"#/components/schemas/ConnectIdentityCommonResult"},"amlResult":{"$ref":"#/components/schemas/ConnectIdentityAmlSupplierResult"},"errors":{"type":["object","null"],"description":"Contains any errors that occurred during the search process, listed as an array of string messages. Each string provides details on specific issues encountered.","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"components/schemas/ConnectIdentityAmlResultCode":{"id":"components/schemas/ConnectIdentityAmlResultCode","kind":"json-schema","title":"ConnectIdentityAmlResultCode","data":{"enum":[0,1,2],"type":"integer","format":"int32"}},"components/schemas/ConnectIdentityReportMatchedData":{"id":"components/schemas/ConnectIdentityReportMatchedData","kind":"json-schema","title":"ConnectIdentityReportMatchedData","data":{"type":"object","properties":{"dateOfBirth":{"type":["string","null"],"format":"date-time"},"name":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"addressLine2":{"type":["string","null"]},"addressLine3":{"type":["string","null"]},"addressLine4":{"type":["string","null"]},"isSelected":{"type":"boolean"}}}},"components/schemas/ConnectIdentityReportResidencyConfirmation":{"id":"components/schemas/ConnectIdentityReportResidencyConfirmation","kind":"json-schema","title":"ConnectIdentityReportResidencyConfirmation","data":{"type":"object","properties":{"address":{"type":["string","null"]},"currentAddress":{"type":"boolean"},"id":{"type":["integer","null"],"format":"int32"},"message":{"type":["string","null"]},"undeclaredAddressType":{"type":["integer","null"],"format":"int32"}}}},"components/schemas/ConnectIdentityReportCreditSearchesAtCurrentAddress":{"id":"components/schemas/ConnectIdentityReportCreditSearchesAtCurrentAddress","kind":"json-schema","title":"ConnectIdentityReportCreditSearchesAtCurrentAddress","data":{"type":"object","properties":{"numberInLast3Months":{"type":"integer","format":"int32"},"numberInLast12Months":{"type":"integer","format":"int32"},"totalInLast3Months":{"type":"integer","format":"int32"}}}},"components/schemas/ConnectIdentityReportInsolvencyAtAddress":{"id":"components/schemas/ConnectIdentityReportInsolvencyAtAddress","kind":"json-schema","title":"ConnectIdentityReportInsolvencyAtAddress","data":{"type":"object","properties":{"restricted":{"type":["boolean","null"]},"currentlyInsolvent":{"type":"boolean"},"totalDischarged":{"type":["integer","null"],"format":"int32"}}}},"components/schemas/ConnectIdentitySummaryLinks":{"id":"components/schemas/ConnectIdentitySummaryLinks","kind":"json-schema","title":"ConnectIdentitySummaryLinks","data":{"type":"object","properties":{"undeclaredAddressCount":{"type":["integer","null"],"format":"int32"},"undeclaredAliasCount":{"type":["integer","null"],"format":"int32"},"undeclaredAssociatesCount":{"type":["integer","null"],"format":"int32"},"undeclaredAddressSearchedCount":{"type":["integer","null"],"format":"int32"},"undeclaredAddressUnsearchedCount":{"type":["integer","null"],"format":"int32"}}}},"components/schemas/ConnectIdentityReportSummaryJudgements":{"id":"components/schemas/ConnectIdentityReportSummaryJudgements","kind":"json-schema","title":"ConnectIdentityReportSummaryJudgements","data":{"type":"object","properties":{"total":{"type":["integer","null"],"format":"int32"},"total3Years":{"type":["integer","null"],"format":"int32"},"totalActive":{"type":["integer","null"],"format":"int32"},"totalSatisfied":{"type":["integer","null"],"format":"int32"},"totalActiveAmount":{"type":["integer","null"],"format":"int32"},"totalSatisfiedAmount":{"type":["integer","null"],"format":"int32"}}}},"components/schemas/ConnectIdentitySummaryShare":{"id":"components/schemas/ConnectIdentitySummaryShare","kind":"json-schema","title":"ConnectIdentitySummaryShare","data":{"type":"object","properties":{"accountCount":{"type":"integer","format":"int32"},"activeAccountCount":{"type":["integer","null"],"format":"int32"},"settledAccountCount":{"type":["integer","null"],"format":"int32"},"accountsOpenedInLast6MonthsCount":{"type":"integer","format":"int32"},"delinquentAccountsInLast12MonthsCount":{"type":["integer","null"],"format":"int32"},"worstPaymentStatusInLast12MonthsCount":{"type":["string","null"]},"worstPaymentStatusInLast36MonthsCount":{"type":["string","null"]},"defaultsInLast12MonthsCount":{"type":"integer","format":"int32"},"defaultsInLast36MonthsCount":{"type":"integer","format":"int32"}}}},"components/schemas/ConnectIdentitySummaryBehaviouralData":{"id":"components/schemas/ConnectIdentitySummaryBehaviouralData","kind":"json-schema","title":"ConnectIdentitySummaryBehaviouralData","data":{"type":"object","properties":{"minPayments12Months":{"type":"integer","format":"int32"},"minPayments36Months":{"type":"integer","format":"int32"},"cashAdvanceValue12Months":{"type":"integer","format":"int32"},"cashAdvanceValue36Months":{"type":"integer","format":"int32"}}}},"components/schemas/ConnectIdentitySummaryIch":{"id":"components/schemas/ConnectIdentitySummaryIch","kind":"json-schema","title":"ConnectIdentitySummaryIch","data":{"type":"object","properties":{"impairedCredit":{"type":"boolean"},"secured":{"type":["boolean","null"]},"unsecured":{"type":["boolean","null"]},"judgement":{"type":["boolean","null"]},"individualVoluntaryAgreement":{"type":["boolean","null"]},"bankruptcy":{"type":["boolean","null"]}}}},"components/schemas/ConnectIdentitySummaryThirdParty":{"id":"components/schemas/ConnectIdentitySummaryThirdParty","kind":"json-schema","title":"ConnectIdentitySummaryThirdParty","data":{"type":"object","properties":{"alertDecision":{"type":"integer","format":"int32"},"alertReview":{"type":"integer","format":"int32"},"householdOverride":{"type":"integer","format":"int32"}}}},"components/schemas/ConnectIdentitySummaryAddress":{"id":"components/schemas/ConnectIdentitySummaryAddress","kind":"json-schema","title":"ConnectIdentitySummaryAddress","data":{"type":"object","properties":{"paf":{"type":"boolean"},"rollingRoll":{"type":["boolean","null"]},"message":{"type":["string","null"]}}}},"components/schemas/ConnectIdentitySummaryInDebt":{"id":"components/schemas/ConnectIdentitySummaryInDebt","kind":"json-schema","title":"ConnectIdentitySummaryInDebt","data":{"type":"object","properties":{"totalActiveBalance":{"type":["integer","null"],"format":"int32"},"totalBalance":{"type":["integer","null"],"format":"int32"},"balanceLimitRatio":{"type":["integer","null"],"format":"int32"},"totalLimit":{"type":["integer","null"],"format":"int32"},"totalLoanBalance":{"type":["integer","null"],"format":"int32"},"totalMortgageBalance":{"type":["integer","null"],"format":"int32"}}}},"components/schemas/ConnectIdentitySummaryCardData":{"id":"components/schemas/ConnectIdentitySummaryCardData","kind":"json-schema","title":"ConnectIdentitySummaryCardData","data":{"type":"object","properties":{"totalMinPayments12Months":{"type":["integer","null"],"format":"int32"},"totalMinPayments36Months":{"type":["integer","null"],"format":"int32"},"totalCashAdvance12Months":{"type":["integer","null"],"format":"int32"},"totalCashAdvance36Months":{"type":["integer","null"],"format":"int32"}}}},"components/schemas/ConnectIdentitySummary":{"id":"components/schemas/ConnectIdentitySummary","kind":"json-schema","title":"ConnectIdentitySummary","data":{"type":"object","properties":{"name":{"type":["string","null"]},"matchedData":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportMatchedData"}},"matchLevel":{"type":["string","null"]},"noticesOfCorrections":{"type":["boolean","null"]},"totalDisputes":{"type":["integer","null"],"format":"int32"},"confirmedAddress":{"type":["string","null"]},"residency":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportResidencyConfirmation"}},"creditSearchesAtCurrentAddress":{"$ref":"#/components/schemas/ConnectIdentityReportCreditSearchesAtCurrentAddress"},"insolvencyAtAddress":{"$ref":"#/components/schemas/ConnectIdentityReportInsolvencyAtAddress"},"links":{"$ref":"#/components/schemas/ConnectIdentitySummaryLinks"},"judgements":{"$ref":"#/components/schemas/ConnectIdentityReportSummaryJudgements"},"totalCifas":{"type":["integer","null"],"format":"int32"},"rtr":{"type":["boolean","null"]},"share":{"$ref":"#/components/schemas/ConnectIdentitySummaryShare"},"behaviouralData":{"$ref":"#/components/schemas/ConnectIdentitySummaryBehaviouralData"},"impairedCreditHistory":{"$ref":"#/components/schemas/ConnectIdentitySummaryIch"},"thirdParty":{"$ref":"#/components/schemas/ConnectIdentitySummaryThirdParty"},"address":{"$ref":"#/components/schemas/ConnectIdentitySummaryAddress"},"inDebt":{"$ref":"#/components/schemas/ConnectIdentitySummaryInDebt"},"cardData":{"$ref":"#/components/schemas/ConnectIdentitySummaryCardData"}}}},"components/schemas/ConnectIdentityCreditScore":{"id":"components/schemas/ConnectIdentityCreditScore","kind":"json-schema","title":"ConnectIdentityCreditScore","data":{"type":"object","properties":{"band":{"type":"integer","format":"int32"},"version":{"type":["string","null"]},"score":{"type":"integer","format":"int32"}}}},"components/schemas/ConnectIdentityReportAddress":{"id":"components/schemas/ConnectIdentityReportAddress","kind":"json-schema","title":"ConnectIdentityReportAddress","data":{"type":"object","properties":{"address":{"type":["string","null"]},"isCurrent":{"type":"boolean"},"isPaf":{"type":["boolean","null"]},"residents":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportResident"}},"otherResidents":{"type":["boolean","null"]},"electoralRollHistory":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportElectoralRollHistory"}},"undeclaredAddressType":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityReportNotice":{"id":"components/schemas/ConnectIdentityReportNotice","kind":"json-schema","title":"ConnectIdentityReportNotice","data":{"type":"object","properties":{"name":{"type":["string","null"]},"address":{"$ref":"#/components/schemas/ConnectIdentityReportAddress"},"reference":{"type":["string","null"]},"comment":{"type":["string","null"]},"type":{"type":["string","null"]},"dateRaised":{"type":["string","null"],"format":"date-time"}}}},"components/schemas/ConnectIdentityReportElectoralRollHistory":{"id":"components/schemas/ConnectIdentityReportElectoralRollHistory","kind":"json-schema","title":"ConnectIdentityReportElectoralRollHistory","data":{"type":"object","properties":{"startDate":{"type":["string","null"],"format":"date-time"},"optOut":{"type":"boolean"},"rollingRoll":{"type":"boolean"},"notices":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportNotice"}}}}},"components/schemas/ConnectIdentityReportResident":{"id":"components/schemas/ConnectIdentityReportResident","kind":"json-schema","title":"ConnectIdentityReportResident","data":{"type":"object","properties":{"matchType":{"type":["string","null"]},"name":{"type":["string","null"]},"duration":{"type":["string","null"]},"startDate":{"type":["string","null"],"format":"date-time"},"endDate":{"type":["string","null"],"format":"date-time"},"electoralRollValid":{"type":"boolean"},"electoralRollHistory":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportElectoralRollHistory"}},"notices":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportNotice"}}}}},"components/schemas/ConnectIdentityReportUndeclaredAddress":{"id":"components/schemas/ConnectIdentityReportUndeclaredAddress","kind":"json-schema","title":"ConnectIdentityReportUndeclaredAddress","data":{"type":"object","properties":{"undeclaredAddress":{"type":["string","null"]},"undeclaredAddressTo":{"type":["string","null"]},"source":{"type":["string","null"]},"lastConfirmation":{"type":["string","null"]},"earliestConfirmation":{"type":["string","null"]},"navigationLinkIdentifier":{"type":["string","null"]},"navigationLinkIdentifierTo":{"type":["string","null"]},"notices":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportNotice"}}}}},"components/schemas/ConnectIdentitySupplierDetails":{"id":"components/schemas/ConnectIdentitySupplierDetails","kind":"json-schema","title":"ConnectIdentitySupplierDetails","data":{"type":"object","properties":{"supplierName":{"type":["string","null"]},"supplierType":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityReportAlias":{"id":"components/schemas/ConnectIdentityReportAlias","kind":"json-schema","title":"ConnectIdentityReportAlias","data":{"type":"object","properties":{"declared":{"type":"boolean"},"name":{"type":["string","null"]},"alias":{"type":["string","null"]},"source":{"type":["string","null"]},"sourceType":{"type":["string","null"]},"creationDate":{"type":["string","null"],"format":"date-time"},"lastConfirmation":{"type":["string","null"],"format":"date-time"},"supplierDetails":{"$ref":"#/components/schemas/ConnectIdentitySupplierDetails"},"notices":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportNotice"}}}}},"components/schemas/ConnectIdentityReportAssociate":{"id":"components/schemas/ConnectIdentityReportAssociate","kind":"json-schema","title":"ConnectIdentityReportAssociate","data":{"type":"object","properties":{"navigationLinkId":{"type":["string","null"]},"name":{"type":["string","null"]},"creationDate":{"type":["string","null"],"format":"date-time"},"lastConfirmation":{"type":["string","null"],"format":"date-time"},"supplierDetails":{"$ref":"#/components/schemas/ConnectIdentitySupplierDetails"},"declared":{"type":"boolean"},"associateId":{"type":["integer","null"],"format":"int32"},"notices":{"type":"array","items":{"$ref":"#/components/schemas/ConnectIdentityReportNotice"}}}}},"components/schemas/ConnectIdentityReportLinks":{"id":"components/schemas/ConnectIdentityReportLinks","kind":"json-schema","title":"ConnectIdentityReportLinks","data":{"type":"object","properties":{"undeclaredAddresses":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportUndeclaredAddress"}},"aliases":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportAlias"}},"associates":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportAssociate"}},"notices":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportNotice"}}}}},"components/schemas/ConnectIdentityReportCifas":{"id":"components/schemas/ConnectIdentityReportCifas","kind":"json-schema","title":"ConnectIdentityReportCifas","data":{"type":"object"}},"components/schemas/ConnectIdentityReportRtr":{"id":"components/schemas/ConnectIdentityReportRtr","kind":"json-schema","title":"ConnectIdentityReportRtr","data":{"type":"object"}},"components/schemas/ConnectIdentityInsolvencyRestriction":{"id":"components/schemas/ConnectIdentityInsolvencyRestriction","kind":"json-schema","title":"ConnectIdentityInsolvencyRestriction","data":{"type":"object","properties":{"type":{"type":["string","null"]},"startDate":{"type":["string","null"],"format":"date-time"},"endDate":{"type":["string","null"],"format":"date-time"}}}},"components/schemas/ConnectIdentityReportInsolvency":{"id":"components/schemas/ConnectIdentityReportInsolvency","kind":"json-schema","title":"ConnectIdentityReportInsolvency","data":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/ConnectIdentityReportAddress"},"companyName":{"type":["string","null"]},"court":{"type":["string","null"]},"dischargeDate":{"type":["string","null"],"format":"date-time"},"name":{"type":["string","null"]},"orderDate":{"type":["string","null"],"format":"date-time"},"orderType":{"type":["string","null"]},"status":{"type":["string","null"]},"tradingName":{"type":["string","null"]},"lineOfBusiness":{"type":["string","null"]},"amount":{"type":["integer","null"],"format":"int32"},"caseYear":{"type":["integer","null"],"format":"int32"},"caseRef":{"type":["string","null"]},"dateOfBirth":{"type":["string","null"],"format":"date-time"},"notices":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportNotice"}},"restriction":{"$ref":"#/components/schemas/ConnectIdentityInsolvencyRestriction"}}}},"components/schemas/ConnectIdentityReportJudgement":{"id":"components/schemas/ConnectIdentityReportJudgement","kind":"json-schema","title":"ConnectIdentityReportJudgement","data":{"type":"object","properties":{"name":{"type":["string","null"]},"address":{"$ref":"#/components/schemas/ConnectIdentityReportAddress"},"addressCurrent":{"type":"boolean"},"dateOfBirth":{"type":["string","null"],"format":"date-time"},"judgementDate":{"type":["string","null"],"format":"date-time"},"amount":{"type":"integer","format":"int32"},"status":{"type":["string","null"]},"court":{"type":["string","null"]},"courtType":{"type":["string","null"]},"caseNumber":{"type":["string","null"]},"satifiedDate":{"type":["string","null"],"format":"date-time"},"notices":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportNotice"}}}}},"components/schemas/ConnectIdentityReportHistory":{"id":"components/schemas/ConnectIdentityReportHistory","kind":"json-schema","title":"ConnectIdentityReportHistory","data":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/ConnectIdentityReportAddress"},"addressMatch":{"type":["string","null"]},"balance":{"type":["integer","null"],"format":"int32"},"date":{"type":["string","null"],"format":"date-time"},"dateOfBirth":{"type":["string","null"],"format":"date-time"},"startDate":{"type":["string","null"],"format":"date-time"},"endDate":{"type":["string","null"],"format":"date-time"},"jointApplication":{"type":["boolean","null"]},"linkType":{"type":["string","null"]},"name":{"type":["string","null"]},"tpOptIn":{"type":"boolean"},"organisationName":{"type":["string","null"]},"organisationType":{"type":["string","null"]},"ownSearch":{"type":"boolean"},"purpose":{"type":["string","null"]},"reason":{"type":["string","null"]},"reference":{"type":["string","null"]},"supplierReference":{"type":["string","null"]},"subsequentEnquiry":{"type":"boolean"},"term":{"type":["integer","null"],"format":"int32"},"transient":{"type":["boolean","null"]},"creditType":{"type":["string","null"]},"unitName":{"type":["string","null"]},"userName":{"type":["string","null"]},"searchDate":{"type":["string","null"],"format":"date-time"},"searchUnitName":{"type":["string","null"]},"searchOrganisationName":{"type":["string","null"]},"searchOrganisationType":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityDemographic":{"id":"components/schemas/ConnectIdentityDemographic","kind":"json-schema","title":"ConnectIdentityDemographic","data":{"type":"object","properties":{"sortOrder":{"type":"integer","format":"int32"},"description":{"type":["string","null"]},"label":{"type":["string","null"]},"score":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityDemographicsNeighbourhoodDefinition":{"id":"components/schemas/ConnectIdentityDemographicsNeighbourhoodDefinition","kind":"json-schema","title":"ConnectIdentityDemographicsNeighbourhoodDefinition","data":{"type":"object","properties":{"financeGroup":{"type":["string","null"]},"financeGroupHouseholdPerc":{"type":["string","null"]},"income":{"type":["string","null"]},"incomeGroup":{"type":["string","null"]},"investorHouseholdPerc":{"type":["string","null"]},"investorIndex":{"type":["string","null"]},"riskFactor":{"type":["string","null"]},"uk":{"type":["string","null"]},"ukGroup":{"type":["string","null"]},"ukHouseholdPerc":{"type":["string","null"]},"description":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityDemographicsPropertyComposition":{"id":"components/schemas/ConnectIdentityDemographicsPropertyComposition","kind":"json-schema","title":"ConnectIdentityDemographicsPropertyComposition","data":{"type":"object","properties":{"averageDetachedPropertyValue":{"type":["string","null"]},"averageDetachedPropertyValueDescription":{"type":["string","null"]},"averageFlatPropertyValue":{"type":["string","null"]},"averageFlatPropertyValueDescriptionField":{"type":["string","null"]},"averageHouseAge":{"type":["string","null"]},"averageSemiDetachedPropertyValue":{"type":["string","null"]},"averageSemiDetachedPropertyValueDescription":{"type":["string","null"]},"averageTerracePropertyValue":{"type":["string","null"]},"averageTerracePropertyValueDescription":{"type":["string","null"]},"councilTaxBand":{"type":["string","null"]},"councilTaxBandDescription":{"type":["string","null"]},"householdDensity":{"type":["string","null"]},"locationType":{"type":["string","null"]},"nationalAverageHousePrice":{"type":["string","null"]},"nationalAverageHousePriceAboveOrBelow":{"type":["string","null"]},"nationalAverageHousePriceDifference":{"type":["string","null"]},"averageFlatPropertyValueDescription":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityDemographicsShareholderComposition":{"id":"components/schemas/ConnectIdentityDemographicsShareholderComposition","kind":"json-schema","title":"ConnectIdentityDemographicsShareholderComposition","data":{"type":"object","properties":{"averageInvestments":{"type":["string","null"]},"averageInvestmentsDescription":{"type":["string","null"]},"averageInvestmentsLabel":{"type":["string","null"]},"averageShareholders":{"type":["string","null"]},"averageShareholdersDescription":{"type":["string","null"]},"averageShareholdersLabel":{"type":["string","null"]},"averageShares":{"type":["string","null"]},"averageSharesDescription":{"type":["string","null"]},"averageSharesLabel":{"type":["string","null"]},"averageValue":{"type":["string","null"]},"averageValueDescription":{"type":["string","null"]},"averageValueLabel":{"type":["string","null"]},"proportionOfHouseholdsWithShares":{"type":["string","null"]},"proportionOfHouseholdsWithSharesDescription":{"type":["string","null"]},"proportionOfHouseholdsWithSharesLabel":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityDemographicsUnemploymentComposition":{"id":"components/schemas/ConnectIdentityDemographicsUnemploymentComposition","kind":"json-schema","title":"ConnectIdentityDemographicsUnemploymentComposition","data":{"type":"object","properties":{"maleLongTermUnemployment":{"type":["string","null"]},"maleLongTermUnemploymentDescription":{"type":["string","null"]},"maleLongTermUnemploymentLabel":{"type":["string","null"]},"unemploymentAmong18to24YearOlds":{"type":["string","null"]},"unemploymentAmong18to24YearOldsDescription":{"type":["string","null"]},"unemploymentAmong18to24YearOldsLabel":{"type":["string","null"]},"unemploymentAmong25to39YearOlds":{"type":["string","null"]},"unemploymentAmong25to39YearOldsDescription":{"type":["string","null"]},"unemploymentAmong25to39YearOldsLabel":{"type":["string","null"]},"unemploymentAmongThoseAged40andOlder":{"type":["string","null"]},"unemploymentAmongThoseAged40andOlderDescription":{"type":["string","null"]},"unemploymentAmongThoseAged40andOlderLabel":{"type":["string","null"]},"unemploymentScoreLabel":{"type":["string","null"]},"unemploymentScoreDescription":{"type":["string","null"]},"unemploymentScore":{"type":["string","null"]},"maleLongTermUnemploymentScore":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityReportDemographics":{"id":"components/schemas/ConnectIdentityReportDemographics","kind":"json-schema","title":"ConnectIdentityReportDemographics","data":{"type":"object","properties":{"cameoCode":{"type":["string","null"]},"cameoInvestorCode":{"type":["string","null"]},"cameoIncomeCode":{"type":["string","null"]},"cameoUnemploymentCode":{"type":["string","null"]},"cameoPropertyCode":{"type":["string","null"]},"cameoFinanceCode":{"type":["string","null"]},"cameoFinanceGroup":{"type":["string","null"]},"cameoIncomeGroup":{"type":["string","null"]},"cameoInvestmentGroup":{"type":["string","null"]},"cameoGroup":{"type":["string","null"]},"familyComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographic"},"ageComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographic"},"economicComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographic"},"economicActivityComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographic"},"hasValues":{"type":"boolean"},"houseTypeComposition":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityDemographic"}},"householdComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographic"},"lifestageComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographic"},"mortgageComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographic"},"neighbourhoodDefinition":{"$ref":"#/components/schemas/ConnectIdentityDemographicsNeighbourhoodDefinition"},"occupationComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographic"},"propertyComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographicsPropertyComposition"},"shareholderComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographicsShareholderComposition"},"socialClassComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographic"},"tenureComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographic"},"unemploymentComposition":{"$ref":"#/components/schemas/ConnectIdentityDemographicsUnemploymentComposition"}}}},"components/schemas/ConnectIdentityThirdPartyAlerts":{"id":"components/schemas/ConnectIdentityThirdPartyAlerts","kind":"json-schema","title":"ConnectIdentityThirdPartyAlerts","data":{"type":"object","properties":{"decision":{"type":"integer","format":"int32"},"review":{"type":"integer","format":"int32"},"hho":{"type":"integer","format":"int32"}}}},"components/schemas/ConnectIdentityShareAccountSupplierDetails":{"id":"components/schemas/ConnectIdentityShareAccountSupplierDetails","kind":"json-schema","title":"ConnectIdentityShareAccountSupplierDetails","data":{"type":"object","properties":{"behaviouralData":{"type":["boolean","null"]},"supplierName":{"type":["string","null"]},"supplierType":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityShareAccountHistory":{"id":"components/schemas/ConnectIdentityShareAccountHistory","kind":"json-schema","title":"ConnectIdentityShareAccountHistory","data":{"type":"object","properties":{"yearAndMonth":{"type":["string","null"]},"balance":{"type":["integer","null"],"format":"int32"},"limit":{"type":["integer","null"],"format":"int32"},"status":{"type":["string","null"]},"statusDescription":{"type":["string","null"]},"paymentStatus":{"type":["string","null"]},"paymentStatusDescription":{"type":["string","null"]},"statementBalance":{"type":["integer","null"],"format":"int32"},"paymentAmount":{"type":["integer","null"],"format":"int32"},"cashAdvanceCount":{"type":["integer","null"],"format":"int32"},"cashAdvancesTotal":{"type":["integer","null"],"format":"int32"}}}},"components/schemas/ConnectIdentityShareAccountHolderDetails":{"id":"components/schemas/ConnectIdentityShareAccountHolderDetails","kind":"json-schema","title":"ConnectIdentityShareAccountHolderDetails","data":{"type":"object","properties":{"name":{"type":["string","null"]},"address":{"$ref":"#/components/schemas/ConnectIdentityReportAddress"},"dateOfBirth":{"type":["string","null"],"format":"date-time"},"status":{"type":["string","null"]},"startDate":{"type":["string","null"],"format":"date-time"},"endDate":{"type":["string","null"],"format":"date-time"}}}},"components/schemas/ConnectIdentityShareAccountDefault":{"id":"components/schemas/ConnectIdentityShareAccountDefault","kind":"json-schema","title":"ConnectIdentityShareAccountDefault","data":{"type":"object","properties":{"date":{"type":["string","null"],"format":"date-time"},"originalBalance":{"type":"integer","format":"int32"},"terminationBalance":{"type":["integer","null"],"format":"int32"},"satisfactionDate":{"type":["string","null"],"format":"date-time"},"repossessionDate":{"type":["string","null"],"format":"date-time"}}}},"components/schemas/ConnectIdentityShareAccountDelinquency":{"id":"components/schemas/ConnectIdentityShareAccountDelinquency","kind":"json-schema","title":"ConnectIdentityShareAccountDelinquency","data":{"type":"object","properties":{"date":{"type":["string","null"],"format":"date-time"},"balance":{"type":"integer","format":"int32"}}}},"components/schemas/ConnectIdentityShareAccountHistoryBatch":{"id":"components/schemas/ConnectIdentityShareAccountHistoryBatch","kind":"json-schema","title":"ConnectIdentityShareAccountHistoryBatch","data":{"type":"object","properties":{"accountHistory":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityShareAccountHistory"}},"isFirstBatch":{"type":"boolean"},"isLastBatch":{"type":"boolean"}}}},"components/schemas/ConnectIdentityShareAccountDetails":{"id":"components/schemas/ConnectIdentityShareAccountDetails","kind":"json-schema","title":"ConnectIdentityShareAccountDetails","data":{"type":"object","properties":{"accountNumber":{"type":["string","null"]},"accountSuffix":{"type":["integer","null"],"format":"int32"},"joint":{"type":"boolean"},"status":{"type":["string","null"]},"dateUpdated":{"type":["string","null"],"format":"date-time"},"currencyCode":{"type":["string","null"]},"balance":{"type":["integer","null"],"format":"int32"},"limit":{"type":["integer","null"],"format":"int32"},"openingBalance":{"type":["integer","null"],"format":"int32"},"arrangementStartDate":{"type":["string","null"],"format":"date-time"},"arrangementEndDate":{"type":["string","null"],"format":"date-time"},"paymentStartDate":{"type":["string","null"],"format":"date-time"}}}},"components/schemas/ConnectIdentityReportShareAccount":{"id":"components/schemas/ConnectIdentityReportShareAccount","kind":"json-schema","title":"ConnectIdentityReportShareAccount","data":{"type":"object","properties":{"supplierDetails":{"$ref":"#/components/schemas/ConnectIdentityShareAccountSupplierDetails"},"history":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityShareAccountHistory"}},"holderDetails":{"$ref":"#/components/schemas/ConnectIdentityShareAccountHolderDetails"},"default":{"$ref":"#/components/schemas/ConnectIdentityShareAccountDefault"},"delinquency":{"$ref":"#/components/schemas/ConnectIdentityShareAccountDelinquency"},"historyBatches":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityShareAccountHistoryBatch"}},"details":{"$ref":"#/components/schemas/ConnectIdentityShareAccountDetails"},"notices":{"type":"array","items":{"$ref":"#/components/schemas/ConnectIdentityReportNotice"}}}}},"components/schemas/ConnectIdentityCreditReport":{"id":"components/schemas/ConnectIdentityCreditReport","kind":"json-schema","title":"ConnectIdentityCreditReport","data":{"type":"object","properties":{"reportTitle":{"type":["string","null"]},"reportType":{"type":["string","null"]},"summary":{"$ref":"#/components/schemas/ConnectIdentitySummary"},"score":{"$ref":"#/components/schemas/ConnectIdentityCreditScore"},"address":{"$ref":"#/components/schemas/ConnectIdentityReportAddress"},"previousAddress1":{"$ref":"#/components/schemas/ConnectIdentityReportAddress"},"previousAddress2":{"$ref":"#/components/schemas/ConnectIdentityReportAddress"},"links":{"$ref":"#/components/schemas/ConnectIdentityReportLinks"},"cifas":{"$ref":"#/components/schemas/ConnectIdentityReportCifas"},"rtr":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportRtr"}},"insolvencies":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportInsolvency"}},"judgements":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportJudgement"}},"history":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportHistory"}},"notices":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportNotice"}},"demographics":{"$ref":"#/components/schemas/ConnectIdentityReportDemographics"},"thirdPartyAlerts":{"$ref":"#/components/schemas/ConnectIdentityThirdPartyAlerts"},"shareAccounts":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityReportShareAccount"}}}}},"components/schemas/ConnectIdentityTransUnionResult":{"id":"components/schemas/ConnectIdentityTransUnionResult","kind":"json-schema","title":"ConnectIdentityTransUnionResult","data":{"type":"object","properties":{"applicant1Report":{"$ref":"#/components/schemas/ConnectIdentityCreditReport"},"applicant2Report":{"$ref":"#/components/schemas/ConnectIdentityCreditReport"},"dateAndTimeOfReport":{"type":["string","null"],"format":"date-time"},"gaugeVersion":{"type":["string","null"]},"reason":{"type":["string","null"]},"success":{"type":"boolean"},"supplierId":{"type":["string","null"]},"supplierOriginalId":{"type":["string","null"]},"creditsIncurred":{"type":"integer","format":"int32"}}}},"components/schemas/ConnectIdentityMappedDocuments":{"id":"components/schemas/ConnectIdentityMappedDocuments","kind":"json-schema","title":"ConnectIdentityMappedDocuments","data":{"type":"object"}},"components/schemas/ConnectIdentityMatchValue":{"id":"components/schemas/ConnectIdentityMatchValue","kind":"json-schema","title":"ConnectIdentityMatchValue","data":{"enum":[0,1,2,3],"type":"integer","format":"int32"}},"components/schemas/ConnectIdentityMappedResultCodeDetails":{"id":"components/schemas/ConnectIdentityMappedResultCodeDetails","kind":"json-schema","title":"ConnectIdentityMappedResultCodeDetails","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"description":{"type":["string","null"]},"override":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityPepSanctionAddress":{"id":"components/schemas/ConnectIdentityPepSanctionAddress","kind":"json-schema","title":"ConnectIdentityPepSanctionAddress","data":{"type":"object","properties":{"city":{"type":["string","null"]},"country":{"type":["string","null"]},"firstLine":{"type":["string","null"]},"region":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityDateType":{"id":"components/schemas/ConnectIdentityDateType","kind":"json-schema","title":"ConnectIdentityDateType","data":{"enum":[0,1,2],"type":"integer","format":"int32"}},"components/schemas/ConnectIdentityPepSanctionDate":{"id":"components/schemas/ConnectIdentityPepSanctionDate","kind":"json-schema","title":"ConnectIdentityPepSanctionDate","data":{"type":"object","properties":{"date":{"type":["string","null"],"format":"date-time"},"dateType":{"$ref":"#/components/schemas/ConnectIdentityDateType"}}}},"components/schemas/ConnectIdentityMappedSanctionDetail":{"id":"components/schemas/ConnectIdentityMappedSanctionDetail","kind":"json-schema","title":"ConnectIdentityMappedSanctionDetail","data":{"type":"object","properties":{"aliases":{"type":["array","null"],"items":{"type":"string"}},"fullName":{"type":["string","null"]},"identityInformation":{"type":["array","null"],"items":{"type":"string"}},"addresses":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityPepSanctionAddress"}},"sanctionBodies":{"type":["array","null"],"items":{"type":"string"}},"dates":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityPepSanctionDate"}}}}},"components/schemas/ConnectIdentityMappedSanctionMatch":{"id":"components/schemas/ConnectIdentityMappedSanctionMatch","kind":"json-schema","title":"ConnectIdentityMappedSanctionMatch","data":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/ConnectIdentityMappedSanctionDetail"},"id":{"type":["string","null"]},"score":{"type":["integer","null"],"format":"int32"},"url":{"type":["string","null"]}}}},"components/schemas/ConnectIdentityMappedPepMatch":{"id":"components/schemas/ConnectIdentityMappedPepMatch","kind":"json-schema","title":"ConnectIdentityMappedPepMatch","data":{"type":"object"}},"components/schemas/ConnectIdentityMappedResultCode":{"id":"components/schemas/ConnectIdentityMappedResultCode","kind":"json-schema","title":"ConnectIdentityMappedResultCode","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":["string","null"]},"description":{"type":["string","null"]},"address":{"$ref":"#/components/schemas/ConnectIdentityMatchValue"},"alert":{"$ref":"#/components/schemas/ConnectIdentityMatchValue"},"dateOfBirth":{"$ref":"#/components/schemas/ConnectIdentityMatchValue"},"forename":{"$ref":"#/components/schemas/ConnectIdentityMatchValue"},"surname":{"$ref":"#/components/schemas/ConnectIdentityMatchValue"},"pass":{"$ref":"#/components/schemas/ConnectIdentityMatchValue"},"comments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityMappedResultCodeDetails"}},"match":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityMappedResultCodeDetails"}},"misMatch":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityMappedResultCodeDetails"}},"sanctions":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityMappedSanctionMatch"}},"peps":{"type":"array","items":{"$ref":"#/components/schemas/ConnectIdentityMappedPepMatch"}}}}},"components/schemas/ConnectIdentityIdAmlResult":{"id":"components/schemas/ConnectIdentityIdAmlResult","kind":"json-schema","title":"ConnectIdentityIdAmlResult","data":{"type":"object","properties":{"authenticationID":{"type":["string","null"]},"bandText":{"type":["string","null"]},"birthIndexMatch":{"type":["boolean","null"]},"chainID":{"type":["string","null"]},"documents":{"$ref":"#/components/schemas/ConnectIdentityMappedDocuments"},"noRetry":{"type":["boolean","null"]},"resultCodes":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/ConnectIdentityMappedResultCode"}},"score":{"type":["integer","null"],"format":"int32"},"searchText":{"type":["string","null"]},"legacyUniqueID":{"type":["string","null"]},"validationID":{"type":["string","null"]},"hasAlerts":{"type":"boolean"},"success":{"type":"boolean"},"supplierId":{"type":["string","null"]},"supplierOriginalId":{"type":["string","null"]},"creditsIncurred":{"type":"integer","format":"int32"}}}},"components/schemas/ConnectIdentityIdentityHistoryItem":{"id":"components/schemas/ConnectIdentityIdentityHistoryItem","kind":"json-schema","title":"ConnectIdentityIdentityHistoryItem","data":{"type":"object","properties":{"uniqueId":{"type":["string","null"]},"customerId":{"type":"integer","format":"int64"},"userId":{"type":"integer","format":"int64"},"searchTime":{"type":"string","format":"date-time"},"searchText":{"type":["string","null"]},"reference":{"type":["string","null"]},"hasConsumerInt":{"type":["integer","null"],"format":"int32"},"hasConsumer":{"type":["boolean","null"]},"hasIdInt":{"type":["integer","null"],"format":"int32"},"hasId":{"type":["boolean","null"]},"hasAmlInt":{"type":["integer","null"],"format":"int32"},"hasAml":{"type":["boolean","null"]},"hasBankMatchInt":{"type":["integer","null"],"format":"int32"},"hasBankMatch":{"type":["boolean","null"]},"hasAmlWithBankMatchInt":{"type":["integer","null"],"format":"int32"},"hasAmlWithBankMatch":{"type":["boolean","null"]},"consumerId":{"type":["string","null"]},"consumerOriginalId":{"type":["string","null"]},"consumerBand1":{"type":["integer","null"],"format":"int32"},"consumerScore1":{"type":["integer","null"],"format":"int32"},"consumerBand2":{"type":["integer","null"],"format":"int32"},"consumerScore2":{"type":["integer","null"],"format":"int32"},"gaugeVersion":{"type":["string","null"]},"consumerReason":{"type":["string","null"]},"linkedReport":{"type":["string","null"]},"idId":{"type":["string","null"]},"idAuthenticationId":{"type":["string","null"]},"idChainId":{"type":["string","null"]},"idValidationId":{"type":["string","null"]},"idLegacyID":{"type":["string","null"]},"idResult":{"$ref":"#/components/schemas/ConnectIdentityAmlResultCode"},"idHasAlertsInt":{"type":["integer","null"],"format":"int32"},"idHasAlerts":{"type":["boolean","null"]},"amlType":{"$ref":"#/components/schemas/ConnectIdentityProduct"},"amlId":{"type":["string","null"]},"amlAuthenticationId":{"type":["string","null"]},"amlChainId":{"type":["string","null"]},"amlValidationId":{"type":["string","null"]},"amlLegacyID":{"type":["string","null"]},"amlResult":{"$ref":"#/components/schemas/ConnectIdentityAmlResultCode"},"amlHasAlertsInt":{"type":["integer","null"],"format":"int32"},"amlHasAlerts":{"type":["boolean","null"]},"idRevalidatedInt":{"type":["integer","null"],"format":"int32"},"idHasRevalidated":{"type":["boolean","null"]},"idCanRevalidate":{"type":["boolean","null"]},"amlRevalidatedInt":{"type":["integer","null"],"format":"int32"},"amlHasRevalidated":{"type":["boolean","null"]},"amlCanRevalidate":{"type":["boolean","null"]},"input":{"$ref":"#/components/schemas/ConnectIdentityAMLSearchRequest"},"consumer":{"$ref":"#/components/schemas/ConnectIdentityTransUnionResult"},"id":{"$ref":"#/components/schemas/ConnectIdentityIdAmlResult"},"aml":{"$ref":"#/components/schemas/ConnectIdentityIdAmlResult"}}}},"components/schemas/ConnectIdentityHistoryListResponse":{"id":"components/schemas/ConnectIdentityHistoryListResponse","kind":"json-schema","title":"ConnectIdentityHistoryListResponse","data":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityIdentityHistoryItem"}},"message":{"type":["string","null"]},"errors":{"type":["object","null"],"additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"components/schemas/ConnectIdentityPassport":{"id":"components/schemas/ConnectIdentityPassport","kind":"json-schema","title":"ConnectIdentityPassport","data":{"type":"object"}},"components/schemas/ConnectIdentityDriversLicense":{"id":"components/schemas/ConnectIdentityDriversLicense","kind":"json-schema","title":"ConnectIdentityDriversLicense","data":{"type":"object"}},"components/schemas/ConnectIdentityElectricitySupplier":{"id":"components/schemas/ConnectIdentityElectricitySupplier","kind":"json-schema","title":"ConnectIdentityElectricitySupplier","data":{"type":"object"}},"components/schemas/ConnectIdentityEuropeanIDCard":{"id":"components/schemas/ConnectIdentityEuropeanIDCard","kind":"json-schema","title":"ConnectIdentityEuropeanIDCard","data":{"type":"object"}},"components/schemas/ConnectIdentityNINumber":{"id":"components/schemas/ConnectIdentityNINumber","kind":"json-schema","title":"ConnectIdentityNINumber","data":{"type":"object"}},"components/schemas/ConnectIdentityBankAccountDetails":{"id":"components/schemas/ConnectIdentityBankAccountDetails","kind":"json-schema","title":"ConnectIdentityBankAccountDetails","data":{"type":"object"}},"components/schemas/ConnectIdentityRevalidateRequest":{"id":"components/schemas/ConnectIdentityRevalidateRequest","kind":"json-schema","title":"ConnectIdentityRevalidateRequest","data":{"type":"object","properties":{"uniqueId":{"type":["string","null"]},"passport":{"$ref":"#/components/schemas/ConnectIdentityPassport"},"driversLicense":{"$ref":"#/components/schemas/ConnectIdentityDriversLicense"},"electricitySupplier":{"$ref":"#/components/schemas/ConnectIdentityElectricitySupplier"},"europeanIDCard":{"$ref":"#/components/schemas/ConnectIdentityEuropeanIDCard"},"niNumber":{"$ref":"#/components/schemas/ConnectIdentityNINumber"},"bankAccountDetails":{"$ref":"#/components/schemas/ConnectIdentityBankAccountDetails"}}}},"components/schemas/ConnectIdentityReasonResponse":{"id":"components/schemas/ConnectIdentityReasonResponse","kind":"json-schema","title":"ConnectIdentityReasonResponse","data":{"type":"object","properties":{"data":{"type":["object","null"],"additionalProperties":{"type":"boolean"}},"message":{"type":["string","null"]},"errors":{"type":["object","null"],"additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"components/schemas/CreditsafeLocalSolutionsGBLandRegistry":{"id":"components/schemas/CreditsafeLocalSolutionsGBLandRegistry","kind":"json-schema","title":"CreditsafeLocalSolutionsGBLandRegistry","data":{"type":"object","example":{"totalSize":64293,"data":[{"rn":1,"address":"Land at Gorse Hill, Farningham, Dartford, Kent, South East","tenure":"Freehold","registeredTitle":"K945315","proprietorship":"Limited Company or Public Limited Company","correspondenceAddress":"Bridge House, 1 Walnut Tree Close, Guildford, Surrey GU1 4LZ, Ash House Falcon Road, Sowton, Exeter EX2 7LB","changeDate":"2015-08-20T00:00:00","propertyType":"Other","newlyBuild":"No","companyRegistrationNo":"09346363"},{"rn":2,"address":"Land at Gorse Hill, Farningham, Dartford, Kent, South East","tenure":"Freehold","registeredTitle":"K945323","proprietorship":"Limited Company or Public Limited Company","correspondenceAddress":"Bridge House, 1 Walnut Tree Close, Guildford, Surrey GU1 4LZ, Ash House Falcon Road, Sowton, Exeter EX2 7LB","changeDate":"2015-08-20T00:00:00","propertyType":"Other","newlyBuild":"No","companyRegistrationNo":"09346363"}]}}},"components/schemas/GBLocalSolutionBankVerificationSearchRequest":{"id":"components/schemas/GBLocalSolutionBankVerificationSearchRequest","kind":"json-schema","title":"GBLocalSolutionBankVerificationSearchRequest","data":{"type":"object","required":["customerName","bankAccount","sortCode","accountType"],"properties":{"customerName":{"type":"string","description":"This field is for the name on the account you are matching against with the bankAccount, sortCode and secondaryReference fields"},"bankAccount":{"type":"string","description":"Must be numeric and a length of 8 characters"},"sortCode":{"type":"string","description":"Must be numeric and a length of 6 characters"},"accountType":{"type":"string","description":"field must be either Business or Personal, it can not be blank or any other value"},"secondaryReference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should not be used unless you have been advised to use this by a bank or building society"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will affect the results data"},"children":[]}]}]}]},"customerReference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field is for text input and does not affect the search result"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field can be used for filtering your past results at a later date"},"children":[]}]}]}]}}}},"components/schemas/SortCodeCheckResponse":{"id":"components/schemas/SortCodeCheckResponse","kind":"json-schema","title":"SortCodeCheckResponse","data":{"type":"object","properties":{"sortCode":{"type":"string","description":"The sorting code of the bank office."},"bankName":{"type":"string","description":"The full name of the owning bank."},"branchName":{"type":"string","description":"The full bank office title."},"address":{"type":"object","properties":{"simpleValue":{"type":"string","description":"The full address details of the bank office."},"country":{"type":"string","description":"The country the bank office resides in."},"postCode":{"type":"string","description":"Postal code for the full address line."}}},"telephone":{"type":"string","description":"The telephone number of the bank office."},"bicCode":{"type":"string","description":"The Bank Identifier Code (BIC) for the bank office."},"chapsBicCode":{"type":"string","description":"A CHAPS BIC code refers to the Bank Identifier Code (BIC) of a financial institution that is a participant in the CHAPS payment system in the United Kingdom."},"paymentTypes":{"type":"object","properties":{"chaps":{"type":"boolean","description":"Indicates whether the bank office accepts CHAPS Sterling payments."},"cncccPayment":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the bank office participates in ICS and accepts C&CCC payments."},"children":[]}]}]}]},"directDebit":{"type":"boolean","description":"Indicates whether the bank office accepts output of electronic DDIs."},"fasterPayments":{"type":"boolean","description":"Indicates whether the bank office accepts FPS payments."},"paymentBacs":{"type":"boolean","description":"Indicates whether the bank office accepts Bacs payments."}}}}}},"components/schemas/GBLocalSolutionBankVerificationSearchResponse":{"id":"components/schemas/GBLocalSolutionBankVerificationSearchResponse","kind":"json-schema","title":"GBLocalSolutionBankVerificationSearchResponse","data":{"type":"object","properties":{"supplierRequestData":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of the customer queried with the the supplier"},"bankAccount":{"type":"string","description":"Bank account number queried with the the supplier"},"sortCode":{"type":"string","description":"Sort code queried with the the supplier"},"accountType":{"type":"string","description":"Type of account - Business or Personal"},"secondaryReference":{"type":"string","description":"Secondary reference queried with the the supplier"}}},"customerReference":{"type":"string","description":"Your Customer reference as described in the requestBody"},"supplierResponse":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of the customer returned by the supplier"},"bankAccount":{"type":"string","description":"The bank account number returned by the supplier"},"sortCode":{"type":"string","description":"The sort code returned by the supplier"},"returnedCustomerName":{"type":"string","description":"A potential name of the customer returned by the supplier when the result is a close match returned by the supplier"},"result":{"type":"boolean","description":"Whether the result is a match or not a match returned by the supplier"},"resultText":{"type":"string","description":"A detailed result returned by the supplier, this includes details of a close match"},"nameMatchResult":{"type":"string","description":"The name match result returned by the supplier. Values are \"No Match\", \"Full\" or \"Close\""},"accountTypeResult":{"type":"boolean","description":"The account type match returned by the supplier. When 'nameMatchResult' is \"Full\" or \"Close\" and this is false then this indicates that the \"accountType\" provided does not match"},"reasonCode":{"type":"string","description":"A reason code returned by the supplier"}}},"requestDatetime":{"type":"string","description":"The date time this request was returned"},"requestId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique reference to your request used for querying the below endpoints where {id} is required"},"children":[]}]}]}]},"sortCodeDetails":{"description":"Provides additional information about the returned sort code. This property is only returned when an additional service line is active. Please contact your account manager for details about availability and enabling this feature.","$ref":"#/components/schemas/SortCodeCheckResponse"}}}},"components/schemas/GBLocalSolutionGetHistoryListResponse":{"id":"components/schemas/GBLocalSolutionGetHistoryListResponse","kind":"json-schema","title":"GBLocalSolutionGetHistoryListResponse","data":{"type":"object","properties":{"requestId":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique reference to your request used for querying the endpoints where {id} is required"},"children":[]}]}]}]},"customerName":{"type":"string","description":"Name of the customer returned by the supplier"},"accountType":{"type":"string","description":"Type of account queried with the the supplier. Possible values are Business or Personal"},"customerReference":{"type":"string","description":"Your Customer reference"},"matchResult":{"type":"string","description":"Whether a match or not a match returned by the supplier. Possible values are Full, Close, No Match"},"requestDatetime":{"type":"string","format":"date-time","description":"The date time this request was first returned"}}}},"components/schemas/GBLocalSolutionGetHistoryRequestResponse":{"id":"components/schemas/GBLocalSolutionGetHistoryRequestResponse","kind":"json-schema","title":"GBLocalSolutionGetHistoryRequestResponse","data":{"type":"object","properties":{"supplierRequestData":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of the customer queried with the the supplier"},"accountType":{"type":"string","description":"Type of account queried with the the supplier"},"secondaryReference":{"type":"string","description":"Secondary reference queried with the the supplier"}}},"customerReference":{"type":"string","description":"Your Customer reference"},"supplierResponse":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of the customer returned by the supplier"},"returnedCustomerName":{"type":"string","description":"A potential name of the customer returned by the supplier when the result is a close match returned by the supplier"},"result":{"type":"boolean","description":"Whether the result is a match or not a match returned by the supplier"},"resultText":{"type":"string","description":"A detailed result returned by the supplier, this includes details of a close match"},"nameMatchResult":{"type":"string","description":"The name match result returned by the supplier. Values are \"No Match\", \"Full\" or \"Close\""},"accountTypeResult":{"type":"boolean","description":"The account type match returned by the supplier. When 'nameMatchResult' is \"Full\" or \"Close\" and this is false then this indicates that the \"accountType\" provided does not match"},"reasonCode":{"type":"string","description":"A reason code returned by the supplier"}}},"requestDatetime":{"type":"string","description":"The date time this request was returned"},"requestId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique reference to your request used for querying the endpoints where {id} is required"},"children":[]}]}]}]},"sortCodeDetails":{"description":"Provides additional information about the returned sort code. This property is only returned when an additional service line is active. Please contact your account manager for details about availability and enabling this feature.","$ref":"#/components/schemas/SortCodeCheckResponse"}}}},"components/schemas/GBLocalSolutionCPHistoryRequestByIdRequest":{"id":"components/schemas/GBLocalSolutionCPHistoryRequestByIdRequest","kind":"json-schema","title":"GBLocalSolutionCPHistoryRequestByIdRequest","data":{"type":"object","required":["customerReference"],"properties":{"customerReference":{"type":"string","description":"The replacement text to overwrite the previous customerReference in the selected history Id."}}}},"components/schemas/LocalSolutionsFRBankMatch":{"id":"components/schemas/LocalSolutionsFRBankMatch","kind":"json-schema","title":"LocalSolutionsFRBankMatch","data":{"type":"object","description":"Represents a match result from the Local Solutions FR Bank system.","properties":{"@domain":{"type":"string","description":"The domain associated with the match."},"createdBy":{"type":"string","description":"The user or system that created the match record."},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the match record was created."},"lastModifiedBy":{"type":"string","description":"The user or system that last modified the match record."},"lastModifiedDate":{"type":"string","format":"date-time","description":"The date and time when the match record was last modified."},"id":{"type":"string","description":"The unique identifier of the match record."},"score":{"type":"integer","description":"The score assigned to the match."},"classification":{"type":"string","description":"The classification of the match."},"status":{"type":"string","description":"The current status of the match."},"entity":{"type":"object","description":"Details of the entity involved in the match.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date and time when the entity was created."},"lastModifiedDate":{"type":"string","format":"date-time","description":"The date and time when the entity was last modified."},"paymentIdentity":{"type":"object","description":"Payment identity information.","properties":{"iban":{"type":"string","description":"The International Bank Account Number (IBAN)."},"type":{"type":"string","description":"The type of payment identity."}}},"company":{"type":"object","description":"Company information associated with the entity.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date and time when the company was created."},"lastModifiedDate":{"type":"string","format":"date-time","description":"The date and time when the company was last modified."},"registrationId":{"type":"string","description":"The registration ID of the company."},"name":{"type":"string","description":"The name of the company."},"legalPerson":{"type":"boolean","description":"Indicates if the company is a legal entity."},"codeTva":{"type":"string","description":"The VAT code of the company."},"typeId":{"type":"string","description":"The type ID of the company."},"countryCode":{"type":"string","description":"The country code of the company."},"status":{"type":"string","description":"The current status of the company."}}},"additionalProperties":{"type":"object","description":"Additional properties related to the entity.","properties":{"vatRequestInfo":{"type":"object","description":"VAT request information.","properties":{"valid":{"type":"boolean","description":"Indicates if the VAT request is valid."},"requestIdentifier":{"type":"string","description":"The identifier for the VAT request."},"date":{"type":"string","format":"date","description":"The date of the VAT request."}}}}}}},"issuerCompany":{"type":"object","description":"Information about the issuer company.","properties":{"createdBy":{"type":"string","description":"The user or system that created the issuer company record."},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the issuer company record was created."},"lastModifiedBy":{"type":"string","description":"The user or system that last modified the issuer company record."},"lastModifiedDate":{"type":"string","format":"date-time","description":"The date and time when the issuer company record was last modified."},"id":{"type":"string","description":"The unique identifier of the issuer company."},"registrationId":{"type":"string","description":"The registration ID of the issuer company."},"name":{"type":"string","description":"The name of the issuer company."},"typeId":{"type":"string","description":"The type ID of the issuer company."},"countryCode":{"type":"string","description":"The country code of the issuer company."}}},"input":{"type":"object","description":"Input data for the match.","properties":{"@input":{"type":"string","description":"The input data identifier."},"paymentIdentity":{"type":"object","description":"Payment identity information from the input.","properties":{"iban":{"type":"string","description":"The International Bank Account Number (IBAN) from the input."}}},"company":{"type":"object","description":"Company information from the input.","properties":{"registrationId":{"type":"string","description":"The registration ID of the company from the input."},"countryCode":{"type":"string","description":"The country code of the company from the input."}}}}},"withDeferredResult":{"type":"boolean","description":"Indicates if the match result is deferred."},"byAPI":{"type":"boolean","description":"Indicates if the match was processed via API."},"byFTP":{"type":"boolean","description":"Indicates if the match was processed via FTP."},"workflow":{"type":"string","description":"The workflow associated with the match."},"reasons":{"type":"array","items":{"type":"string"},"description":"The reasons associated with the match."},"reasonLabels":{"type":"object","description":"Labels for the reasons associated with the match.","additionalProperties":{"type":"string"}}}}},"components/schemas/ConnectUSLocalSolutionsFreshInvCreateInvestigationFormData":{"id":"components/schemas/ConnectUSLocalSolutionsFreshInvCreateInvestigationFormData","kind":"json-schema","title":"ConnectUSLocalSolutionsFreshInvCreateInvestigationFormData","data":{"type":"object","description":"Represents the data form used to submit a new investigation request within the US local solutions context. This form includes comprehensive details about the customer initiating the request as well as the target of the investigation.","additionalProperties":false,"properties":{"attachment":{"type":"string","description":"Base64 encoded string of any relevant document or file that supports the investigation request."},"fiBody":{"type":"object","description":"Contains all necessary details about the investigation, focusing on both the customer submitting the request and the target subject.","additionalProperties":false,"properties":{"companyId":{"type":"string","description":"Unique identifier for the company on behalf of which the investigation is being conducted."},"comments":{"type":"string","description":"Additional comments or instructions provided by the customer to guide the investigation process."},"companyName":{"type":"string","description":"The name of the company initiating the investigation."},"consent":{"type":"string","description":"Explicit consent provided by the customer for conducting the investigation, usually required for legal compliance."},"customerEmail":{"type":"string","description":"Email address of the customer initiating the investigation."},"customerId":{"type":"string","description":"Unique identifier of the customer requesting the investigation."},"customerName":{"type":"string","description":"Full name of the customer who is initiating the investigation."},"customerPhoneNo":{"type":"string","description":"Phone number of the customer, used for contact purposes related to the investigation."},"customerUserId":{"type":"string","description":"Unique user identifier for the customer within the system."},"executiveName":{"type":"string","description":"Name of the executive or representative of the company who is directly handling the investigation."},"ipAddress":{"type":"string","description":"IP address from which the investigation request was submitted, used for logging or security purposes."},"targetBuildingNumber":{"type":"string","description":"The building number of the address associated with the target of the investigation."},"targetCity":{"type":"string","description":"The city where the target of the investigation is located."},"targetCompanyName":{"type":"string","description":"The legal name of the company being investigated."},"targetContact":{"type":"string","description":"Contact information for the target of the investigation, such as a direct phone number or email."},"targetPhoneNo":{"type":"string","description":"Phone number associated with the target of the investigation."},"targetSosNumber":{"type":"string","description":"Secretary of State file number or other governmental identifier for the target entity."},"targetState":{"type":"string","description":"State in which the target of the investigation is located."},"targetStreet":{"type":"string","description":"Street address of the target entity."},"targetTaxId":{"type":"string","description":"Tax identification number of the target company, used for verifying its business identity."},"targetTradeName":{"type":"string","description":"Trade name or DBA (Doing Business As) under which the target company operates, if different from the legal name."},"targetWebsiteUrl":{"type":"string","description":"URL of the target company's website, providing a direct link to their online presence."},"targetZip":{"type":"string","description":"Postal code for the target company's location, used for further location-specific investigations."}}}}}},"components/schemas/ConnectUSLocalSolutionsFreshInvCreateInvestigation":{"id":"components/schemas/ConnectUSLocalSolutionsFreshInvCreateInvestigation","kind":"json-schema","title":"ConnectUSLocalSolutionsFreshInvCreateInvestigation","data":{"type":"object","additionalProperties":false,"properties":{"companyId":{"type":"string","description":"Unique identifier for the company on behalf of which the investigation is being conducted."},"comments":{"type":"string","description":"Additional comments or instructions provided by the customer to guide the investigation process."},"companyName":{"type":"string","description":"The name of the company initiating the investigation."},"consent":{"type":"string","description":"Explicit consent provided by the customer for conducting the investigation, usually required for legal compliance."},"customerEmail":{"type":"string","description":"Email address of the customer initiating the investigation."},"customerId":{"type":"string","description":"Unique identifier of the customer requesting the investigation."},"customerName":{"type":"string","description":"Full name of the customer who is initiating the investigation."},"customerPhoneNo":{"type":"string","description":"Phone number of the customer, used for contact purposes related to the investigation."},"customerUserId":{"type":"string","description":"Unique user identifier for the customer within the system."},"executiveName":{"type":"string","description":"Name of the executive or representative of the company who is directly handling the investigation."},"ipAddress":{"type":"string","description":"IP address from which the investigation request was submitted, used for logging or security purposes."},"targetBuildingNumber":{"type":"string","description":"The building number of the address associated with the target of the investigation."},"targetCity":{"type":"string","description":"The city where the target of the investigation is located."},"targetCompanyName":{"type":"string","description":"The legal name of the company being investigated."},"targetContact":{"type":"string","description":"Contact information for the target of the investigation, such as a direct phone number or email."},"targetPhoneNo":{"type":"string","description":"Phone number associated with the target of the investigation."},"targetSosNumber":{"type":"string","description":"Secretary of State file number or other governmental identifier for the target entity."},"targetState":{"type":"string","description":"State in which the target of the investigation is located."},"targetStreet":{"type":"string","description":"Street address of the target entity."},"targetTaxId":{"type":"string","description":"Tax identification number of the target company, used for verifying its business identity."},"targetTradeName":{"type":"string","description":"Trade name or DBA (Doing Business As) under which the target company operates, if different from the legal name."},"targetWebsiteUrl":{"type":"string","description":"URL of the target company's website, providing a direct link to their online presence."},"targetZip":{"type":"string","description":"Postal code for the target company's location, used for further location-specific investigations."}}}},"components/schemas/CreditsafeUSLocalFIResponse":{"id":"components/schemas/CreditsafeUSLocalFIResponse","kind":"json-schema","title":"CreditsafeUSLocalFIResponse","data":{"type":"object","properties":{"freshInvestigationRequestResult":{"type":"object","properties":{"Message":{"type":"string","example":""},"Status":{"type":"string","example":"Success"},"TransId":{"type":"string","example":"27079"}}}}}},"components/schemas/DELocalSolutionsNonLtdCompaniesSearchCriteriaResponse":{"id":"components/schemas/DELocalSolutionsNonLtdCompaniesSearchCriteriaResponse","kind":"json-schema","title":"DELocalSolutionsNonLtdCompaniesSearchCriteriaResponse","data":{"type":"object","properties":{"criteriaSets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"object","description":"The name of the company to search for. This is a mandatory field.","properties":{"required":{"type":"boolean","example":true},"minLength":{"type":"number"}}},"telephone":{"type":"object","properties":{"countryAreaCode":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The international dialing code for the telephone number (e.g., \"\"+49\"\" for Germany)."},"children":[]}]}]}],"properties":{"required":{"type":"boolean","example":false}}},"number":{"type":"object","description":"The primary telephone number.","properties":{"required":{"type":"boolean","example":false}}},"areaCode":{"type":"object","description":"The regional or city-specific area code ( e.g. \"\"030\"\" for Berlin ).","properties":{"required":{"type":"boolean","example":false}}}}},"address":{"type":"object","properties":{"postCodePoBox":{"type":"object","description":"A combination of ZIP and PO box information, if applicable.","properties":{"required":{"type":"boolean","example":false},"minLength":{"type":"number"}}},"country":{"type":"object","description":"The country of the address.","properties":{"required":{"type":"boolean","example":false},"minLength":{"type":"number"}}},"poBox":{"type":"object","description":"The post office box number, if applicable.","properties":{"required":{"type":"boolean","example":false},"minLength":{"type":"number"}}},"postCode":{"type":"object","description":"The postal code associated with the address. This field is optional.","properties":{"required":{"type":"boolean","example":false},"minLength":{"type":"number"}}},"city":{"type":"object","description":"The city where the company is located. This field is mandatory.","properties":{"required":{"type":"boolean","example":true}}},"street":{"type":"object","description":"The street name and house number for the address. This field is optional.","properties":{"required":{"type":"boolean","example":false}}}}}}}},"languages":{"type":"array","description":"The language in which the search results are returned.","items":{"type":"string"}},"country":{"type":"array","description":"The country of the address.","items":{"type":"string"}}}}},"components/schemas/DELocalSolutionsNonLtdCompaniesSearchResponse":{"id":"components/schemas/DELocalSolutionsNonLtdCompaniesSearchResponse","kind":"json-schema","title":"DELocalSolutionsNonLtdCompaniesSearchResponse","data":{"type":"object","properties":{"matches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"The primary Company identifier"},"country":{"type":"string","description":"country code"},"name":{"type":"string","description":"Company Name"},"address":{"type":"object","properties":{"simpleValue":{"type":"string","description":"Combination of street,town and zip code"},"street":{"type":"string","description":"Address part identifier - Street of the Company"},"city":{"type":"string","description":"Address part identifier - City of the Company"},"postCode":{"type":"string","description":"Address part identifier - Postcode/Zip Code of the Company"}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status of the company. [active, nonActive]"},"children":[]}]}]}]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of the company. [ltd, nonltd]"},"children":[]}]}]}]},"matchScore":{"type":"number","description":"Match score of the company"}}}}}}},"components/schemas/DELocalSolutionsNonLtdCompaniesReportResponse":{"id":"components/schemas/DELocalSolutionsNonLtdCompaniesReportResponse","kind":"json-schema","title":"DELocalSolutionsNonLtdCompaniesReportResponse","data":{"type":"object","description":"Response object containing detailed information about non-limited companies.","properties":{"pdfFile":{"type":"string","description":"Encoded PDF file containing the business report."},"status":{"type":"string","description":"Status of the report request (e.g., success, failure)."},"deCompanyData":{"type":"string","description":"Raw data related to the company in German format."},"companyData":{"type":"object","description":"Detailed information about the company.","properties":{"reportDate":{"type":"string","description":"Date when the report was generated."},"contact":{"type":"object","description":"Contact details of the person responsible for the request.","properties":{"client":{"type":"string","description":"Name of the client requesting the report."},"id":{"type":"string","description":"Unique identifier for the contact person."},"customerReference":{"type":"string","description":"Reference number provided by the customer."},"personResponsible":{"type":"string","description":"Name of the person responsible for the request."},"note":{"type":"string","description":"Additional notes related to the contact."},"requestReason":{"type":"string","description":"Reason for requesting the business report."}}},"note":{"type":"array","description":"List of notes containing additional remarks or codes.","items":{"type":"object","properties":{"code":{"type":"string","description":"Unique code identifying the note."},"description":{"type":"string","description":"Detailed description of the note."}}}},"id":{"type":"string","description":"Unique identifier of the company."},"currentBasicData":{"type":"string","description":"Basic company data as of the latest update."},"previousBasicData":{"type":"string","description":"Basic company data from previous records."},"currentAddress":{"type":"string","description":"Latest known address of the company."},"previousAddress":{"type":"string","description":"Past address details of the company."},"currentRegisterData":{"type":"string","description":"Most recent registration data of the company."},"previousRegisterData":{"type":"string","description":"Historical registration data of the company."},"creditRatingData":{"type":"string","description":"Credit rating details of the company."},"employees":{"type":"string","description":"Number of employees in the company."},"turnover":{"type":"string","description":"Revenue or turnover of the company."},"shareCapital":{"type":"string","description":"Share capital information of the company."},"profit":{"type":"string","description":"Profit details of the company."},"businessPurpose":{"type":"string","description":"Stated business purpose of the company."},"industry":{"type":"string","description":"Industry sector in which the company operates."},"balancesheet":{"type":"string","description":"Balance sheet details of the company."},"bankData":{"type":"string","description":"Bank-related information of the company."},"currentDirector":{"type":"string","description":"Current director or executive in charge."},"previousDirector":{"type":"string","description":"Previous director or executive."},"otherFunctionsCurrent":{"type":"string","description":"Other current functions or roles held within the company."},"otherFunctionsPrevious":{"type":"string","description":"Previous functions or roles held within the company."},"shareholderCurrent":{"type":"string","description":"Current shareholders of the company."},"shareholderPrevious":{"type":"string","description":"Past shareholders of the company."},"shareholderList":{"type":"string","description":"Complete list of shareholders."},"sharesCurrent":{"type":"string","description":"Current shareholding structure."},"sharesPrevious":{"type":"string","description":"Previous shareholding structure."},"furtherRelationCurrent":{"type":"string","description":"Additional current relationships linked to the company."},"furtherRelationPrevious":{"type":"string","description":"Additional past relationships linked to the company."},"notification":{"type":"string","description":"Notification details related to company updates."},"currentNotificationEvent":{"type":"string","description":"Latest notification events related to the company."},"registerPublication":{"type":"string","description":"Official registration publications."},"oldestNotification":{"type":"string","description":"Oldest available notification for the company."},"latestNotification":{"type":"string","description":"Most recent notification for the company."},"economicJustification":{"type":"string","description":"Economic justification details."},"structure":{"type":"string","description":"Organizational structure of the company."},"event":{"type":"string","description":"Significant events related to the company."},"subsidiary":{"type":"string","description":"Details about any subsidiary companies."}}}}}},"components/schemas/CreditsafeGlobalDataCountryCode":{"id":"components/schemas/CreditsafeGlobalDataCountryCode","kind":"json-schema","title":"CreditsafeGlobalDataCountryCode","data":{"description":"Country where the company is registered.","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MC","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VA","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","XK","SS","SX","CW","BQ","WW","PLC"],"type":"string"}},"components/schemas/CreditsafeGlobalDataOfficeType":{"id":"components/schemas/CreditsafeGlobalDataOfficeType","kind":"json-schema","title":"CreditsafeGlobalDataOfficeType","data":{"enum":["Registered","Trading","HeadOffice","Branch","Subsidiary","Franchise","Franchisor","SingleOffice","Other"],"type":"string"}},"components/schemas/CreditsafeGlobalDataCompanyStatus":{"id":"components/schemas/CreditsafeGlobalDataCompanyStatus","kind":"json-schema","title":"CreditsafeGlobalDataCompanyStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High-level status. Values include \"Active\", \"NonActive\", \"Pending\" and \"Other\". Note - “Pending” indicates that the entity has entered into a legal process such as insolvency or liquidation, and “Other” indicates an unknown status."},"children":[]}]}]}],"enum":["Active","NonActive","Pending","Other"],"type":"string"}},"components/schemas/CreditsafeGlobalDataCompanyType":{"id":"components/schemas/CreditsafeGlobalDataCompanyType","kind":"json-schema","title":"CreditsafeGlobalDataCompanyType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NonLtdNonReg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only available for countries in Norway."},"children":[]}]}]}],"enum":["NotSet","Ltd","NonLtd","NonLtdNonReg"],"type":"string"}},"components/schemas/CreditsafeGlobalDataMessageType":{"id":"components/schemas/CreditsafeGlobalDataMessageType","kind":"json-schema","title":"CreditsafeGlobalDataMessageType","data":{"enum":["Information","Warning","Error"],"type":"string"}},"components/schemas/CreditsafeGlobalDataMessageCode":{"id":"components/schemas/CreditsafeGlobalDataMessageCode","kind":"json-schema","title":"CreditsafeGlobalDataMessageCode","data":{"enum":["NoResults","TooManyResults","ReportUnavailable","ReportUnavailableDueToLegal","ReportUnavailableOnline","LegalNotice","InvalidCredentials","AccessRestricted","AccessLimitsNearing","InsufficientCustomerData","ReportboxAlmostFull","ReportboxFull","InvalidRequestXml","InvalidOperationParameters","OperationNotSupported","InvalidCustomData","ChangeNotification","TemporarySystemProblem","EndpointShutdown","UnexpectedInternalError","Other","DataServiceAccessProblems","DataServiceInvalidResponse"],"type":"string"}},"components/schemas/CreditsafeGlobalDataMessage":{"id":"components/schemas/CreditsafeGlobalDataMessage","kind":"json-schema","title":"CreditsafeGlobalDataMessage","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/CreditsafeGlobalDataMessageType"},"code":{"$ref":"#/components/schemas/CreditsafeGlobalDataMessageCode"},"text":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataReportsIdType":{"id":"components/schemas/CreditsafeGlobalDataReportsIdType","kind":"json-schema","title":"CreditsafeGlobalDataReportsIdType","data":{"description":"Description for the ID, to describe the type of ID presented e.g. Person number, Tax ID (if a company), Company Registration Number etc.","enum":["Other","SafeNumber","RegistrationNumber","VATNumber","TaxID","PersonNumber","ExternalID","InternalID"],"type":"string"}},"components/schemas/CreditsafeGlobalDataAdditionalInformation":{"id":"components/schemas/CreditsafeGlobalDataAdditionalInformation","kind":"json-schema","title":"CreditsafeGlobalDataAdditionalInformation","data":{"type":"object","properties":{"isPLC":{"type":"string"},"coefficientLinear":{"type":"number"}}}},"components/schemas/CreditsafeGlobalDataSearchAddressData":{"id":"components/schemas/CreditsafeGlobalDataSearchAddressData","kind":"json-schema","title":"CreditsafeGlobalDataSearchAddressData","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."},"houseNo":{"type":"string","description":"House number portion of the address line."},"city":{"type":"string","description":"City portion of the address line."},"postCode":{"type":"string","description":"Postal code portion of the address line."},"province":{"type":"string","description":"Province portion of the address line."},"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":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"}}}},"components/schemas/CreditsafeGlobalDataCompanyActivityClassification":{"id":"components/schemas/CreditsafeGlobalDataCompanyActivityClassification","kind":"json-schema","title":"CreditsafeGlobalDataCompanyActivityClassification","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main activity classification being used for the company’s main activity, including the code, industry sector, and description."},"children":[]}]}]}],"properties":{"code":{"type":"string","description":"Main activity code used in that country e.g. SIC / NACE."},"industrySector":{"type":"string","description":"(Optionally populated) A high-level description, describing the industry sector/division in which the company operates."},"description":{"type":"string","description":"Description of main activity."},"classification":{"type":"string","description":"The type of activity classification being used for the main activity. E.g SIC07, NACE Rev2 etc. Where possible includes the version/revision date."}}}},"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/CreditsafeGlobalDataCompanyDataAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataCompanyDataAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataCompanyDataAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataCompanyData":{"id":"components/schemas/CreditsafeGlobalDataCompanyData","kind":"json-schema","title":"CreditsafeGlobalDataCompanyData","data":{"type":"object","properties":{"id":{"type":"string","description":"Connect Id."},"country":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"regNo":{"type":"string","description":"Official registration number."},"safeNo":{"type":"string","description":"Creditsafe global identifier, called the Safe Number."},"idType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIdType"},"name":{"type":"string","description":"Full company name of Ultimate Holding Company."},"type":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyType"},"officeType":{"$ref":"#/components/schemas/CreditsafeGlobalDataOfficeType"},"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"},"vatNo":{"description":"Local VAT Number.","oneOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}}]},"additionalInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataAdditionalInformation"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchAddressData"},"activity":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyActivityClassification"},"legalForm":{"type":"string"},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyDataAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataCompany":{"id":"components/schemas/CreditsafeGlobalDataCompany","kind":"json-schema","title":"CreditsafeGlobalDataCompany","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyData"},{"type":"object","properties":{"dateOfLatestAccounts":{"type":["string","null"],"format":"date-time"},"dateOfLatestChange":{"type":["string","null"],"format":"date-time"},"phoneNumbers":{"type":"array","items":{"type":"string"}},"activityCode":{"type":["string","null"]}}}]}},"components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataCompany":{"id":"components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataCompany","kind":"json-schema","title":"CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataCompany","data":{"allOf":[{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"messages":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataMessage"}},"totalSize":{"type":"integer","format":"int32"},"companies":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompany"}}}}]}},"components/schemas/ConnectCompanySearchNoResults":{"id":"components/schemas/ConnectCompanySearchNoResults","kind":"json-schema","title":"ConnectCompanySearchNoResults","data":{"type":"object","properties":{"totalSize":{"type":"number"},"companies":{"type":"object"},"messages":{"type":"object","properties":{"code":{"type":"string","description":"Message code indicating the reason or status for the result. See enum values for possible codes.","enum":["NoResults","TooManyResults","ReportUnavailable","ReportUnavailableDueToLegal","ReportUnavailableOnline","LegalNotice","InvalidCredentials","AccessRestricted","AccessLimitsNearing","InsufficientCustomerData","ReportboxAlmostFull","ReportboxFull","InvalidRequestXml","InvalidOperationParameters","OperationNotSupported","InvalidCustomData","ChangeNotification","TemporarySystemProblem","EndpointShutdown","UnexpectedInternalError","Other","DataServiceAccessProblems","DataServiceInvalidResponse"]},"text":{"type":"string"},"type":{"type":"string","description":"Message type indicating the severity or nature of the message. See enum values for possible types.","enum":["Information","Warning","Error"]}}}}}},"components/schemas/ConnectCompanySearchResponse":{"id":"components/schemas/ConnectCompanySearchResponse","kind":"json-schema","title":"ConnectCompanySearchResponse","data":{"oneOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataCompany"},{"$ref":"#/components/schemas/ConnectCompanySearchNoResults"}]}},"components/schemas/LocalSolutionsVerifyCompanyResponse":{"id":"components/schemas/LocalSolutionsVerifyCompanyResponse","kind":"json-schema","title":"LocalSolutionsVerifyCompanyResponse","data":{"type":"object","properties":{"companyID":{"type":"string","description":"Unique identifier for the company."},"verifyMatch":{"type":"boolean","description":"Indicates if the verification matches the company."}}}},"components/schemas/CreditsafeGlobalDataReportsReportSection":{"id":"components/schemas/CreditsafeGlobalDataReportsReportSection","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportSection","data":{"enum":["CompanySummary","CompanySummaryExtra","AlternateSummary","CompanyIdentification","CompanyIdentificationExtra","CreditScore","CreditScoreExtra","ContactInformation","ContactInformationExtra","ShareCapitalStructure","ShareCapitalStructureExtra","Directors","DirectorsExtra","Directorships","DirectorshipsExtra","OtherInformation","OtherInformationExtra","GroupStructure","GroupStructureExtra","ExtendedGroupStructure","ExtendedGroupStructureExtra","GlobalFinancialStatements","GlobalFinancialStatementsExtra","LocalFinancialStatements","LocalFinancialStatementsExtra","PaymentData","PaymentDataExtra","NegativeInformation","NegativeInformationExtra","AdditionalInformation","AdditionalInformationExtra","UPPData","Unused"],"type":"string"}},"components/schemas/CreditsafeGlobalDataLanguage":{"id":"components/schemas/CreditsafeGlobalDataLanguage","kind":"json-schema","title":"CreditsafeGlobalDataLanguage","data":{"enum":["OM","AB","AA","AF","SQ","AM","AR","HY","AS","AY","AZ","BA","EU","BN","DZ","BH","BI","BR","BG","MY","BE","KM","CA","ZH","CO","HR","CS","DA","NL","EN","EO","ET","FO","FJ","FI","FR","FY","GL","KA","DE","EL","KL","GN","GU","HA","HE","HI","HU","IS","ID","IA","IE","IK","IU","GA","IT","JA","JW","KN","KS","KK","RW","KY","RN","KO","KU","LO","LA","LV","LN","LT","MK","MG","MS","ML","MT","MI","MR","MO","MN","NA","NE","NO","OC","OR","PS","FA","PL","PT","PA","QU","RM","RO","RU","SM","SG","SA","GD","SR","SH","ST","TN","SN","SD","SI","SS","SK","SL","SO","ES","SU","SW","SV","TL","TG","TA","TT","TE","TH","BO","TI","TO","TS","TR","TK","TW","UG","UK","UR","UZ","VI","VO","CY","WO","XH","YI","YO","ZA","ZU"],"type":"string"}},"components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyStatusDescription","data":{"type":"object","description":"High-level status of the company, such as 'Active', 'NonActive', 'Pending', or 'Other'.","properties":{"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"},"providerStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Optionally populated) high-level local status. E.g. may contain a registry status, such as \"Active\" for a \"Non-Trading\" company, whereas the common \"status\" will say “NonActive\"."},"children":[]}]}]}]},"providerCode":{"type":"string","description":"(Optionally populated) if available, this code pairs with the companyStatus.description"},"isActive":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean [true/false] when set to true indicates that the company is economically active."},"children":[]}]}]}]},"description":{"type":"string","description":"A more in-depth status value, based on local descriptions."}}}},"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/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/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/CreditsafeGlobalDataReportsLtdCompanySummary":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdCompanySummary","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdCompanySummary","data":{"type":"object","properties":{"businessName":{"type":"string","description":"Registered company name/trading name of the business."},"country":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"companyNumber":{"type":"string","description":"Creditsafe global identifier, called the Safe Number."},"companyRegistrationNumber":{"type":"string","description":"Official registration number."},"ggsID":{"type":"string","description":"The Connect API ID as used in v1.3 (GGS)."},"leiNumber":{"type":"string","description":"Global Legal Entity Identifier (LEI), often used in financial transactions identifier of an organisation"},"mainActivity":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyActivityClassification"},"companyStatus":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription"},"latestTurnoverFigure":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"latestShareholdersEquityFigure":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"creditRating":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCreditRating"}}}},"components/schemas/CreditsafeGlobalDataReportsLegalForm":{"id":"components/schemas/CreditsafeGlobalDataReportsLegalForm","kind":"json-schema","title":"CreditsafeGlobalDataReportsLegalForm","data":{"type":"object","properties":{"commonCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A common global code that aims to categorise legal forms across Countries. Currently only available for Non Ltd reports as “Sole Trader” or “Other”."},"children":[]}]}]}]},"providerCode":{"type":"string","description":"The local provider legal form codes specific to each Country"},"description":{"type":"string","description":"The legal type of the company e.g. S.A., GmbH, Ltd, N.V. etc."}}}},"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/CreditsafeGlobalDataReportsLtdCompanyBasicInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdCompanyBasicInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdCompanyBasicInformation","data":{"type":"object","properties":{"businessName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The trading name of business, or “-“ if unknown"},"children":[]}]}]}]},"registeredCompanyName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registered company name, the legal name of the company. For NonLtd companies this would include the Owner name (i.e. the legal name), or “-“ if unknown."},"children":[]}]}]}]},"companyRegistrationNumber":{"type":"string","description":"Official registration number."},"ggsId":{"type":"string","description":"The Connect API ID as used in v1.3 (GGS)."},"leiNumber":{"type":"string","description":"Global Legal Entity Identifier (LEI), often used in financial transactions identifier of an organisation."},"country":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"vatRegistrationNumber":{"type":"string","description":"Local VAT Number."},"vatRegistrationDate":{"description":"Registration date of the local VAT number.","type":["string","null"],"format":"date-time"},"companyRegistrationDate":{"description":"The date the company was registered.","type":["string","null"],"format":"date-time"},"operationsStartDate":{"description":"The date the company began trading.","type":["string","null"],"format":"date-time"},"commercialCourt":{"description":"The local commercial court at which the company was registered.","type":"string"},"legalForm":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLegalForm"},"officeType":{"description":"Describes the office establishment type","enum":["Registered","Trading","HeadOffice","Branch","Subsidiary","Franchise","Franchisor","SingleOffice"]},"ownershipType":{"description":"Whether the company is wholly, part owned etc.","type":"string"},"companyStatus":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription"},"principalActivity":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyActivityClassification"},"contactAddress":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"}}}},"components/schemas/CreditsafeGlobalDataReportsCompanyActivity":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyActivity","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyActivity","data":{"type":"object","properties":{"code":{"type":"string","description":"Industry code used in that country e.g. SIC / NACE"},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of company’s main activity."},"children":[]}]}]}]}}}},"components/schemas/CreditsafeGlobalDataReportsCompanyActivityList":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyActivityList","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyActivityList","data":{"type":"object","properties":{"classification":{"type":"string","description":"The type of activity classification being used in the activities array. E.g. SIC07, NACE etc. Where possible includes the version/revision date."},"activities":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyActivity"}}}}},"components/schemas/CreditsafeGlobalDataReportsPreviousValue":{"id":"components/schemas/CreditsafeGlobalDataReportsPreviousValue","kind":"json-schema","title":"CreditsafeGlobalDataReportsPreviousValue","data":{"type":"object","properties":{"dateChanged":{"description":"Date when this name was officially changed (i.e. end date).","type":["string","null"],"format":"date-time"}}}},"components/schemas/CreditsafeGlobalDataReportsPreviousName":{"id":"components/schemas/CreditsafeGlobalDataReportsPreviousName","kind":"json-schema","title":"CreditsafeGlobalDataReportsPreviousName","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsPreviousValue"},{"type":"object","properties":{"name":{"type":"string","description":"Any previous name under which the company was registered."}}}]}},"components/schemas/CreditsafeGlobalDataReportsPreviousLegalForm":{"id":"components/schemas/CreditsafeGlobalDataReportsPreviousLegalForm","kind":"json-schema","title":"CreditsafeGlobalDataReportsPreviousLegalForm","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsPreviousValue"},{"type":"object","properties":{"legalForm":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLegalForm"}}}]}},"components/schemas/CreditsafeGlobalDataReportsLtdCompanyIdentification":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdCompanyIdentification","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdCompanyIdentification","data":{"type":"object","properties":{"basicInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdCompanyBasicInformation"},"activityClassifications":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyActivityList"}},"previousNames":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsPreviousName"}},"previousLegalForms":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsPreviousLegalForm"}}}}},"components/schemas/CreditsafeGlobalDataReportsLtdCreditScore":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdCreditScore","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdCreditScore","data":{"type":"object","properties":{"currentCreditRating":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCreditRating"},"currentContractLimit":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"previousCreditRating":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCreditRating"},"latestRatingChangeDate":{"description":"Last date that the credit score changed.","type":["string","null"],"format":"date-time"}}}},"components/schemas/CreditsafeGlobalDataAddressDataReport":{"id":"components/schemas/CreditsafeGlobalDataAddressDataReport","kind":"json-schema","title":"CreditsafeGlobalDataAddressDataReport","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":"Telephone number of the main address."},"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":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"}}}},"components/schemas/CreditsafeGlobalDataReportsLtdContactInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdContactInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdContactInformation","data":{"type":"object","properties":{"mainAddress":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressDataReport"},"otherAddresses":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressDataReport"}},"previousAddresses":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressDataReport"}},"emailAddresses":{"type":"array","description":"Email address for the company.","items":{"type":"string"}},"websites":{"type":"array","description":"Website address of the company.","items":{"type":"string"}}}}},"components/schemas/CreditsafeGlobalDataReportsIndicatorIndustryComparison":{"id":"components/schemas/CreditsafeGlobalDataReportsIndicatorIndustryComparison","kind":"json-schema","title":"CreditsafeGlobalDataReportsIndicatorIndustryComparison","data":{"type":"object","properties":{"sectorCode":{"type":"string"},"sectorAverage":{"type":"string","description":"The average indicator value for the industry sector in which the subject company operates."},"sectorCount":{"type":["integer","null"],"format":"int32","description":"The count of all companies in this industry sector."},"totalAverage":{"type":"string","description":"The average indicator value for all companies (irrespective of industry sector)."},"totalCount":{"type":["integer","null"],"format":"int32","description":"The count of all companies (irrespective of industry sector)."}}}},"components/schemas/CreditsafeGlobalDataReportsIndicators":{"id":"components/schemas/CreditsafeGlobalDataReportsIndicators","kind":"json-schema","title":"CreditsafeGlobalDataReportsIndicators","data":{"type":"array","description":"Indicators provides additional information when assessing a company's performance. This is a premium service, not available for all customers.","items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lowercase char(3) code indicating the type of indicator. For example - Financial Strength Indicator (“fsi”), Payment Behaviour Indicator (“pbi”), Payment Expectation Indicator (“pei”)."},"children":[]}]}]}],"enum":["eti","pei","fsi","pbi"]},"value":{"type":"string","description":"The value of the indicator.","example":"X"},"changeDate":{"type":"string","format":"date-time","description":"The date associated with the current indicator."},"industryComparison":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIndicatorIndustryComparison"}}}}},"components/schemas/CreditsafeGlobalDataReportsEntityFullName":{"id":"components/schemas/CreditsafeGlobalDataReportsEntityFullName","kind":"json-schema","title":"CreditsafeGlobalDataReportsEntityFullName","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID."},"idType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIdType"},"name":{"type":"string","description":"Name of the Shareholder, or Company Name if a corporate shareholder exists."},"title":{"type":"string","description":"Title, if known."},"firstNames":{"type":"string","description":"First name(s) of the shareholder. May optionally include middle names, or initials if these cannot be distinguished."},"firstName":{"type":"string","description":"First name of the shareholder. This field should be used if a middleName also exists."},"middleName":{"type":"string","description":"Middle name of the shareholder."},"surname":{"type":"string","description":"Last name of the shareholder."},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"}}}},"components/schemas/CreditsafeGlobalDataReportsEntityType":{"id":"components/schemas/CreditsafeGlobalDataReportsEntityType","kind":"json-schema","title":"CreditsafeGlobalDataReportsEntityType","data":{"description":"Indicates if the shareholders record relates to a \"Person\", \"Company\" or \"Other\".","enum":["Other","Person","Company"],"type":"string"}},"components/schemas/CreditsafeGlobalDataReportsShareClassAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsShareClassAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsShareClassAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsShareClass":{"id":"components/schemas/CreditsafeGlobalDataReportsShareClass","kind":"json-schema","title":"CreditsafeGlobalDataReportsShareClass","data":{"type":"object","properties":{"shareType":{"description":"(Optionally populated) The share class description.","type":"string"},"currency":{"$ref":"#/components/schemas/CreditsafeGlobalDataCurrency"},"valuePerShare":{"type":["number","null"],"format":"double","description":"(Optionally populated) The value per share, also known as the par value. Expressed as an integer, or to two decimal places."},"jointlyOwned":{"type":["boolean","null"],"description":"(Optionally populated) Boolean. Set to true where the shares are jointly owned."},"numberOfSharesOwned":{"type":["integer","null"],"format":"int64","description":"(Optionally populated) The number of shares owned. If more than one share class exists, this is the number per share class."},"valueOfSharesOwned":{"type":["number","null"],"format":"double","description":"(Optionally populated) The total nominal value of Shares owned. If more than one share class exists, this is the total nominal value per share class."},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsShareClassAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataReportsShareHolder":{"id":"components/schemas/CreditsafeGlobalDataReportsShareHolder","kind":"json-schema","title":"CreditsafeGlobalDataReportsShareHolder","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsEntityFullName"},{"type":"object","properties":{"shareholderType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsEntityType"},"shareType":{"type":"string","description":"The share class, for example \"Ordinary\"."},"currency":{"$ref":"#/components/schemas/CreditsafeGlobalDataCurrency"},"totalValueOfSharesOwned":{"type":["number","null"],"format":"double","description":"The total nominal value of all shares owned. Expressed as an integer, or to two decimal places."},"totalNumberOfSharesOwned":{"type":["integer","null"],"format":"int64","description":"The total number of all shares owned."},"percentSharesHeld":{"type":["number","null"],"format":"double","description":"The total percentage of all shares held. Expressed as an integer, or to two decimal places."},"startDate":{"type":["string","null"],"format":"date-time","description":"Date when the shareholding started."},"endDate":{"type":["string","null"],"format":"date-time","description":"Date when the shareholding ended. Where populated, this indicates that the party has ceased to be a shareholder."},"hasNegativeInfo":{"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] when set to true, this indicates that the shareholder has negative information such as Protesti, Court Judgements etc. linked to their unique shareholders ID."},"children":[]}]}]}]},"shareClasses":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsShareClass"}}}}]}},"components/schemas/CreditsafeGlobalDataReportsLtdShareCapitalStructure":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdShareCapitalStructure","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdShareCapitalStructure","data":{"type":"object","properties":{"nominalShareCapital":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"issuedShareCapital":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"shareCapitalCurrency":{"type":"string","description":"The Currency in which the share values are displayed, as a three-character ISO code."},"numberOfSharesIssued":{"type":["integer","null"],"format":"int64","description":"The total number of issued shares."},"shareHolders":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsShareHolder"}}}}},"components/schemas/CreditsafeGlobalDataReportsGender":{"id":"components/schemas/CreditsafeGlobalDataReportsGender","kind":"json-schema","title":"CreditsafeGlobalDataReportsGender","data":{"enum":["Unknown","Male","Female","NotApplicable"],"type":"string"}},"components/schemas/CreditsafeGlobalDataReportsCorporatePositionAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsCorporatePositionAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsCorporatePositionAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsCorporatePosition":{"id":"components/schemas/CreditsafeGlobalDataReportsCorporatePosition","kind":"json-schema","title":"CreditsafeGlobalDataReportsCorporatePosition","data":{"type":"object","properties":{"dateAppointed":{"type":["string","null"],"format":"date-time","description":"The date the director was appointed."},"commonCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A common global code that aims to categorise director positions across Countries – currently no data available."},"children":[]}]}]}]},"providerCode":{"type":"string","description":"The local provider director code (if exists) specific to each Country."},"positionName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The director’s role/position in a company."},"children":[]}]}]}]},"authority":{"type":"string","description":"If available, any available details pertaining to the score, power, limitations, signing authority or ability to bind the company."},"apptDurationType":{"type":"string","description":"The appointment duration should be used in conjunction with the appointment term field."},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCorporatePositionAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataReportsDirectorAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsDirector":{"id":"components/schemas/CreditsafeGlobalDataReportsDirector","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirector","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsEntityFullName"},{"type":"object","properties":{"gender":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsGender"},"birthName":{"type":"string","description":"The birth name or previous legal name of the officer."},"dateOfBirth":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The director’s date of birth."},"children":[]}]}]}]},"placeOfBirth":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The director’s place or region of birth."},"children":[]}]}]}]},"nationality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The director’s nationality or country of birth."},"children":[]}]}]}]},"countryOfResidence":{"type":"string","description":"The country of residence, if known."},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code representing the geographic location of the entity.","example":"MC"},"directorType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsEntityType"},"hasNegativeInfo":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Linked with DE searches, may return with other countries if data is available. Boolean [true/false] if the director has negative information, such as Protesti, Court Judgements etc linked to their unique directors ID. Boolean [true/false] set to true where the director is known to be an authorised signatory. Further details, if known, may be present in \"authority\" or \"additionalData\"."},"children":[]}]}]}]},"signingAuthority":{"description":"Linked with DE searches, may return with other countries if data is available.","type":["boolean","null"]},"positions":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCorporatePosition"}},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorAdditionalData"}}}]}},"components/schemas/CreditsafeGlobalDataReportsPreviousDirector":{"id":"components/schemas/CreditsafeGlobalDataReportsPreviousDirector","kind":"json-schema","title":"CreditsafeGlobalDataReportsPreviousDirector","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirector"},{"type":"object","properties":{"resignationDate":{"type":["string","null"],"format":"date-time","description":"The date the director resigned."}}}]}},"components/schemas/CreditsafeGlobalDataReportsLtdDirectors":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdDirectors","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdDirectors","data":{"type":"object","properties":{"currentDirectors":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirector"}},"previousDirectors":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsPreviousDirector"}}}}},"components/schemas/CreditsafeGlobalDataReportsCorporatePositionResigned":{"id":"components/schemas/CreditsafeGlobalDataReportsCorporatePositionResigned","kind":"json-schema","title":"CreditsafeGlobalDataReportsCorporatePositionResigned","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCorporatePosition"},{"type":"object","properties":{"resignationDate":{"type":["string","null"],"format":"date-time"}}}]}},"components/schemas/CreditsafeGlobalDataReportsDirectorship":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorship","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorship","data":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"initials":{"type":"string"},"name":{"type":"string"},"position":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCorporatePositionResigned"},"registrationNumber":{"type":"string"},"companyName":{"type":"string"},"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription"}}}},"components/schemas/CreditsafeGlobalDataReportsDirectorships":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorships","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorships","data":{"type":"object","properties":{"currentDirectorships":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorship"}},"previousDirectorships":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorship"}}}}},"components/schemas/CreditsafeGlobalDataReportsEntity":{"id":"components/schemas/CreditsafeGlobalDataReportsEntity","kind":"json-schema","title":"CreditsafeGlobalDataReportsEntity","data":{"type":"object","properties":{"name":{"description":"Name of bank that the company holds an account with.","type":"string"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"}}}},"components/schemas/CreditsafeGlobalDataReportsBanker":{"id":"components/schemas/CreditsafeGlobalDataReportsBanker","kind":"json-schema","title":"CreditsafeGlobalDataReportsBanker","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsEntity"},{"type":"object","properties":{"bankCode":{"type":"string","description":"Bank code associated with the bank."},"bic":{"type":"string","description":"Bank Identifier Code (BIC) or SWIFT code, used for international transfers."}}}]}},"components/schemas/CreditsafeGlobalDataReportsAdvisor":{"id":"components/schemas/CreditsafeGlobalDataReportsAdvisor","kind":"json-schema","title":"CreditsafeGlobalDataReportsAdvisor","data":{"type":"object","properties":{"auditorName":{"type":"string","description":"Full name of the company who is responsible for auditing."},"solicitorName":{"type":"string","description":"Name of solicitors."},"accountantName":{"type":"string","description":"Full name of the accountancy firm who responsible for preparing the accounts."}}}},"components/schemas/CreditsafeGlobalDataReportsEmployeeInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsEmployeeInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsEmployeeInformation","data":{"type":"object","properties":{"year":{"type":["integer","null"],"format":"int32","description":"Year that the figures were reordered."},"numberOfEmployees":{"type":"string","description":"Number of staff that the company employ directly."}}}},"components/schemas/CreditsafeGlobalDataReportsLtdOtherInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdOtherInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdOtherInformation","data":{"type":"object","properties":{"bankers":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsBanker"}},"advisors":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdvisor"}},"employeesInformation":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsEmployeeInformation"}}}}},"components/schemas/CreditsafeGlobalDataGroupStructureCompanyData":{"id":"components/schemas/CreditsafeGlobalDataGroupStructureCompanyData","kind":"json-schema","title":"CreditsafeGlobalDataGroupStructureCompanyData","data":{"type":"object","properties":{"id":{"type":"string","description":"Connect Id."},"country":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"registrationNumber":{"type":"string","description":"Official registration number."},"safeNo":{"type":"string","description":"Creditsafe global identifier, called the Safe Number."},"idType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIdType"},"name":{"type":"string","description":"Full company name of Ultimate Holding Company."},"type":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyType"},"officeType":{"$ref":"#/components/schemas/CreditsafeGlobalDataOfficeType"},"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"},"vatNo":{"description":"Local VAT Number.","oneOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}}]},"additionalInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataAdditionalInformation"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"},"activity":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyActivityClassification"},"legalForm":{"type":"string"},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyDataAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataReportsLtdGroupStructure":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdGroupStructure","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdGroupStructure","data":{"type":"object","properties":{"ultimateParent":{"$ref":"#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData"},"immediateParent":{"$ref":"#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData"},"subsidiaryCompanies":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData"}},"affiliatedCompanies":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData"}}}}},"components/schemas/CreditsafeGlobalDataReportsCompanyInGroupAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyInGroupAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyInGroupAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsCompanyInGroup":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyInGroup","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyInGroup","data":{"type":"object","properties":{"id":{"type":"string","description":"Connect Id."},"country":{"type":"string","description":"Country where the company is established."},"safeNumber":{"type":"string","description":"Creditsafe global identifier, called the Safe Number."},"idType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIdType"},"companyName":{"type":"string","description":"Full company name."},"registeredNumber":{"type":"string","description":"Official registration number."},"latestAnnualAccounts":{"type":["string","null"],"format":"date-time","description":"The last filed financial statements Year End Date of the company."},"level":{"type":"integer","format":"int32","description":"The hierarchical level of the company within the group structure."},"percentOfOwnership":{"type":["number","null"],"format":"double","description":"The percentage of shares owned."},"status":{"type":"string","description":"High-level status. Values include \"Active\", \"NonActive\", \"Pending\" and \"Other\"."},"commonRatingBand":{"type":"string","description":"Standardised credit score."},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyInGroupAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataReportsLtdFinancialStatement":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdFinancialStatement","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdFinancialStatement","data":{"type":"object","properties":{"type":{"type":"string","description":"A code element set as \"GlobalFinancialsGGS\", which represents that the financial statements are in a common/standardised international format."},"yearEndDate":{"type":"string","format":"date-time","description":"Financial Year End date for the annual accounts."},"numberOfWeeks":{"type":["integer","null"],"format":"int32","description":"Number of weeks in the year."},"currency":{"$ref":"#/components/schemas/CreditsafeGlobalDataCurrency"},"consolidatedAccounts":{"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]. Are the accounts consolidated?"},"children":[]}]}]}]}}}},"components/schemas/CreditsafeGlobalDataReportsProfitAndLossFigures":{"id":"components/schemas/CreditsafeGlobalDataReportsProfitAndLossFigures","kind":"json-schema","title":"CreditsafeGlobalDataReportsProfitAndLossFigures","data":{"type":"object","properties":{"revenue":{"type":["number","null"],"format":"double","description":"Income earned from normal business activities, including the sale of goods and services."},"operatingCosts":{"type":["number","null"],"format":"double","description":"Costs incurred in the general running of the business."},"operatingProfit":{"type":["number","null"],"format":"double","description":"The results of the company after deducting Operating Costs from its Revenue."},"wagesAndSalaries":{"type":["number","null"],"format":"double","description":"Wages and salaries paid to employees of the company. Where possible this excludes Pensions."},"pensionCosts":{"type":["number","null"],"format":"double","description":"The cost of pension benefits for employees of the company."},"depreciation":{"type":["number","null"],"format":"double","description":"The amount written off Tangible Fixed Assets during the year."},"amortisation":{"type":["number","null"],"format":"double","description":"The amount written off Intangible Fixed Assets during the year."},"financialIncome":{"type":["number","null"],"format":"double","description":"Interest income earned during the year."},"financialExpenses":{"type":["number","null"],"format":"double","description":"Interest expenses incurred during the year."},"extraordinaryIncome":{"type":["number","null"],"format":"double","description":"Income arising due to events of a non-recurring nature."},"extraordinaryCosts":{"type":["number","null"],"format":"double","description":"Costs incurred due to events of a non-recurring nature."},"profitBeforeTax":{"type":["number","null"],"format":"double","description":"The results of the company before deducting any charge for taxation."},"tax":{"type":["number","null"],"format":"double","description":"Taxation payable on the profits of the company."},"profitAfterTax":{"type":["number","null"],"format":"double","description":"The results of the company after deducting any charge for taxation."},"dividends":{"type":["number","null"],"format":"double","description":"The total amount of profits distributed to shareholders."},"minorityInterests":{"type":["number","null"],"format":"double","description":"Profits attributable to shareholders holding a minority interest in the company."},"otherAppropriations":{"type":["number","null"],"format":"double","description":"Other miscellaneous items that are deducted / added to affect the Retained Profit / Loss of a company."},"retainedProfit":{"type":["number","null"],"format":"double","description":"The results of the company after all income and expenses have been credited/debited."}}}},"components/schemas/CreditsafeGlobalDataReportsBalanceSheet":{"id":"components/schemas/CreditsafeGlobalDataReportsBalanceSheet","kind":"json-schema","title":"CreditsafeGlobalDataReportsBalanceSheet","data":{"type":"object","properties":{"landAndBuildings":{"type":["number","null"],"format":"double","description":"Land and buildings owned by the company for long-term use."},"plantAndMachinery":{"type":["number","null"],"format":"double","description":"Plant and machinery owned by the company for long-term use."},"otherTangibleAssets":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tangible fixed assets other than Land & Buildings or Plant & Machinery."},"children":[]}]}]}]},"totalTangibleAssets":{"type":["number","null"],"format":"double","description":"Physical assets owned by the company for long-term use."},"goodwill":{"type":["number","null"],"format":"double","description":"The premium paid or accumulated on the purchase of an asset."},"otherIntangibleAssets":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intangible fixed assets other than goodwill such as Trademarks, Patents, Research & Development, etc."},"children":[]}]}]}]},"totalIntangibleAssets":{"type":["number","null"],"format":"double","description":"Assets that have a value but no physical existence."},"investments":{"type":["number","null"],"format":"double","description":"Long-term investments including shares and securities."},"loansToGroup":{"type":["number","null"],"format":"double","description":"Long-term loans made by the company to related businesses."},"otherLoans":{"type":["number","null"],"format":"double","description":"Other long-term loans made by the company."},"miscellaneousFixedAssets":{"type":["number","null"],"format":"double","description":"Long-term assets other than Tangible Assets, Intangible Assets, Investments, or Loans."},"totalOtherFixedAssets":{"type":["number","null"],"format":"double","description":"Total long-term assets other than Tangible Assets or Intangible Assets."},"totalFixedAssets":{"type":["number","null"],"format":"double","description":"The total of Tangible, Intangible, and Other Fixed Assets."},"rawMaterials":{"type":["number","null"],"format":"double","description":"Materials held by the company that have not yet been processed."},"workInProgress":{"type":["number","null"],"format":"double","description":"Goods or contracts that are in the process of manufacture or completion."},"finishedGoods":{"type":["number","null"],"format":"double","description":"Goods held that are ready for sale or use."},"otherInventories":{"type":["number","null"],"format":"double","description":"Other amounts classed as Inventory but not included above."},"totalInventories":{"type":["number","null"],"format":"double","description":"The total of stocks held by the company and work in progress."},"tradeReceivables":{"type":["number","null"],"format":"double","description":"Amounts due within one year from customers for goods and services supplied on credit."},"groupReceivables":{"type":["number","null"],"format":"double","description":"Amounts due within one year from related businesses."},"receivablesDueAfter1Year":{"type":["number","null"],"format":"double","description":"Amounts due after one year owing to the company (including trade and group receivables due after one year)."},"miscellaneousReceivables":{"type":["number","null"],"format":"double","description":"Amounts due within one year owing to the company other than trade and group receivables."},"totalReceivables":{"type":["number","null"],"format":"double","description":"Total amounts receivable by the company."},"cash":{"type":["number","null"],"format":"double","description":"Cash at bank, cash in hand, and cash equivalents."},"otherCurrentAssets":{"type":["number","null"],"format":"double","description":"Any short-term assets that have not already been included as Inventory, Receivables, or Cash."},"totalCurrentAssets":{"type":["number","null"],"format":"double","description":"The total of Stocks, Debtors, Cash, and other assets due within one year."},"totalAssets":{"type":["number","null"],"format":"double","description":"The total of Current and Fixed Assets."},"tradePayables":{"type":["number","null"],"format":"double","description":"Amounts due within one year owing to suppliers for goods and services provided on credit."},"bankLiabilities":{"type":["number","null"],"format":"double","description":"Amounts due within one year owing to banks for overdrafts and loans."},"otherLoansOrFinance":{"type":["number","null"],"format":"double","description":"Loans or finance due within one year owing to parties other than banks or related businesses."},"groupPayables":{"type":["number","null"],"format":"double","description":"Amounts due within one year to related businesses."},"miscellaneousLiabilities":{"type":["number","null"],"format":"double","description":"Other amounts due within one year owing by the company."},"totalCurrentLiabilities":{"type":["number","null"],"format":"double","description":"Total short-term liabilities of the company."},"tradePayablesDueAfter1Year":{"type":["number","null"],"format":"double","description":"Amounts due after one year owing to suppliers for goods and services provided on credit."},"bankLiabilitiesDueAfter1Year":{"type":["number","null"],"format":"double","description":"Amounts due after one year owing to banks for overdrafts and loans."},"otherLoansOrFinanceDueAfter1Year":{"type":["number","null"],"format":"double","description":"Loans or finance due after one year owing to parties other than banks or related businesses."},"groupPayablesDueAfter1Year":{"type":["number","null"],"format":"double","description":"Amounts due after one year to related businesses."},"miscellaneousLiabilitiesDueAfter1Year":{"type":["number","null"],"format":"double","description":"Other amounts due after one year owing by the company."},"totalLongTermLiabilities":{"type":["number","null"],"format":"double","description":"Total long-term liabilities of the company."},"totalLiabilities":{"type":["number","null"],"format":"double","description":"The total of Total Long-term Liabilities and Total Current Liabilities."},"calledUpShareCapital":{"type":["number","null"],"format":"double","description":"The issued and paid share capital from shareholders."},"sharePremium":{"type":["number","null"],"format":"double","description":"The excess of the amount received on the issue of shares over their value."},"revenueReserves":{"type":["number","null"],"format":"double","description":"The accumulation of profits/losses from previous trading periods."},"otherReserves":{"type":["number","null"],"format":"double","description":"Other capital and reserves that form part of shareholders' equity."},"totalShareholdersEquity":{"type":["number","null"],"format":"double","description":"The total capital and reserves of the company."}}}},"components/schemas/CreditsafeGlobalDataReportsOtherFinancials":{"id":"components/schemas/CreditsafeGlobalDataReportsOtherFinancials","kind":"json-schema","title":"CreditsafeGlobalDataReportsOtherFinancials","data":{"type":"object","properties":{"contingentLiabilities":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Potential liabilities that are not recognised in the balance sheet, output as a string. Usually contains integers, but can also be output as a string value (such as “YES” or “NO”)."},"children":[]}]}]}]},"workingCapital":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total Current Assets – Receivables Due after 1 year – Total Current Liabilities. This measures if the company has sufficient short-term assets to cover its current debts."},"children":[]}]}]}]},"netWorth":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Often referred to as the 'book value' of the business this equals Total Shareholders’ Equity less Total Intangible Assets"},"children":[]}]}]}]}}}},"components/schemas/CreditsafeGlobalDataReportsFinancialRatios":{"id":"components/schemas/CreditsafeGlobalDataReportsFinancialRatios","kind":"json-schema","title":"CreditsafeGlobalDataReportsFinancialRatios","data":{"type":"object","properties":{"preTaxProfitMargin":{"type":["number","null"],"format":"double","description":"Pre-tax profits / Turnover x 100. This shows the percentage of Profit in each pound of sales or the equivalent of retailers 'mark-up'."},"returnOnCapitalEmployed":{"type":["number","null"],"format":"double","description":"Pre-Tax Profit / Capital Employed x 100. This ratio measures the profits a business yields in return for the money (Capital) invested."},"returnOnTotalAssetsEmployed":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-Tax Profits / Total Assets x 100. This shows the ‘return’ or 'profit' on each pound of Assets used as a percentage."},"children":[]}]}]}]},"returnOnNetAssetsEmployed":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-Tax Profits / Net Assets x 100. This shows the ‘return’ in percent on the net assets of the company. The higher the percentage the more profitable the company."},"children":[]}]}]}]},"salesOrNetWorkingCapital":{"type":["number","null"],"format":"double","description":"Turnover / (Total Current Assets - Receivables Due after 1 year - Total Current Liabilities). The higher the ratio the higher the volume of Sales made per the companies working capital."},"stockTurnoverRatio":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stocks / Turnover x 100. This shows the number of times the trading stock of a company is ‘turned over’ in a trading period. If the ratio is low this indicates that relatively little money is tied up in Stocks."},"children":[]}]}]}]},"debtorDays":{"type":["number","null"],"format":"double","description":"Trade Debtors / Turnover x 365 days. This is a calculation that predicts the average time taken for the company to collect its invoices for goods and services provided to its customers."},"creditorDays":{"type":["number","null"],"format":"double","description":"Trade Creditors / Turnover x 365 days. This is a calculation that predicts the average time taken for the company to settle its invoices for goods and services provided by its suppliers."},"currentRatio":{"type":["number","null"],"format":"double","description":"Total Current Assets - Receivables Due after 1 year / Total Current Liabilities. This is an indication of a company's ability to meet short-term debt obligations; the higher the ratio, the more liquid the company is."},"liquidityRatioOrAcidTest":{"type":["number","null"],"format":"double","description":"Total Current Assets - Total Inventories - Receivables Due after 1 year / Total Current Liabilities. This, like the current ratio, measures how quickly a company can meet its short-term debts. However, this ratio excludes stock, as there is no guarantee the value of Stocks can be realised quickly."},"currentDebtRatio":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total Current Liabilities / Total Shareholders’ Equity. This measures the amount of short-term debt in relation to the value of shareholders’ funds."},"children":[]}]}]}]},"gearing":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Overdraft & Loans + Total Long-term Liabilities/Total Shareholders’ Equity x 100. This is the relationship between the size of the company’s debt in proportion to Equity (Shareholders Funds)."},"children":[]}]}]}]},"equityInPercentage":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total Shareholders’ Equity / (Total Current Assets + Tangible Fixed Assets – Total Intangible Assets) x 100. This ratio shows the worth of the company (shareholders’ funds) as a percentage of total current and tangible assets."},"children":[]}]}]}]},"totalDebtRatio":{"type":["number","null"],"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total Current Liabilities + Total Long-term liabilities / Total Shareholders’ Equity x 100. This shows the relative indebtedness of a company in relation to the worth of the company."},"children":[]}]}]}]}}}},"components/schemas/CreditsafeGlobalDataReportsGlobalFinancialsGGS":{"id":"components/schemas/CreditsafeGlobalDataReportsGlobalFinancialsGGS","kind":"json-schema","title":"CreditsafeGlobalDataReportsGlobalFinancialsGGS","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdFinancialStatement"},{"type":"object","properties":{"profitAndLoss":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsProfitAndLossFigures"},"balanceSheet":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsBalanceSheet"},"otherFinancials":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsOtherFinancials"},"ratios":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialRatios"}}}]}},"components/schemas/CreditsafeGlobalDataReportsLocalFinancialStatement":{"id":"components/schemas/CreditsafeGlobalDataReportsLocalFinancialStatement","kind":"json-schema","title":"CreditsafeGlobalDataReportsLocalFinancialStatement","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdFinancialStatement"},{"type":"object","properties":{"profitAndLoss":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]},"balanceSheet":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]},"otherFinancials":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]},"ratios":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]}}}]}},"components/schemas/CreditsafeGlobalDataReportsReportNegativeInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsReportNegativeInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportNegativeInformation","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]}},"components/schemas/CreditsafeGlobalDataReportsReportAdditionalInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsReportAdditionalInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportAdditionalInformation","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]}},"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyReportExtraSection","data":{"type":"object"}},"components/schemas/CreditsafeGlobalDataReportsLtdDirectorsExtra":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdDirectorsExtra","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdDirectorsExtra","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsLtdExtendedGroupStructureExtra":{"id":"components/schemas/CreditsafeGlobalDataReportsLtdExtendedGroupStructureExtra","kind":"json-schema","title":"CreditsafeGlobalDataReportsLtdExtendedGroupStructureExtra","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsReportPaymentData":{"id":"components/schemas/CreditsafeGlobalDataReportsReportPaymentData","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportPaymentData","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the relevant country data dictionary for the properties expected in this object "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect API data dictionaries"},"children":[]}]}]}]}]}},"components/schemas/CreditsafeGlobalDataReportsReportPaymentDataExtra":{"id":"components/schemas/CreditsafeGlobalDataReportsReportPaymentDataExtra","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportPaymentDataExtra","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsReportAlternateSummary":{"id":"components/schemas/CreditsafeGlobalDataReportsReportAlternateSummary","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportAlternateSummary","data":{"type":"object"}},"components/schemas/CreditsafeGlobalDataReportsReportNegativeInformationExtra":{"id":"components/schemas/CreditsafeGlobalDataReportsReportNegativeInformationExtra","kind":"json-schema","title":"CreditsafeGlobalDataReportsReportNegativeInformationExtra","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsExceptions":{"id":"components/schemas/CreditsafeGlobalDataReportsExceptions","kind":"json-schema","title":"CreditsafeGlobalDataReportsExceptions","data":{"type":"object","properties":{"eventType":{"type":"object","description":"Describes the exception alert","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code associated with the exception event, for example GA_8"},"children":[]}]}]}]},"description":{"type":"string","description":"A description associated with the event, for example \"Multiple companies has this exact address\"."}}},"eventLevel":{"type":"object","description":"Level of risk for the exception alert","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A numeric code which indicates if the event level is General [0] OR \"High\" [1]."},"children":[]}]}]}]},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text description which indicates if the event level is General [0] OR \"High\" [1]."},"children":[]}]}]}]}}},"eventDate":{"type":"string","description":"The date associated with the exception event - this might be the date when the unusual behaviour was detected, not necessarily the date of the original event.","format":"date-time"}}}},"components/schemas/CreditsafeGlobalDataReportsCompanyReport":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyReport","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyReport","data":{"type":"object","properties":{"companyId":{"type":"string"},"language":{"$ref":"#/components/schemas/CreditsafeGlobalDataLanguage"},"companySummary":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdCompanySummary"},"companyIdentification":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdCompanyIdentification"},"creditScore":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdCreditScore"},"contactInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdContactInformation"},"indicators":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIndicators"},"shareCapitalStructure":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdShareCapitalStructure"},"directors":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdDirectors"},"directorships":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorships"},"otherInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdOtherInformation"},"groupStructure":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdGroupStructure"},"extendedGroupStructure":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyInGroup"}},"financialStatements":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsGlobalFinancialsGGS"}},"localFinancialStatements":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLocalFinancialStatement"}},"negativeInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportNegativeInformation"},"additionalInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportAdditionalInformation"},"directorsExtra":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdDirectorsExtra"},"extendedGroupStructureExtra":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdExtendedGroupStructureExtra"},"paymentData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportPaymentData"},"paymentDataExtra":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportPaymentDataExtra"},"alternateSummary":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportAlternateSummary"},"negativeInformationExtra":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportNegativeInformationExtra"},"exceptions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies unusual behaviours, for example multiple changes in address in a short period of time. This is a premium service, not available for all customers and is only availble for specific report templates [gycs, custom, full]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsExceptions"}}}}},"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse":{"id":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse","kind":"json-schema","title":"CreditsafeGlobalDataReportsCompanyReportResponse","data":{"allOf":[{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"failedSections":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportSection"}},"report":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReport"},"companyId":{"type":"string"},"dateOfOrder":{"type":"string","format":"date-time"},"language":{"type":"string"},"userId":{"type":"integer"}}}]}},"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachmentjson":{"id":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachmentjson","kind":"json-schema","title":"CreditsafeGlobalDataCoreAttachmentBinaryAttachmentjson","data":{"type":"object","properties":{"correlationID":{"type":"string","description":"A unique ID assigned to this request."},"failedSections":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsReportSection"}},"report":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReport"},"pdfReportStream":{"type":"string","format":"byte","description":"Base64-encoded contents of the PDF."},"companyID":{"type":"string"},"dateOfOrder":{"type":"string","format":"date-time"},"language":{"type":"string"},"userID":{"type":"integer"}}}},"components/schemas/IndividualSummary":{"id":"components/schemas/IndividualSummary","kind":"json-schema","title":"IndividualSummary","data":{"type":"object","properties":{"verifyMatch":{"type":"boolean","description":"Indicates if the verification matches the individual."}}}},"components/schemas/Flags":{"id":"components/schemas/Flags","kind":"json-schema","title":"Flags","data":{"type":"object","properties":{"ccjMatch":{"type":"boolean","description":"Indicates a CCJ match for the individual."},"electoralRegisterMatch":{"type":"boolean","description":"Indicates an electoral roll match on an individual."},"deceasedRegisterMatch":{"type":"boolean","description":"Indicates a deceased match against an individual."},"insolvencyMatch":{"type":"boolean","description":"Indicates an insolvency match against an individual."}}}},"components/schemas/CCJDetails":{"id":"components/schemas/CCJDetails","kind":"json-schema","title":"CCJDetails","data":{"type":"object","properties":{"name":{"type":"string","description":"Full name."},"amount":{"type":"object","properties":{"currency":{"type":"string","description":"The currency for the amount of the CCJ."},"value":{"type":"integer","description":"The value for the amount of the CCJ."}}},"date":{"type":"string","format":"date","description":"Date when the judgment was made."},"paidDate":{"type":"string","format":"date","description":"Date when the judgment was satisfied or canceled."},"status":{"type":"string","description":"The type of transaction for the judgment."},"caseNumber":{"type":"string","description":"CCJ case number"},"category":{"type":"string","description":"CCJ caseType"},"fullAddress":{"type":"object","properties":{"simpleValue":{"type":"string","description":"Full address line."},"postCode":{"type":"string","description":"Postcode for the full address line."}}},"partialAddress":{"type":"object","properties":{"simpleValue":{"type":"string","description":"Partial address line."}}}}}},"components/schemas/ElectoralRoll":{"id":"components/schemas/ElectoralRoll","kind":"json-schema","title":"ElectoralRoll","data":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the individual."},"middleName":{"type":"string","description":"Middle name of the individual."},"lastName":{"type":"string","description":"Last name of the individual."},"canvasYear":{"type":"integer","description":"Electoral roll canvas year."},"fullAddress":{"type":"object","properties":{"simpleValue":{"type":"string","description":"Full address line."},"postCode":{"type":"string","description":"Postcode for the full address line."}}},"partialAddress":{"type":"object","properties":{"simpleValue":{"type":"string","description":"Partial address line."}}}}}},"components/schemas/Deceased":{"id":"components/schemas/Deceased","kind":"json-schema","title":"Deceased","data":{"type":"object","properties":{"uniqueReferenceNumber":{"type":"string","description":"Unique reference number for the deceased record."},"dateOfDeath":{"type":"string","format":"date","description":"Date of death."},"firstName":{"type":"string","description":"First name of the deceased."},"middleName":{"type":"string","description":"Middle name of the deceased."},"lastName":{"type":"string","description":"Last name of the deceased."},"fullAddress":{"type":"object","properties":{"simpleValue":{"type":"string","description":"Full address line."},"postCode":{"type":"string","description":"Postcode for the full address line."}}},"partialAddress":{"type":"object","properties":{"simpleValue":{"type":"string","description":"Partial address line."}}}}}},"components/schemas/Insolvency":{"id":"components/schemas/Insolvency","kind":"json-schema","title":"Insolvency","data":{"type":"object","properties":{"individualDetails":{"type":"object","properties":{"title":{"type":"string","description":"Title of individual on Insolvency"},"firstName":{"type":"string","description":"First name of individual on Insolvency"},"middleName":{"type":"string","description":"Middle name of individual on Insolvency"},"lastName":{"type":"string","description":"Last name of individual on Insolvency"},"occupation":{"type":"string","description":"Occupation of individual on Insolvency"},"fullAddress":{"type":"object","properties":{"simpleValue":{"type":"string","description":"Full address of individual on Insolvency."},"postCode":{"type":"string","description":"Postcode for the full address line."}}},"partialAddress":{"type":"object","properties":{"simpleValue":{"type":"string","description":"Partial address of individual on Insolvency."}}}}},"caseDetails":{"type":"object","properties":{"caseNumber":{"type":"string","description":"Individual case number assigned to insolvency."},"caseType":{"type":"string","description":"Type of insolvency."},"caseStatus":{"type":"string","description":"Current status of the Insolvency."},"court":{"type":"string","description":"Court name."},"courtNumber":{"type":"string","description":"Court number."},"startDate":{"type":"string","format":"date","description":"Start date of the Insolvency."},"dischargeDate":{"type":"string","format":"date","description":"Date of insolvency annulment."}}}}}},"components/schemas/SearchRequestDetails":{"id":"components/schemas/SearchRequestDetails","kind":"json-schema","title":"SearchRequestDetails","data":{"type":"object","properties":{"title":{"type":"string","description":"Title of the individual from request."},"firstName":{"type":"string","description":"First name of the individual from request."},"middleName":{"type":"string","description":"Middle name of the individual from request."},"lastName":{"type":"string","description":"Last name of the individual from request."},"dateOfBirth":{"type":"string","description":"Date of birth of the individual from request."},"buildingNo":{"type":"string","description":"Building number of the address from request."},"buildingName":{"type":"string","description":"Building name of the address from request."},"street":{"type":"string","description":"Street of the address from request."},"town":{"type":"string","description":"Town of the address from request."},"county":{"type":"string","description":"County of the address from request."},"postcode":{"type":"string","description":"Postal code of the address from request."},"addressLine":{"type":"string","description":"Full address line from request."}}}},"components/schemas/LocalSolutionsVerifyIndividualDirectReportResponse":{"id":"components/schemas/LocalSolutionsVerifyIndividualDirectReportResponse","kind":"json-schema","title":"LocalSolutionsVerifyIndividualDirectReportResponse","data":{"properties":{"requestDetails":{"$ref":"#/components/schemas/SearchRequestDetails"}},"oneOf":[{"type":"object","title":"Verify Match","allOf":[{"$ref":"#/components/schemas/IndividualSummary"}]},{"type":"object","title":"Flags","allOf":[{"$ref":"#/components/schemas/IndividualSummary"},{"properties":{"flags":{"$ref":"#/components/schemas/Flags"}}}]},{"type":"object","title":"Full","allOf":[{"$ref":"#/components/schemas/IndividualSummary"},{"properties":{"countyCourtJudgments":{"type":"array","items":{"$ref":"#/components/schemas/CCJDetails"}},"electoralRolls":{"type":"array","items":{"$ref":"#/components/schemas/ElectoralRoll"}},"deceased":{"type":"array","items":{"$ref":"#/components/schemas/Deceased"}},"insolvencies":{"type":"array","items":{"$ref":"#/components/schemas/Insolvency"}}}}]},{"type":"object","title":"Full with Flags","allOf":[{"$ref":"#/components/schemas/IndividualSummary"},{"properties":{"flags":{"$ref":"#/components/schemas/Flags"},"countyCourtJudgments":{"type":"array","items":{"$ref":"#/components/schemas/CCJDetails"}},"electoralRolls":{"type":"array","items":{"$ref":"#/components/schemas/ElectoralRoll"}},"deceased":{"type":"array","items":{"$ref":"#/components/schemas/Deceased"}},"insolvencies":{"type":"array","items":{"$ref":"#/components/schemas/Insolvency"}}}}]}]}},"components/schemas/MultiVerifyAddressSearchRequest":{"id":"components/schemas/MultiVerifyAddressSearchRequest","kind":"json-schema","title":"MultiVerifyAddressSearchRequest","data":{"type":"object","required":["firstName","lastName","dateOfBirth","reasonForSearch","addresses"],"properties":{"firstName":{"type":"string","description":"First name of the individual."},"middleName":{"type":"string","description":"Middle name of the individual."},"lastName":{"type":"string","description":"Last name of the individual."},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth of the individual.","example":"YYYY-MM-DD"},"reasonForSearch":{"type":"string","enum":["AM","AV","BS","CA","DC","DS","EC","GI","QS","TV","GC","SA","IA"],"description":"Reason for performing the search."},"title":{"type":"string","description":"Title of the individual."},"addresses":{"type":"object","required":["currentAddress"],"properties":{"currentAddress":{"type":"object","required":["postCode"],"properties":{"postCode":{"type":"string","description":"Postal code of the address."},"addressLine":{"type":"string","description":"Full address line. You can provide either addressLine OR the component fields (buildingNo, buildingName, subBuilding, street, town, county)."},"buildingNo":{"type":"string","description":"Building number of the address."},"buildingName":{"type":"string","description":"Building name of the address."},"subBuilding":{"type":"string","description":"Sub building of the address."},"street":{"type":"string","description":"Street of the address."},"town":{"type":"string","description":"Town of the address."},"county":{"type":"string","description":"County of the address."}}},"previousAddresses":{"type":"array","description":"Previous addresses (optional, max 2 items).","maxItems":2,"items":{"type":"object","required":["position","postCode"],"properties":{"position":{"type":"integer","description":"Position of the previous address (1 for first previous, 2 for second previous).","minimum":1,"maximum":2},"postCode":{"type":"string","description":"Postal code of the address."},"addressLine":{"type":"string","description":"Full address line. You can provide either addressLine OR the component fields (buildingNo, buildingName, subBuilding, street, town, county)."},"buildingNo":{"type":"string","description":"Building number of the address."},"buildingName":{"type":"string","description":"Building name of the address."},"subBuilding":{"type":"string","description":"Sub building of the address."},"street":{"type":"string","description":"Street of the address."},"town":{"type":"string","description":"Town of the address."},"county":{"type":"string","description":"County of the address."}}}}}}}}},"components/schemas/PostSearchRequestDetails":{"id":"components/schemas/PostSearchRequestDetails","kind":"json-schema","title":"PostSearchRequestDetails","data":{"type":"object","properties":{"title":{"type":"string","description":"Title of the individual from request."},"firstName":{"type":"string","description":"First name of the individual from request."},"middleName":{"type":"string","description":"Middle name of the individual from request."},"lastName":{"type":"string","description":"Last name of the individual from request."},"dateOfBirth":{"type":"string","description":"Date of birth of the individual from request."},"reasonForSearch":{"type":"string","description":"Reason for performing the search from request."},"buildingNo":{"type":"string","description":"Building number of the address from request."},"buildingName":{"type":"string","description":"Building name of the address from request."},"subBuilding":{"type":"string","description":"Sub building of the address from request."},"street":{"type":"string","description":"Street of the address from request."},"town":{"type":"string","description":"Town of the address from request."},"county":{"type":"string","description":"County of the address from request."},"postcode":{"type":"string","description":"Postal code of the address from request."},"addressLine":{"type":"string","description":"Full address line from request."},"addresses":{"type":"object","description":"Addresses from the request (used in multi-address search).","required":["currentAddress"],"properties":{"currentAddress":{"type":"object","description":"Current address details from request.","properties":{"postcode":{"type":"string","description":"Postal code of the current address from request."},"addressLine":{"type":"string","description":"Full address line of the current address from request."},"buildingNo":{"type":"string","description":"Building number of the current address from request."},"buildingName":{"type":"string","description":"Building name of the current address from request."},"subBuilding":{"type":"string","description":"Sub building of the current address from request."},"street":{"type":"string","description":"Street of the current address from request."},"town":{"type":"string","description":"Town of the current address from request."},"county":{"type":"string","description":"County of the current address from request."}}},"previousAddresses":{"type":"array","description":"Previous addresses from request (max 2 items).","items":{"type":"object","properties":{"position":{"type":"integer","description":"Position of the previous address (1 for first previous, 2 for second previous).","minimum":1,"maximum":2},"postcode":{"type":"string","description":"Postal code of the previous address from request."},"addressLine":{"type":"string","description":"Full address line of the previous address from request."},"buildingNo":{"type":"string","description":"Building number of the previous address from request."},"buildingName":{"type":"string","description":"Building name of the previous address from request."},"subBuilding":{"type":"string","description":"Sub building of the previous address from request."},"street":{"type":"string","description":"Street of the previous address from request."},"town":{"type":"string","description":"Town of the previous address from request."},"county":{"type":"string","description":"County of the previous address from request."}}}}}}}}},"components/schemas/LocalSolutionsVerifyIndividualDirectReportPostResponse":{"id":"components/schemas/LocalSolutionsVerifyIndividualDirectReportPostResponse","kind":"json-schema","title":"LocalSolutionsVerifyIndividualDirectReportPostResponse","data":{"type":"object","properties":{"verifyMatch":{"type":"boolean","description":"Indicates if the verification matches (true if ANY address matched). Aggregated from all address results using OR logic."},"flags":{"$ref":"#/components/schemas/Flags","description":"Top-level aggregated flags. Each flag is true if ANY address has the flag set to true (aggregated using OR logic). Always present in response."},"directorships":{"type":"array","description":"Company directorships for the individual. Always present in response (may be empty array). Only populated when PNR is matched and customer has Full (3136) backend flag. Ordered by appointment status: Current, then Resigned, then Dissolved.","items":{"type":"object","description":"Company directorship information for an individual. Only present in directorships array when PNR is matched and customer has Full (3136) backend flag.","properties":{"pnr":{"type":"string","description":"Person Number Reference (PNR) associated with this directorship.","example":"24137254"},"companyName":{"type":"string","description":"Name of the company.","example":"Creditsafe Business Solutions"},"companyNumber":{"type":"string","description":"Company registration number.","example":"00445790"},"appointmentStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the directorship appointment. Mapped from backend codes: \"01\" = \"Current\", \"03\" = \"Resigned\". Note: In case the company status is \"Dissolved\", the appointment status would be \"Dissolved\" as well."},"children":[]}]}]}],"enum":["Current","Resigned","Dissolved"],"example":"Current"},"companyStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the company. Mapped from backend codes: \"C\" = \"Closed\", \"D\" = \"Dissolved\", \"L\" = \"Liquidation\", \"R\" = \"Receivership\", space = \"Active\", \"$\" = \"Insufficient information\"."},"children":[]}]}]}],"enum":["Active","Closed","Dissolved","Liquidation","Receivership","Insufficient information"],"example":"Active"}}}},"addresses":{"type":"object","description":"Address verification results matching the request structure. Always present in response.","required":["currentAddress"],"properties":{"currentAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current address result object. All fields (flags and arrays) are always present in the response, regardless of customData pseudo ID. Arrays may be empty [] and flags may be false based on the pseudo ID used."},"children":[]}]}]}],"properties":{"postCode":{"type":"string","description":"Postal code of the address from the request body."},"addressLine":{"type":"string","description":"Full address line from the request body."},"verifyMatch":{"type":"boolean","description":"Indicates if the verification matches for this address."},"flags":{"$ref":"#/components/schemas/Flags","description":"Flags for this address. Always present in response."},"countyCourtJudgments":{"type":"array","items":{"$ref":"#/components/schemas/CCJDetails"}},"electoralRolls":{"type":"array","items":{"$ref":"#/components/schemas/ElectoralRoll"}},"deceased":{"type":"array","items":{"$ref":"#/components/schemas/Deceased"}},"insolvencies":{"type":"array","items":{"$ref":"#/components/schemas/Insolvency"}}}},"previousAddresses":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous address result object. All fields (flags and arrays) are always present in the response, regardless of customData pseudo ID. Arrays may be empty [] and flags may be false based on the pseudo ID used."},"children":[]}]}]}],"required":["position"],"properties":{"position":{"type":"integer","description":"Position of the previous address (1 for first previous, 2 for second previous), matching the request.","minimum":1,"maximum":2},"postCode":{"type":"string","description":"Postal code of the address from the request body."},"addressLine":{"type":"string","description":"Full address line from the request body."},"verifyMatch":{"type":"boolean","description":"Indicates if the verification matches for this address."},"flags":{"$ref":"#/components/schemas/Flags","description":"Flags for this address. Always present in response."},"countyCourtJudgments":{"type":"array","items":{"$ref":"#/components/schemas/CCJDetails"}},"electoralRolls":{"type":"array","items":{"$ref":"#/components/schemas/ElectoralRoll"}},"deceased":{"type":"array","items":{"$ref":"#/components/schemas/Deceased"}},"insolvencies":{"type":"array","items":{"$ref":"#/components/schemas/Insolvency"}}}}}},"requestDetails":{"$ref":"#/components/schemas/PostSearchRequestDetails"}}}},"components/schemas/CreditsafeGlobalDataServiceResponse":{"id":"components/schemas/CreditsafeGlobalDataServiceResponse","kind":"json-schema","title":"CreditsafeGlobalDataServiceResponse","data":{"type":"object","properties":{"messages":{"description":"Provides information about the request and the response.","type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataMessage"}}}}},"components/schemas/CreditsafeGlobalDataDirectorSearchData":{"id":"components/schemas/CreditsafeGlobalDataDirectorSearchData","kind":"json-schema","title":"CreditsafeGlobalDataDirectorSearchData","data":{"type":"object","properties":{"peopleId":{"description":"The unique identifier of the person.","type":"string"},"firstName":{"description":"The first name of the director.","type":"string"},"lastName":{"description":"The last name of the director.","type":"string"},"country":{"description":"The country of the director.","$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"company":{"type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"}}},"companyName":{"description":"The name of the company.","type":"string"},"companyType":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyType"},"companyRegistrationNumber":{"description":"The registration number of the company.","type":"string"},"status":{"type":"string"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"},"dateOfLatestChange":{"description":"The date of the latest change to the director information.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"The date of birth of the director.","type":"string","format":"date-time"},"localDirectorNumber":{"description":"The local director number of the director.","type":"string"},"score":{"type":"integer"},"taxCode":{"type":"string"},"searchRanking":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataDirectorSearchData":{"id":"components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataDirectorSearchData","kind":"json-schema","title":"CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataDirectorSearchData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataServiceResponse"},{"type":"object","properties":{"correlationId":{"type":"string"},"directors":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataDirectorSearchData"}},"totalSize":{"description":"The total number of results.","type":"integer","format":"int32"}}}]}},"components/schemas/LocalSolutionsVerifyIndividualSummaryReportResponse":{"id":"components/schemas/LocalSolutionsVerifyIndividualSummaryReportResponse","kind":"json-schema","title":"LocalSolutionsVerifyIndividualSummaryReportResponse","data":{"type":"object","properties":{"verifyMatch":{"type":"boolean","description":"Indicates if the verification matches the individual."},"flags":{"type":"object","properties":{"ccjMatch":{"type":"boolean","description":"Indicates a CCJ match for the individual."},"electoralRegisterMatch":{"type":"boolean","description":"Indicates an electoral roll match on an individual."},"deceasedRegisterMatch":{"type":"boolean","description":"Indicates a deceased match against an individual."},"insolvencyMatch":{"type":"boolean","description":"Indicates an insolvency match against an individual."}}}}}},"components/schemas/LocalSolutionsVerifyIndividualFullReportResponse":{"id":"components/schemas/LocalSolutionsVerifyIndividualFullReportResponse","kind":"json-schema","title":"LocalSolutionsVerifyIndividualFullReportResponse","data":{"oneOf":[{"title":"Verify Match","type":"object","allOf":[{"$ref":"#/components/schemas/IndividualSummary"}]},{"type":"object","title":"Flags","allOf":[{"$ref":"#/components/schemas/IndividualSummary"},{"properties":{"flags":{"$ref":"#/components/schemas/Flags"}}}]},{"type":"object","title":"Full","allOf":[{"$ref":"#/components/schemas/IndividualSummary"},{"properties":{"countyCourtJudgments":{"type":"array","items":{"$ref":"#/components/schemas/CCJDetails"}},"electoralRolls":{"type":"array","items":{"$ref":"#/components/schemas/ElectoralRoll"}},"deceased":{"type":"array","items":{"$ref":"#/components/schemas/Deceased"}},"insolvencies":{"type":"array","items":{"$ref":"#/components/schemas/Insolvency"}}}}]},{"type":"object","title":"Full with Flags","allOf":[{"$ref":"#/components/schemas/IndividualSummary"},{"properties":{"flags":{"$ref":"#/components/schemas/Flags"},"countyCourtJudgments":{"type":"array","items":{"$ref":"#/components/schemas/CCJDetails"}},"electoralRolls":{"type":"array","items":{"$ref":"#/components/schemas/ElectoralRoll"}},"deceased":{"type":"array","items":{"$ref":"#/components/schemas/Deceased"}},"insolvencies":{"type":"array","items":{"$ref":"#/components/schemas/Insolvency"}}}}]}]}},"schema_598":{"kind":"json-schema","data":{"type":"string"},"id":"schema_598"},"schema_599":{"kind":"json-schema","data":{"type":["string","null"]},"id":"schema_599"},"schema_600":{"kind":"json-schema","data":{"type":["boolean","null"]},"id":"schema_600"},"schema_601":{"kind":"json-schema","data":{"type":["string","null"],"default":null},"id":"schema_601"},"schema_602":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_602"},"schema_603":{"kind":"json-schema","data":{"enum":["Both","Validate","Verify"]},"id":"schema_603"},"schema_604":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/AMLSearch"},{"$ref":"#/components/schemas/AMLMultiBureauSearch"},{"$ref":"#/components/schemas/ConsumerSearch"}]},"id":"schema_604"},"schema_605":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ConnectIdentityConsumerSearchResult"},{"$ref":"#/components/schemas/ConnectIdentityMultiBureauAmlSearchResult"},{"$ref":"#/components/schemas/ConnectIdentityAmlSearchResult"}]},"id":"schema_605"},"schema_606":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"},"example":["1:1:1_0"]},"id":"schema_606"},"schema_607":{"kind":"json-schema","data":{"type":["integer","null"],"format":"int32"},"id":"schema_607"},"schema_608":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_608"},"schema_609":{"kind":"json-schema","data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityProduct"}},"id":"schema_609"},"schema_610":{"kind":"json-schema","data":{"type":["string","null"],"format":"date-time"},"id":"schema_610"},"schema_611":{"kind":"json-schema","data":{"type":"object","required":["bankAccount","sortCode"],"properties":{"bankAccount":{"type":"string","description":"The bank account number you would like to check matches the bank account number you queried with the the supplier when making the request with request-id"},"sortCode":{"type":"string","description":"The sort code you would like to check matches the sort code you queried with the the supplier when making the request with request-id"}}},"id":"schema_611"},"schema_612":{"kind":"json-schema","data":{"type":"object","properties":{"isValid":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result of this endpoint is not a match result and is not indicative of whether the suppliers result. As such:-"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint can return isValid as true for a No Match result."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint can return isValid as false for a Match result."},"children":[]}]}]}]}}},"id":"schema_612"},"schema_613":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SortCodeCheckResponse"}},"id":"schema_613"},"schema_614":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/GBLocalSolutionGetHistoryListResponse"}},"id":"schema_614"},"schema_615":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_615"},"schema_616":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ConnectFootprintDataFinance"},{"$ref":"#/components/schemas/ConnectFootprintIndicatorData"},{"$ref":"#/components/schemas/ConnectIndicatorData"},{"$ref":"#/components/schemas/ConnectFullFinanceData"}]},"id":"schema_616"},"schema_617":{"kind":"json-schema","data":{"pattern":"^[a-zA-Z]{2}$","type":"string","default":"en"},"id":"schema_617"},"schema_618":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_618"},"schema_619":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_619"},"schema_620":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"id":"schema_620"},"schema_621":{"kind":"json-schema","data":{"type":["string","null"],"default":null,"maxLength":2,"minLength":2},"id":"schema_621"},"schema_622":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataOfficeType"},{"type":"null"}]},"id":"schema_622"},"schema_623":{"kind":"json-schema","data":{"type":["array","null"],"items":{"type":"string"}},"id":"schema_623"},"schema_624":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"},{"type":"null"}]},"id":"schema_624"},"schema_625":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyType"},"id":"schema_625"},"schema_626":{"kind":"json-schema","data":{"type":"string","pattern":"/^(GB|IE)-[01]-.+$/i"},"id":"schema_626"},"schema_627":{"kind":"json-schema","data":{"type":"string","enum":["AM","AV","BS","CA","DC","DS","EC","GI","QS","TV","GC"]},"id":"schema_627"},"schema_628":{"kind":"json-schema","data":{"pattern":"^[a-zA-Z]{2}$","type":["string","null"],"default":"en"},"id":"schema_628"},"schema_629":{"kind":"json-schema","data":{"type":["string","null"],"default":"full"},"id":"schema_629"},"schema_630":{"kind":"json-schema","data":{"type":"string","pattern":"^([a-zA-Z\\\\s]+,)*[a-zA-Z\\\\s]+$"},"id":"schema_630"},"schema_631":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataDirectorSearchData"}]},"id":"schema_631"},"schema_632":{"kind":"json-schema","data":{"type":"string","pattern":"/^(GB|IE)-.+$/i"},"id":"schema_632"},"schema_633":{"kind":"json-schema","data":{"type":"string","enum":["searchSupport"]},"id":"schema_633"}},"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/localsolutions/localsolutions","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/connect-apis-catalog/product-catalog/LocalSolutions/localSolutions.json?download"},{"url":"/_bundle/connect-apis-catalog/product-catalog/LocalSolutions/localSolutions.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Local Solutions","description":"# Introduction\n\nThe Local Solutions API provides a suite of specialized endpoints designed to address region-specific business needs across multiple countries.\nIt enables users to access a variety of local data services, such as land registry information, bank account verification, consumer and anti-money laundering checks, and company searches tailored to local requirements.\nThe API supports operations in several regions, including Great Britain, France, Germany, the Netherlands, and the United States, offering targeted solutions for each market.\n\nWith secure authentication and a modular structure, Local Solutions allows businesses to integrate local compliance, verification, and data enrichment processes into their workflows efficiently.\n\nThe list of supported regions is always expanding and will not be limited to those currently available.\n","status":"published","tags":["Featured"]}},"baseSlug":"/connect-apis-catalog/product-catalog/localsolutions/localsolutions","routesMapping":{}}